diff --git a/docs/site_assets/authelia/aquamarine.png b/docs/site_assets/authelia/aquamarine.png new file mode 100644 index 00000000..df94fa3f Binary files /dev/null and b/docs/site_assets/authelia/aquamarine.png differ diff --git a/docs/site_assets/authelia/dark.png b/docs/site_assets/authelia/dark.png new file mode 100644 index 00000000..989cca90 Binary files /dev/null and b/docs/site_assets/authelia/dark.png differ diff --git a/docs/site_assets/authelia/dracula.png b/docs/site_assets/authelia/dracula.png new file mode 100644 index 00000000..24a77899 Binary files /dev/null and b/docs/site_assets/authelia/dracula.png differ diff --git a/docs/site_assets/authelia/hotline.png b/docs/site_assets/authelia/hotline.png new file mode 100644 index 00000000..ad5a81b5 Binary files /dev/null and b/docs/site_assets/authelia/hotline.png differ diff --git a/docs/site_assets/authelia/hotpink.png b/docs/site_assets/authelia/hotpink.png new file mode 100644 index 00000000..cea6ab28 Binary files /dev/null and b/docs/site_assets/authelia/hotpink.png differ diff --git a/docs/site_assets/authelia/logo.png b/docs/site_assets/authelia/logo.png new file mode 100644 index 00000000..b58b9c63 Binary files /dev/null and b/docs/site_assets/authelia/logo.png differ diff --git a/docs/site_assets/authelia/maroon.png b/docs/site_assets/authelia/maroon.png new file mode 100644 index 00000000..300fa713 Binary files /dev/null and b/docs/site_assets/authelia/maroon.png differ diff --git a/docs/site_assets/authelia/nord.png b/docs/site_assets/authelia/nord.png new file mode 100644 index 00000000..ef0d4955 Binary files /dev/null and b/docs/site_assets/authelia/nord.png differ diff --git a/docs/site_assets/authelia/organizr.png b/docs/site_assets/authelia/organizr.png new file mode 100644 index 00000000..6720d6fd Binary files /dev/null and b/docs/site_assets/authelia/organizr.png differ diff --git a/docs/site_assets/authelia/overseerr.png b/docs/site_assets/authelia/overseerr.png new file mode 100644 index 00000000..1a8faace Binary files /dev/null and b/docs/site_assets/authelia/overseerr.png differ diff --git a/docs/site_assets/authelia/plex.png b/docs/site_assets/authelia/plex.png new file mode 100644 index 00000000..0473a104 Binary files /dev/null and b/docs/site_assets/authelia/plex.png differ diff --git a/docs/site_assets/authelia/space-gray.png b/docs/site_assets/authelia/space-gray.png new file mode 100644 index 00000000..8851071b Binary files /dev/null and b/docs/site_assets/authelia/space-gray.png differ diff --git a/docs/themes/addons/authelia/authelia-login-logo/addon-example.png b/docs/themes/addons/authelia/authelia-login-logo/addon-example.png new file mode 100644 index 00000000..ac86bd72 Binary files /dev/null and b/docs/themes/addons/authelia/authelia-login-logo/addon-example.png differ diff --git a/docs/themes/addons/authelia/authelia-login-logo/authelia-dracula.png b/docs/themes/addons/authelia/authelia-login-logo/authelia-dracula.png new file mode 100644 index 00000000..24a77899 Binary files /dev/null and b/docs/themes/addons/authelia/authelia-login-logo/authelia-dracula.png differ diff --git a/docs/themes/addons/authelia/authelia-login-logo/index.md b/docs/themes/addons/authelia/authelia-login-logo/index.md new file mode 100644 index 00000000..574cf4f9 --- /dev/null +++ b/docs/themes/addons/authelia/authelia-login-logo/index.md @@ -0,0 +1,56 @@ +# Authelia Logos + +This is a collection of addons that allow you to modify the authelia login page with the logo of an app. By using the routing functions of a reverse proxy such as Traefik, you can apply this addon when using ForwardAuth to log in to an app. This can be useful for making it clearer to a user (or yourself) what app is being logged into. Unfortunately, there doesn't seem to be a way to apply this to oidc logins. + +The following logo options are currently available: +``` +authelia-bazarr-logo +authelia-jellyfin-logo +authelia-jellyseerr-logo +authelia-komga-logo +authelia-lidarr-logo +authelia-lldap-logo +authelia-mylar-logo +authelia-photoprism-logo +authelia-pihole-logo +authelia-prowlarr-logo +authelia-qbittorrent-logo +authelia-radarr-logo +authelia-romm-logo +authelia-sabnzbd-logo +authelia-sonarr-logo +authelia-traefik-logo +``` + +Here is an example of using a custom traefik router and the traefik-themepark middleware addon to set a different theme and addon on a sonarr login, while still having a seperate theme in Authelia. + +Replace auth.example.com with your Authelia instance url, and sonarr.example.com with your sonarr instance url. + +```traefik + # Authelia Theme + - "traefik.http.routers.authelia.rule=Host(`auth.example.com`)" + - "traefik.http.routers.authelia.middlewares=themepark-authelia@docker" + - "traefik.http.middlewares.themepark-authelia.plugin.themepark.app=authelia" + - "traefik.http.middlewares.themepark-authelia.plugin.themepark.theme=dracula" + # Authelia Sonarr Login Page Theme + - "traefik.http.middlewares.authelia-sonarr.plugin.themepark.app=authelia" + - "traefik.http.middlewares.authelia-sonarr.plugin.themepark.theme=aquamarine" + - "traefik.http.middlewares.authelia-sonarr.plugin.themepark.addons=sonarr-logo" + - "traefik.http.routers.authelia-sonarr.middlewares=authelia-sonarr@docker" + - "traefik.http.routers.authelia-sonarr.entrypoints=https" + - "traefik.http.routers.authelia-sonarr.rule=Host(`auth.example.com`) && QueryRegexp(`rd`, `.*sonarr.example.com.*`)" +``` + +That will give you this result, with your sonarr login (sonarr.example.com) having a seperate theme and the logo, and your base authelia login (auth.example.com) having its own theming and the base Authelia logo: + + +
+

Radarr Logo Addon

+

Base Authelia

+
+ +To apply your own default Authelia logo, or modify some of the strings such as changing "Sign in" to "Sign in to {Your Domain}", see the Authelia [Server Asset Overrides](https://www.authelia.com/reference/guides/server-asset-overrides/) documentation. + +{% set addon_app = "authelia" %} +{% set addon_name = "authelia-sonarr-logo" %} +{% include-markdown "themes/addons/example.md" %} diff --git a/docs/themes/authelia.md b/docs/themes/authelia.md new file mode 100644 index 00000000..5babd6f9 --- /dev/null +++ b/docs/themes/authelia.md @@ -0,0 +1,25 @@ +{% set github_link = "https://github.com/authelia/authelia" %} + +{% include-markdown "../themes/title.md" %} + +{% include-markdown "../themes/installation.md" %} + +!!! warning "Subfilter CSP" + As Authelia will block the theme with its content security policy, you need to modify or remove the default CSP header. + Removing the CSP header can leave your Authelia instance open to attacks such as clickjacking or cross-site scripting (XSS). This is especially dangerous if your Authelia instance is publically accessible. As Authelia already supports modifying the CSP header, it is not advisable to remove it. + +### Custom CSP Headers in Authelia Configuration + +To modify the Authelia Content Security Policy Header, change this line in the Authelia configuration.yml, and restart Authelia. + +```authelia +server: + headers: + csp_template: "default-src 'self'; style-src 'self' 'nonce-${NONCE}' 'sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=' 'unsafe-inline' theme-park.dev raw.githubusercontent.com use.fontawesome.com; img-src 'self' theme-park.dev raw.githubusercontent.com data:; script-src 'self' 'unsafe-inline'; object-src 'none'; form-action 'self'; frame-ancestors 'self'; font-src use.fontawesome.com;" +``` + +If you are self-hosting theme-park, instead replace 'theme-park.dev raw.githubusercontent.com' with the domain of your self-hosted theme-park instance. + +{% include-markdown "../themes/addons/addons.md" %} + +{% include-markdown "../themes/screenshots.md" %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 23af0b6e..f4a2bd5e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -100,6 +100,7 @@ nav: Dozzle ⚠️: themes/dozzle.md Bitwarden ⚠️: themes/bitwarden.md Vaultwarden ⚠️: themes/bitwarden/#vaultwarden + Authelia ⚠️: themes/authelia.md Nzbhydra2: themes/nzbhydra2.md Portainer: themes/portainer.md Guacamole: themes/guacamole.md @@ -165,6 +166,8 @@ nav: Plex: Alternative Logo: themes/addons/plex/plex-alt-logo/index.md Overseerr Side Menu: themes/addons/plex/overseerr-side-menu/index.md + Authelia: + Login Logo: themes/addons/authelia/authelia-login-logo/index.md - Theme Options: Theme Options: theme-options/index.md Organizr: theme-options/organizr.md @@ -322,6 +325,9 @@ extra: path: themes/addons/plex/overseerr-side-menu Alternative Logo: path: themes/addons/plex/plex-alt-logo + authelia: + Login Logo: + path: themes/addons/authelia/authelia-login-logo themes: - aquamarine - hotline