documented the new WEBUI_AUTH_TRUSTED_NAME_HEADER environment variable

This commit is contained in:
John Karabudak 2024-06-15 21:36:20 -02:30
parent 9f12fae422
commit 94228beafe
2 changed files with 6 additions and 0 deletions

View File

@ -124,6 +124,10 @@ Here is a list of supported environment variables used by `backend/config.py` in
- Description: Defines the trusted request header for authentication. See [SSO docs](/tutorial/sso).
#### `WEBUI_AUTH_TRUSTED_NAME_HEADER`
- Description: Defines the trusted request header for the username of anyone registering with the `WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/tutorial/sso).
#### `WEBUI_SECRET_KEY`
- Default: `t0p-s3cr3t`

View File

@ -22,6 +22,8 @@ When the `WEBUI_AUTH_TRUSTED_EMAIL_HEADER` environment variable is set, Open Web
For example, setting `WEBUI_AUTH_TRUSTED_EMAIL_HEADER=X-User-Email` and passing a HTTP header of `X-User-Email: example@example.com` would authenticate the request with the email `example@example.com`.
Optionally, you can also define the `WEBUI_AUTH_TRUSTED_NAME_HEADER` to determine the name of any user being created using trusted headers. This has no effect if the user already exists.
## Tailscale Serve
[Tailscale Serve](https://tailscale.com/kb/1242/tailscale-serve) allows you to share a service within your tailnet, and Tailscale will set the header `Tailscale-User-Login` with the email address of the requester.