2021-05-06 16:37:47 -04:00
< div align = "center" >
< img src = "https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width = "400" alt = "NetBox logo" / >
< / div >
2016-06-27 16:48:54 -04:00
2021-06-14 14:08:55 -04:00
NetBox is an infrastructure resource modeling (IRM) tool designed to empower
network automation. Initially conceived by the network engineering team at
2018-02-01 16:52:24 -05:00
[DigitalOcean ](https://www.digitalocean.com/ ), NetBox was developed specifically
2019-10-17 20:56:37 -04:00
to address the needs of network and infrastructure engineers. It is intended to
function as a domain-specific source of truth for network operations.
2016-03-01 11:23:03 -05:00
2018-02-01 16:52:24 -05:00
NetBox runs as a web application atop the [Django ](https://www.djangoproject.com/ )
2020-12-21 18:02:30 +01:00
Python framework with a [PostgreSQL ](https://www.postgresql.org/ ) database. For a
2019-07-09 11:36:39 -04:00
complete list of requirements, see `requirements.txt` . The code is available [on GitHub ](https://github.com/netbox-community/netbox ).
2016-06-17 16:17:55 -04:00
2021-04-29 13:45:44 -04:00
The complete documentation for NetBox can be found at [Read the Docs ](https://netbox.readthedocs.io/en/stable/ ). A public demo instance is available at https://demo.netbox.dev.
2016-07-13 06:04:29 +10:00
2021-05-06 16:37:47 -04:00
< div align = "center" >
< h4 > Thank you to our sponsors!< / h4 >
2016-06-27 11:43:33 -04:00
2021-05-20 12:41:23 -04:00
[](https://try.digitalocean.com/developer-cloud)
2021-06-15 15:22:20 -04:00
[](https://metal.equinix.com/)
2021-05-06 16:37:47 -04:00
2021-06-15 15:22:20 -04:00
[](https://ns1.com/)
< br / >
2021-05-06 16:37:47 -04:00
[](https://stellar.tech/)
2020-02-24 15:22:33 +00:00
2021-05-06 16:37:47 -04:00
< / div >
2016-06-27 11:43:33 -04:00
2021-05-06 16:37:47 -04:00
### Discussion
2020-02-24 15:22:33 +00:00
2021-05-06 16:37:47 -04:00
* [GitHub Discussions ](https://github.com/netbox-community/netbox/discussions ) - Discussion forum hosted by GitHub; ideal for Q& A and other structured discussions
2021-06-14 16:41:10 -04:00
* [Slack ](https://netdev.chat/ ) - Real-time chat hosted by the NetDev Community; best for unstructured discussion or just hanging out
2021-05-06 16:37:47 -04:00
* [Google Group ](https://groups.google.com/g/netbox-discuss ) - Legacy mailing list; slowly being replaced by GitHub discussions
2016-06-27 11:43:33 -04:00
2021-05-06 16:37:47 -04:00
### Installation
2016-06-17 16:17:55 -04:00
2020-12-21 18:02:30 +01:00
Please see [the documentation ](https://netbox.readthedocs.io/en/stable/ ) for
2020-12-10 15:59:42 -05:00
instructions on installing NetBox. To upgrade NetBox, please download the
[latest release ](https://github.com/netbox-community/netbox/releases ) and
run `upgrade.sh` .
2016-03-01 11:23:03 -05:00
2021-05-06 16:37:47 -04:00
### Providing Feedback
2019-10-17 20:56:37 -04:00
2020-12-10 15:59:42 -05:00
The best platform for general feedback, assistance, and other discussion is our
[GitHub discussions ](https://github.com/netbox-community/netbox/discussions ).
To report a bug or request a specific feature, please open a GitHub issue using
the [appropriate template ](https://github.com/netbox-community/netbox/issues/new/choose ).
2019-10-17 20:56:37 -04:00
If you are interested in contributing to the development of NetBox, please read
our [contributing guide ](CONTRIBUTING.md ) prior to beginning any work.
2021-05-06 16:37:47 -04:00
### Screenshots
### Related projects
2018-09-10 13:30:22 +02:00
2020-12-10 15:59:42 -05:00
Please see [our wiki ](https://github.com/netbox-community/netbox/wiki/Community-Contributions )
for a list of relevant community projects.
