blob: e4cfc77ccf06cfc5e62e281d4eeac6154c42d1da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
---
layout: default
title: Contributing
nav_order: 7
has_children: true
---
# 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:
```console
$ source bootstrap.sh
```
Then, start the *Standalone* [suite].
```console
$ 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](./suites.md).
## FAQ
### What version of Docker and docker-compose should I use?
Here are the versions used for testing in Buildkite:
```console
$ docker --version
Docker version 20.10.8, build 3967b7d
$ docker-compose --version
docker-compose version 1.28.0, 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 added you can access the listed sub-domains
from your browser, and they will target the reverse proxy.
[suite]: ./suites.md
|
