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!
The installation instructions provided here have been tested to work on Ubuntu 24.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:
- PostgreSQL database
- Redis
- Install the NetBox application using either:
- a release archive or Git checkout; or
- the Python package (experimental)
- Gunicorn or uWSGI
- HTTP server
- LDAP authentication (optional)
Experimental Python package installation
Installing NetBox from the Python package is experimental in NetBox v4.7 and is not recommended for production use. It is intended for evaluation and feedback. The release archive and Git workflows remain supported and are the established installation methods.
Requirements
| Dependency | Supported Versions |
|---|---|
| Python | 3.12, 3.13, 3.14 |
| PostgreSQL | 15+ |
| Redis | 6.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.
Customization
While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit...
PostgreSQL Database Installation
This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t...