Installation

• Eager to Get Started?

  ---

  Check out the NetBox Cloud Free Plan! Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Completely free!

  Sign Up

The installation instructions provided here have been tested to work on Ubuntu 22.04. The particular commands needed to install dependencies on other distributions may vary significantly. Unfortunately, this is outside the control of the NetBox maintainers. Please consult your distribution's documentation for assistance with any errors.

The following sections detail how to set up a new instance of NetBox:

1. PostgreSQL database
2. Redis
3. NetBox components
4. Gunicorn or uWSGI
5. HTTP server
6. LDAP authentication (optional)

Requirements

Dependency	Supported Versions
Python	3.10, 3.11, 3.12
PostgreSQL	14+
Redis	4.0+

Below is a simplified overview of the NetBox application stack for reference:

Upgrading

If you are upgrading from an existing installation, please consult the upgrading guide.