From 5786dce3675c392b8791e297116699bbce244d1c Mon Sep 17 00:00:00 2001 From: GeorgianaElena Date: Tue, 6 Apr 2021 18:04:43 +0300 Subject: [PATCH] Document enabling the configurator --- docs/topic/index.rst | 1 + docs/topic/jupyterhub-configurator.rst | 28 ++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/topic/jupyterhub-configurator.rst diff --git a/docs/topic/index.rst b/docs/topic/index.rst index 6e5744f..d4366a7 100644 --- a/docs/topic/index.rst +++ b/docs/topic/index.rst @@ -17,3 +17,4 @@ Topic guides provide in-depth explanations of specific topics. authenticator-configuration escape-hatch idle-culler + jupyterhub-configurator diff --git a/docs/topic/jupyterhub-configurator.rst b/docs/topic/jupyterhub-configurator.rst new file mode 100644 index 0000000..642a996 --- /dev/null +++ b/docs/topic/jupyterhub-configurator.rst @@ -0,0 +1,28 @@ +.. _topic/jupyterhub-configurator: + +======================= +JupyterHub Configurator +======================= + +The `JupyterHub configurator `_ allows admins to change a subset of hub settings via a GUI. + +.. image:: ../images/jupyterhub-configurator.png + :alt: Changing the default JupyterHub interface + +Enabling the configurator +========================= + +Because the configurator is under continue development and it might change over time, it is disabled by default in TLJH. +If you want to experiment with it, it can be enabled using ``tljh-config``: + +.. code-block:: bash + + sudo tljh-config set services.configurator.enabled True + sudo tljh-config reload + +Accessing the Configurator +========================== + +After enabling the configurator using ``tljh-config``, the service will only be available to hub admins, from within the control panel. +The configurator can be accessed from under ``Services`` in the top navigation bar. It will ask to authenticate, so it knows the user is an admin. +Once done, the configurator interface will be available. \ No newline at end of file