【Django】settings.py：各設定値の解説（まとめ・一覧）

BASE_DIRにはプロジェクトのベースフォルダを指定しています。

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

デフォルトではプロジェクトを作成した際に作成されるフォルダ（manage.pyが入っている場所）を指しています。

BASE_DIRについて詳しく知りたい方は以下記事をご参照ください。

【Django】settings.py内のBASE_DIRの意味と指す場所を解説

SECRET_KEYには暗号化やハッシュ化で使用される秘密鍵（シークレットキー）が指定されています。

シークレットキーはプロジェクトごとに異なるキーが作成されます。外部に公開はしないようにしましょう。

アプリケーション開発する上では意識することがない設定値です。

DEBUGにはTrue（有効）またはFalse（無効）の値を指定しデバッグの有無を設定します。

DEBUG = Trueの場合デバッグモードが有効となり、エラー発生がするとブラウザにエラー詳細を表示します。

デフォルト値はDEBUG = Trueであり、開発環境ではデバッグモードを有効にしたまま利用します。

DEBUG = Falseの場合デバッグモードが無効となり、エラー情報が表示されなくなります。

本番環境で公開するときは、エラー情報から情報が漏れることを防ぐため必ずDEBUG = Falseにします。

デバッグモードについて詳しくは以下記事をご参照ください。

【Django】settings.py内のBASE_DIRの意味と指す場所を解説

ALLOWED_HOSTSにはWebサービスを配信するサーバーのドメイン名・IPアドレス・ホスト名をリストで指定します。

デフォルト値は空のリストです。DEBUG = Falseにした本番環境では、必ずALLOWED_HOSTSに値を設定する必要があります。

クライアントから送信されたHttpRequestのヘッダ値と比較し、一致しない場合は400エラーを返します。

ALLOWED_HOSTSについて詳しくは以下記事をご参照ください。

【Django】settings.py：Debug＝Trueは本番環境公開前にFalseにすべき理由

Djangoではアプリケーションと呼ばれる単位に分割し、それらを組み合わせることで一つのWebアプリケーションを作成していきます。

各アプリケーションは作成したら必ずsettings.pyのINSTALLED_APPSに追加します。

プロジェクト作成時には次のように初めから複数のアプリケーションが登録されています。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

Djangoはフルスタックフレームワークと言われるように、標準で認証やセッションの機能を有しています。
それら標準の機能はINSTALLED_APPSに登録されているということです。

フラッシュメッセージ機能のmessagesについては以下記事をご参照ください。

【Django】settings.py内のBASE_DIRの意味と指す場所を解説

python manage.py startappでアプリケーションを作成した後は、INSTALLED_APPSにそのアプリケーションを追加して利用できるようにしましょう。

settings.pyのMIDDLEWAREにミドルウェアを追加することでミドルウェアが有効化されます。

ミドルウェアとはDjangoでリクエスト・レスポンス処理の前後でフックを加える仕組みです。

ミドルウェアについて詳しく知りたい方は以下記事をご参照ください。

【Django】Middlewareミドルウェアとは（有効化、構造、実行されるタイミング）

Djangoはフルスタックフレームワークと呼ばれるだけあって、初めから様々なミドルウェアが用意されています。

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

これらはセキュリティを強化するミドルウェアや、セッションを有効にするミドルウェア、アクセス制限を行うミドルウェアなどです。

ミドルウェアを自作したときは、MIDDLEWAREに追加することでそれが有効になります。

ミドルウェアの自作方法については以下記事をご参照ください。

【Django】Middlewareミドルウェアを新たに自分で作成（自作）する方法

ROOT_URLCONFにはルートのurls.pyを指定します。
基本的にはプロジェクトのurls.pyを指定します。

プロジェクト名がofficeの場合、デフォルトでは以下のように設定されます。

ROOT_URLCONF = 'office.urls'

TEMPLATESにはプロジェクトのテンプレートに関する設定を行います。

デフォルトでは以下のように設定されています。

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

BACKENDにはDTL（Django Template Language）を利用するための「django.template.backends.django.DjangoTemplates」がデフォルトで設定されています。

DIRSにはテンプレートを優先して探しに行くフォルダをリストで指定します。ベースフォルダ（manage.pyが置かれているフォルダ）直下の「templates」フォルダを検索対象に追加する場合は次のように記入します。

'DIRS': [BASE_DIR / 'templates'],

APP_DIRSには各アプリケーション直下にある「templates」フォルダを検索対象に含めるかを指定します。デフォルトではTrueが指定されています。

'APP_DIRS': True,

OPTIONSにはcontext_processorsという関数が記載されています。これはテンプレートから参照できる変数を渡す機能を提供しています。

DATABASESにはWebアプリケーションで利用するデータベースに関する設定を行います。

Webアプリケーションで利用するデータベースの設定はデフォルトでは以下のように設定されています。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

上記からわかるように、デフォルトではデータベースとしてsqlite3が指定されています。ENGINEにはデータベースエンジン、NAMEにはデータベース情報（データベース名）を指定します。

もちろんsqlite3以外のmysqlやpostgresql、oracleなども利用できます。私は普段から利用することが多いMySQLを主に使います。

MySQLを利用する時はENGINEを以下のように変更します。

'ENGINE': 'django.db.backends.mysql',

プロジェクトの言語のデフォルト値は英語、タイムゾーンはUTCで設定されています。

言語を日本語、タイムゾーンを日本に変更するには以下の設定値を変更します。

LANGUAGE_CODE = 'ja'
TIME_ZONE = 'UTC'

デフォルト値は言語が'en-us'、タイムゾーンは'UTC'の値が設定されています。

STATIC_URLにはスタティックファイルのURLを指定します。
つまりCSSやJavaScript、Imageの保存場所を指定するということです。

STATIC_URL = '/static/'

基本的にここの設定は変更しません。

Djangoでのスタティックファイルについては以下記事をご参照ください。

【django】静的ファイル（CSS、JavaScript、Image）の保存場所や設定について

本記事「【Django】settings.py：各設定値の解説（まとめ・一覧）」はいかがでしたか。

ぜひ本記事で学んだことをWebアプリケーション開発に活かしてください。