Mascali
/
netbox
mirror of https://github.com/netbox-community/netbox.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The premier source of truth powering network automation. Open source under Apache 2. Public demo: https://demo.netbox.dev
8,869 Commits 16 Branches 298 Tags 135 MiB
Python 94.1%
HTML 4.8%
TypeScript 0.9%
SCSS 0.1%
Go to file
jeremystretch 7b0dff88ae Closes #8210: Establish netbox/local/ as a path for local resources 2022-01-03 09:45:30 -05:00
.github Release NetBox v3.1.3 2021-12-29 12:10:46 -05:00
contrib Merge v2.11.10 2021-07-28 16:26:04 -04:00
docs Closes #8210: Establish netbox/local/ as a path for local resources 2022-01-03 09:45:30 -05:00
netbox Fixes #8200: Correct typo in navigation menu 2022-01-03 09:20:26 -05:00
scripts Allow bypassing the pre-commit script with NOVALIDATE=1 2021-11-05 13:40:38 -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
CHANGELOG.md Reorganized CHANGELOG into release notes based on minor version number 2019-10-09 13:54:05 -04:00
CONTRIBUTING.md Issues policy tweaks 2021-11-05 13:26:18 -04:00
LICENSE.txt Initial push to public repo 2016-03-01 11:23:03 -05:00
NOTICE Create NOTICE file 2019-06-25 13:59:00 -04:00
README.md Add features summary to README 2021-12-30 10:08:31 -05:00
base_requirements.txt Release v3.1.1 2021-12-13 08:51:55 -05:00
mkdocs.yml Move remote authentication config parameters to a separate page 2021-11-04 15:41:46 -04:00
requirements.txt Release NetBox v3.1.3 2021-12-29 12:10:46 -05:00
upgrade.sh Closes #7319: Remove migrations check from upgrade.sh to avoid misleading error messages 2021-10-01 08:57:17 -04:00

README.md

NetBox logo

Master branch build status

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, 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 Python framework with a PostgreSQL database. For a complete list of requirements, see requirements.txt. The code is available on GitHub.

The complete documentation for NetBox can be found at Read the Docs. A public demo instance is available at https://demo.netbox.dev.

Thank you to our sponsors!

DigitalOcean            Equinix Metal            NS1
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
  • Google Group - Legacy mailing list; slowly being replaced by GitHub discussions

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 (light mode)

Screenshot of main page (dark mode)

Screenshot of rack elevation

Screenshot of prefixes hierarchy

Screenshot of cable trace

Related projects

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