From 92bb302343215e5e32962e2bb632cdfc02f9d644 Mon Sep 17 00:00:00 2001
From: Eric Redon <eric.redon@coox.org>
Date: Mon, 11 May 2020 22:28:17 +0200
Subject: [PATCH] Add a deployment section in documentation

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index db0e4d5..215222a 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,23 @@ make run
 
 You can then navigate the project at [http://localhost:8000/](http://localhost:8000/).
 
+## Deployment
+
+To install and run the project in production, you must ensure that the following extra prerequisites are fulfilled:
+
+- you can run an [WSGI](https://www.python.org/dev/peps/pep-3333/) server with IPv6 support to expose the project’s [`application`](https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/#the-application-object)
+- you can run a web server with IPv6 support to act as a file server for the project’s static files, and as a reverse proxy between the WSGI server and the internet
+
+Proceed to deploying this repository, and navigate to its directory.
+
+Then, execute the following command to install the project’s static files:
+
+```sh
+make build
+```
+
+Then, configure and run your WSGI server and your web server.
+
 ## Hacking
 
 See [CONTRIBUTING](CONTRIBUTING.md) for developer documentation.