dev: update Dockerfile/docker-compose development environment setup

Author: fallen

Dockerfile

@@ -7,8 +7,13 @@ RUN apt-get update && \
     rm -rf /var/lib/apt/lists/*
 
 RUN mkdir /code
+RUN mkdir /config
+RUN mkdir /static
 WORKDIR /code
 COPY requirements.txt requirements_dev.txt /code/
 RUN pip install -r requirements_dev.txt
 RUN pip install psycopg2-binary==2.8.4
 COPY . /code/
+COPY pytition/pytition/settings/config_example.py /config/docker_config.py
+RUN touch /config/__init__.py
+RUN /code/dev/generate_docker_config.sh

dev/generate_docker_config.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+SECRET_KEY=$(python3 -c "from django.core.management.utils import get_random_secret_key as g; print(g())")
+sed -i -e '/SECRET_KEY/d' /config/docker_config.py
+sed -i -e '/DATABASES/d' /config/docker_config.py
+sed -i -e '/STATIC_ROOT/d' /config/docker_config.py
+echo "SECRET_KEY = \"${SECRET_KEY}\"" >> /config/docker_config.py
+echo "STATIC_ROOT = \"/static/\"" >> /config/docker_config.py
+echo "DEBUG = True" >> /config/docker_config.py
+echo "ALLOWED_HOSTS.append('0.0.0.0')" >> /config/docker_config.py

dev/initialize.sh

@@ -4,6 +4,14 @@ echo "Running database migrations"
 
 cd pytition && python3 ./manage.py migrate && cd -
 
+echo "Installing static files"
+
+cd pytition && python3 ./manage.py collectstatic && cd -
+
+echo "Generating translation files"
+
+cd pytition && python3 ./manage.py compilemessages && cd -
+
 echo "Creating superuser account"
 
 cd pytition && python3 ./manage.py createsuperuser && cd -

doc/conf.py

@@ -12,7 +12,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../pytition'))
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
 
 # -- Project information -----------------------------------------------------

doc/configuration.rst

@@ -1,7 +1,7 @@
 Configuration
 *************
 
-A configuration example is provided in `pytition/pytition/settings/config_example.py`.
+A configuration example is provided in `pytition/settings/config_example.py`.
 You should copy and edit it to configure Pytition.
 
 
@@ -10,7 +10,7 @@ Mandatory settings
 
 You **must** set the following variables:
 
-.. automodule:: pytition.pytition.settings.config_example
+.. automodule:: pytition.settings.config_example
   :members:
 
 
@@ -22,8 +22,8 @@ You are **highly encouraged** to set the following variables in a production env
 Pytition specific settings
 --------------------------
 
-.. autodata:: pytition.pytition.settings.base.USE_MAIL_QUEUE
-.. autodata:: pytition.pytition.settings.base.ALLOW_REGISTER
+.. autodata:: pytition.settings.base.USE_MAIL_QUEUE
+.. autodata:: pytition.settings.base.ALLOW_REGISTER
 
 Django settings
 ---------------
@@ -48,5 +48,5 @@ Other optional settings
 
 Those are things you can configure to customize your Pytition instance:
 
-.. autodata:: pytition.pytition.settings.base.SITE_NAME
-.. autodata:: pytition.pytition.settings.base.FOOTER_TEMPLATE
+.. autodata:: pytition.settings.base.SITE_NAME
+.. autodata:: pytition.settings.base.FOOTER_TEMPLATE

doc/installation.rst

@@ -1,8 +1,8 @@
 Installation
 ************
 
-Manual installation (recommended)
-=================================
+Manual installation (recommended for production)
+================================================
 
 Install system dependencies:
 
@@ -228,3 +228,59 @@ Start uwsgi and nginx servers:
 Your Pytition home page should be available over there: http://mydomain.tld
 
 Now it's time to :ref:`Configure<Configuration>` your Pytition instance the way you want!
+
+Installation via Docker (recommended for development)
+=====================================================
+
+.. warning:: Please, do **NOT** use this in production. You would have tons of security and performance issues. You could lose your SECRET_KEY, you would run with Django's DEBUG setting enabled, you would be serving static files via Django basic webserver. You would be running with no HTTPS possibility at all. etc etc. Please : don't.
+
+Clone latest development version of Pytition:
+
+.. code-block:: bash
+
+  $ git clone https://github.com/pytition/pytition
+
+Install docker and docker-compose:
+
+.. code-block:: bash
+
+  $ sudo apt install docker.io docker-compose
+
+Put your user in the docker group (needed for Ubuntu 18.04) and start docker daemon:
+
+.. code-block:: bash
+
+  $ sudo usermod -a -G docker $USER
+  $ # log-in again as your user for group change to take effect
+  $ # or just type the following line
+  $ su -l $USER
+  $ sudo systemctl enable docker
+  $ sudo systemctl start docker
+
+For the first run you need to create the database container and let it be ready:
+
+.. code-block:: bash
+
+  $ docker-compose up --build db
+
+Wait until it prints something like::
+
+  LOG:  database system is ready to accept connections
+
+Then hit ^C (ctrl+C) to shutdown the database container.
+
+From now on, you can just type this to run Pytition in a container:
+
+.. code-block:: bash
+
+  $ docker-compose up --build
+
+Last command before being able to click on the "http://0.0.0.0:8000/" link that the "web" container prints to out on the console. You need to run migrations, install static files, compile language files, create an admin account and lastly populate your database with some dummy data. You can do all of this with the `dev/initialize.sh` script:
+
+.. code-block:: bash
+
+  $ docker-compose exec web ./dev/initialize.sh
+
+Aaaand that's it! You can now just click on the "http://0.0.0.0:8000/" link!
+
+Next time, just run ``$ docker-compose up --build``

docker-compose.yml

@@ -3,7 +3,13 @@ version: '3'
 services:
   db:
     image: postgres
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
   web:
+    environment:
+      - DJANGO_SETTINGS_MODULE=config.docker_config
+      - PYTHONPATH=/
     build: .
     command: python pytition/manage.py runserver 0.0.0.0:8000
     volumes:

pytition/pytition/settings/config_example.py

@@ -1,4 +1,4 @@
-from .base import *
+from pytition.settings.base import *
 
 # 1/ The following settings MUST be set
 

pytition/pytition/settings/pgsql.py

@@ -4,6 +4,7 @@
         'ENGINE': 'django.db.backends.postgresql',
         'NAME': 'postgres',
         'USER': 'postgres',
+        'PASSWORD': 'postgres',
         'HOST': 'db',
         'PORT': 5432,
     }