DjangoをS3(AWS)ストレージ付きのHerokuにデプロイする
Herokuで画像などのファイルをアップロードしたい時、別途ストレージを用意する必要がある。
特に代表的なのがAWSのS3をストレージとする方法。
既に解説記事があるので、S3の設定関係はDjangoをEC2(Ubuntu)、RDS(PostgreSQL)、S3の環境にデプロイをするを参照。
コードはDjangoで画像及びファイルをアップロードする方法から流用する。
Herokuデプロイの詳しい流れは、DjangoをDEBUG=FalseでHerokuにデプロイする方法を参照。
仮想環境に必要なライブラリのインストール
仮想環境に必要なライブラリをインストールさせる
pip install django django-heroku dj-database-url gunicorn whitenoise psycopg2
pip install Pillow python-magic
pip install boto3 django-storages
上から順に、DjangoとHerokuデプロイ用のライブラリ、ファイルアップロード用のライブラリ、S3用のライブラリ
インストールしたら、requirements.txtを生成する。
pip freeze > requirements.txt
Procfileを作成する。
echo "web: gunicorn config.wsgi:application --log-file -" > Procfile
settings.pyの中身
"""
Django settings for config project.
Generated by 'django-admin startproject' using Django 2.2.3.
For more information on this file, see
https://docs.djangoproject.com/en/2.2/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.2/ref/settings/
"""
import os
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = "GENERATED KEY "
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = False
ALLOWED_HOSTS = []
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'upload.apps.UploadConfig',
'storages', #←追加
]
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',
]
ROOT_URLCONF = 'config.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR,"templates")],
'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 = 'config.wsgi.application'
# Database
# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
# Password validation
# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators
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',
},
]
# Internationalization
# https://docs.djangoproject.com/en/2.2/topics/i18n/
LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.2/howto/static-files/
STATIC_URL = '/static/'
if DEBUG:
STATICFILES_DIRS = [os.path.join(BASE_DIR, "static")]
"""
MEDIA_URL = "/media/"
if DEBUG:
MEDIA_ROOT = os.path.join(BASE_DIR, "media")
else:
PROJECT_NAME = os.path.basename(BASE_DIR)
#↓は一般的なLinuxサーバーにデプロイする場合のパス。クラウドにデプロイする場合、下記は要修正。
MEDIA_ROOT = "/var/www/{}/media".format(PROJECT_NAME)
"""
DEFAULT_AUTO_FIELD='django.db.models.AutoField'
if not DEBUG:
# Herokuデプロイ時に必要になるライブラリのインポート
import django_heroku
import dj_database_url
# ALLOWED_HOSTSにホスト名)を入力
ALLOWED_HOSTS = [ 'hogehoge.herokuapp.com' ]
# 静的ファイル配信ミドルウェア、whitenoiseを使用。※順番不一致だと動かないため下記をそのままコピーする。
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',
]
# DBを使用する場合は下記を入力する。
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'ここにDatabaseを入力',
'USER': 'ここにUserを入力',
'PASSWORD': 'ここにPasswordを入力',
'HOST': 'ここにHostを入力',
'PORT': 'ここにPortを入力',
}
}
db_from_env = dj_database_url.config(conn_max_age=600, ssl_require=True)
DATABASES['default'].update(db_from_env)
# 静的ファイル(static)の存在場所を指定する。
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
#ストレージ設定。
AWS_ACCESS_KEY_ID = "ここにアクセスキーのIDを入れる"
AWS_SECRET_ACCESS_KEY = "ここにアクセスキーを入れる。"
AWS_STORAGE_BUCKET_NAME = "ここにバケットの名前を入れる"
DEFAULT_FILE_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'
S3_URL = 'http://%s.s3.amazonaws.com/' % AWS_STORAGE_BUCKET_NAME
MEDIA_URL = S3_URL
AWS_S3_FILE_OVERWRITE = False
AWS_DEFAULT_ACL = None
Herokuのデプロイ仕様のsettings.pyに、S3の設定を追加で施す。ただ、それだけ。
デプロイ
git add .
git commit -m "deploy"
heroku login
heroku git:clone -a [ここにアプリ名を]
git push heroku master
結論
おそらく、他のクラウドにデプロイする際でもS3の設定部分は共通していると思われる。
S3のリージョンはHeroku側(アメリカ)に合わせたほうが良さげ。
日本からアメリカのHerokuへファイルをアップロードして、アメリカのHerokuから東京にあるS3へファイルをコピーしているようではレスポンスが遅くなると思われる。
また、デフォルトのNginxと違ってファイルのアップロード上限は存在しない模様。50MB以上のファイルでも問題なくアップロードできた。ただ、ファイルが大きすぎるとタイムアウトしてしまうので程々に。