Template Django app.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mark Veidemanis 906f34f3a2
Merge branch 'master' of zm.is:XF/envelope
1 year ago
app Remove async and update CRUD helpers 1 year ago
core Merge branch 'master' of zm.is:XF/envelope 1 year ago
docker Tweak UWSGI settings 2 years ago
.gitignore Add local settings to Git 1 year ago
.pre-commit-config.yaml Update pre-commit versions 1 year ago
Dockerfile Switch to UWSGI and make docker build/run smarter 2 years ago
Makefile Make running with Docker more convenient 2 years ago
README.md Create a better Readme 2 years ago
docker-compose.yml Switch to UWSGI and make docker build/run smarter 2 years ago
manage.py Initial commit 2 years ago
requirements.txt Switch to UWSGI and make docker build/run smarter 2 years ago



Template Django app.

Setting up the environment

Create the virtual environment, enable it, and install the dependencies.

$ python3 -m venv env
$ source env/bin/activate
(env) $ pip install -r docker/prod/requirements.prod.txt

Local settings

You'll need to copy the app/local_settings.example.py file to app/local_settings.py. The project won't start otherwise.

$ cp app/local_settings.example.py app/local_settings.py


The stack.env file referenced is a Portainer special. This is where Portainer would put a file containing all the environment variables set up in its UI. To run it manually, you will need to copy stack.env.example to stack.env in the project root.

Running database migrations

Now we need to run the database migrations in order to get a working database.

(env) $ python manage.py migrate

Note that these are automatically run by a step in the compose file in production. You won't need to do that manually.

Creating a superuser

In order to access Django admin, we need a superuser.

(env) $ python manage.py createsuperuser
Username: t2
Email address: t2@google.com
Password (again): 
Superuser created successfully.


The Docker Compose file is located in docker/docker-compose.prod.yml. There is a shortcut to run it: make run.


To stop the containers, run make stop.


This setup may be different from what you've seen before.


There is a Uvicorn worker in the app container listening on /var/run/socks/app.sock. This is the bit that runs the actual code.


Nginx runs in the nginx container and proxies requests to Uvicorn thanks to a mounted and shared directory. No TCP required.

Pre-start steps

There's a few commands running before start to ensure Django works correctly.


The migration container step runs the migrations so you don't need to remember to do it.


The collectstatic container step collects all static files from plugins and puts them in the core/static folder. This folder is served straight from Nginx without going through Uvicorn.