self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2024-12-12 10:45:38 +02:00
Code Issues Releases Activity

Rewording INITIAL_ADMIN_MODE documentation

Browse Source
This commit is contained in:
Erriez 2021-12-22 18:18:15 +01:00
parent 83d9a81f0f
commit 4c52cf1d6a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuration.rst
View File

@ -162,13 +162,13 @@ To have the account created automatically, you just need to define a few environ
- ``INITIAL_ADMIN_ACCOUNT``: the admin username: The first part of the e-mail address before the @.
- ``INITIAL_ADMIN_DOMAIN``: the domain appendix: Most probably identical to the ``DOMAIN`` variable.
- ``INITIAL_ADMIN_PW``: the admin password.
- ``INITIAL_ADMIN_MODE``: one of the options below how the code should behave when it will try to create the admin user:
- ``INITIAL_ADMIN_MODE``: use one of the options below for configuring how the admin account must be created:
- ``create``: (default) Will try to create user and will raise an exception if present.
- ``ifmissing``: if user exists, nothing happens, else it will be created.
- ``update``: user is created or, if it exists, its password gets updated.
- ``create``: (default) creates a new admin account and raises an exception when already exists.
- ``ifmissing``: creates a new admin account when the admin account does not exist.
- ``update``: creates a new admin account when it does not exist, or update the password of an existing admin account.
You should set ``INITIAL_ADMIN_MODE`` also to either ``update`` or ``ifmissing``. Leaving it with the default value could cause errors when restarting the system.
Note: It is recommended to set ``INITIAL_ADMIN_MODE`` to either ``update`` or ``ifmissing``. Leaving it with the default value will cause an error when the system is restarted.
An example: