mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
76fa325f08
Authelia client uses hash router instead of browser router in order to work with Kubernetes nginx-ingress-controller. This is also better for users having old browsers. This commit is breaking because it requires to change the configuration of the proxy to include the # in the URL of the login portal.
84 lines
2.8 KiB
Markdown
84 lines
2.8 KiB
Markdown
# Getting Started
|
||
|
||
**Authelia** can be tested in a matter of seconds with docker-compose based
|
||
on the latest image available on [Dockerhub].
|
||
|
||
In order to deploy the latest release locally, run the following command and
|
||
follow the instructions of bootstrap.sh:
|
||
|
||
source bootstrap.sh
|
||
|
||
Then, start the *dockerhub* [suite].
|
||
|
||
authelia-scripts suites start dockerhub
|
||
|
||
A [suite] is kind of a virtual environment for running Authelia.
|
||
If you want more details please read the related [documentation](./suites.md).
|
||
|
||
## Test it!
|
||
|
||
After few seconds the services should be running and you should be able to
|
||
visit [https://home.example.com:8080/](https://home.example.com:8080/).
|
||
|
||
When accessing the login page, since this is a test environment a
|
||
self-signed certificate exception should appear, it has to be trusted
|
||
before you can get to the home page.
|
||
The certificate must also be trusted for each subdomain, therefore it is
|
||
normal to see this exception several times.
|
||
|
||
Below is what the login page looks like after you accepted all exceptions:
|
||
|
||
<p align="center">
|
||
<img src="../images/first_factor.png" width="400">
|
||
</p>
|
||
|
||
You can use one of the users listed in [https://home.example.com:8080/](https://home.example.com:8080/).
|
||
The rights granted to each user and group is also provided in the page as
|
||
a list of rules.
|
||
|
||
At some point, you'll be required to register your second factor device.
|
||
Since your security is **Authelia**'s priority, it will send
|
||
an email to the email address of the user to confirm the user identity.
|
||
Since we're running a test environment, we provide a fake webmail called
|
||
*MailCatcher* from which you can checkout the email and confirm
|
||
your identity.
|
||
The webmail is accessible from
|
||
[http://mail.example.com:8080](http://mail.example.com:8085).
|
||
|
||
Enjoy!
|
||
|
||
## FAQ
|
||
|
||
### What version of Docker and docker-compose should I use?
|
||
|
||
Here are the versions used for testing in Travis:
|
||
|
||
$ docker --version
|
||
Docker version 17.03.1-ce, build c6d412e
|
||
|
||
$ docker-compose --version
|
||
docker-compose version 1.14.0, build c7bdf9e
|
||
|
||
### How am I supposed to access the subdomains of example.com?
|
||
|
||
Well, in order to test Authelia, we will fake your browser that example.com is
|
||
served by your machine. To do that, open */etc/hosts* and append the following
|
||
lines:
|
||
|
||
127.0.0.1 home.example.com
|
||
127.0.0.1 public.example.com
|
||
127.0.0.1 secure.example.com
|
||
127.0.0.1 dev.example.com
|
||
127.0.0.1 admin.example.com
|
||
127.0.0.1 mx1.mail.example.com
|
||
127.0.0.1 mx2.mail.example.com
|
||
127.0.0.1 singlefactor.example.com
|
||
127.0.0.1 login.example.com
|
||
|
||
### What should I do if I want to contribute?
|
||
|
||
You can refer to the dedicated documentation [here](./build-and-dev.md).
|
||
|
||
[config.template.yml]: ../config.template.yml
|
||
[DockerHub]: https://hub.docker.com/r/clems4ever/authelia/
|
||
[suite]: ./suites.md |