2016-08-09 14:57:14 -04:00
|
|
|
|
2016-06-27 16:48:54 -04:00
|
|
|
|
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
|
|
|
|
|
to address the needs of network and infrastructure engineers.
|
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
|
|
|
|
|
complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/digitalocean/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
|
|
|
|
|
|
2018-07-02 16:33:18 -04:00
|
|
|
NetBox is built against both Python 2.7 and 3.5. Python 3.5 or higher is strongly recommended.
|
2017-05-02 20:39:43 -04:00
|
|
|
|
|
|
|
|
| | status |
|
2016-06-27 19:55:17 -04:00
|
|
|
|-------------|------------|
|
|
|
|
|
| **master** | [](https://travis-ci.org/digitalocean/netbox) |
|
|
|
|
|
| **develop** | [](https://travis-ci.org/digitalocean/netbox) |
|
|
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
2016-07-08 12:07:04 -04:00
|
|
|
|
2016-06-27 11:43:33 -04:00
|
|
|
|
2016-07-08 12:07:04 -04:00
|
|
|
|
2016-06-27 11:43:33 -04:00
|
|
|
|
2016-07-08 12:07:04 -04:00
|
|
|
|
2016-06-27 11:43:33 -04:00
|
|
|
|
2016-06-17 16:17:55 -04:00
|
|
|
# Installation
|
|
|
|
|
|
2018-02-01 16:52:24 -05:00
|
|
|
Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for
|
|
|
|
|
instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/digitalocean/netbox/releases)
|
|
|
|
|
and run `upgrade.sh`.
|
2016-03-01 11:23:03 -05:00
|
|
|
|
2017-01-04 17:16:04 -05:00
|
|
|
## Alternative Installations
|
|
|
|
|
|
2017-10-13 11:50:06 -04:00
|
|
|
* [Docker container](https://github.com/ninech/netbox-docker) (via [@cimnine](https://github.com/cimnine))
|
|
|
|
|
* [Vagrant deployment](https://github.com/ryanmerolle/netbox-vagrant) (via [@ryanmerolle](https://github.com/ryanmerolle))
|
2018-02-22 05:56:33 +09:00
|
|
|
* [Ansible deployment](https://github.com/lae/ansible-role-netbox) (via [@lae](https://github.com/lae))
|
2018-09-10 13:30:22 +02:00
|
|
|
|
|
|
|
|
# Related projects
|
|
|
|
|
|
|
|
|
|
## Supported SDK
|
|
|
|
|
|
|
|
|
|
- [pynetbox](https://github.com/digitalocean/pynetbox) Python API client library for Netbox.
|
|
|
|
|
|
|
|
|
|
## Community SDK
|
|
|
|
|
|
|
|
|
|
- [netbox-client-ruby](https://github.com/ninech/netbox-client-ruby) A ruby client library for Netbox v2.
|
|
|
|
|
|
|
|
|
|
## Ansible Inventory
|
|
|
|
|
|
|
|
|
|
- [netbox-as-ansible-inventory](https://github.com/AAbouZaid/netbox-as-ansible-inventory) Ansible dynamic inventory script for Netbox.
|
|
|
|
|
|
