2019-12-29 14:10:31 +00:00
![NetBox ](docs/netbox_logo.svg "NetBox logo" )
2016-06-27 16:48:54 -04:00
2020-03-05 08:51:03 -05:00
**The [2020 NetBox user survey ](https://docs.google.com/forms/d/1OVZuC4kQ-6kJbVf0bDB6vgkL9H96xF6phvYzby23elk/edit ) is open!** Your feedback helps guide the project's long-term development.
2018-02-01 16:52:24 -05:00
NetBox is an IP address management (IPAM) and data center infrastructure
management (DCIM) tool. Initially conceived by the network engineering team at
[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/ )
Python framework with a [PostgreSQL ](http://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
2017-01-04 17:16:04 -05:00
The complete documentation for NetBox can be found at [Read the Docs ](http://netbox.readthedocs.io/en/stable/ ).
2016-07-13 06:04:29 +10:00
2018-02-01 16:52:24 -05:00
Questions? Comments? Please subscribe to [the netbox-discuss mailing list ](https://groups.google.com/forum/#!forum/netbox-discuss ),
2018-03-14 10:30:55 -04:00
or join us in the #netbox Slack channel on [NetworkToCode ](https://networktocode.slack.com/ )!
2016-06-27 15:23:06 -04:00
2016-06-27 19:55:17 -04:00
### Build Status
2017-05-02 20:39:43 -04:00
| | status |
2016-06-27 19:55:17 -04:00
|-------------|------------|
2019-09-26 15:03:20 -04:00
| **master** | [![Build Status ](https://travis-ci.org/netbox-community/netbox.svg?branch=master )](https://travis-ci.com/netbox-community/netbox/) |
| **develop** | [![Build Status ](https://travis-ci.org/netbox-community/netbox.svg?branch=develop )](https://travis-ci.com/netbox-community/netbox/) |
2016-06-27 19:55:17 -04:00
2020-03-05 08:51:03 -05:00
### Screenshots
2016-06-27 19:55:17 -04:00
2016-07-08 12:07:04 -04:00
![Screenshot of main page ](docs/media/screenshot1.png "Main page" )
2016-06-27 11:43:33 -04:00
2020-02-24 15:22:33 +00:00
---
2016-07-08 12:07:04 -04:00
![Screenshot of rack elevation ](docs/media/screenshot2.png "Rack elevation" )
2016-06-27 11:43:33 -04:00
2020-02-24 15:22:33 +00:00
---
2016-07-08 12:07:04 -04:00
![Screenshot of prefix hierarchy ](docs/media/screenshot3.png "Prefix hierarchy" )
2016-06-27 11:43:33 -04:00
2020-03-05 08:51:03 -05:00
## Installation
2016-06-17 16:17:55 -04:00
2018-02-01 16:52:24 -05:00
Please see [the documentation ](http://netbox.readthedocs.io/en/stable/ ) for
2019-07-09 11:36:39 -04:00
instructions on installing NetBox. To upgrade NetBox, please download the [latest release ](https://github.com/netbox-community/netbox/releases )
2018-02-01 16:52:24 -05:00
and run `upgrade.sh` .
2016-03-01 11:23:03 -05:00
2020-03-05 08:51:03 -05:00
## Providing Feedback
2019-10-17 20:56:37 -04:00
Feature requests and bug reports must be submitted as GiHub issues. (Please be
sure to use the [appropriate template ](https://github.com/netbox-community/netbox/issues/new/choose ).)
For general discussion, please consider joining our [mailing list ](https://groups.google.com/forum/#!forum/netbox-discuss ).
If you are interested in contributing to the development of NetBox, please read
our [contributing guide ](CONTRIBUTING.md ) prior to beginning any work.
2020-03-05 08:51:03 -05:00
## Related projects
2018-09-10 13:30:22 +02:00
2019-09-10 15:30:19 -04:00
Please see [our wiki ](https://github.com/netbox-community/netbox/wiki/Community-Contributions ) for a list of relevant community projects.