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, skip to the advanced-settings section in this documentation.
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.
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
macOS are supported.
Windows is only supported through the “Windows Subsystem for Linux” ("WSL").
- Currently, Nebari supports
Python >= 3.8
- For more details on Terraform and its dependencies, visit the official Terraform documentation
- To install conda, visit the official conda documentation, or if you prefer, visit the mamba installation documentation
How to install Nebari
There are currently two ways to install Nebari:
You can install Nebari directly from the Python Package Index (PyPI) using
pip. For most common architectures and platforms (
pipwill download and install the most recent version available.
python3 -m pip install nebari
Nebari is also available at conda-forge and can be installed using the
condapackage manager by running the following command:
conda install nebari -c conda-forge
if you prefer mamba, you can use the following command:
mamba install nebari
You can verify that the Nebari package is properly installed and you can execute the client commands by running:
If you are unable to successfully validate the Nebari installation above, you may want to check out our troubleshooting guide.
Nebari Init and Guided Init
Nebari Init creates and initializes your Nebari configuration. Guided init does the same but you can have a step-by-step experience while running it.
You can pass the
--help flag to the
init command to check all the arguments and options available for it.
nebari init --help
You can pass the
--guided-init flag to the
init command to interact with Guided Init Wizard.
Need more information before deploying Nebari? Check out the following sections in the documentation:
- To get more insights on the multiple deployment methods for Nebari - check out the Choosing a deployment platform guide
- To learn more about the currently supported public cloud providers - check out the Supported cloud providers guide
Already made your mind about deployment? Check our handy how-to-guides: