Skip to content

Commit ae50b41

Browse files
committed
docs(env): update OVERRIDE_ADMIN_EMAIL documentation
- Clarify the behavior of the OVERRIDE_ADMIN_EMAIL environment variable - Emphasize the security benefits of this feature - Provide more detailed explanations for different scenarios
1 parent 163532b commit ae50b41

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

.env.example

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,12 @@
3434
# Use "https://api.eu.sendgrid.com" for EU-based accounts.
3535
# SENDGRID_API_URL="https://api.sendgrid.com"
3636

37-
# REQUIRED FOR FIRST RUN: The email address for the initial administrator account.
38-
# This value is used ONLY on the first startup to create the first admin user.
39-
# If a user with this email already exists, nothing will happen.
40-
# Changing this value after the first run WILL NOT change the existing admin's email.
41-
# To create a new admin, you must do so from the dashboard after logging in.
42-
# INITIAL_ADMIN_EMAIL="[email protected]"
37+
# ADMIN OVERRIDE: Sets the single administrator account for the application.
38+
# On server startup, the system ensures that the user with this email is the
39+
# one and only administrator.
40+
# - If no admin exists, one will be created with this email.
41+
# - If an admin with a DIFFERENT email exists, they will be REMOVED and
42+
# replaced by a new admin with this email.
43+
# - If an admin with this email already exists, nothing changes.
44+
# This provides a secure way to set or recover the admin account.
45+
# OVERRIDE_ADMIN_EMAIL="[email protected]"

0 commit comments

Comments
 (0)