Skip to content

Commit 3aaa17a

Browse files
committed
docs: update email regex examples
1 parent 4dc9564 commit 3aaa17a

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ DEPLOY_REGISTRY_HOST=localhost:5000
3434

3535
# OPTIONAL VARIABLES
3636
# This is used for validating emails that are allowed to log in. Every email that do not match this regex will be rejected.
37-
# WHITELISTED_EMAILS="authorized@yahoo\.com|authorized@gmail\.com"
37+
# WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
3838
# Accounts with these emails will get global admin rights. This grants access to the admin UI.
39-
# ADMIN_EMAILS="admin@example\.com|another-admin@example\.com"
39+
# ADMIN_EMAILS="^(admin@example\.com|another-admin@example\.com)$"
4040
# This is used for logging in via GitHub. You can leave these commented out if you don't want to use GitHub for authentication.
4141
# AUTH_GITHUB_CLIENT_ID=
4242
# AUTH_GITHUB_CLIENT_SECRET=

docs/open-source-self-hosting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ All email addresses can sign up and log in this way. If you would like to restri
313313

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

319319
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.

docs/self-hosting/docker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ All email addresses can sign up and log in this way. If you would like to restri
299299
300300
```bash
301301
# every email that does not match this regex will be rejected
302-
WHITELISTED_EMAILS="authorized@yahoo\.com|authorized@gmail\.com"
302+
WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
303303
```
304304
305305
This will apply to all auth methods including magic link and GitHub OAuth.

docs/self-hosting/kubernetes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ webapp:
476476
webapp:
477477
extraEnvVars:
478478
- name: WHITELISTED_EMAILS
479-
value: "user1@company\\.com|user2@company\\.com"
479+
value: "^(user1@company\\.com|user2@company\\.com)$"
480480
```
481481

482482
## Version locking

0 commit comments

Comments
 (0)