The premier source of truth powering network automation. Open source under Apache 2. Public demo: https://demo.netbox.dev
Go to file
jeremystretch 6a793087b4 Reference GitHub advisory reporting 2023-01-23 10:23:49 -05:00
.github Release v3.4.3 2023-01-20 13:10:21 -05:00
contrib NetBox should always be referred to as NetBox [DATALAD RUNCMD] 2023-01-05 16:06:00 -05:00
docs Changelog for #11487 2023-01-23 10:21:11 -05:00
netbox 11487 remove set null from read-only custom fields bulk edit (#11552) 2023-01-23 08:48:14 -05:00
scripts 10310 pre commit yarn (#10315) 2022-09-12 09:16:17 -04:00
.gitattributes Treat compiled JS/CSS as binary when diffing 2021-09-16 11:03:55 -04:00
.gitignore Closes #8210: Establish netbox/local/ as a path for local resources 2022-01-03 09:45:30 -05:00
.readthedocs.yaml Create custom RTD configuration 2022-02-11 14:49:45 -05:00
CHANGELOG.md Closes #9218: Update documentation links with docs.netbox.dev 2022-04-25 09:48:39 -04:00
CONTRIBUTING.md Add items to contributing guide 2023-01-10 15:47:33 -05:00
LICENSE.txt Initial push to public repo 2016-03-01 11:23:03 -05:00
NOTICE Update NOTICE file 2022-07-01 11:36:34 -04:00
README.md NetBox should always be referred to as NetBox [DATALAD RUNCMD] 2023-01-05 16:06:00 -05:00
SECURITY.md Reference GitHub advisory reporting 2023-01-23 10:23:49 -05:00
base_requirements.txt Release v3.4.0 2022-12-14 13:10:22 -05:00
mkdocs.yml Update features docs for v3.4 2022-11-16 09:11:03 -05:00
pyproject.toml Add [tool.pyright] to pyproject.toml 2022-09-21 15:19:40 -04:00
requirements.txt Correct pinned sentry-sdk version 2023-01-20 13:53:28 -05:00
upgrade.sh Clear the cache when running the upgrade script 2022-04-29 09:19:37 +02:00

README.md

NetBox logo

NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Available as open source software under the Apache 2.0 license, NetBox is employed by thousands of organizations around the world.

Master branch build status

Timeline graph Issue status graph Pull request status graph Top contributors
Stats via Repography

About NetBox

Screenshot of NetBox UI

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
  • L2VPN and overlays
  • 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.

The complete documentation for NetBox can be found at docs.netbox.dev. A public demo instance is available at demo.netbox.dev.

NetBox runs as a web application atop the Django Python framework with a PostgreSQL database. For a complete list of requirements, see requirements.txt. The code is available on GitHub.

Thank you to our sponsors!

DigitalOcean            Equinix Metal            NS1
Sentry            Stellar Technologies

Discussion

  • GitHub Discussions - Discussion forum hosted by GitHub; ideal for Q&A and other structured discussions
  • Slack - Real-time chat hosted by the NetDev Community; best for unstructured discussion or just hanging out

Installation

Please see the documentation for instructions on installing NetBox. To upgrade NetBox, please download the latest release and run upgrade.sh.

Providing Feedback

The best platform for general feedback, assistance, and other discussion is our GitHub discussions. To report a bug or request a specific feature, please open a GitHub issue using the appropriate template.

If you are interested in contributing to the development of NetBox, please read our contributing guide prior to beginning any work.

Screenshots

Screenshot of main page (dark mode)

Screenshot of rack elevation

Screenshot of prefixes hierarchy

Screenshot of cable trace

Please see our wiki for a list of relevant community projects.