docs/installation/index.md
:material-clock-fast:{ .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!
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:
| Dependency | Supported Versions |
|---|---|
| Python | 3.12, 3.13, 3.14 |
| PostgreSQL | 14+ 1 |
| Redis | 4.0+ |
Below is a simplified overview of the NetBox application stack for reference:
flowchart TB
nginx["<span style='color:#fff'><b>nginx / Apache</b>
HTTP reverse proxy</span>"]:::red
gunicorn["<span style='color:#fff'><b>gunicorn</b>
WSGI HTTP server</span>"]:::orange
rqworker["<span style='color:#fff'><b>rqworker</b>
Background worker</span>"]:::pink
netbox["<span style='color:#fff'><b>NetBox</b>
Django application</span>"]:::blue
django["<span style='color:#fff'><b>Django</b>
Python application framework</span>"]:::green
storage["<span style='color:#fff'><b>Storage Driver</b>
Static asset storage</span>"]:::gray
postgres["<span style='color:#fff'><b>PostgreSQL</b>
Relational database</span>"]:::teal
redis["<span style='color:#fff'><b>Redis</b>
In-memory store</span>"]:::purple
nginx --> gunicorn
nginx --> storage
gunicorn --> netbox
rqworker --> netbox
netbox --> django
django --> postgres
django --> redis
classDef red fill:#b91c1c,stroke:#7f1d1d,color:#fff
classDef orange fill:#c2410c,stroke:#7c2d12,color:#fff
classDef pink fill:#a21caf,stroke:#701a75,color:#fff
classDef blue fill:#1d4ed8,stroke:#1e3a8a,color:#fff
classDef green fill:#15803d,stroke:#14532d,color:#fff
classDef gray fill:#4b5563,stroke:#1f2937,color:#fff
classDef teal fill:#0f766e,stroke:#134e4a,color:#fff
classDef purple fill:#6d28d9,stroke:#4c1d95,color:#fff
If you are upgrading from an existing installation, please consult the upgrading guide.
Support for PostgreSQL 14 is deprecated and will be removed in NetBox v4.7. PostgreSQL 15 or later will be required. ↩