From 94228beafe428d940591c55e048aec2557bd36de Mon Sep 17 00:00:00 2001 From: John Karabudak Date: Sat, 15 Jun 2024 21:36:20 -0230 Subject: [PATCH] documented the new WEBUI_AUTH_TRUSTED_NAME_HEADER environment variable --- docs/getting-started/env-configuration.md | 4 ++++ docs/tutorial/sso.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 221dd2d..736894f 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -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` diff --git a/docs/tutorial/sso.md b/docs/tutorial/sso.md index 2d1e895..56c93cd 100644 --- a/docs/tutorial/sso.md +++ b/docs/tutorial/sso.md @@ -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.