Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify setting up JupyterLab as default #1690

Merged
merged 1 commit into from
Jun 9, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions doc/source/customizing/user-environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,27 +92,21 @@ user interface for Jupyter about to replace the classic user interface (UI).
While users already can interchange ``/tree`` and ``/lab`` in the URL to switch between
the classic UI and JupyterLab, they will default to use the classic UI.

To let users use JupyterLab by default, add the following entries to your
:term:`config.yaml`:
The classic Jupyter Notebook UI is the default provided, but you can change it to
JupyterLab with the following config in your :term:`config.yaml`:

.. code-block:: yaml

singleuser:
defaultUrl: "/lab"

hub:
extraConfig:
jupyterlab: |
c.Spawner.cmd = ['jupyter-labhub']

.. note::

You need the `jupyterlab <https://github.com/jupyterlab/jupyterlab>`_
package (installable via ``pip`` or ``conda``) for this to work.
All images in the `jupyter/docker-stacks repository
<https://github.com/jupyter/docker-stacks/>`_ come pre-installed with
JupyterLab and the `JupyterLab-Hub extension
<https://github.com/jupyterhub/jupyterlab-hub>`_ required for this
configuration to work.

it.


.. _custom-docker-image:
Expand Down