This repository has been archived on 2026-03-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
docs/docs/installation
Anthony LC 325c7d9786 🔧(project) add DJANGO_EMAIL_URL_APP environment variable
Most of Docs app is configured thanks to environment
variables, except the url in the email that
was from the django site table.
Now we can set it with DJANGO_EMAIL_URL_APP
environment variable to have a better consistency.
We keep the previous way to avoid breaking
changes.
2026-01-23 17:56:31 +01:00
..

Installation

If you want to install Docs you've come to the right place. Here are a bunch of resources to help you install the project.

Kubernetes

We (Docs maintainers) are only using the Kubernetes deployment method in production. We can only provide advanced support for this method. Please follow the instructions laid out here.

Docker Compose

We are aware that not everyone has Kubernetes Cluster laying around 😆. We also provide Docker images that you can deploy using Compose. Please follow the instructions here. ⚠️ Please keep in mind that we do not use it ourselves in production. Let us know in the issues if you run into troubles, we'll try to help.

Other ways to install Docs

Community members have contributed several other ways to install Docs. While we owe them a big thanks 🙏, please keep in mind we (Docs maintainers) can't provide support on these installation methods as we don't use them ourselves and there are two many options out there for us to keep track of. Of course you can contact the contributors and the broader community for assistance.

Here is the list of other methods in alphabetical order:

Feel free to make a PR to add ones that are not listed above 🙏

Cloud providers

Some cloud providers are making it easy to deploy Docs on their infrastructure.

Here is the list in alphabetical order:

Feel free to make a PR to add ones that are not listed above 🙏