diff --git a/docs/howto/auth/firstuse.rst b/docs/howto/auth/firstuse.rst index dc9dcb9..e7c7f1c 100644 --- a/docs/howto/auth/firstuse.rst +++ b/docs/howto/auth/firstuse.rst @@ -34,3 +34,38 @@ the JupyterHub, run the following command. tljh-config set auth.FirstUseAuthenticator.create_users true tljh-config reload + + +Resetting user password +======================= + +You can reset user passwords by *deleting* the user from the JupyterHub admin +page. This logs the user out, but does **not** remove any of their data or +home directories. The user can then set a new password by logging in again with +their new password. + +#. As an admin user, open the **Control Panel** by clicking the control panel + button on the top right of your JupyterHub. + + .. image:: ../../images/control-panel-button.png + :alt: Control panel button in notebook, top right + +#. In the control panel, open the **Admin** link in the top left. + + .. image:: ../../images/admin/admin-access-button.png + :alt: Admin button in control panel, top left + + This opens up the JupyterHub admin page, where you can add / delete users, + start / stop peoples' servers and see who is online. + +#. **Delete** the user whose password needs resetting. Remember this **does not** + delete their data or home directory. + + .. image:: ../../images/auth/firstuse/delete-user.png + :alt: Delete user button for each user + + If there is a confirmation dialog, confirm the deletion. This will also log the + user out if they were currently running. + +#. Ask the user to log in again with their new password as usual. This will be their + new password going forward. \ No newline at end of file diff --git a/docs/images/auth/firstuse/delete-user.png b/docs/images/auth/firstuse/delete-user.png new file mode 100644 index 0000000..9d60279 Binary files /dev/null and b/docs/images/auth/firstuse/delete-user.png differ diff --git a/tljh/installer.py b/tljh/installer.py index 185389f..1a6de3a 100644 --- a/tljh/installer.py +++ b/tljh/installer.py @@ -182,7 +182,7 @@ def ensure_jupyterhub_package(prefix): 'jupyterhub==0.9.2', 'jupyterhub-dummyauthenticator==0.3.1', 'jupyterhub-systemdspawner==0.11', - 'jupyterhub-firstuseauthenticator==0.10', + 'jupyterhub-firstuseauthenticator==0.11', 'jupyterhub-ldapauthenticator==1.2.2', 'oauthenticator==0.8.0', ])