Skip to main content

Installing Nebari

This installation guide provides the basic instructions to install and deploy Nebari for the first time, and assumes you are already familiar with the Conda and Python packaging ecosystems.

If you are already familiar with Nebari and would like information on advanced configuration options, feel free to skip to the advanced-settings section in this documentation.

ℹ️note

This guide focuses on installing Nebari for cloud usage.

For other alternatives, visit the Choosing a deployment platform section for an overview of the available options and their respective installation steps.

Pre-requisites​

Nebari heavily depends on Terraform and Python. The installation of the Terraform binary is built-in within the Nebari source code, and it is automatically downloaded during the first execution. Currently, only Linux and macOS are supported. Windows is only supported through the “Windows Subsystem for Linux” (see "WSL").

How to install Nebari​

There are currently two ways to install Nebari:

  1. You can install Nebari directly from the Python Package Index (PyPI) using pip. For most common architectures and platforms (Linux x86-64 and macOS x86-64), pip will download and install the most recent version available.

    python3 -m pip install qhub

  2. Nebari is also available at conda-forge and can be installed using the conda package manager by running the following command:

    conda install qhub -c conda-forge

    if you prefer mamba, you can use the following command:

    mamba install qhub

Verify installation​

You can verify that Nebari is properly installed, and you are able to execute the client commands by running the following command on your command line:

qhub --help

A representation of the output generated when Nebari help command argument is executed, the output contains a list of the available positional arguments and their use.

ℹ️Troubleshooting

If you are unable to successfully validate the Nebari installation above, you may want to check out our troubleshooting guide.

What's next?​

Need more information before deploying Nebari? Check out the following sections in the documentation:

Already made your mind about deployment? Check our handy how-to-guides: