zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move notebook interface switching to how-to guide

Browse Source
This commit is contained in:
yuvipanda
2018-07-10 16:03:05 -07:00
parent 8f30c774b0
commit 3c755af154
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/guides/notebook-interfaces.rst
View File

@@ -1,66 +0,0 @@
.. _notebook_interfaces:
==================================================
Notebook Interfaces (Classic, JupyterLab, nteract)
==================================================
By default, logging into TLJH puts you in the classic Jupyter Notebook interface
we all know and love. However, there are at least two other popular notebook
interfaces you can use:
1. `JupyterLab <http://jupyterlab.readthedocs.io/en/stable/>`_
2. `nteract <https://nteract.io/>`_
Both these interfaces are also shipped with tljh by default. You can try them
temporarily, or set them to be the default interface whenever you login.
Trying alternate interface tempoarily
=====================================
When you log in & start your server, by default the URL in your browser
will be something like ``/user/<username>/tree``. The ``/tree`` is what tells
the notebook server to give you the classic notebook interface.
* **For the JupyterLab interface**: change ``/tree`` to ``/lab``.
* **For the nteract interface**: change ``/tree`` to ``/nteract``
You can play around with them and see what fits your use cases best.
Changing the default user interface
===================================
You can change the default interface users get when they log in by modifying
``config.yaml`` as an admin user.
#. Open the ``config.yaml`` file.
.. code-block:: bash
sudo nano /opt/tljh/config.yaml
#. To launch **JupyterLab** when users log in, add the following snippet to the config
.. code-block:: yaml
userEnvironment:
defaultApp: jupyterlab
#. Alternatively, to launch **nteract** when users log in, add the following snippet to the config
.. code-block:: yaml
userEnvironment:
defaultApp: nteract
#. Save and exit the editor. With ``nano``, you can do this by pressing ``Ctrl-X``.
#. Apply the changes by restarting JupyterHub. This should not disrupt current users.
.. code-block:: yaml
sudo systemctl restart jupyterhub
If this causes problems, check the :ref:`troubleshoot_logs_jupyterhub` for clues
on what went wrong.
Users might have to restart their servers from control panel to get the new interface.