Fork me on GitHub Link Search Menu Expand Document

Contributing

Development workflow

Authelia and its development workflow can be tested with Docker and docker-compose on Linux.

In order to deploy the current version of Authelia locally, run the following command and follow the instructions of bootstrap.sh:

$ source bootstrap.sh

Then, start the Standalone suite.

$ authelia-scripts suites setup Standalone

A suite is kind of a virtual environment for running Authelia in a complete ecosystem. If you want more details please read the related documentation.

FAQ

What version of Docker and docker-compose should I use?

Here are the versions used for testing in Buildkite:

$ docker --version
Docker version 19.03.5, build 633a0ea838

$ docker-compose --version
docker-compose version 1.24.1, build unknown

How can I serve my application under example.com?

Don’t worry, you don’t need to own the domain example.com to test Authelia. Copy the following lines in your /etc/hosts.

192.168.240.100 home.example.com
192.168.240.100 login.example.com
192.168.240.100 singlefactor.example.com
192.168.240.100 public.example.com
192.168.240.100 secure.example.com
192.168.240.100 mail.example.com
192.168.240.100 mx1.mail.example.com

192.168.240.100 is the IP attributed by Docker to the reverse proxy. Once done you can access the listed sub-domains from your browser and they will target the reverse proxy.


Table of contents