Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new doc for weathermap #7536

Merged
merged 7 commits into from Oct 25, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions doc/Extensions/Weathermap.md
@@ -0,0 +1,33 @@
source: Extensions/Weathermap.md

# WeatherMap with LibreNMS
Intergarting LibreNMS with Weathermap, allows you to build network maps to visulaize network traffic rates.
[Link](https://network-weathermap.com/) to Wearthermap Offical Website

### Installing WeatherMap

### Step 1.
Extract to your LibreNMS plugins directory `html/plugins` so you should see something like `/opt/librenms/html/plugins/Weathermap/`
The best way to do this is via git. Go to your install directory and then `html/plugins`.
Enter:
`git clone https://github.com/librenms-plugins/Weathermap.git`
### Step 2.
Make the configs directory writeable by your web server, either `chown apache:apache configs/` or `chmod 777 configs`.
I'd highly advise you choose the first option, replace `apache:apache` with your web servers user and group.
### Step 3.
Enable the plugin from the LibreNMS Plugins -> Plugin Admin menu.
### Step 4.
Create your maps, please note when you create a MAP, please click Map Style, ensure Overlib is selected for HTML Style and click submit.
### Step 5.
Also, ensure you set an output image filename and output HTML filename in Map Properties.
I'd recommend you use the output folder as this is excluded from git updates (i.e enter output/mymap.png and output/mymap.html).
### Step 6.
Enable the cron process by editing your current LibreNMS cron file (typically /etc/cron.d/librenms) and add the following:
LibreNMS:
`*/5 * * * * root /opt/librenms/html/plugins/Weathermap/map-poller.php >> /dev/null 2>&1`
### Step 7.
Now you should see Weathermap Overview -> Plugins -> Weathermap

Optional: If your install is in another directory than standard, set `$basehref` within `map-poller.php`.

source How To from [Link](https://github.com/librenms-plugins/Weathermap/edit/master/INSTALL.md)
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -72,6 +72,7 @@ pages:
- Extensions/Proxmox.md
- Storing Metrics: Extensions/Metric-Storage.md
- Extensions/Smokeping.md
- Extensions/Weathermap.md
- 7. API:
- API/index.md
- 8. Alerting:
Expand Down