2c42464fc8
* refactor: logging config key to log This refactors the recent pre-release change adding log options to their own configuration section in favor of a log section (from logging). * docs: add step to getting started to get the latest tagged commit This is so we avoid issues with changes on master having differences that don't work on the latest docker tag. * test: adjust tests * docs: adjust doc strings
1.8 KiB
| layout | title | nav_order |
|---|---|---|
| default | Getting Started | 2 |
Getting Started
Docker Compose
Steps
These commands are intended to be run sequentially:
git clone https://github.com/authelia/authelia.gitcd authelia/examples/compose/localgit checkout $(git describe --tags `git rev-list --tags --max-count=1`)sudo ./setup.shsudo is required to modify the/etc/hostsfile
You can now visit the following locations; replace example.com with the domain you specified in the setup script:
- https://public.example.com - Bypasses Authelia
- https://traefik.example.com - Secured with Authelia one-factor authentication
- https://secure.example.com - Secured with Authelia two-factor authentication (see note below)
You will need to authorize the self-signed certificate upon visiting each domain.
To visit https://secure.example.com you will need to register a device for second factor authentication and confirm by clicking on a link sent by email.
Since this is a demo with a fake email address, the content of the email will be stored in ./authelia/notification.txt.
Upon registering, you can grab this link easily by running the following command: grep -Eo '"https://.*" ' ./authelia/notification.txt.
Deployment
So you're convinced that Authelia is what you need. You can head to the deployment documentation here. Some recipes have been crafted for helping with the bootstrap of your environment. You can choose between a lite deployment which is deployment advised for a single server setup. However, this setup just does not scale. If you want a full environment that can scale out, use the HA or Kubernetes deployment documentation.