Nebari how-to's

Phase out notice

Nebari is evolving. The original Nebari project is now called Nebari Classic, and is in maintenance mode.

We'll continue to provide security updates and key bug fixes; however, no new features are planned at this time. We're using the lessons learned from Nebari Classic to build a new Nebari ecosystem of tools, on a more robust foundation with a modular architecture. Nebari Classic's maintenance window will remain open until the new architecture reaches stability and feature parity, and current users are able to migrate, expected through the end of 2026.

See the current Nebari documentation for details on the new platform.

Practical step-by-step guides to help you achieve a specific goal. Most useful when you're trying to get something done.

Deploy Nebari on GCPA basic overview of how to deploy Nebari on GCP.

Deploy Nebari on AWSA basic overview of how to deploy Nebari on AWS

Deploy Nebari on AzureA basic overview of how to deploy Nebari on Azure

How to deploy Nebari on pre-existing infrastructureDeploying Nebari on an existing Kubernetes infrastructure

Deploy Nebari on local machines (for testing)Deploying Nebari on a local development environment with kind

Nebari Stages DirectoryPurpose and Usage of the "stages" Directory

Setup Deployment EnvironmentBest Practices for Managing Your Python Environment

Destroy your Nebari deploymenthow to destroy your Nebari deployment and associated resources

Setup Nebari domain registrySetting a custom DNS Domain Registry

Debug Nebari deploymentDebug your Nebari deployment

Configure KeycloakHow to configure Keycloak, add new users, add new groups and update roles.

Configure Outgoing SMTP in KeycloakSet up your Nebari instance to send emails

Using Visual Studio (VS) Code

Create a manual backupPerform a manual backup of a Nebari instance

Upgrade NebariAn overview of how to upgrade Nebari. Includes instructions on updating when breaking changes are expected to occur.

Upgrade cluster's Kubernetes versionA basic overview on how to upgrade your cluster Kubernetes version

Set up Argo workflowsArgo Workflow Setup

Automate your first workflow with ArgoArgo workflow management

JHub App Launcher with NebariUsing JHub App Launcher with Nebari

Update JupyterHub idle-culling settingsHow to update JupyterHub idle-culling settings

Nebari Extension SystemAn overview of the pluggy extension system for Nebari

Telemetry

How to Set Up Monitoring on Nebari

Set up healthchecks with KuberhealthySet up healthchecks with Kuberhealthy

Access system logs (Loki) via GrafanaAccess common system logs on Nebari

Use GPUs on NebariOverview of using GPUs on Nebari including server setup, environment setup, and validation.

Develop Local Packages on NebariHow to install a dev package from a local project

Install pip packagesHow to install pip packages on Nebari

Creating and Managing Groups, Roles, and DirectoriesHow to configure Keycloak's permissions, groups and roles, and manage group directories in JupyterHub.

Connect to Nebari's JupyterLab via SSH or SFTPSet up a remote SSH connection using jupyter-ssh

Share Git Repository via JupyterLab-GalleryShare files or tutorials with your team