docs: clarify the default admin credentials only seed the database

The default_admin_username/password descriptions now state that the
values are applied when the controller database is created and only
take effect again after it is re-created (resetting the account).
This commit is contained in:
YueGuobin 2026-08-24 01:12:48 +08:00
parent 4dcde5df59
commit 317f4d2406
No known key found for this signature in database
2 changed files with 10 additions and 6 deletions

View File

@ -6,12 +6,14 @@ jwt_algorithm = HS256
jwt_access_token_expire_minutes = 1440
jwt_refresh_token_expire_minutes = 43200
; Initial default super admin username
; It cannot be changed once the controller has started once
; Username of the super admin account seeded when the controller database is
; created. Changing it has no effect until the database is re-created (which
; resets the account back to these values).
default_admin_username = admin
; Initial default super admin password
; It cannot be changed once the controller has started once
; Password of the super admin account seeded when the controller database is
; created. Changing it has no effect until the database is re-created (which
; resets the account back to these values).
default_admin_password = admin
[Server]

View File

@ -43,10 +43,12 @@ class ControllerSettings(BaseModel):
43200, description="Lifetime of the JWT refresh tokens in minutes (30 days by default)")
default_admin_username: str = Field(
"admin",
description="Initial default super admin username, cannot be changed once the controller has started once")
description="Username of the super admin account seeded when the controller database is created; "
"changing it has no effect until the database is re-created (which resets the account)")
default_admin_password: SecretStr = Field(
SecretStr("admin"),
description="Initial default super admin password, cannot be changed once the controller has started once")
description="Password of the super admin account seeded when the controller database is created; "
"changing it has no effect until the database is re-created (which resets the account)")
model_config = ConfigDict(validate_assignment=True, str_strip_whitespace=True)