1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

56 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

2021-07-28 15:12:17 -04:00
![NetBox](netbox_logo.svg "NetBox logo"){style="height: 100px; margin-bottom: 3em"}
2018-07-27 13:42:18 -04:00
2023-09-20 14:44:04 -04:00
# The Premier Network Source of Truth
2016-05-24 12:38:06 -04:00
2022-08-12 13:39:07 -04:00
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. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure.
2016-07-08 12:07:04 -04:00
[![NetBox UI](./media/screenshots/home-light.png)](./media/screenshots/home-light.png)
2022-08-26 10:31:56 -04:00
2022-08-12 13:39:07 -04:00
## :material-server-network: Built for Networks
2016-07-08 12:07:04 -04:00
2022-08-12 13:39:07 -04:00
Unlike general-purpose CMDBs, NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of infrastructure design and documentation. These cover all facets of network technology, from IP address managements to cabling to overlays and more:
2022-08-12 13:39:07 -04:00
* Hierarchical regions, sites, and locations
2022-07-29 10:06:26 -04:00
* Racks, devices, and device components
* Cables and wireless connections
2022-08-12 13:39:07 -04:00
* Power distribution tracking
2022-07-29 10:06:26 -04:00
* 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
* L2VPN overlays
2022-08-12 13:39:07 -04:00
* Tenancy assignments
* Contact management
2022-08-12 13:39:07 -04:00
## :material-hammer-wrench: Customizable & Extensible
2022-08-12 13:39:07 -04:00
In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. Its powerful plugins architecture enables users to extend the application to meet their needs with minimal development effort.
2022-07-29 10:06:26 -04:00
* Custom fields
* Custom model validation
* Export templates
* Event rules
2022-07-29 10:06:26 -04:00
* Plugins
* REST & GraphQL APIs
2022-08-12 13:39:07 -04:00
## :material-lock-open: Always Open
2016-07-08 12:07:04 -04:00
2022-08-12 13:39:07 -04:00
Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-in. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input.
2020-03-03 10:52:56 -05:00
2022-08-12 13:39:07 -04:00
!!! tip "NetBox Development"
Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started!
## :material-language-python: Powered by Python
NetBox is built on the enormously popular [Django](http://www.djangoproject.com/) framework for the Python programming language, already a favorite among network engineers. Users can leverage their existing skills coding Python tools to extend NetBox's already vast functionality via custom scripts and plugins.
## :material-flag: Getting Started
2016-07-08 12:07:04 -04:00
2022-08-11 16:34:29 -04:00
* Try out our [public demo](https://demo.netbox.dev/) if you want to jump right in
* The [installation guide](./installation/index.md) will help you get your own deployment up and running
* Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch approach
2023-01-27 16:46:49 -05:00
* [NetBox Cloud](https://netboxlabs.com/netbox-cloud) is a managed solution offered by [NetBox Labs](https://netboxlabs.com/)