11 |
14 | Version 2.0
12 | 13 |
15 |
18 | 16 | New Django-Docker version now uses Bulma.io for rendering styles.
17 |
4 |
5 | This is a magic repository for everyone who wants to start developing and do not want to worry about initial django and docker setup.
6 |
7 | You can see deployed example here: [https://django-docker.matakov.com](https://django-docker.matakov.com)
8 |
9 | Github link: [https://github.com/matacoder/django-docker](https://github.com/matacoder/django-docker)
10 | Redeployed 2024
11 |
12 | ## What's new in version 2.0
13 |
14 | * All styles now are implemented with Bulma CSS framework.
15 | * Loguru logger
16 | * Dark mode (using OS toggle, supported in Safari/Chrome/Firefox)
17 | * Auto loading README to index page
18 | * More efficient Github workflow
19 | * Added Pagination template
20 | * Drop support of Bootstrap and Crispy Forms
21 |
22 | ## What is included
23 |
24 | - Django
25 | - Nginx
26 | - PostgreSQL
27 | - Gunicorn
28 | - Docker Compose for development
29 | - Docker Compose for production
30 | - Caddy config for fast SSL + domain deploy
31 | - Poetry dependency manager
32 | - Loguru logger
33 | - Initial entrypoint to take care of django and postgres setup
34 | - Black code formatter
35 | - Basic Workflow for GitHub Actions
36 | - Accounts app with all authorization forms implemented with Bulma CSS
37 | - Basic template to test login/logout
38 | - Sign up form
39 | - Main app to immediately start writing your first business logic
40 | - Django Debug Toolbar! Analyze SQL on-the-fly
41 |
42 | ## Why project is named _settings?
43 |
44 | Do you know that frustration when you are looking for your setting file directory?
45 |
46 | I know! So underscored `_settings` folder is always close to top and easy to find.
47 |
48 | ## What next step?
49 |
50 | Export all your `.env` environment variables with command:
51 |
52 | `set -o allexport; source .env; set +o allexport`
53 |
54 | Create your app using:
55 |
56 | `python manage.py startapp my_new_app`
57 |
58 | Or just use `main` app. It is already here and urls are included!
59 |
60 | ## What You Develop is What You Get
61 |
62 | Just `docker compose up` and you will see your development version at `127.0.0.1:1111`
63 |
64 | Restart your django container (using Docker GUI) everytime you make a change in app logic.
65 |
66 | Django's templates engine is reloading without container needed to restart
67 |
68 | ## Fast Deploy Using Docker Context (Manually)
69 |
70 | Docker context is a bridge to your remote server to run docker commands on your local pc or mac.
71 |
72 | #### STEP 0: Create new context to remote control your server docker (once)
73 |
74 | `docker context create new_ip --docker "host=ssh://username@ip"`
75 |
76 | #### STEP 1: Switch to remote server docker
77 |
78 | `docker context use new_ip`
79 |
80 | #### STEP 2: Build image DIRECTLY on remote server (use variables in .env)
81 |
82 | `docker build -t username/project:latest .`
83 |
84 | #### STEP 3: Down your compose gracefully on remote server
85 |
86 | `docker compose -f docker-compose-prod.yaml down`
87 |
88 | Here consider deleting static volume if you have static files modified
89 |
90 | #### STEP 4: Up your compose, force recreate containers using new image
91 |
92 | `docker compose -f docker-compose-prod.yaml up -d --force-recreate`
93 |
94 | #### STEP 5: Don't forget to switch back to your local docker
95 |
96 | `docker context use default`
97 |
98 | # Run your site with Caddy Server
99 |
100 | Install [Caddy Server](https://caddyserver.com), replace `example.com` with your domain in `Caddyfile` and run command:
101 |
102 | ```bash
103 | sudo caddy stop
104 | sudo caddy run
105 | ```
106 |
107 | Consider adding `caddy` to [linux start up sequence](https://caddy.community/t/want-caddy-to-run-automatically-on-boot/5240).
108 |
109 | # Deploy using GitHub Actions (automatically)
110 |
111 | You can not use experimental `docker compose` feature in GitHub Actions yet, but `docker-compose` works just fine.
112 |
113 | Do not forget to add GitHub secrets for:
114 |
115 | - SSH_KEY
116 | - IP_HOST
117 | - SSH_USER
118 |
119 | For all other docker-related secrets you can use sole `ENV` secret. Run this command within project:
120 |
121 | `base64 -i .env`
122 |
123 | That will give you string array very alike SSH key. Save it to `ENV` secret. Now look at workflow.
124 |
125 | `RollyPeres/base64-to-path@v1` action will extract this to `.env` file. That is fast and reliable way to export all your environment variable at once.
126 |
127 | This is example workflow you need to implement:
128 |
129 | ```yaml
130 | name: Django-Docker workflow
131 |
132 | on:
133 | push:
134 | branches:
135 | - master
136 |
137 | jobs:
138 | magic_deploy:
139 | name: Deploy to server with remote docker-compose
140 | runs-on: ubuntu-latest
141 | steps:
142 | - uses: actions/checkout@v2
143 | - name: Set up Python
144 | uses: actions/setup-python@v2
145 | with:
146 | python-version: 3.9
147 |
148 | - name: Install SSH key to github server
149 | uses: kielabokkie/ssh-key-and-known-hosts-action@v1.1.0
150 | with:
151 | ssh-private-key: ${{ secrets.SSH_KEY }}
152 | ssh-host: ${{ secrets.IP_HOST }}
153 |
154 | - name: Install latest version of docker with experimental compose support
155 | run: |
156 | pip install docker-compose
157 |
158 | - name: Generate env file from Base64 encoded string (base64 -i .env)
159 | uses: RollyPeres/base64-to-path@v1
160 | with:
161 | filePath: ${{ github.workspace }}/.env
162 | encodedString: ${{ secrets.ENV }}
163 |
164 | - name: Remote docker compose down/up using context (zero files)
165 | run: |
166 | docker context create remote --docker "host=ssh://${{ secrets.SSH_USER }}@${{ secrets.IP_HOST }}"
167 | docker context use remote
168 | docker image prune -f
169 | docker-compose --context remote -f docker-compose-prod.yaml down
170 | docker-compose --context remote -f docker-compose-prod.yaml up -d --build --force-recreate
171 | ```
172 |
--------------------------------------------------------------------------------
/_settings/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/matacoder/django-docker/2340fe5a27d2c096d1ef0445b51e0a4e0baeadee/_settings/__init__.py
--------------------------------------------------------------------------------
/_settings/asgi.py:
--------------------------------------------------------------------------------
1 | """
2 | ASGI config for _settings 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/3.2/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", "_settings.settings")
15 |
16 | application = get_asgi_application()
17 |
--------------------------------------------------------------------------------
/_settings/settings.py:
--------------------------------------------------------------------------------
1 | """
2 | Django settings for _settings project.
3 |
4 | Generated by 'django-admin startproject' using Django 3.2.3.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.2/topics/settings/
8 |
9 | For the full list of settings and their values, see
10 | https://docs.djangoproject.com/en/3.2/ref/settings/
11 | """
12 | import os
13 | from pathlib import Path
14 |
15 | # Build paths inside the project like this: BASE_DIR / 'subdir'.
16 | BASE_DIR = Path(__file__).resolve().parent.parent
17 |
18 | # Quick-start development settings - unsuitable for production
19 | # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
20 |
21 | # SECURITY WARNING: keep the secret key used in production secret!
22 | SECRET_KEY = os.environ.get("SECRET_KEY")
23 |
24 | # SECURITY WARNING: don't run with debug turned on in production!
25 | DEBUG = os.environ.get("DEBUG") == "1"
26 |
27 | ALLOWED_HOSTS = ["127.0.0.1", "django-docker.matakov.com"]
28 |
29 | INTERNAL_IPS = [
30 | "127.0.0.1",
31 | ]
32 |
33 | if DEBUG:
34 | DEBUG_TOOLBAR_CONFIG = {
35 | "SHOW_TOOLBAR_CALLBACK": lambda request: not request.is_ajax(),
36 | }
37 |
38 | # Application definition
39 |
40 | INSTALLED_APPS = [
41 | "main",
42 | "accounts",
43 | "debug_toolbar",
44 | "django.contrib.admin",
45 | "django.contrib.auth",
46 | "django.contrib.contenttypes",
47 | "django.contrib.sessions",
48 | "django.contrib.messages",
49 | "django.contrib.staticfiles",
50 | "markdownify.apps.MarkdownifyConfig",
51 | "bulma",
52 | ]
53 |
54 | MIDDLEWARE = [
55 | "debug_toolbar.middleware.DebugToolbarMiddleware",
56 | "django.middleware.security.SecurityMiddleware",
57 | "django.contrib.sessions.middleware.SessionMiddleware",
58 | "django.middleware.common.CommonMiddleware",
59 | "django.middleware.csrf.CsrfViewMiddleware",
60 | "django.contrib.auth.middleware.AuthenticationMiddleware",
61 | "django.contrib.messages.middleware.MessageMiddleware",
62 | "django.middleware.clickjacking.XFrameOptionsMiddleware",
63 | ]
64 |
65 | ROOT_URLCONF = "_settings.urls"
66 | TEMPLATES_DIR = os.path.join(BASE_DIR, "templates")
67 | TEMPLATES = [
68 | {
69 | "BACKEND": "django.template.backends.django.DjangoTemplates",
70 | "DIRS": [TEMPLATES_DIR],
71 | "APP_DIRS": True,
72 | "OPTIONS": {
73 | "context_processors": [
74 | "django.template.context_processors.debug",
75 | "django.template.context_processors.request",
76 | "django.contrib.auth.context_processors.auth",
77 | "django.contrib.messages.context_processors.messages",
78 | ],
79 | },
80 | },
81 | ]
82 |
83 | MARKDOWNIFY = {
84 | "default": {
85 | "BLEACH": False,
86 | "LINKIFY_TEXT": {
87 | "PARSE_URLS": True,
88 | # Next key/value-pairs only have effect if "PARSE_URLS" is True
89 | "PARSE_EMAIL": True,
90 | "CALLBACKS": [],
91 | "SKIP_TAGS": [],
92 | },
93 | "MARKDOWN_EXTENSIONS": [
94 | "markdown.extensions.fenced_code",
95 | "markdown.extensions.extra",
96 | "markdown.extensions.codehilite",
97 | "markdown.extensions.nl2br",
98 | "markdown.extensions.sane_lists",
99 | "markdown.extensions.toc",
100 | ],
101 | }
102 | }
103 |
104 | WSGI_APPLICATION = "_settings.wsgi.application"
105 |
106 | # Database
107 | # https://docs.djangoproject.com/en/3.2/ref/settings/#databases
108 |
109 | DATABASES = {
110 | "default": {
111 | "ENGINE": os.environ.get("DB_ENGINE"),
112 | "NAME": os.environ.get("DB_NAME"),
113 | "USER": os.environ.get("POSTGRES_USER"),
114 | "PASSWORD": os.environ.get("POSTGRES_PASSWORD"),
115 | "HOST": os.environ.get("DB_HOST"),
116 | "PORT": os.environ.get("DB_PORT"),
117 | }
118 | }
119 |
120 | # Password validation
121 | # https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
122 |
123 | AUTH_PASSWORD_VALIDATORS = [
124 | {
125 | "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
126 | },
127 | {
128 | "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
129 | },
130 | {
131 | "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
132 | },
133 | {
134 | "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
135 | },
136 | ]
137 |
138 | # Internationalization
139 | # https://docs.djangoproject.com/en/3.2/topics/i18n/
140 |
141 | LANGUAGE_CODE = "en-us"
142 |
143 | TIME_ZONE = "UTC"
144 |
145 | USE_I18N = True
146 |
147 | USE_L10N = True
148 |
149 | USE_TZ = True
150 |
151 | # Static files (CSS, JavaScript, Images)
152 | # https://docs.djangoproject.com/en/3.2/howto/static-files/
153 |
154 | STATIC_URL = "/static/"
155 | STATIC_ROOT = os.path.join(BASE_DIR, "static")
156 |
157 | MEDIA_URL = "/media/"
158 | MEDIA_ROOT = os.path.join(BASE_DIR, "media")
159 |
160 | # Default primary key field type
161 | # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
162 |
163 | DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
164 |
165 | CRISPY_TEMPLATE_PACK = "bootstrap4"
166 |
167 | LOGIN_URL = "/auth/login/"
168 | LOGIN_REDIRECT_URL = "index"
169 |
--------------------------------------------------------------------------------
/_settings/urls.py:
--------------------------------------------------------------------------------
1 | """_settings URL Configuration
2 |
3 | The `urlpatterns` list routes URLs to views. For more information please see:
4 | https://docs.djangoproject.com/en/3.2/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 | import debug_toolbar
17 | from django.contrib import admin
18 | from django.urls import include, path
19 |
20 | urlpatterns = [
21 | path("admin/", admin.site.urls),
22 | path("auth/", include("accounts.urls")),
23 | path("", include("main.urls")),
24 | path("__debug__/", include(debug_toolbar.urls)),
25 | ]
26 |
--------------------------------------------------------------------------------
/_settings/wsgi.py:
--------------------------------------------------------------------------------
1 | """
2 | WSGI config for _settings 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/3.2/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", "_settings.settings")
15 |
16 | application = get_wsgi_application()
17 |
--------------------------------------------------------------------------------
/accounts/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/matacoder/django-docker/2340fe5a27d2c096d1ef0445b51e0a4e0baeadee/accounts/__init__.py
--------------------------------------------------------------------------------
/accounts/admin.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/matacoder/django-docker/2340fe5a27d2c096d1ef0445b51e0a4e0baeadee/accounts/admin.py
--------------------------------------------------------------------------------
/accounts/apps.py:
--------------------------------------------------------------------------------
1 | from django.apps import AppConfig
2 |
3 |
4 | class UsersConfig(AppConfig):
5 | name = "accounts"
6 |
--------------------------------------------------------------------------------
/accounts/forms.py:
--------------------------------------------------------------------------------
1 | from django.contrib.auth import get_user_model
2 | from django.contrib.auth.forms import UserCreationForm
3 |
4 | User = get_user_model()
5 |
6 |
7 | class CreationForm(UserCreationForm):
8 | class Meta:
9 | model = User
10 | fields = ("first_name", "last_name", "username", "email")
11 |
--------------------------------------------------------------------------------
/accounts/migrations/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/matacoder/django-docker/2340fe5a27d2c096d1ef0445b51e0a4e0baeadee/accounts/migrations/__init__.py
--------------------------------------------------------------------------------
/accounts/models.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/matacoder/django-docker/2340fe5a27d2c096d1ef0445b51e0a4e0baeadee/accounts/models.py
--------------------------------------------------------------------------------
/accounts/templates/registration/logged_out.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}Logged out{% endblock %}
3 | {% block header %}Logged out{% endblock %}
4 | {% block content %}
5 | Version 2.0
12 | 13 |16 | New Django-Docker version now uses Bulma.io for rendering styles.
17 |