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

58 lines
2.7 KiB
Markdown
Raw Normal View History

We have a logo!
2016-08-09 14:57:14 -04:00
![NetBox](docs/netbox_logo.png "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
to address the needs of network and infrastructure engineers.
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/)
Python framework with a [PostgreSQL](http://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
Added alternative installations section
2017-01-04 17:16:04 -05:00
The complete documentation for NetBox can be found at [Read the Docs](http://netbox.readthedocs.io/en/stable/).
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
Replaced IRC with Slack; formatting cleanup
2018-02-01 16:52:24 -05:00
Questions? Comments? Please subscribe to [the netbox-discuss mailing list](https://groups.google.com/forum/#!forum/netbox-discuss),
Fixed Slack URL
2018-03-14 10:30:55 -04:00
or join us in the #netbox Slack channel on [NetworkToCode](https://networktocode.slack.com/)!
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
Fix misleading build matrix At one point, I had intended to have a matrix of build badges for each different branch and Python version combination. It seems this is not possible with Travis. This change replaces "python 2.7" with "status" and clarifies that both Python 2.7 and 3.5 are tested, but Python 3.5 is recommended.
2017-05-02 20:39:43 -04:00
| | status |
Add Travis build badges for both master and develop against python 2.7
2016-06-27 19:55:17 -04:00
|-------------|------------|
| **master** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=master)](https://travis-ci.org/digitalocean/netbox) |
| **develop** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=develop)](https://travis-ci.org/digitalocean/netbox) |
## Screenshots
Moving docs to readthedocs.org
2016-07-08 12:07:04 -04:00
![Screenshot of main page](docs/media/screenshot1.png "Main page")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Moving docs to readthedocs.org
2016-07-08 12:07:04 -04:00
![Screenshot of rack elevation](docs/media/screenshot2.png "Rack elevation")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Moving docs to readthedocs.org
2016-07-08 12:07:04 -04:00
![Screenshot of prefix hierarchy](docs/media/screenshot3.png "Prefix hierarchy")
Fixes #21: Added screenshots to README
2016-06-27 11:43:33 -04:00
Tweaked README
2016-06-17 16:17:55 -04:00
# Installation
Replaced IRC with Slack; formatting cleanup
2018-02-01 16:52:24 -05:00
Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for
Replacing references to digitalocean org s/(?<=:\/\/github.com\/)digitalocean(?=\/netbox)/netbox-community/g
2019-07-09 11:36:39 -04:00
instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/netbox-community/netbox/releases)
Replaced IRC with Slack; formatting cleanup
2018-02-01 16:52:24 -05:00
and run `upgrade.sh`.
Initial push to public repo
2016-03-01 11:23:03 -05:00
Added alternative installations section
2017-01-04 17:16:04 -05:00
## Alternative Installations
Updated link to netbox-docker, again After some feedback, that `netbox-community/docker` is not an ideal name, I've renamed the repo back to `netbox-docker`. Hence one more PR to update that link.
2019-01-31 09:02:12 +01:00
* [Docker container](https://github.com/netbox-community/netbox-docker) (via [@cimnine](https://github.com/cimnine))
Designated new Docker build repo; removed stale Heroku build repo
2017-10-13 11:50:06 -04:00
* [Vagrant deployment](https://github.com/ryanmerolle/netbox-vagrant) (via [@ryanmerolle](https://github.com/ryanmerolle))
Add Ansible alternative installation to README
2018-02-22 05:56:33 +09:00
* [Ansible deployment](https://github.com/lae/ansible-role-netbox) (via [@lae](https://github.com/lae))
Add a page related to community related projects
2018-09-10 13:30:22 +02:00
# Related projects
## Supported SDK
Closes #2995: Added powerbox to community SDK list
2019-03-19 09:48:16 -04:00
- [pynetbox](https://github.com/digitalocean/pynetbox) - A Python API client library for Netbox
Add a page related to community related projects
2018-09-10 13:30:22 +02:00
## Community SDK
Closes #2995: Added powerbox to community SDK list
2019-03-19 09:48:16 -04:00
- [netbox-client-ruby](https://github.com/ninech/netbox-client-ruby) - A Ruby client library for Netbox
- [powerbox](https://github.com/BatmanAMA/powerbox) - A PowerShell library for Netbox
Add a page related to community related projects
2018-09-10 13:30:22 +02:00
## Ansible Inventory
Closes #2995: Added powerbox to community SDK list
2019-03-19 09:48:16 -04:00
- [netbox-as-ansible-inventory](https://github.com/AAbouZaid/netbox-as-ansible-inventory) - Ansible dynamic inventory script for Netbox
Copy Permalink