@jupyterlab/hub-extension

jupyterlab-hub

JupyterLab integration for JupyterHub.

This adds a "Hub" menu to JupyterLab that allows a user to log out of JupyterHub or access their JupyterHub control panel. This follows the JupyterLab extension system where an extension is just an npm package, not wrapped in a Python package.

Prerequisites

• JupyterLab.
• A properly configured JupyterHub.

Installation

Notebook

To install this extension into JupyterLab, do the following:

jupyter labextension install @jupyterlab/hub-extension

JupyterHub

For single-user images based off jupyter/base-notebook, you may enable Jupyter-Lab with JUPYTER_ENABLE_LAB in jupyterhub_config.py:

c.Spawner.environment = { 'JUPYTER_ENABLE_LAB': 'yes' }

For other images, have your single-user servers using the following entry command:

jupyter labhub

This can be achieved by the Spawner configuration:

c.Spawner.cmd = ['jupyter-labhub']

Note: Additional information may be found in the Zero to JupyterHub Guide for Kubernetes

If Jupyterhub is served under a subdirectory (for instance /jupyter), you will need to pass this information to JupyterLab via page_config.json. In an Anaconda installation, this file should be created at /path/to/anaconda/share/jupyter/lab/settings/page_config.json. Example contents:

{
    "hub_prefix": "/jupyter"
}

Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

npm install
jupyter labextension link .

To rebuild the package and the JupyterLab app after making changes:

npm run build
jupyter lab build