.. _jupyterlab:

JupyterLab on JupyterHub
------------------------

JupyterLab works out of the box with JupyterHub, and can even run side by side
with the classic Notebook.

When JupyterLab is deployed with JupyterHub it will show additional menu
items in the File menu that allow the user to log out or go to the JupyterHub
control panel.

Use JupyterLab by Default
~~~~~~~~~~~~~~~~~~~~~~~~~

If you install JupyterLab on a system running JupyterHub, it will immediately be
available at the ``/lab`` URL, but users will still be directed to the classic
Notebook (``/tree``) by default. To change the user's default user interface to
JupyterLab, set the following configuration option in your
:file:`jupyterhub_config.py` file::

    c.Spawner.default_url = '/lab'

In this configuration, users can still access the classic Notebook at ``/tree``,
by either typing that URL into the browser, or by using the "Launch Classic
Notebook" item in JupyterLab's Help menu.


Example Configuration
~~~~~~~~~~~~~~~~~~~~~

For a fully-configured example of using JupyterLab with JupyterHub, see
the `jupyterhub-deploy-teaching
<https://github.com/jupyterhub/jupyterhub-deploy-teaching>`__ repository.

.. _jupyterlab:

JupyterLab on JupyterHub
------------------------

JupyterLab works out of the box with JupyterHub, and can even run side by side
with the classic Notebook.

When JupyterLab is deployed with JupyterHub it will show additional menu
items in the File menu that allow the user to log out or go to the JupyterHub
control panel.

Use JupyterLab by Default
~~~~~~~~~~~~~~~~~~~~~~~~~

If you install JupyterLab on a system running JupyterHub, it will immediately be
available at the ``/lab`` URL, but users will still be directed to the classic
Notebook (``/tree``) by default. To change the user's default user interface to
JupyterLab, set the following configuration option in your
:file:`jupyterhub_config.py` file::

    c.Spawner.default_url = '/lab'

In this configuration, users can still access the classic Notebook at ``/tree``,
by either typing that URL into the browser, or by using the "Launch Classic
Notebook" item in JupyterLab's Help menu.

For this to work, you will need to enable the jupyterlab server 
extension with ``jupyter serverextension enable jupyterlab``.

Example Configuration
~~~~~~~~~~~~~~~~~~~~~

For a fully-configured example of using JupyterLab with JupyterHub, see
the `jupyterhub-deploy-teaching
<https://github.com/jupyterhub/jupyterhub-deploy-teaching>`__ repository.

Document the need to enable jupyterlab extension for JupyterHub
Document the need to enable jupyterlab extension for JupyterHub
