Docs
Installation & Upgrade

Installation

  • { .lg .middle } 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 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:

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

Requirements

DependencySupported Versions
Python3.12, 3.13, 3.14
PostgreSQL14+ 1
Redis5.0+ 2

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.

Footnotes

  1. Support for PostgreSQL 14 is deprecated and will be removed in NetBox v4.7. PostgreSQL 15 or later will be required. ↩

  2. Support for Redis versions older than 6.0 is deprecated and will be removed in NetBox v4.7. Redis 6.0 or later will be required. ↩

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...

On this page

RequirementsUpgradingFootnotes