├── app
    ├── config
    │   ├── __init__.py
    │   ├── asgi.py
    │   ├── wsgi.py
    │   ├── urls.py
    │   └── settings.py
    ├── requirements.txt
    ├── Dockerfile
    ├── manage.py
    └── Dockerfile.prod
├── .dockerignore
├── .gitignore
├── Dockerfile.traefik
├── traefik.dev.toml
├── traefik.prod.toml
├── README.md
├── docker-compose.yml
├── LICENSE
└── docker-compose.prod.yml


/app/config/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.dockerignore:
--------------------------------------------------------------------------------
1 | .venv
2 | db.sqlite3


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .venv
2 | db.sqlite3


--------------------------------------------------------------------------------
/Dockerfile.traefik:
--------------------------------------------------------------------------------
1 | FROM traefik:v2.9.6
2 | 
3 | COPY ./traefik.prod.toml ./etc/traefik/traefik.toml
4 | 


--------------------------------------------------------------------------------
/app/requirements.txt:
--------------------------------------------------------------------------------
1 | Django==4.1.6
2 | django-environ==0.9.0
3 | psycopg2-binary==2.9.5
4 | gunicorn==20.1.0
5 | whitenoise==6.3.0
6 | 


--------------------------------------------------------------------------------
/traefik.dev.toml:
--------------------------------------------------------------------------------
 1 | # listen on port 80
 2 | [entryPoints]
 3 |   [entryPoints.web]
 4 |     address = ":80"
 5 | 
 6 | # Traefik dashboard over http
 7 | [api]
 8 | insecure = true
 9 | 
10 | [log]
11 | level = "DEBUG"
12 | 
13 | [accessLog]
14 | 
15 | # containers are not discovered automatically
16 | [providers]
17 |   [providers.docker]
18 |     exposedByDefault = false
19 | 


--------------------------------------------------------------------------------
/app/Dockerfile:
--------------------------------------------------------------------------------
 1 | # app/Dockerfile
 2 | 
 3 | # pull the official docker image
 4 | FROM python:3.11.2-slim
 5 | 
 6 | # set work directory
 7 | WORKDIR /app
 8 | 
 9 | # set env variables
10 | ENV PYTHONDONTWRITEBYTECODE 1
11 | ENV PYTHONUNBUFFERED 1
12 | 
13 | # install dependencies
14 | COPY requirements.txt .
15 | RUN pip install -r requirements.txt
16 | 
17 | # copy project
18 | COPY . .
19 | 


--------------------------------------------------------------------------------
/app/config/asgi.py:
--------------------------------------------------------------------------------
 1 | """
 2 | ASGI config for config project.
 3 | 
 4 | It exposes the ASGI callable as a module-level variable named ``application``.
 5 | 
 6 | For more information on this file, see
 7 | https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
 8 | """
 9 | 
10 | import os
11 | 
12 | from django.core.asgi import get_asgi_application
13 | 
14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
15 | 
16 | application = get_asgi_application()
17 | 


--------------------------------------------------------------------------------
/app/config/wsgi.py:
--------------------------------------------------------------------------------
 1 | """
 2 | WSGI config for config project.
 3 | 
 4 | It exposes the WSGI callable as a module-level variable named ``application``.
 5 | 
 6 | For more information on this file, see
 7 | https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
 8 | """
 9 | 
10 | import os
11 | 
12 | from django.core.wsgi import get_wsgi_application
13 | 
14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
15 | 
16 | application = get_wsgi_application()
17 | 


--------------------------------------------------------------------------------
/traefik.prod.toml:
--------------------------------------------------------------------------------
 1 | [entryPoints]
 2 |   [entryPoints.web]
 3 |     address = ":80"
 4 |   [entryPoints.web.http]
 5 |     [entryPoints.web.http.redirections]
 6 |       [entryPoints.web.http.redirections.entryPoint]
 7 |         to = "websecure"
 8 |         scheme = "https"
 9 | 
10 |   [entryPoints.websecure]
11 |     address = ":443"
12 | 
13 | [accessLog]
14 | 
15 | [api]
16 | dashboard = true
17 | 
18 | [providers]
19 |   [providers.docker]
20 |     exposedByDefault = false
21 | 
22 | [certificatesResolvers.letsencrypt.acme]
23 |   email = "your@email.com"
24 |   storage = "/certificates/acme.json"
25 |   [certificatesResolvers.letsencrypt.acme.httpChallenge]
26 |     entryPoint = "web"
27 | 


--------------------------------------------------------------------------------
/app/manage.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | """Django's command-line utility for administrative tasks."""
 3 | import os
 4 | import sys
 5 | 
 6 | 
 7 | def main():
 8 |     """Run administrative tasks."""
 9 |     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
10 |     try:
11 |         from django.core.management import execute_from_command_line
12 |     except ImportError as exc:
13 |         raise ImportError(
14 |             "Couldn't import Django. Are you sure it's installed and "
15 |             "available on your PYTHONPATH environment variable? Did you "
16 |             "forget to activate a virtual environment?"
17 |         ) from exc
18 |     execute_from_command_line(sys.argv)
19 | 
20 | 
21 | if __name__ == "__main__":
22 |     main()
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Dockerizing Django with Postgres, Gunicorn, and Traefik
 2 | 
 3 | ## Want to learn how to build this?
 4 | 
 5 | Check out the [post](https://testdriven.io/blog/django-docker-traefik/).
 6 | 
 7 | ## Want to use this project?
 8 | 
 9 | ### Development
10 | 
11 | Build the images and spin up the containers:
12 | 
13 | ```sh
14 | $ docker-compose up -d --build
15 | ```
16 | 
17 | Test it out:
18 | 
19 | 1. [http://django.localhost:8008/](http://django.localhost:8008/)
20 | 1. [http://django.localhost:8081/](http://django.localhost:8081/)
21 | 
22 | ### Production
23 | 
24 | Update the domain in *docker-compose.prod.yml*, and add your email to *traefik.prod.toml*.
25 | 
26 | Build the images and run the containers:
27 | 
28 | ```sh
29 | $ docker-compose -f docker-compose.prod.yml up -d --build
30 | ```
31 | 


--------------------------------------------------------------------------------
/app/config/urls.py:
--------------------------------------------------------------------------------
 1 | """config URL Configuration
 2 | 
 3 | The `urlpatterns` list routes URLs to views. For more information please see:
 4 |     https://docs.djangoproject.com/en/4.1/topics/http/urls/
 5 | Examples:
 6 | Function views
 7 |     1. Add an import:  from my_app import views
 8 |     2. Add a URL to urlpatterns:  path('', views.home, name='home')
 9 | Class-based views
10 |     1. Add an import:  from other_app.views import Home
11 |     2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
12 | Including another URLconf
13 |     1. Import the include() function: from django.urls import include, path
14 |     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
15 | """
16 | from django.contrib import admin
17 | from django.urls import path
18 | 
19 | urlpatterns = [
20 |     path("admin/", admin.site.urls),
21 | ]
22 | 


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | version: '3.8'
 2 | 
 3 | services:
 4 |   web:
 5 |     build: ./app
 6 |     command: bash -c 'while !</dev/tcp/db/5432; do sleep 1; done; python manage.py runserver 0.0.0.0:8000'
 7 |     volumes:
 8 |       - ./app:/app
 9 |     expose:
10 |       - 8000
11 |     environment:
12 |       - DEBUG=1
13 |       - DATABASE_URL=postgresql://django_traefik:django_traefik@db:5432/django_traefik
14 |     depends_on:
15 |       - db
16 |     labels:
17 |       - "traefik.enable=true"
18 |       - "traefik.http.routers.django.rule=Host(`django.localhost`)"
19 |   db:
20 |     image: postgres:15-alpine
21 |     volumes:
22 |       - postgres_data:/var/lib/postgresql/data/
23 |     expose:
24 |       - 5432
25 |     environment:
26 |       - POSTGRES_USER=django_traefik
27 |       - POSTGRES_PASSWORD=django_traefik
28 |       - POSTGRES_DB=django_traefik
29 |   traefik:
30 |     image: traefik:v2.9.6
31 |     ports:
32 |       - 8008:80
33 |       - 8081:8080
34 |     volumes:
35 |       - "$PWD/traefik.dev.toml:/etc/traefik/traefik.toml"
36 |       - "/var/run/docker.sock:/var/run/docker.sock:ro"
37 | 
38 | volumes:
39 |   postgres_data:
40 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 TestDriven.io
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/app/Dockerfile.prod:
--------------------------------------------------------------------------------
 1 | ###########
 2 | # BUILDER #
 3 | ###########
 4 | 
 5 | # pull official base image
 6 | FROM python:3.11-slim as builder
 7 | 
 8 | # set work directory
 9 | WORKDIR /app
10 | 
11 | # set environment variables
12 | ENV PYTHONDONTWRITEBYTECODE 1
13 | ENV PYTHONUNBUFFERED 1
14 | 
15 | # install system dependencies
16 | RUN apt-get update && \
17 |     apt-get install -y --no-install-recommends gcc
18 | 
19 | # lint
20 | RUN pip install --upgrade pip
21 | RUN pip install flake8==6.0.0
22 | COPY . .
23 | RUN flake8 --ignore=E501,F401 .
24 | 
25 | # install python dependencies
26 | COPY requirements.txt .
27 | RUN pip wheel --no-cache-dir --no-deps --wheel-dir /usr/src/app/wheels -r requirements.txt
28 | 
29 | 
30 | #########
31 | # FINAL #
32 | #########
33 | 
34 | # pull official base image
35 | FROM python:3.11-slim
36 | 
37 | # create directory for the app user
38 | RUN mkdir -p /home/app
39 | 
40 | # create the app user
41 | RUN addgroup --system app && adduser --system --group app
42 | 
43 | # create the appropriate directories
44 | ENV HOME=/home/app
45 | ENV APP_HOME=/home/app/web
46 | RUN mkdir $APP_HOME
47 | WORKDIR $APP_HOME
48 | 
49 | # install dependencies
50 | COPY --from=builder /usr/src/app/wheels /wheels
51 | COPY --from=builder /app/requirements.txt .
52 | RUN pip install --upgrade pip
53 | RUN pip install --no-cache /wheels/*
54 | 
55 | # copy project
56 | COPY . $APP_HOME
57 | 
58 | # chown all the files to the app user
59 | RUN chown -R app:app $APP_HOME
60 | 
61 | # change to the app user
62 | USER app
63 | 


--------------------------------------------------------------------------------
/docker-compose.prod.yml:
--------------------------------------------------------------------------------
 1 | version: '3.8'
 2 | 
 3 | services:
 4 |   web:
 5 |     build:
 6 |       context: ./app
 7 |       dockerfile: Dockerfile.prod
 8 |     command: bash -c 'while !</dev/tcp/db/5432; do sleep 1; done; gunicorn --bind 0.0.0.0:8000 config.wsgi'
 9 |     expose:
10 |       - 8000
11 |     environment:
12 |       - DEBUG=0
13 |       - DATABASE_URL=postgresql://django_traefik:django_traefik@db:5432/django_traefik
14 |       - DJANGO_ALLOWED_HOSTS=.your-domain.com
15 |     depends_on:
16 |       - db
17 |     labels:
18 |       - "traefik.enable=true"
19 |       - "traefik.http.routers.django.rule=Host(`django-traefik.your-domain.com`)"
20 |       - "traefik.http.routers.django.tls=true"
21 |       - "traefik.http.routers.django.tls.certresolver=letsencrypt"
22 |   db:
23 |     image: postgres:15-alpine
24 |     volumes:
25 |       - postgres_data_prod:/var/lib/postgresql/data/
26 |     expose:
27 |       - 5432
28 |     environment:
29 |       - POSTGRES_USER=django_traefik
30 |       - POSTGRES_PASSWORD=django_traefik
31 |       - POSTGRES_DB=django_traefik
32 |   traefik:
33 |     build:
34 |       context: .
35 |       dockerfile: Dockerfile.traefik
36 |     ports:
37 |       - 80:80
38 |       - 443:443
39 |     volumes:
40 |       - "/var/run/docker.sock:/var/run/docker.sock:ro"
41 |       - "./traefik-public-certificates:/certificates"
42 |     labels:
43 |       - "traefik.enable=true"
44 |       - "traefik.http.routers.dashboard.rule=Host(`dashboard-django-traefik.your-domain.com`)"
45 |       - "traefik.http.routers.dashboard.tls=true"
46 |       - "traefik.http.routers.dashboard.tls.certresolver=letsencrypt"
47 |       - "traefik.http.routers.dashboard.service=api@internal"
48 |       - "traefik.http.routers.dashboard.middlewares=auth"
49 |       - "traefik.http.middlewares.auth.basicauth.users=testuser:$$apr1$$jIKW.bdS$$eKXe4Lxjgy/rH65wP1iQe1"
50 | 
51 | volumes:
52 |   postgres_data_prod:
53 |   traefik-public-certificates:
54 | 


--------------------------------------------------------------------------------
/app/config/settings.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Django settings for config project.
  3 | 
  4 | Generated by 'django-admin startproject' using Django 4.1.6.
  5 | 
  6 | For more information on this file, see
  7 | https://docs.djangoproject.com/en/4.1/topics/settings/
  8 | 
  9 | For the full list of settings and their values, see
 10 | https://docs.djangoproject.com/en/4.1/ref/settings/
 11 | """
 12 | 
 13 | from pathlib import Path
 14 | 
 15 | import environ
 16 | 
 17 | env = environ.Env()
 18 | 
 19 | # Build paths inside the project like this: BASE_DIR / 'subdir'.
 20 | BASE_DIR = Path(__file__).resolve().parent.parent
 21 | 
 22 | 
 23 | # Quick-start development settings - unsuitable for production
 24 | # See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
 25 | 
 26 | # SECURITY WARNING: keep the secret key used in production secret!
 27 | SECRET_KEY = "django-insecure-*y(bpj*0ho*d6w9_cz0fvf428$&&jyzw==ztb$0(fkbvq)o-r5"
 28 | 
 29 | # SECURITY WARNING: don't run with debug turned on in production!
 30 | DEBUG = env('DEBUG')
 31 | 
 32 | ALLOWED_HOSTS = env('DJANGO_ALLOWED_HOSTS', default=[])
 33 | 
 34 | 
 35 | # Application definition
 36 | 
 37 | INSTALLED_APPS = [
 38 |     "django.contrib.admin",
 39 |     "django.contrib.auth",
 40 |     "django.contrib.contenttypes",
 41 |     "django.contrib.sessions",
 42 |     "django.contrib.messages",
 43 |     "django.contrib.staticfiles",
 44 | ]
 45 | 
 46 | MIDDLEWARE = [
 47 |     'django.middleware.security.SecurityMiddleware',
 48 |     'whitenoise.middleware.WhiteNoiseMiddleware',
 49 |     'django.contrib.sessions.middleware.SessionMiddleware',
 50 |     'django.middleware.common.CommonMiddleware',
 51 |     'django.middleware.csrf.CsrfViewMiddleware',
 52 |     'django.contrib.auth.middleware.AuthenticationMiddleware',
 53 |     'django.contrib.messages.middleware.MessageMiddleware',
 54 |     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 55 | ]
 56 | 
 57 | ROOT_URLCONF = "config.urls"
 58 | 
 59 | TEMPLATES = [
 60 |     {
 61 |         "BACKEND": "django.template.backends.django.DjangoTemplates",
 62 |         "DIRS": [],
 63 |         "APP_DIRS": True,
 64 |         "OPTIONS": {
 65 |             "context_processors": [
 66 |                 "django.template.context_processors.debug",
 67 |                 "django.template.context_processors.request",
 68 |                 "django.contrib.auth.context_processors.auth",
 69 |                 "django.contrib.messages.context_processors.messages",
 70 |             ],
 71 |         },
 72 |     },
 73 | ]
 74 | 
 75 | WSGI_APPLICATION = "config.wsgi.application"
 76 | 
 77 | 
 78 | # Database
 79 | # https://docs.djangoproject.com/en/4.1/ref/settings/#databases
 80 | 
 81 | DATABASES = {
 82 |     'default': env.db(),
 83 | }
 84 | 
 85 | 
 86 | # Password validation
 87 | # https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
 88 | 
 89 | AUTH_PASSWORD_VALIDATORS = [
 90 |     {
 91 |         "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
 92 |     },
 93 |     {
 94 |         "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
 95 |     },
 96 |     {
 97 |         "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
 98 |     },
 99 |     {
100 |         "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
101 |     },
102 | ]
103 | 
104 | 
105 | # Internationalization
106 | # https://docs.djangoproject.com/en/4.1/topics/i18n/
107 | 
108 | LANGUAGE_CODE = "en-us"
109 | 
110 | TIME_ZONE = "UTC"
111 | 
112 | USE_I18N = True
113 | 
114 | USE_TZ = True
115 | 
116 | 
117 | # Static files (CSS, JavaScript, Images)
118 | # https://docs.djangoproject.com/en/4.1/howto/static-files/
119 | 
120 | STATIC_URL = "static/"
121 | STATIC_ROOT = BASE_DIR / 'staticfiles'
122 | STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
123 | 
124 | # Default primary key field type
125 | # https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
126 | 
127 | DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
128 | 


--------------------------------------------------------------------------------