浏览代码

Initial work on JupyterHub+Lab docs.

Brian E. Granger 7 年之前
父节点
当前提交
9e49f226a5
共有 2 个文件被更改,包括 37 次插入0 次删除
  1. 1 0
      docs/source/index.rst
  2. 36 0
      docs/source/user/jupyterhub.rst

+ 1 - 0
docs/source/index.rst

@@ -29,6 +29,7 @@ JupyterLab Documentation
    user/documents_kernels
    user/file_formats
    user/extensions
+   user/jupyterhub
 
 .. toctree::
    :maxdepth: 1

+ 36 - 0
docs/source/user/jupyterhub.rst

@@ -0,0 +1,36 @@
+.. _jupyterlab:
+
+JupyterLab on JupyterHub
+------------------------
+
+JupyterLab works out of the box with JupyterHub, and can even run side-by-side
+with the classic Notebook. There are a couple of configuration options
+you may want to set.
+
+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 options in your
+:file:`jupyterlab_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.
+
+Additional integration between JupyterLab and JupyterHub is offered by the
+`jupyterlab-hub <https://github.com/jupyterhub/jupyterlab-hub>`__ extension for
+JupyterLab. It provides a Hub menu, with items to access the JupyterHub control
+panel or logout of the hub.
+
+To install the ``jupyterlab-hub`` extension, run::
+
+    jupyter labextension install @jupyterlab/hub-extension
+
+Further directions are provided on the `jupyterlab-hub GitHub repository
+<https://github.com/jupyterhub/jupyterlab-hub>`__.
+
+Finally, for a fully configured example of using JupyterLab with JupyterHub, see
+the `jupyterhub-deploy-teaching
+<https://github.com/jupyterhub/jupyterhub-deploy-teaching>`__ repository.