Skip to content

docs: update email regex examples #2749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicktrn merged 1 commit into from
Dec 4, 2025
Merged

docs: update email regex examples #2749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ DEPLOY_REGISTRY_HOST=localhost:5000

# OPTIONAL VARIABLES
# This is used for validating emails that are allowed to log in. Every email that do not match this regex will be rejected.
# WHITELISTED_EMAILS="authorized@yahoo\.com|authorized@gmail\.com"
# WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
# Accounts with these emails will get global admin rights. This grants access to the admin UI.
# ADMIN_EMAILS="admin@example\.com|another-admin@example\.com"
# ADMIN_EMAILS="^(admin@example\.com|another-admin@example\.com)$"
# This is used for logging in via GitHub. You can leave these commented out if you don't want to use GitHub for authentication.
# AUTH_GITHUB_CLIENT_ID=
# AUTH_GITHUB_CLIENT_SECRET=
Expand Down
2 changes: 1 addition & 1 deletion docs/open-source-self-hosting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ All email addresses can sign up and log in this way. If you would like to restri

```bash
# every email that does not match this regex will be rejected
WHITELISTED_EMAILS="authorized@yahoo\.com|authorized@gmail\.com"
WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
```

It's currently impossible to restrict GitHub OAuth logins by account name or email like above, so this method is _not recommended_ for self-hosted instances. It's also very easy to lock yourself out of your own instance.
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ All email addresses can sign up and log in this way. If you would like to restri

```bash
# every email that does not match this regex will be rejected
WHITELISTED_EMAILS="authorized@yahoo\.com|authorized@gmail\.com"
WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
```

This will apply to all auth methods including magic link and GitHub OAuth.
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ webapp:
webapp:
extraEnvVars:
- name: WHITELISTED_EMAILS
value: "user1@company\\.com|user2@company\\.com"
value: "^(user1@company\\.com|user2@company\\.com)$"
```

## Version locking
Expand Down
Loading