mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-16 19:21:53 +00:00
Update Authelia recipe
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
@@ -3,11 +3,11 @@ title: Using Authelia to secure services in Docker
|
||||
description: Authelia is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your applications via a web portal.
|
||||
---
|
||||
|
||||
# Authelia
|
||||
# Authelia in Docker Swarm
|
||||
|
||||
[Authelia](https://github.com/authelia/authelia) is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion of reverse proxies like Nginx, Traefik, or HAProxy to let them know whether queries should pass through. Unauthenticated users are redirected to Authelia Sign-in portal instead.
|
||||
[Authelia](https://github.com/authelia/authelia) is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your applications via a web portal. Like [Traefik Forward Auth][tfa], Authelia acts as a companion of reverse proxies like Nginx, [Traefik](/docker-swarm/traefik/), or HAProxy to let them know whether queries should pass through. Unauthenticated users are redirected to Authelia Sign-in portal instead. Authelia is a popular alternative to a heavyweight such as [KeyCloak][keycloak].
|
||||
|
||||
{ loading=lazy }
|
||||
{ loading=lazy }
|
||||
|
||||
Features include
|
||||
|
||||
@@ -47,9 +47,7 @@ Authelia configurations are defined in `/var/data/config/authelia/configuration.
|
||||
!!! warning
|
||||
Your variables may vary significantly from what's illustrated below, and it's best to read up and understand exactly what each option does.
|
||||
|
||||
???+ note "Much scroll, very text. Click here to collapse it for better readability"
|
||||
|
||||
```yaml
|
||||
```yaml title="/var/data/config/authelia/configuration.yml"
|
||||
###############################################################
|
||||
# Authelia configuration #
|
||||
###############################################################
|
||||
@@ -94,7 +92,7 @@ Authelia configurations are defined in `/var/data/config/authelia/configuration.
|
||||
- domain: "whoami-authelia-2fa.example.com"
|
||||
policy: two_factor
|
||||
|
||||
- domain: "*.example.com"
|
||||
- domain: "*.example.com" # (1)!
|
||||
policy: one_factor
|
||||
|
||||
|
||||
@@ -132,11 +130,13 @@ Authelia configurations are defined in `/var/data/config/authelia/configuration.
|
||||
filename: /config/notification.txt
|
||||
```
|
||||
|
||||
1. The wildcard rule must go last, since the first rule to match the request, wins
|
||||
|
||||
### Create Authelia user Accounts
|
||||
|
||||
Create `/var/data/config/authelia/users_database.yml` this will be where we can create user accounts and give them groups
|
||||
|
||||
```yaml
|
||||
```yaml title="/var/data/config/authelia/users_database.yml"
|
||||
# To create a hashed password you can run the following command:
|
||||
# `docker run authelia/authelia:latest authelia hash-password YOUR_PASSWORD``
|
||||
users:
|
||||
@@ -159,9 +159,7 @@ Create a docker swarm config file in docker-compose syntax (v3), something like
|
||||
|
||||
--8<-- "premix-cta.md"
|
||||
|
||||
???+ note "Much scroll, very YAML. Click here to collapse it for better readability"
|
||||
|
||||
```yaml
|
||||
```yaml title="/var/data/config/authelia/authelia.yml"
|
||||
version: "3.2"
|
||||
|
||||
services:
|
||||
@@ -188,12 +186,8 @@ Create a docker swarm config file in docker-compose syntax (v3), something like
|
||||
- "traefik.http.routers.authelia.rule=Host(`authelia.example.com`)"
|
||||
- "traefik.http.routers.authelia.entrypoints=https"
|
||||
- "traefik.http.services.authelia.loadbalancer.server.port=9091"
|
||||
# - "traefik.http.middlewares.authelia.forwardauth.address=http://authelia:9091/api/verify?rd=https://authelia.example.com"
|
||||
# - "traefik.http.middlewares.authelia.forwardauth.trustForwardHeader=true"
|
||||
# - "traefik.http.middlewares.authelia.forwardauth.authResponseHeaders=Remote-User, Remote-Groups"
|
||||
|
||||
# This simply validates that traefik forward authentication is working
|
||||
whoami-1fa:
|
||||
whoami-1fa: # (1)!
|
||||
image: containous/whoami
|
||||
networks:
|
||||
- traefik_public
|
||||
@@ -217,7 +211,7 @@ Create a docker swarm config file in docker-compose syntax (v3), something like
|
||||
- "traefik.http.services.whoami-authelia-1fa.loadbalancer.server.port=80"
|
||||
|
||||
|
||||
whoami-2fa:
|
||||
whoami-2fa: # (2)!
|
||||
image: containous/whoami
|
||||
networks:
|
||||
- traefik_public
|
||||
@@ -245,23 +239,41 @@ Create a docker swarm config file in docker-compose syntax (v3), something like
|
||||
external: true
|
||||
```
|
||||
|
||||
1. Optionally used to test 1FA authentication
|
||||
2. Optionally used to test 2FA authentication
|
||||
|
||||
|
||||
|
||||
!!! question "Why not just use Traefik Forward Auth?"
|
||||
[Traefik Forward Auth][tfa] is a very minimal authentication layer that provides google and openID authentication. Authelia provides more features such as multiple methods of authentication (*Hardware, OTP, Email*) and push notifications.
|
||||
While [Traefik Forward Auth][tfa] is a very lightweight, minimal authentication layer, which provides OIDC-based authentication, Authelia provides more features such as multiple methods of authentication (*Hardware, OTP, Email*), advanced rules, and push notifications.
|
||||
|
||||
## Serving
|
||||
|
||||
### Launch Authelia!
|
||||
## Run Authelia
|
||||
|
||||
Launch the Authelia stack by running ```docker stack deploy authelia -c <path -to-docker-compose.yml>```
|
||||
|
||||
## Test Authelia
|
||||
### Test Authelia
|
||||
|
||||
To test the service works successfully, try logging into authelia itself first, as a user whose password you've setup in `/var/data/config/authelia/users_database.yml`. You'll notice that upon successful login, you're requested to setup 2FA. You probably didn't configure an SMTP server, but the contents of the email request should be found in ``/var/data/config/authelia/notifications.txt`
|
||||
To test the service works successfully, try logging into Authelia itself first, as a user whose password you've setup in `/var/data/config/authelia/users_database.yml`.
|
||||
|
||||
You'll notice that upon successful login, you're requested to setup 2FA. If (*like me!*) you didn't configure an SMTP server, you can still setup 2FA (*TOTP or webauthn*), and the setup link email instructions should be found in `/var/data/config/authelia/notifications.txt`
|
||||
|
||||
Now you're ready to test 1FA and 2FA auth, against the two "whoami" services defined in the docker-compose file.
|
||||
|
||||
Try to access each in turn, and confirm that you're _not_ prompted for 2FA on whoami-authelia-1fa, but you _are_ prompted for 2FA on whoami-authelia-2fa ;)
|
||||
Try to access each in turn, and confirm that you're _not_ prompted for 2FA on whoami-authelia-1fa, but you _are_ prompted for 2FA on whoami-authelia-2fa! :thumbsup:
|
||||
|
||||
## Summary
|
||||
|
||||
What have we achieved? By adding a simple label to any service, we can secure any service behind our Authelia, with minimal processing / handling overhead, and benefit from the 1FA/2FA multi-layered features provided by Autheila.
|
||||
|
||||
!!! summary "Summary"
|
||||
Created:
|
||||
|
||||
* [X] Authelia configured and available to provide a layer of authentication to other services deployed in the stack
|
||||
|
||||
### Authelia vs Keycloak
|
||||
|
||||
[KeyCloak][keycloak] is the "big daddy" of self-hosted authentication platforms - it has a beautiful GUI, and a very advanced and mature featureset. Like Authelia, KeyCloak can [use an LDAP server](/recipes/keycloak/authenticate-against-openldap/) as a backend, but _unlike_ Authelia, KeyCloak allows for 2-way sync between that LDAP backend, meaning KeyCloak can be used to _create_ and _update_ the LDAP entries (*Authelia's is just a one-way LDAP lookup - you'll need another tool to actually administer your LDAP database*).
|
||||
|
||||
|
||||
[^1]: The initial inclusion of Authelia was due to the efforts of @bencey in Discord (Thanks Ben!)
|
||||
|
||||
|
||||
@@ -96,4 +96,9 @@ What have we achieved? By adding an additional three simple labels to any servic
|
||||
|
||||
[^1]: Keycloak is very powerful. You can add 2FA and all other clever things outside of the scope of this simple recipe ;)
|
||||
|
||||
### Keycloak vs Authelia
|
||||
|
||||
[KeyCloak][keycloak] is the "big daddy" of self-hosted authentication platforms - it has a beautiful GUI, and a very advanced and mature featureset. Like Authelia, KeyCloak can [use an LDAP server](/recipes/keycloak/authenticate-against-openldap/) as a backend, but _unlike_ Authelia, KeyCloak allows for 2-way sync between that LDAP backend, meaning KeyCloak can be used to _create_ and _update_ the LDAP entries (*Authelia's is just a one-way LDAP lookup - you'll need another tool to actually administer your LDAP database*).
|
||||
|
||||
|
||||
--8<-- "recipe-footer.md"
|
||||
|
||||
Reference in New Issue
Block a user