mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
87 lines
6.3 KiB
Markdown
87 lines
6.3 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width="400" alt="NetBox logo" />
|
|
<p>The premier source of truth powering network automation</p>
|
|
<img src="https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master" alt="CI status" />
|
|
<p></p>
|
|
</div>
|
|
|
|
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 serves
|
|
as the cornerstone for network automation in thousands of organizations.
|
|
|
|
* **Physical infrastructure:** Accurately model the physical world, from global regions down to individual racks of gear. Then connect everything - network, console, and power!
|
|
* **Modern IPAM:** All the standard IPAM functionality you expect, plus VRF import/export tracking, VLAN management, and overlay support.
|
|
* **Data circuits:** Confidently manage the delivery of critical circuits from various service providers, modeled seamlessly alongside your own infrastructure.
|
|
* **Power tracking:** Map the distribution of power from upstream sources to individual feeds and outlets.
|
|
* **Organization:** Manage tenant and contact assignments natively.
|
|
* **Powerful search:** Easily find anything you need using a single global search function.
|
|
* **Comprehensive logging:** Leverage both automatic change logging and user-submitted journal entries to track your network's growth over time.
|
|
* **Endless customization:** Custom fields, custom links, tags, export templates, custom validation, reports, scripts, and more!
|
|
* **Flexible permissions:** An advanced permissions systems enables very flexible delegation of permissions.
|
|
* **Integrations:** Easily connect NetBox to your other tooling via its REST & GraphQL APIs.
|
|
* **Plugins:** Not finding what you need in the core application? Try one of many community plugins - or build your own!
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/netbox-community/netbox)
|
|
|
|
[](https://github.com/netbox-community/netbox-docker)
|
|
|
|
[](https://netboxlabs.com/netbox-cloud/)
|
|
|
|
</div>
|
|
|
|
* Just want to explore? Check out [our public demo](https://demo.netbox.dev/) right now!
|
|
* The [official documentation](https://docs.netbox.dev) offers a comprehensive introduction.
|
|
* Check out [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions) for even more projects to get the most out of NetBox!
|
|
|
|
## Get Involved
|
|
|
|
* Follow [@NetBoxOfficial](https://twitter.com/NetBoxOfficial) on Twitter!
|
|
* Join the conversation on [the discussion forum](https://github.com/netbox-community/netbox/discussions) and [Slack](https://netdev.chat/)!
|
|
* Already a power user? You can [suggest a feature](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+feature&template=feature_request.yaml) or [report a bug](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+bug&template=bug_report.yaml) on GitHub.
|
|
* Contributions from the community are encouraged and appreciated! Check out our [contributing guide](CONTRIBUTING.md) to get started.
|
|
|
|
## Project Stats
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/netbox-community/netbox/commits"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/whQtEr_TGD9PhW1BPlhlEQ5jnrgQ0KJpm-LlGtpoGO0/3Kx_iWUSBRJ5-AI4QwJEJWrUDEz3KrX2lvh8aYE0WXY_timeline.svg" alt="Timeline graph"></a>
|
|
<a href="https://github.com/netbox-community/netbox/issues"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/whQtEr_TGD9PhW1BPlhlEQ5jnrgQ0KJpm-LlGtpoGO0/3Kx_iWUSBRJ5-AI4QwJEJWrUDEz3KrX2lvh8aYE0WXY_issues.svg" alt="Issues graph"></a>
|
|
<a href="https://github.com/netbox-community/netbox/pulls"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/whQtEr_TGD9PhW1BPlhlEQ5jnrgQ0KJpm-LlGtpoGO0/3Kx_iWUSBRJ5-AI4QwJEJWrUDEz3KrX2lvh8aYE0WXY_prs.svg" alt="Pull requests graph"></a>
|
|
<a href="https://github.com/netbox-community/netbox/graphs/contributors"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/whQtEr_TGD9PhW1BPlhlEQ5jnrgQ0KJpm-LlGtpoGO0/3Kx_iWUSBRJ5-AI4QwJEJWrUDEz3KrX2lvh8aYE0WXY_users.svg" alt="Top contributors"></a>
|
|
<br />Stats via <a href="https://repography.com">Repography</a>
|
|
</div>
|
|
|
|
## Sponsors
|
|
|
|
<div align="center">
|
|
|
|
[](https://netboxlabs.com)
|
|
|
|
[](https://try.digitalocean.com/developer-cloud)
|
|
|
|
[](https://sentry.io)
|
|
<br />
|
|
[](https://metal.equinix.com)
|
|
|
|
[](https://onemindservices.com)
|
|
|
|
</div>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|