Hopefully improved documentation around initial admin account creation.

This commit is contained in:
cristi
2019-05-21 21:06:25 +03:00
parent f2a009795b
commit 078082fac9
3 changed files with 43 additions and 21 deletions

View File

@@ -117,7 +117,17 @@ Create the first admin account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When the cluster is online you need to create you master user to access https://mail.example.com/admin
Enter the main ``admin`` pod to create the root account:
You can create it now manually, or have the system create it automatically.
If you want the system to create the admin user account automatically, see :ref:`admin_account`
about the environment variables needed (``INITIAL_ADMIN_*``).
Also, important, taking into consideration that a pod in Kubernetes can be stopped/rescheduled at
any time, you should set ``INITIAL_ADMIN_MODE`` to either ``update`` or ``ifmissing`` - depending on what you
want to happen to its password.
To create the admin user account manually, enter the main ``admin`` pod:
.. code-block:: bash
@@ -139,25 +149,6 @@ And in the pod run the following command. The command uses following entries:
Now you should be able to login on the mail account: https://mail.example.com/admin
Create the first admin account - automatically
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to have your user created automatically, you need to edit the Deployment descriptor and add
a few environment variables:
.. code-block:: bash
- INITIAL_ADMIN_ACCOUNT = ``root`` The first part of the e-mail address (ROOT@example.com)
- INITIAL_ADMIN_DOMAIN = ``example.com`` the domain appendix
- INITIAL_ADMIN_PW = ``password`` the chosen password for the user
Optionally, you can add the environment ``INITIAL_ADMIN_MODE`` with the value ``update`` if you want to
code to *always* update the password whenever container is started. Which could mean anytime,
so you probably do not want this :-)
Now you should be able to login on the mail account: https://mail.example.com/admin
Adaptations
-----------