DjangoをDEBUG=Falseでデプロイできない：Server Error (500)が出る時の原因

2023.02.18

Django を DEBUG=False でデプロイすると Server Error (500) が出ることがある。この時に確かめることは下の通り。

ALLOWED_HOSTS に実際のドメインが入っているか→ローカルホストだけだともちろんエラーが出る
アスタリスクが入っていないか→直接悪さをするわけではないが推奨されない
whitenoise をきちんと設定していない

whitenoise については今調べているので後で追記する。

アスタリスクでは治らない

ドメイン名が書かれている場合、アスタリスクにしても当然治らない。アスタリスクはワイルドカード、つまりなんでも受け付けることを意味するが、アスタリスクにしてもダメということは、ALLOWED_HOSTS に原因はないということ。

サーバーエラーが出たらとりあえずアスタリスクにしてみる。原因が ALLOWED_HOSTS にあるかないかでその後の対処法は変わる。

静的ファイルのディレクトリを読み取れていない可能性

正直今は混乱しているので、ここは間違った情報かもしれない。サーバーエラーが起きるのは、サーバー側のデバッグモードをオフにした Django が Static Assets をきちんと読み取っていない可能性が考えられる。

whitenoise.middleware.WhiteNoiseMiddleware

なぜ静的ファイルを疑ったかというと、デバッグモードをオフにしたとき、cssファイルですら表示されなくなったから。ここで真っ先に考えることは WhiteNoiseMiddleware というもの。

しかし MIDDLEWARE に

'whitenoise.middleware.WhiteNoiseMiddleware',

を追加しただけでは治らない。ただしこの行は必須のようだ。順番は

'django.middleware.security.SecurityMiddleware',

の次、それ以外よりも前がいいらしい。

ここまででもダメ。次に

STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

を同じ設定ファイルに書く。しかしこれでもダメ。そもそもこの CompressedManifestStaticFilesStorage というのはオプションで、あってもなくもかまわないもの。

python manage.py collectstatic

python manage.py collectstatic が必要ということを知る。これは静的ファイルをアプリディレクトリ直下のディレクトリに集めるという処理だが、ここでなぜかエラーが出る。

この辺でスタックオーバーフローの情報もほとんど尽きてしまっている。静的ファイル関係はなぜか体系的におさえたページがなく、誤った情報もあふれているようだ。

STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

が意外と問題となる。これがあると今度はローカルで動かなくなる。

最終的にわかったこと

ようやく治った。原因は一部のcssファイルに画像読み込みの何かが書かれていたことだった。つまり下のコードは完全に正解だったことになる。

設定ファイル

import os
import django_heroku
import dj_database_url

DEBUG = False

CLOUD = True

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

SECRET_KEY = 'hsdkhfdjfruvdjncgljsieskjva45asefsaf8vjxnsjdbvjad'

ALLOWED_HOSTS = ['yourdomain.herokuapp.com', 'www.yourdomain.com', 'django_sendgrid', '127.0.0.1', ]

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

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'whitenoise.middleware.WhiteNoiseMiddleware',
    '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',
]

ROOT_URLCONF = 'blog.urls'

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',
            ],
        },
    },
]

WSGI_APPLICATION = 'blog.wsgi.application'

if not CLOUD:
    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.postgresql_psycopg2',
            'NAME': 'yourdomaindb',
            'USER': 'postgres',
            'PASSWORD': '',
            'HOST': 'localhost',
            'PORT': '',
        }
    }
else:
    SECURE_SSL_REDIRECT = True
    django_heroku.settings(locals())
    DATABASES = {
        'default': dj_database_url.config(
            default='postgres://djshfendljncljdfvhl.compute-1.amazonaws.com:5432/dgkjdbcnskrhjvb'
        )
    }
    db_from_env = dj_database_url.config()
    DATABASES['default'].update(db_from_env)
    STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

STATIC_URL = '/static/'

STATIC_ROOT = os.path.join(BASE_DIR, 'static')

# STATICFILES_DIRS = (os.path.join(BASE_DIR, 'static'),)

MEDIA_URL = '/media/'

MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

GOOGLE_APPLICATION_CREDENTIALS = BASE_DIR + '/hflhrueghslakjncljadnvlu'

SENDGRID_API_KEY = 'uhgflncdsuhr547sklnclvhsijf84jfkjsdfjlsughdjfvs'

EMAIL_HOST = 'smtp.sendgrid.net'

EMAIL_HOST_USER = 'sjdfnajlshusirdvdnkjvlssru'

EMAIL_HOST_PASSWORD = 'djne57ajnlsdjshu'

EMAIL_PORT = 587

EMAIL_USE_TLS = True

sendgrid も含めてこれがすべて。これで動く。

わかったこと

サーバーエラーはやっぱり画像関係だった。
STATICFILES_DIRS はいらない。
python manage.py collectstatic は必須。重要である。これですべての画像をアプリ直下のstaticディレクトリに集める。
STATIC_ROOT はきちんと設定する。
DISABLE_COLLECTSTATIC=1 はサーバー側で設定する。
whitenoise.middleware.WhiteNoiseMiddleware は必須。
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage' も必須。ただしローカルで動かないようにする。

海外のサイトを見て結局だめだった方法

DISABLE_COLLECTSTATIC=1 を消せばいい→誤り。

STATICFILES_STORAGE はオプションで消しても問題ない→誤り。STATICFILES_STORAGE を消せばオッケーだよと言っている人は、自分の環境がローカルか本番か区別していないで言っている可能性が高い。実際は、本番で必要、ローカルで削除ということで問題ない。

wsgiにwhitenoise を書く→誤り。whitenoise は現在 v4 となっていて、wsgi に何かを追記する必要はまったくない。そんなことよりも設定ファイルの MIDDLEWARE にアレを書くことが重要。

Django

デプロイ