From a053c1f4e153478b0d0db48809bc46192b7a7ad8 Mon Sep 17 00:00:00 2001 From: Donnie Adams Date: Thu, 19 Dec 2024 13:28:24 -0500 Subject: [PATCH] fix: update auth provider environment variables Signed-off-by: Donnie Adams --- .../05-configuration/03-auth-providers.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/docs/05-configuration/03-auth-providers.md b/docs/docs/05-configuration/03-auth-providers.md index fc827371..699c9259 100644 --- a/docs/docs/05-configuration/03-auth-providers.md +++ b/docs/docs/05-configuration/03-auth-providers.md @@ -8,14 +8,14 @@ The following environment variables are required for all authentication provider Setting the Client ID and Client Secret will mean that the authentication provider is enabled. The remaining configuration will be validated on startup. -- `OBOT_AUTH_CLIENT_ID`: The client ID of the authentication provider. -- `OBOT_AUTH_CLIENT_SECRET`: The client secret of the authentication provider. -- `OBOT_AUTH_COOKIE_SECRET`: The secret used to encrypt the authentication cookie. Must be of size 16, 24, or 32 bytes. -- `OBOT_AUTH_ADMIN_EMAILS`: A comma-separated list of the email addresses of the admin users. +- `OBOT_SERVER_AUTH_CLIENT_ID`: The client ID of the authentication provider. +- `OBOT_SERVER_AUTH_CLIENT_SECRET`: The client secret of the authentication provider. +- `OBOT_SERVER_AUTH_COOKIE_SECRET`: The secret used to encrypt the authentication cookie. Must be of size 16, 24, or 32 bytes. +- `OBOT_SERVER_AUTH_ADMIN_EMAILS`: A comma-separated list of the email addresses of the admin users. The following environment variables are optional for all authentication providers: -- `OBOT_AUTH_EMAIL_DOMAINS`: A comma-separated list of email domains allowed for authentication. Ignored if not set. -- `OBOT_AUTH_CONFIG_TYPE`: The type of the authentication provider. For example, `google` or `github`. Defaults to `google`. +- `OBOT_SERVER_AUTH_EMAIL_DOMAINS`: A comma-separated list of email domains allowed for authentication. Ignored if not set. +- `OBOT_SERVER_AUTH_CONFIG_TYPE`: The type of the authentication provider. For example, `google` or `github`. Defaults to `google`. ## Google @@ -25,8 +25,8 @@ Google is the default authentication provider. There are currently no additional GitHub authentication has the following optional configuration: -- `OBOT_AUTH_GITHUB_ORG`: The name of the organization allowed for authentication. Ignored if not set. -- `OBOT_AUTH_GITHUB_TEAM`: The name of the team allowed for authentication. Ignored if not set. -- `OBOT_AUTH_GITHUB_REPO`: Restrict logins to collaborators of this repository formatted as `orgname/repo`. Ignored if not set. -- `OBOT_AUTH_GITHUB_TOKEN`: The token to use when verifying repository collaborators (must have push access to the repository). -- `OBOT_AUTH_GITHUB_ALLOW_USERS`: A comma-separated list of users allowed to log in even if they don't belong to the organization or team. \ No newline at end of file +- `OBOT_SERVER_AUTH_GITHUB_ORG`: The name of the organization allowed for authentication. Ignored if not set. +- `OBOT_SERVER_AUTH_GITHUB_TEAM`: The name of the team allowed for authentication. Ignored if not set. +- `OBOT_SERVER_AUTH_GITHUB_REPO`: Restrict logins to collaborators of this repository formatted as `orgname/repo`. Ignored if not set. +- `OBOT_SERVER_AUTH_GITHUB_TOKEN`: The token to use when verifying repository collaborators (must have push access to the repository). +- `OBOT_SERVER_AUTH_GITHUB_ALLOW_USERS`: A comma-separated list of users allowed to log in even if they don't belong to the organization or team. \ No newline at end of file