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

65 lines
3.0 KiB
Markdown
Raw Normal View History

Replace doc logo with svg
2019-12-29 14:10:31 +00:00
![NetBox](docs/netbox_logo.svg "NetBox logo")
Add Travis CI build
2016-06-27 16:48:54 -04:00
Replaced IRC with Slack; formatting cleanup
2018-02-01 16:52:24 -05:00
NetBox is an IP address management (IPAM) and data center infrastructure
management (DCIM) tool. Initially conceived by the network engineering team at
[DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically
Minor improvements pertaining to CII best practices
2019-10-17 20:56:37 -04:00
to address the needs of network and infrastructure engineers. It is intended to
function as a domain-specific source of truth for network operations.
Initial push to public repo
2016-03-01 11:23:03 -05:00
Replaced IRC with Slack; formatting cleanup
2018-02-01 16:52:24 -05:00
NetBox runs as a web application atop the [Django](https://www.djangoproject.com/)
Use HTTPS URL schema everywhere (#5505) * Use HTTPS everywhere (mechanical edit using util from https-everywhere) ```Shell node ~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js . git checkout netbox/project-static/ ``` A few additional changes where reset manually before the commit. * Use HTTPS everywhere (mechanical edit using util from opening_hours.js) ```Shell make -f ~/src/opening-hours/opening_hours.js/Makefile qa-https-everywhere git checkout netbox/project-static/ git checkout netbox/*/tests ```
2020-12-21 18:02:30 +01:00
Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a
Replacing references to digitalocean org s/(?<=:\/\/github.com\/)digitalocean(?=\/netbox)/netbox-community/g
2019-07-09 11:36:39 -04:00
complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox).
Tweaked README
2016-06-17 16:17:55 -04:00
Reference the demo instance in the README
2021-04-29 13:45:44 -04:00
The complete documentation for NetBox can be found at [Read the Docs](https://netbox.readthedocs.io/en/stable/). A public demo instance is available at https://demo.netbox.dev.
Added a link to docs in readme.md Adding a direct link for easy access. I couldn't find a link anywhere except digging in through the docs/ directory.
2016-07-13 06:04:29 +10:00
Update Slack links; start phasing out mailing list
2021-03-01 09:54:30 -05:00
### Discussion
* [GitHub Discussions](https://github.com/netbox-community/netbox/discussions) - Discussion forum hosted by GitHub; ideal for Q&A and other structured discussions
Update Slack links
2021-03-15 14:45:53 -04:00
* [Slack](https://slack.netbox.dev/) - Real-time chat hosted by the NetDev Community; best for unstructured discussion or just hanging out
Update Slack links; start phasing out mailing list
2021-03-01 09:54:30 -05:00
* [Google Group](https://groups.google.com/g/netbox-discuss) - Legacy mailing list; slowly being replaced by GitHub discussions
Added a note about the IRC chanel to the README
2016-06-27 15:23:06 -04:00
Add Travis build badges for both master and develop against python 2.7
2016-06-27 19:55:17 -04:00
### Build Status
update readme screenshots
2021-04-23 11:52:42 -07:00
| | status |
| ----------- | ------------------------------------------------------------------------------------------------- |
| **master** | ![Build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master) |
Move CI to GitHub Actions (#5431) Replaces Travis CI with GitHub Actions
2020-12-08 14:55:06 -05:00
| **develop** | ![Build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=develop) |
Add Travis build badges for both master and develop against python 2.7
2016-06-27 19:55:17 -04:00
Add user survey note to README
2020-03-05 08:51:03 -05:00
### Screenshots
Add Travis build badges for both master and develop against python 2.7
2016-06-27 19:55:17 -04:00
update docs & readme with screenshots
2021-04-26 01:15:37 -07:00
![Screenshot of Main Page](docs/media/home-light.png "Main Page")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Added separators between screenshots
2020-02-24 15:22:33 +00:00
---
update docs & readme with screenshots
2021-04-26 01:15:37 -07:00
![Screenshot of Rack Elevation](docs/media/rack-dark.png "Rack Elevation")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Added separators between screenshots
2020-02-24 15:22:33 +00:00
---
update docs & readme with screenshots
2021-04-26 01:15:37 -07:00
![Screenshot of Prefix Hierarchy](docs/media/prefixes-light.png "Prefix Hierarchy")
update readme screenshots
2021-04-23 11:52:42 -07:00
---
update docs & readme with screenshots
2021-04-26 01:15:37 -07:00
![Screenshot of Cable Tracing](docs/media/cable-dark.png "Cable Tracing")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Add user survey note to README
2020-03-05 08:51:03 -05:00
## Installation
Tweaked README
2016-06-17 16:17:55 -04:00
Use HTTPS URL schema everywhere (#5505) * Use HTTPS everywhere (mechanical edit using util from https-everywhere) ```Shell node ~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js . git checkout netbox/project-static/ ``` A few additional changes where reset manually before the commit. * Use HTTPS everywhere (mechanical edit using util from opening_hours.js) ```Shell make -f ~/src/opening-hours/opening_hours.js/Makefile qa-https-everywhere git checkout netbox/project-static/ git checkout netbox/*/tests ```
2020-12-21 18:02:30 +01:00
Please see [the documentation](https://netbox.readthedocs.io/en/stable/) for
Encourage people to use GitHub discussions in place of the mailing list
2020-12-10 15:59:42 -05:00
instructions on installing NetBox. To upgrade NetBox, please download the
[latest release](https://github.com/netbox-community/netbox/releases) and
run `upgrade.sh`.
Initial push to public repo
2016-03-01 11:23:03 -05:00
Add user survey note to README
2020-03-05 08:51:03 -05:00
## Providing Feedback
Minor improvements pertaining to CII best practices
2019-10-17 20:56:37 -04:00
Encourage people to use GitHub discussions in place of the mailing list
2020-12-10 15:59:42 -05:00
The best platform for general feedback, assistance, and other discussion is our
[GitHub discussions](https://github.com/netbox-community/netbox/discussions).
To report a bug or request a specific feature, please open a GitHub issue using
the [appropriate template](https://github.com/netbox-community/netbox/issues/new/choose).
Minor improvements pertaining to CII best practices
2019-10-17 20:56:37 -04:00
If you are interested in contributing to the development of NetBox, please read
our [contributing guide](CONTRIBUTING.md) prior to beginning any work.
Add user survey note to README
2020-03-05 08:51:03 -05:00
## Related projects
Add a page related to community related projects
2018-09-10 13:30:22 +02:00
Encourage people to use GitHub discussions in place of the mailing list
2020-12-10 15:59:42 -05:00
Please see [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions)
for a list of relevant community projects.
Copy Permalink