clones/librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-09-22 10:58:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add a getting started section to the Oxidized docs (#5861)

Browse Source
This commit is contained in:
Tony Murray 2017-02-10 15:19:17 -06:00 committed by Neil Lathwood
parent 2e235b27c6
commit 4ec373f749
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/Extensions/Oxidized.md
View File

@ -1,7 +1,18 @@
source: Extensions/Oxidized.md
# Oxidized integration
You can integrate LibreNMS with [Oxidized](https://github.com/ytti/oxidized-web) in two ways:
Integrating LibreNMS with [Oxidized](https://github.com/ytti/oxidized-web) brings the following benefits:
- Config viewing: Current, History, and Diffs all under the `Configs` tab of each device
- Automatic addition of devices to Oxidized: Including filtering and grouping to ease credential management
- Configuration searching (Requires oxidized-web 0.8.0 or newer)
First you will need to [install Oxidized following their documentation](https://github.com/ytti/oxidized#installation).
Then you can procede to the LibreNMS Web UI and go to Oxidized Settings in the External Settings section of Global Settings. Enable it and enter the url to your oxidized instance.
To have devices automatically added, you will need to configure oxidized to pull them from LibreNMS [Feeding Oxidized](#feeding-oxidized)
## Detailed integration information
### Config viewing
@ -31,6 +42,14 @@ You can set a default group that devices will fall back to with:
$config['oxidized']['default_group'] = 'default';
```
##### SELinux
If you're runnng SELinux, you'll need to allow httpd to connect outbound to the network, otherwise Oxidized integration in the web UI will silently fail:
```
setsebool -P httpd_can_network_connect 1
```
### Feeding Oxidized
Oxidized has support for feeding devices into it via an API call, support for Oxidized has been added to the LibreNMS API. A sample config for Oxidized is provided below.
@ -101,8 +120,3 @@ $config['oxidized']['ignore_types'] = array('server');
$config['oxidized']['ignore_os'] = array('linux');
```
If you're runnng SELinux, you'll need to allow httpd to connect outbound to the network, otherwise Oxidized integration in the web UI will silently fail:
```
setsebool -P httpd_can_network_connect 1
```