mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Added support for Oxidized versioning
This commit is contained in:
40
doc/Extensions/Oxidized.md
Normal file
40
doc/Extensions/Oxidized.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Oxidized integration
|
||||
|
||||
You can integrate LibreNMS with [Oxidized](https://github.com/ytti/oxidized-web) in two ways:
|
||||
|
||||
### Config viewing
|
||||
|
||||
This is a straight forward use of Oxidized, it relies on you having a working Oxidized setup which is already taking config snapshots for your devices.
|
||||
When you have that, you only need the following config to enable the display of device configs within the device page itself:
|
||||
|
||||
```php
|
||||
$config['oxidized']['enabled'] = TRUE;
|
||||
$config['oxidized']['url'] = 'http://127.0.0.1:8888';
|
||||
```
|
||||
|
||||
We also support config versioning within Oxidized, this will allow you to see the old configs stored. At present this is waiting on a [PR](https://github.com/ytti/oxidized-web/pull/25) to be merged upstream into Oxidized but you could simply patch your local install in the meantime.
|
||||
|
||||
```php
|
||||
$config['oxidized']['features']['versioning'] = true;
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
You will need to configure default credentials for your devices, LibreNMS doesn't provide login credentials at this time.
|
||||
|
||||
```bash
|
||||
source:
|
||||
default: http
|
||||
debug: false
|
||||
http:
|
||||
url: https://librenms/api/v0/oxidized
|
||||
scheme: https
|
||||
delimiter: !ruby/regexp /:/
|
||||
map:
|
||||
name: hostname
|
||||
model: os
|
||||
headers:
|
||||
X-Auth-Token: '01582bf94c03104ecb7953dsadsadwed'
|
||||
```
|
||||
Reference in New Issue
Block a user