diff --git a/docs/contributing/dev-setup.rst b/docs/contributing/dev-setup.rst index af0a3b8..01ca6d0 100644 --- a/docs/contributing/dev-setup.rst +++ b/docs/contributing/dev-setup.rst @@ -43,6 +43,14 @@ The easiest & safest way to develop & test TLJH is with `Docker ``` + the very first time. It is recommended that you also set a password + for the admin at this step. The :ref:`--admin ` flag passed to the installer does this. If you had forgotten to do so, the easiest way to fix this is to run the installer again. diff --git a/docs/topic/customizing-installer.rst b/docs/topic/customizing-installer.rst index ea5585f..2285d6f 100644 --- a/docs/topic/customizing-installer.rst +++ b/docs/topic/customizing-installer.rst @@ -20,11 +20,24 @@ This page documents the various options you can pass as commandline parameters t Adding admin users =================== -``--admin `` adds user ```` to JupyterHub as an admin user. -This can be repeated multiple times. +``--admin :`` adds user ```` to JupyterHub as an admin user +and sets its password to be ````. +Although it is not recommended, it is possible to only set the admin username at this point +and set the admin password after the installation. -For example, to add ``admin-user1`` and ``admin-user2`` as admins when installing, you -would do: +Also, the ``--admin`` flag can be repeated multiple times. For example, to add ``admin-user1`` +and ``admin-user2`` as admins when installing, depending if you would like to set their passwords +during install you would: + +* set ``admin-user1`` with password ``password-user1`` and ``admin-user2`` with ``password-user2`` using: + +.. code-block:: bash + + curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \ + | sudo python3 - \ + --admin admin-user1:password-user1 --admin admin-user2:password-user2 + +* set ``admin-user1`` and ``admin-user2`` to be admins, without any passwords at this stage, using: .. code-block:: bash @@ -32,6 +45,14 @@ would do: | sudo python3 - \ --admin admin-user1 --admin admin-user2 +* set ``admin-user1`` with password ``password-user1`` and ``admin-user2`` with no password at this stage using: + +.. code-block:: bash + + curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \ + | sudo python3 - \ + --admin admin-user1:password-user1 --admin admin-user2 + Installing python packages in the user environment ==================================================