diff --git a/README.md b/README.md index 60f007946..93e125079 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,14 @@ ![Master branch build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master) -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](https://www.digitalocean.com/), 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. +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. + +![Screenshot of Netbox UI](docs/media/screenshots/netbox-ui.png "NetBox UI") Myriad infrastructure components can be modeled in NetBox, including: @@ -21,6 +23,7 @@ Myriad infrastructure components can be modeled in NetBox, including: * 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 @@ -45,11 +48,13 @@ customized and extended through the use of: 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](https://docs.netbox.dev/). +A public demo instance is available at [demo.netbox.dev](https://demo.netbox.dev). + NetBox runs as a web application atop the [Django](https://www.djangoproject.com/) Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a -complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox). - -The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/). A public demo instance is available at https://demo.netbox.dev. +complete list of requirements, see `requirements.txt`. The code is available +[on GitHub](https://github.com/netbox-community/netbox).

Thank you to our sponsors!

@@ -90,8 +95,6 @@ our [contributing guide](CONTRIBUTING.md) prior to beginning any work. ### Screenshots -![Screenshot of main page (light mode)](docs/media/screenshots/home-light.png "Main page (light mode)") - ![Screenshot of main page (dark mode)](docs/media/screenshots/home-dark.png "Main page (dark mode)") ![Screenshot of rack elevation](docs/media/screenshots/rack.png "Rack elevation") diff --git a/docs/index.md b/docs/index.md index c233dedb7..d61465443 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,8 @@ 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. +[![NetBox UI](./media/screenshots/netbox-ui.png)](./media/screenshots/netbox-ui.png) + ## :material-server-network: Built for Networks 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: diff --git a/docs/media/screenshots/home-dark.png b/docs/media/screenshots/home-dark.png index 796637ac5..f6290fa55 100644 Binary files a/docs/media/screenshots/home-dark.png and b/docs/media/screenshots/home-dark.png differ diff --git a/docs/media/screenshots/home-light.png b/docs/media/screenshots/home-light.png deleted file mode 100644 index 78d54a7d2..000000000 Binary files a/docs/media/screenshots/home-light.png and /dev/null differ diff --git a/docs/media/screenshots/netbox-ui.png b/docs/media/screenshots/netbox-ui.png new file mode 100644 index 000000000..fb692558f Binary files /dev/null and b/docs/media/screenshots/netbox-ui.png differ