netbox-community-netbox/README.md

<div align="center">
  <img src="https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width="400" alt="NetBox logo" />
</div>

![Master branch build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master)

NetBox is an infrastructure resource modeling (IRM) tool designed to empower
network automation, used by thousands of organizations around the world.
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. It is intended to
function as a domain-specific source of truth for network operations.

Myriad infrastructure components can be modeled in NetBox, including:

* Hierarchical regions, site groups, sites, and locations
* Racks, devices, and device components
* Cables and wireless connections
* Power distribution
* Data circuits and providers
* Virtual machines and clusters
* IP prefixes, ranges, and addresses
* VRFs and route targets
* FHRP groups (VRRP, HSRP, etc.)
* AS numbers
* VLANs and scoped VLAN groups
* Organizational tenants and contacts

In addition to its extensive built-in models and functionality, NetBox can be
customized and extended through the use of:

* Custom fields
* Custom links
* Configuration contexts
* Custom model validation rules
* Reports
* Custom scripts
* Export templates
* Conditional webhooks
* Plugins
* Single sign-on (SSO) authentication
* NAPALM integration
* Detailed change logging

NetBox also features a complete REST API as well as a GraphQL API for easily
integrating with other tools and systems.

NetBox runs as a web application atop the [Django](https://www.djangoproject.com/)
Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a
complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox).

The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/). A public demo instance is available at https://demo.netbox.dev.

<div align="center">
  <h4>Thank you to our sponsors!</h4>

  [![DigitalOcean](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/digitalocean.png)](https://try.digitalocean.com/developer-cloud)
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  [![Equinix Metal](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/equinix.png)](https://metal.equinix.com/)
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  [![NS1](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/ns1.png)](https://ns1.com/)
  <br />
  [![Sentry](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/sentry.png)](https://sentry.io/)
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  [![Stellar Technologies](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/stellar.png)](https://stellar.tech/)

</div>

### Discussion

* [GitHub Discussions](https://github.com/netbox-community/netbox/discussions) - Discussion forum hosted by GitHub; ideal for Q&A and other structured discussions
* [Slack](https://netdev.chat/) - Real-time chat hosted by the NetDev Community; best for unstructured discussion or just hanging out

### Installation

Please see [the documentation](https://docs.netbox.dev/) for
instructions on installing NetBox. To upgrade NetBox, please download the
[latest release](https://github.com/netbox-community/netbox/releases) and
run `upgrade.sh`.

### Providing Feedback

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

If you are interested in contributing to the development of NetBox, please read
our [contributing guide](CONTRIBUTING.md) prior to beginning any work.

### Screenshots

![Screenshot of main page (light mode)](docs/media/screenshots/home-light.png "Main page (light mode)")

![Screenshot of main page (dark mode)](docs/media/screenshots/home-dark.png "Main page (dark mode)")

![Screenshot of rack elevation](docs/media/screenshots/rack.png "Rack elevation")

![Screenshot of prefixes hierarchy](docs/media/screenshots/prefixes-list.png "Prefixes hierarchy")

![Screenshot of cable trace](docs/media/screenshots/cable-trace.png "Cable tracing")

### Related projects

Please see [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions)
for a list of relevant community projects.
Add sponsors 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>`
Add Travis CI build 2016-06-27 16:48:54 -04:00
Adopt IRM terminology 2021-06-14 14:08:55 -04:00			`![Master branch build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master)`

			`NetBox is an infrastructure resource modeling (IRM) tool designed to empower`
Add features summary to README 2021-12-30 10:08:31 -05:00			`network automation, used by thousands of organizations around the world.`
			`Initially conceived by the network engineering team at`
Replaced IRC with Slack; formatting cleanup 2018-02-01 16:52:24 -05:00			`[DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically`
Minor improvements pertaining to CII best practices 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.`
Initial push to public repo 2016-03-01 11:23:03 -05:00
Add features summary to README 2021-12-30 10:08:31 -05:00			`Myriad infrastructure components can be modeled in NetBox, including:`

			`* Hierarchical regions, site groups, sites, and locations`
			`* Racks, devices, and device components`
			`* Cables and wireless connections`
			`* Power distribution`
			`* Data circuits and providers`
			`* Virtual machines and clusters`
			`* IP prefixes, ranges, and addresses`
			`* VRFs and route targets`
			`* FHRP groups (VRRP, HSRP, etc.)`
			`* AS numbers`
			`* VLANs and scoped VLAN groups`
			`* Organizational tenants and contacts`

			`In addition to its extensive built-in models and functionality, NetBox can be`
			`customized and extended through the use of:`

			`* Custom fields`
			`* Custom links`
			`* Configuration contexts`
			`* Custom model validation rules`
			`* Reports`
			`* Custom scripts`
			`* Export templates`
			`* Conditional webhooks`
			`* Plugins`
			`* Single sign-on (SSO) authentication`
			`* NAPALM integration`
			`* Detailed change logging`

			`NetBox also features a complete REST API as well as a GraphQL API for easily`
			`integrating with other tools and systems.`

Replaced IRC with Slack; formatting cleanup 2018-02-01 16:52:24 -05:00			`NetBox runs as a web application atop the [Django](https://www.djangoproject.com/)`
Use HTTPS URL schema everywhere (#5505) * Use HTTPS everywhere (mechanical edit using util from https-everywhere) ```Shell node ~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js . git checkout netbox/project-static/ ``` A few additional changes where reset manually before the commit. * Use HTTPS everywhere (mechanical edit using util from opening_hours.js) ```Shell make -f ~/src/opening-hours/opening_hours.js/Makefile qa-https-everywhere git checkout netbox/project-static/ git checkout netbox/*/tests ``` 2020-12-21 18:02:30 +01:00			`Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a`
Replacing references to digitalocean org s/(?<=:\/\/github.com\/)digitalocean(?=\/netbox)/netbox-community/g 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).
Tweaked README 2016-06-17 16:17:55 -04:00
Closes #9218: Update documentation links with docs.netbox.dev 2022-04-25 09:48:39 -04:00			`The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/). A public demo instance is available at https://demo.netbox.dev.`
Added a link to docs in readme.md Adding a direct link for easy access. I couldn't find a link anywhere except digging in through the docs/ directory. 2016-07-13 06:04:29 +10:00
Add sponsors 2021-05-06 16:37:47 -04:00			`<div align="center">`
			`<h4>Thank you to our sponsors!</h4>`
Add Travis build badges for both master and develop against python 2.7 2016-06-27 19:55:17 -04:00
Add DigitalOcean as sponsor 2021-05-20 12:41:23 -04:00			`[![DigitalOcean](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/digitalocean.png)](https://try.digitalocean.com/developer-cloud)`
			`          `
Add Equinix Metal as a sponsor 2021-06-15 15:22:20 -04:00			`[![Equinix Metal](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/equinix.png)](https://metal.equinix.com/)`
Add sponsors 2021-05-06 16:37:47 -04:00			`          `
Add Equinix Metal as a sponsor 2021-06-15 15:22:20 -04:00			`[![NS1](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/ns1.png)](https://ns1.com/)`
			`<br />`
Add Sentry as a sponsor 2022-05-11 16:44:26 -04:00			`[![Sentry](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/sentry.png)](https://sentry.io/)`
			`          `
Add sponsors 2021-05-06 16:37:47 -04:00			`[![Stellar Technologies](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/stellar.png)](https://stellar.tech/)`
Fixes #21: Added screenshots to README 2016-06-27 11:43:33 -04:00
Add sponsors 2021-05-06 16:37:47 -04:00			`</div>`
Added separators between screenshots 2020-02-24 15:22:33 +00:00
Add sponsors 2021-05-06 16:37:47 -04:00			`### Discussion`
update readme screenshots 2021-04-23 11:52:42 -07:00
Add sponsors 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`
Update NetDev Slack links 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`
Fixes #21: Added screenshots to README 2016-06-27 11:43:33 -04:00
Add sponsors 2021-05-06 16:37:47 -04:00			`### Installation`
Tweaked README 2016-06-17 16:17:55 -04:00
Closes #9218: Update documentation links with docs.netbox.dev 2022-04-25 09:48:39 -04:00			`Please see [the documentation](https://docs.netbox.dev/) for`
Encourage people to use GitHub discussions in place of the mailing list 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`.
Initial push to public repo 2016-03-01 11:23:03 -05:00
Add sponsors 2021-05-06 16:37:47 -04:00			`### Providing Feedback`
Minor improvements pertaining to CII best practices 2019-10-17 20:56:37 -04:00
Encourage people to use GitHub discussions in place of the mailing list 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).`
Minor improvements pertaining to CII best practices 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.`

Add sponsors 2021-05-06 16:37:47 -04:00			`### Screenshots`

Update UI screenshots 2021-08-30 10:52:11 -04:00			`![Screenshot of main page (light mode)](docs/media/screenshots/home-light.png "Main page (light mode)")`
Add sponsors 2021-05-06 16:37:47 -04:00
Update UI screenshots 2021-08-30 10:52:11 -04:00			`![Screenshot of main page (dark mode)](docs/media/screenshots/home-dark.png "Main page (dark mode)")`
Add sponsors 2021-05-06 16:37:47 -04:00
Update UI screenshots 2021-08-30 10:52:11 -04:00			`![Screenshot of rack elevation](docs/media/screenshots/rack.png "Rack elevation")`
Merge branch 'develop' into feature 2021-05-07 10:27:23 -04:00
Update UI screenshots 2021-08-30 10:52:11 -04:00			`![Screenshot of prefixes hierarchy](docs/media/screenshots/prefixes-list.png "Prefixes hierarchy")`

			`![Screenshot of cable trace](docs/media/screenshots/cable-trace.png "Cable tracing")`
Add sponsors 2021-05-06 16:37:47 -04:00
			`### Related projects`
Add a page related to community related projects 2018-09-10 13:30:22 +02:00
Encourage people to use GitHub discussions in place of the mailing list 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.`