Initial commit

Author: evildmp

.env-local

@@ -0,0 +1,5 @@
+DATABASE_URL=postgres://postgres@database_default:5432/db
+DEFAULT_STORAGE_DSN=file:///data/media/?url=%2Fmedia%2F
+DJANGO_DEBUG=True
+DOMAIN_ALIASES=localhost, 127.0.0.1
+SECURE_SSL_REDIRECT=False

.gitignore

@@ -0,0 +1,20 @@
+# Python
+*.pyc
+*.pyo
+db.sqlite3
+
+# Django
+/staticfiles
+
+# Divio
+.divio
+/data.tar.gz
+/data
+
+
+# OS-specific patterns - add your own here
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes

Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.8
+WORKDIR /app
+COPY . /app
+RUN pip install -r requirements.txt
+RUN python manage.py collectstatic --noinput
+CMD uwsgi --http=0.0.0.0:80 --module=quickstart.wsgi

LICENSE

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

README.md

@@ -0,0 +1,21 @@
+# django CMS Divio quickstart
+
+A Dockerised django CMS project, ready to deploy on Divio or another Docker-based cloud platform, and run
+locally in Docker on your own machine. A Divio account is not required.
+
+This version uses Python 3.8 running and the most up-to-date versions of Django 3.1 and django CMS 3.8.
+
+For a complete how-to guide for this project, see [Deploy a new django CMS project using the Divio quickstart
+repository](https://docs.divio.com/en/latest/how-to/django-cms-deploy-quickstart/) in the [Divio Developer
+Handbook](https://docs.divio.com).
+
+The guide shows you how to use this repository to deploy a Twelve-factor Django project including Postgres or MySQL,
+and cloud media storage using S3, with Docker. It also gives you a fully working local project for development,
+also running in Docker.
+
+## Important
+
+This project is ready-to-go, but also gives you some options. As-is, it will include a number of useful django CMS
+plugins and Bootstrap 4 for the frontend. You don't have to use these; they're optional. If you don't want to use them,
+read through the `settings.py` and `requirements.txt` files to see sections that can be removed - in each case, the
+section is noted with a comment containing the word 'optional'.

docker-compose.yml

@@ -0,0 +1,28 @@
+version: "2.4"
+services:
+  web:
+    # the application's web service (container) will use an image based on our Dockerfile
+    build: "."
+    # map the internal port 80 to port 8000 on the host
+    ports:
+      - "8000:80"
+    # map the host directory to app (which allows us to see and edit files inside the container)
+    volumes:
+      - ".:/app:rw"
+      - "./data:/data:rw"
+    # the default command to run whenever the container is launched
+    command: python manage.py runserver 0.0.0.0:80
+    # the URL 'postgres' or 'mysql' will point to the application's db service
+    links:
+      - "database_default"
+    env_file: .env-local
+
+  database_default:
+    # Select one of the following db configurations for the database
+    image: postgres:9.6-alpine
+    environment:
+      POSTGRES_DB: "db"
+      POSTGRES_HOST_AUTH_METHOD: "trust"
+      SERVICE_MANAGER: "fsm-postgres"
+    volumes:
+      - ".:/app:rw"

manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'quickstart.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

quickstart/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for quickstart project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'quickstart.settings')
+
+application = get_asgi_application()

quickstart/asgi.py

@@ -0,0 +1,212 @@
+from pathlib import Path
+import os
+import dj_database_url
+from django_storage_url import dsn_configured_storage_class
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.environ.get('SECRET_KEY', '<a string of random characters>')
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = os.environ.get('DJANGO_DEBUG') == "True"
+
+DIVIO_DOMAIN = os.environ.get('DOMAIN', '')
+DIVIO_DOMAIN_ALIASES = [
+    d.strip()
+    for d in os.environ.get('DOMAIN_ALIASES', '').split(',')
+    if d.strip()
+]
+ALLOWED_HOSTS = [DIVIO_DOMAIN] + DIVIO_DOMAIN_ALIASES
+
+# Redirect to HTTPS by default, unless explicitly disabled
+SECURE_SSL_REDIRECT = os.environ.get('SECURE_SSL_REDIRECT') != "False"
+
+X_FRAME_OPTIONS = 'SAMEORIGIN'
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'quickstart',
+
+    # optional, but used in most projects
+    'djangocms_admin_style',
+
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django.contrib.sites',
+
+    # key django CMS modules
+    'cms',
+    'menus',
+    'treebeard',
+    'sekizai',
+
+    # Django Filer - optional, but used in most projects
+    'filer',
+    'easy_thumbnails',
+
+    # the default CKEditor - optional, but used in most projects
+    'djangocms_text_ckeditor',
+
+    # some content plugins - optional, but used in most projects
+    'djangocms_file',
+    'djangocms_icon',
+    'djangocms_link',
+    'djangocms_picture',
+    'djangocms_style',
+    'djangocms_googlemap',
+    'djangocms_video',
+
+    # optional django CMS Bootstrap 4 modules
+    'djangocms_bootstrap4',
+    'djangocms_bootstrap4.contrib.bootstrap4_alerts',
+    'djangocms_bootstrap4.contrib.bootstrap4_badge',
+    'djangocms_bootstrap4.contrib.bootstrap4_card',
+    'djangocms_bootstrap4.contrib.bootstrap4_carousel',
+    'djangocms_bootstrap4.contrib.bootstrap4_collapse',
+    'djangocms_bootstrap4.contrib.bootstrap4_content',
+    'djangocms_bootstrap4.contrib.bootstrap4_grid',
+    'djangocms_bootstrap4.contrib.bootstrap4_jumbotron',
+    'djangocms_bootstrap4.contrib.bootstrap4_link',
+    'djangocms_bootstrap4.contrib.bootstrap4_listgroup',
+    'djangocms_bootstrap4.contrib.bootstrap4_media',
+    'djangocms_bootstrap4.contrib.bootstrap4_picture',
+    'djangocms_bootstrap4.contrib.bootstrap4_tabs',
+    'djangocms_bootstrap4.contrib.bootstrap4_utilities',
+]
+
+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',
+    'django.middleware.locale.LocaleMiddleware',
+
+    'cms.middleware.user.CurrentUserMiddleware',
+    'cms.middleware.page.CurrentPageMiddleware',
+    'cms.middleware.toolbar.ToolbarMiddleware',
+    'cms.middleware.language.LanguageCookieMiddleware',
+]
+
+ROOT_URLCONF = 'quickstart.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',
+                'django.template.context_processors.media',
+                'django.template.context_processors.csrf',
+                'django.template.context_processors.tz',
+                'django.template.context_processors.i18n',
+
+                'cms.context_processors.cms_settings',
+                'sekizai.context_processors.sekizai',
+
+            ],
+        },
+    },
+]
+
+CMS_TEMPLATES = [
+    # a minimal template to get started with
+    ('minimal.html', 'Minimal template'),
+
+    # optional templates that extend base.html, to be used with Bootstrap 4
+    ('page.html', 'Page'),
+    ('feature.html', 'Page with Feature')
+]
+
+WSGI_APPLICATION = 'quickstart.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
+
+# Configure database using DATABASE_URL; fall back to sqlite in memory when no
+# environment variable is available, e.g. during Docker build
+DATABASE_URL = os.environ.get('DATABASE_URL', 'sqlite://:memory:')
+
+DATABASES = {'default': dj_database_url.parse(DATABASE_URL)}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.1/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/3.1/topics/i18n/
+
+LANGUAGE_CODE = 'en'
+
+LANGUAGES = [
+    ('en', 'English'),
+]
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.1/howto/static-files/
+
+STATIC_URL = '/static/'
+STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+
+# Media files
+# DEFAULT_FILE_STORAGE is configured using DEFAULT_STORAGE_DSN
+
+# read the setting value from the environment variable
+DEFAULT_STORAGE_DSN = os.environ.get('DEFAULT_STORAGE_DSN')
+
+# dsn_configured_storage_class() requires the name of the setting
+DefaultStorageClass = dsn_configured_storage_class('DEFAULT_STORAGE_DSN')
+
+# Django's DEFAULT_FILE_STORAGE requires the class name
+DEFAULT_FILE_STORAGE = 'quickstart.settings.DefaultStorageClass'
+
+# only required for local file storage and serving, in development
+MEDIA_URL = 'media/'
+MEDIA_ROOT = os.path.join('/data/media/')
+
+
+SITE_ID = 1