🐳

DockerComposeでNginx+Django+MySQL環境の構築

2024/06/25に公開

概要

Ubuntu(20.04 LTS)でDjangoの開発環境をDocker-composeを利用して構築したのでその備忘録です。

  • Ubuntu:20.04LTS
  • Docker:26.1.4
  • Docker Compose:2.24.1
  • Nginx:1.27.0
  • MySQL:8.0
  • Python:3.12

ディレクトリ構成

今回のディレクトリ構成は下記になります。

.
├── .gitignore
├── .env
├── docker-compose.yml
|
├── django/
|   ├── .env
|   ├── Dockerfile
|   └── requirements.txt
|
├── nginx/
│   ├── nginx.conf
│   └── uwsgi_params
│
├── mysql/
│   └── .env
│
├── sql/
│   └── init.sql
|
├── src/
│   └── ...(Djangoのプロジェクト)
│
└── static/
    └── ... (静的ファイル)

ファイルの作成

まず必要なファイルを作成します。

docker-compose.yml

version: '3.8'

services:
  nginx:
    image: nginx:1.27.0
    ports:
      - "8000:8000"
    volumes:
      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
      - ./nginx/uwsgi_params:/etc/nginx/uwsgi_params:ro
      - static_volume:/static
    depends_on:
      - django

  mysql:
    image: mysql:8.0
    command: --default-authentication-plugin=mysql_native_password
    ports:
      - "3306:3306"
    env_file:
      - ./mysql/.env
    volumes:
      - mysql_data:/var/lib/mysql
      - ./sql:/docker-entrypoint-initdb.d
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      timeout: 20s
      retries: 10

  django:
    build:
      context: ./django
      dockerfile: Dockerfile
    command: uwsgi --socket :8001 --module プロジェクト名.wsgi --py-autoreload 1 --logto /tmp/mylog.log
    volumes:
      - ./src:/code
      - static_volume:/static
    expose:
      - "8001"
    env_file:
      - ./django/.env
    depends_on:
      mysql:
        condition: service_healthy
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"

volumes:
  mysql_data:
  static_volume:

今回はDjangoのプロジェクト名を「app」で進めます。
Djangoの「プロジェクト名.wsgi」の部分は適宜差し替えてください。

django/Dockerfile

# Python 3.12のイメージを使用
FROM python:3.12-slim

# 作業ディレクトリを設定
WORKDIR /code

# 必要なパッケージをインストール
RUN apt-get update && apt-get install -y \
  gcc \
  libmariadb-dev \
  pkg-config \
  default-libmysqlclient-dev \
  build-essential \
  && rm -rf /var/lib/apt/lists/*

# 依存関係ファイルをコピー
COPY requirements.txt .

# Pythonパッケージをインストール
RUN pip install --upgrade pip
RUN pip install --no-cache-dir -r requirements.txt

# プロジェクトファイルをコピー
COPY . .

# uWSGIを実行
CMD ["uwsgi", "--socket", ":8001", "--module", "app.wsgi", "--py-autoreload", "1", "--logto", "/tmp/mylog.log"]

pkg-config
default-libmysqlclient-dev
上記に関してはPyMySQLを使用する場合は必要ない場合もあります。

django/requirements.txt

Django
uwsgi
mysqlclient

MySQLのドライバーはPyMySQLではなくmysqlclientを利用しています。
PyPI - PyMySQL
PyPI - mysqlclient

django/.env

DJANGO_SECRET_KEY=your-secret-key
DJANGO_DEBUG=True
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
MYSQL_ROOT_PASSWORD=root
MYSQL_DATABASE=db
MYSQL_USER=db-user
MYSQL_PASSWORD=password
MYSQL_HOST=mysql
MYSQL_PORT=3306

ユーザー名、データベース名、パスワードは適宜変更してください。

nginx/nginx.conf

user  nginx;
worker_processes  1;

error_log  /var/log/nginx/error.log warn;
pid        /var/run/nginx.pid;

events {
    worker_connections  1024;
}

http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

    access_log  /var/log/nginx/access.log  main;

    sendfile        on;
    keepalive_timeout  65;

    upstream django {
        server django:8001;  # Django サービスの名前と port
    }

    server {
        listen 8000;
        server_name localhost;
        charset     utf-8;

        client_max_body_size 75M;

        location /static {
            alias /static;  # Docker ボリュームにマウントされた静的ファイルのパス
        }

        location / {
            uwsgi_pass  django;
            include     /etc/nginx/uwsgi_params;
        }
    }
}

/staticは静的ファイルが格納されているディレクトリです。
client_max_body_size ... はアップロードできる最大値です。
worker_processesは必要に応じて増やしてください。

nginx/uwsgi_params

uwsgi_param  QUERY_STRING       $query_string;
uwsgi_param  REQUEST_METHOD     $request_method;
uwsgi_param  CONTENT_TYPE       $content_type;
uwsgi_param  CONTENT_LENGTH     $content_length;

uwsgi_param  REQUEST_URI        $request_uri;
uwsgi_param  PATH_INFO          $document_uri;
uwsgi_param  DOCUMENT_ROOT      $document_root;
uwsgi_param  SERVER_PROTOCOL    $server_protocol;
uwsgi_param  REQUEST_SCHEME     $scheme;
uwsgi_param  HTTPS              $https if_not_empty;

uwsgi_param  REMOTE_ADDR        $remote_addr;
uwsgi_param  REMOTE_PORT        $remote_port;
uwsgi_param  SERVER_PORT        $server_port;
uwsgi_param  SERVER_NAME        $server_name;

mysql/.env

MYSQL_ROOT_PASSWORD=root
MYSQL_DATABASE=db
MYSQL_USER=db-user
MYSQL_PASSWORD=password
TZ='Asia/Tokyo'

ユーザー名、データベース名、パスワードは適宜変更してください。

sql/init.sql

GRANT ALL PRIVILEGES ON db.* TO 'db-user'@'%';

FLUSH PRIVILEGES;

上記のユーザー名に合わせてください。

DockerComposeのビルド

ルートディレクトリで下記コマンドを実行します。

docker-compose build

docker-compose.ymlの内容でビルドを行います。

Djangoプロジェクトの準備

ローカルで開発しているDjangoのプロジェクトがあれば、src/以下にコピーして先へ進んでください。

プロジェクトがない場合は下記コマンドでプロジェクトを作成します。
今回はプロジェクト名を「app」としています。

docker-compose run --rm django django-admin startproject app .

コマンドを実行すると、yamlの部分で

django:
  volumes:
    - ./src:/code

Dockerfileで

WORKDIR /code

と指定されているのでsrc/以下に「app」という名前のプロジェクトが作成されます。

app/settings.pyの編集

Djangoプロジェクトのsettings.pyを編集します。
django/app/settings.pyを下記に書き換えてください。

"""
Django settings for app project.

Generated by 'django-admin startproject' using Django 5.0.6.

For more information on this file, see
https://docs.djangoproject.com/en/5.0/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/5.0/ref/settings/
"""
import os
from pathlib import Path

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY', 'django-insecure-default-key-change-this')

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = os.environ.get('DJANGO_DEBUG', 'True') == 'True'

ALLOWED_HOSTS = os.environ.get('DJANGO_ALLOWED_HOSTS', 'localhost 127.0.0.1 [::1]').split()


# Application definition

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

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 = 'app.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 = 'app.wsgi.application'


# Database
# https://docs.djangoproject.com/en/5.0/ref/settings/#databases

# Database
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': os.environ.get('MYSQL_DATABASE', 'django'),
        'USER': os.environ.get('MYSQL_USER', 'django'),
        'PASSWORD': os.environ.get('MYSQL_PASSWORD', 'django_password'),
        'HOST': os.environ.get('MYSQL_HOST', 'mysql'),
        'PORT': os.environ.get('MYSQL_PORT', '3306'),
    }
}


# Password validation
# https://docs.djangoproject.com/en/5.0/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/5.0/topics/i18n/
LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'
USE_I18N = True
USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.0/howto/static-files/

STATIC_URL = '/static/'
STATIC_ROOT = '/static'
STATICFILES_DIRS = [BASE_DIR / 'staticfiles']

# Default primary key field type
# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

Djangoの環境変数は/django/.envに設定しています。

マイグレーションの実行

マイグレーションを行います。

docker-compose run --rm django python manage.py makemigrations
docker-compose run --rm django python manage.py migrate

コンテナの起動

下記コマンドでコンテナを起動します。

docker-compose up -d

その後http://localhost:8000/にアクセスし、Djangoの初期画面が起動されたら成功です。

その他

requirements.txtにパッケージを追加した場合はその部分を再ビルドしてください。

docker-compose build django

Discussion