Administrator Guide for configuring Notebooks Hub

Default Quick Launch templates on fresh install

On API startup, Notebooks Hub can automatically seed default Quick Launch templates (JupyterLab, RStudio, and VSCode) for the first configured hub admin in HUB_ADMIN_EMAILS.

Setting	Purpose
`SEED_DEFAULT_QUICKLAUNCH=true`	Enable automatic seeding (default)
`SEED_DEFAULT_QUICKLAUNCH=false`	Disable automatic seeding
`DEFAULT_QUICKLAUNCH_TEMPLATES_PATH`	Optional path to a custom JSON template list
`DEFAULT_QUICKLAUNCH_HARDWARE`	Optional hardware override for seeded templates

Bundled defaults live in packages/API/config/default-quicklaunch-templates.json and omit hardware so each deployment uses DEFAULT_QUICKLAUNCH_HARDWARE, API_DEFAULT_HARDWARE_OPTION, or the first entry in HARDWARE_OPTION_NAMES. Seeding is idempotent: restarting the API does not create duplicate templates.

Adding Launchers and Examples

To populate Launcher and Examples tab, the Administator needs to make POST API calls to /templates

Below are examples of the JSON body for each type of template.

Launchers

{
    "name": "JupyterLab",
    "description": "JupyterLab Launcher",
    "type": "quicklaunch",
    "applicationType": "jupyterlab",
    "modules": [
        "python-data-science/0.1.8"
    ],
    "hardware": "cpuMedium",
    "creator": "admin@org.com",
    "public": false
}

{
    "name": "RStudio",
    "description": "RStudio Launcher",
    "type": "quicklaunch",
    "applicationType": "rstudio",
    "modules": [
        "R/0.1.1"
    ],
    "hardware": "cpuMedium",
    "creator": "admin@org.com",
    "public": false
}

{
	"name": "VSCode",
	"type": "quicklaunch",
	"description": "VSCode Launcher",
	"applicationType": "vscode",
	"modules": [
        "python-data-science/0.1.8"
    ],
	"hardware": "cpuMedium",
	"creator": "admin@org.com",
	"public": false
}

Examples

{{
    "name": "Stable Diffusion",
    "description": "Stable Diffusion is a deep learning, text-to-image model used to generate detailed images conditioned on text descriptions. This dashboard provides simple UI for Stable Diffusion",
    "type": "featured",
    "applicationType": "voila",
    "modules": ["python-data-science/0.1.8"],
    "hardware": "dedicatedGpuLarge",
    "creator": "admin@org.com",
    "public": false,
    "filePath": "shared/notebooks/stable_diffusion/StableDiffusion.ipynb"
}