NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-18 05:28:16 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Add intro docs link

Browse Source
This commit is contained in:
Jeremy Stretch 2024-01-10 10:48:06 -05:00
parent 13edee5133
commit 20e2d50437
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -12,12 +12,8 @@
NetBox exists to empower network engineers. Since its release in 2016, it has become the go-to solution for modeling and documenting network infrastructure for thousands of organizations worldwide. As a successor to legacy IPAM and DCIM applications, NetBox provides a cohesive, extensive, and accessible data model for all things networked. By providing a single robust user interface and programmable APIs for everything from cable maps to device configurations, NetBox serves as the central source of truth for the modern network. NetBox exists to empower network engineers. Since its release in 2016, it has become the go-to solution for modeling and documenting network infrastructure for thousands of organizations worldwide. As a successor to legacy IPAM and DCIM applications, NetBox provides a cohesive, extensive, and accessible data model for all things networked. By providing a single robust user interface and programmable APIs for everything from cable maps to device configurations, NetBox serves as the central source of truth for the modern network.
<div align="center">
<img src="docs/media/screenshots/netbox-ui.png" width="600" alt="NetBox user interface screenshot" />
<p></p>
</div>
<p align="center"> <p align="center">
<a href="#netboxs-role">NetBox's Role</a> |
<a href="#why-netbox">Why NetBox?</a> | <a href="#why-netbox">Why NetBox?</a> |
<a href="#getting-started">Getting Started</a> | <a href="#getting-started">Getting Started</a> |
<a href="#get-involved">Get Involved</a> | <a href="#get-involved">Get Involved</a> |
@ -25,7 +21,12 @@ NetBox exists to empower network engineers. Since its release in 2016, it has be
<a href="#screenshots">Screenshots</a> <a href="#screenshots">Screenshots</a>
</p> </p>
## Where Does NetBox Fit In? <div align="center">
<img src="docs/media/screenshots/netbox-ui.png" width="600" alt="NetBox user interface screenshot" />
<p></p>
</div>
## NetBox's Role
<p align="center"> <p align="center">
<img src="docs/media/misc/reference_architecture.png" alt="Reference network automation architecture" /> <img src="docs/media/misc/reference_architecture.png" alt="Reference network automation architecture" />
@ -71,15 +72,18 @@ Users can define event rules to automatically trigger a custom script or outboun
NetBox automatically logs the creation, modification, and deletion of all managed objects, providing a thorough change history. Changes can be attributed to the executing user, and related changes are grouped automatically by request ID. NetBox automatically logs the creation, modification, and deletion of all managed objects, providing a thorough change history. Changes can be attributed to the executing user, and related changes are grouped automatically by request ID.
## Getting Started > [!INFO]
> A complete list of NetBox's myriad features can be found in [the introductory documentation](https://docs.netbox.dev/en/stable/introduction/).
> [!TIP] ## Getting Started
> Are you looking for an enterprise solution? Check out **[NetBox Cloud](https://netboxlabs.com/netbox-cloud/)**!
* Just want to explore? Check out [our public demo](https://demo.netbox.dev/) right now! * 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. * 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! * Check out [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions) for even more projects to get the most out of NetBox!
> [!TIP]
> Are you looking for an enterprise solution? Check out **[NetBox Cloud](https://netboxlabs.com/netbox-cloud/)**!
## Get Involved ## Get Involved
* Follow [@NetBoxOfficial](https://twitter.com/NetBoxOfficial) on Twitter! * Follow [@NetBoxOfficial](https://twitter.com/NetBoxOfficial) on Twitter!