tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2024-11-22 11:50:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation for support for auth forwarding proxy (#20)

Browse Source
This commit is contained in:
Igor Rzegocki 2023-10-07 04:57:21 +02:00 committed by GitHub
parent 9884508ff2
commit b4f1425032
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
mkdocs/docs/configuration/forward-auth.md Normal file
View File

@ -0,0 +1,16 @@
You can enable support for authentication proxies such as Authelia.
This effectively disables credentials-based authentication and instead authenticates users if a specific request header contains a known username.
You must make sure that your proxy (nginx, Traefik, Caddy, ...) forwards this header from your auth proxy to tubearchivist.
Check the documentation of your auth proxy and your reverse proxy on how to correctly set this up.
Note that this automatically creates new users in the database if they do not already exist.
- `TA_ENABLE_AUTH_PROXY` (ex: `true`) - Set to anything besides empty string to use forward proxy authentication.
- `TA_AUTH_PROXY_USERNAME_HEADER` - The name of the request header that the auth proxy passes to the proxied application (tubearchivist in this case), so that the application can identify the user.
Check the documentation of your auth proxy to get this information.
Note that the request headers are rewritten in tubearchivist: all HTTP headers are prefixed with `HTTP_`, all letters are in uppercase, and dashes are replaced with underscores.
For example, for Authelia, which passes the `Remote-User` HTTP header, the `TA_AUTH_PROXY_USERNAME_HEADER` needs to be configured as `HTTP_REMOTE_USER`.
- `TA_AUTH_PROXY_LOGOUT_URL` - The URL that tubearchivist should redirect to after a logout.
By default, the logout redirects to the login URL, which means the user will be automatically authenticated again.
Instead, you might want to configure the logout URL of the auth proxy here.

1
mkdocs/mkdocs.yml
View File

@ -27,6 +27,7 @@ nav:
- 'Helm Charts': 'installation/helm-charts.md' - 'Helm Charts': 'installation/helm-charts.md'
- Configuration: - Configuration:
- 'LDAP Authentication': 'configuration/ldap.md' - 'LDAP Authentication': 'configuration/ldap.md'
- 'Forward Authentication': 'configuration/forward-auth.md'
- 'Cast Support': 'configuration/cast.md' - 'Cast Support': 'configuration/cast.md'
- API: - API:
- 'Introduction': 'api/introduction.md' - 'Introduction': 'api/introduction.md'