135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Oliver Gorwits
2018-01-01 12:56:49 +00:00
parent 6244cece1e
commit 3cea51303b
1 changed files with 16 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -1,34 +1,26 @@
# netdisco
**Netdisco** is a web-based network management tool suitable for small to very large networks. IP and MAC address data is collected into a PostgreSQL database using SNMP, CLI, or device APIs. Some of the things you can do with Netdisco:
[![Build Status](https://travis-ci.org/netdisco/netdisco.svg?branch=master)](https://travis-ci.org/netdisco/netdisco)
[![CPAN version](https://badge.fury.io/pl/App-Netdisco.svg)](https://metacpan.org/pod/App::Netdisco)
## Description
Netdisco is a web-based network management tool designed for network
administrators. Data is collected into a PostgreSQL database using SNMP.
Some of the things you can do with Netdisco:
* Locate a machine on the network by MAC or IP and show the switch port it lives at
* Turn off a switch port, or change the VLAN or PoE status of a port
* Inventory your network hardware by model, vendor, software and operating system
* Pretty pictures of your network
App::Netdisco provides a web frontend with built-in web server, and a backend
daemon to gather information from your network, and handle interactive
requests such as changing port or device properties.
[[[https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-2.png|alt="Device Search"|width=200px]]](https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-2.png)
[[[https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-1.png|alt="Device Ports and Nodes"|width=200px]]](https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-1.png)
[[[https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-3.png|alt="Device Details"|width=200px]]](https://raw.githubusercontent.com/netdisco/upstream-sources/master/screenshots/nd2-shot-3.png)
## Startup
Start the web-app server (accessible on port 5000)
```bash
~/bin/netdisco-web start
```
Start the daemon
```bash
netdisco$ ~/bin/netdisco-backend start
```
See the demo at: [https://netdisco2-demo.herokuapp.com/](https://netdisco2-demo.herokuapp.com/)
## Installation
Netdisco is written in Perl and is self-contained apart from the PostgreSQL database, so is very easy to install and runs well on any linux or unix system.
It includes a lightweight web server for the interface, a backend daemon to gather data from your network, and a command line interface for troubleshooting. There is a simple configuration file in YAML format.
Please check out the [installation instructions](https://metacpan.org/pod/App::Netdisco) on CPAN.
You can also speak to someone in the [`#netdisco@freenode`](https://webchat.freenode.net/?randomnick=1&prompt=1&channels=%23netdisco) IRC channel, or on the [community email list](https://lists.sourceforge.net/lists/listinfo/netdisco-users).
Main resource:
- [Main documentation on metacpan](https://metacpan.org/pod/App::Netdisco)
Other resources:
- [Github wiki](https://github.com/netdisco/netdisco/wiki)