mirror of
https://github.com/librenms/librenms.git
synced 2024-09-21 10:28:13 +00:00
Updated to use new theme for docs site (#9320)
* Updated to use new theme for docs site * Updated theme location * Removed librenms.css * Updated index page + re-added librenms.css * Use built in theme modification * flexbox grid, dump bootstrap * tidy up things * Added path and updated deploy script + mkdocs config * Removed db schmea changes * Updated to install python/pip 3 * Removed pip3 install * Pip3 install * Updated deploy-docs * Updated deploy-docs
This commit is contained in:
parent
c37786d845
commit
1ee2e8e0e0
@ -27,7 +27,7 @@ cache:
|
|||||||
|
|
||||||
before_install:
|
before_install:
|
||||||
- sudo apt-get -qq update
|
- sudo apt-get -qq update
|
||||||
- sudo apt-get install -y snmp fping
|
- sudo apt-get install -y snmp fping python3-pip
|
||||||
- mysql -e 'CREATE DATABASE librenms_phpunit_78hunjuybybh;'
|
- mysql -e 'CREATE DATABASE librenms_phpunit_78hunjuybybh;'
|
||||||
- cp tests/config/config.test.php config.php
|
- cp tests/config/config.test.php config.php
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/ARP.md
|
source: API/ARP.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `list_arp`
|
### `list_arp`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Alerts.md
|
source: API/Alerts.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `get_alert`
|
### `get_alert`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Bills.md
|
source: API/Bills.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `list_bills`
|
### `list_bills`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/DeviceGroups.md
|
source: API/DeviceGroups.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `get_devicegroups`
|
### `get_devicegroups`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Devices.md
|
source: API/Devices.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `del_device`
|
### `del_device`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Inventory.md
|
source: API/Inventory.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `get_inventory`
|
### `get_inventory`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Logs.md
|
source: API/Logs.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
All the `list_*logs` calls are aliased to `list_logs`.
|
All the `list_*logs` calls are aliased to `list_logs`.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/PortGroups.md
|
source: API/PortGroups.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `get_graph_by_portgroup`
|
### `get_graph_by_portgroup`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Devices.md
|
source: API/Devices.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `get_all_ports`
|
### `get_all_ports`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Routing.md
|
source: API/Routing.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `list_bgp`
|
### `list_bgp`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Services.md
|
source: API/Services.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `list_services`
|
### `list_services`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/Switching.md
|
source: API/Switching.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `list_vlans`
|
### `list_vlans`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/System.md
|
source: API/System.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### `system`
|
### `system`
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: API/index.md
|
source: API/index.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Creating-Transport.md
|
source: Alerting/Creating-Transport.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Creating a new Transport.
|
# Creating a new Transport.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Device-Dependencies.md
|
source: Alerting/Device-Dependencies.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Device Dependencies
|
# Device Dependencies
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Entities.md
|
source: Alerting/Entities.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Entities
|
# Entities
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Introduction.md
|
source: Alerting/Introduction.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Macros.md
|
source: Alerting/Macros.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Macros
|
# Macros
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Templates.md
|
source: Alerting/Templates.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Templates
|
# Templates
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Rules.md
|
source: Alerting/Rules.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Rules
|
# Rules
|
||||||
Rules are defined using a logical language.
|
Rules are defined using a logical language.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Templates.md
|
source: Alerting/Templates.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Templates
|
# Templates
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Testing.md
|
source: Alerting/Testing.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### Rules
|
### Rules
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/Transports.md
|
source: Alerting/Transports.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Transports
|
# Transports
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Alerting/index.md
|
source: Alerting/index.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Code-Guidelines.md
|
source: Developing/Code-Guidelines.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Coding guidelines
|
# Coding guidelines
|
||||||
|
|
||||||
This document is here to help code standards for contributions towards LibreNMS. The original code base that we forked from had a lack of standards and as such the code base has a variety of different styles. Whilst we don't want to restrict how people write code, these guidelines should mean we have a good standard going forward that makes reading the code easier. All modern day ide's should be able to assist in these guidelines without breaking your usual workflow.
|
This document is here to help code standards for contributions towards LibreNMS. The original code base that we forked from had a lack of standards and as such the code base has a variety of different styles. Whilst we don't want to restrict how people write code, these guidelines should mean we have a good standard going forward that makes reading the code easier. All modern day ide's should be able to assist in these guidelines without breaking your usual workflow.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Code-Structure.md
|
source: Developing/Code-Structure.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Code structure.
|
# Code structure.
|
||||||
|
|
||||||
This document will try and provide a good overview of how the code is structured within LibreNMS. We will go through the main directories and provide information on how and when they are used.
|
This document will try and provide a good overview of how the code is structured within LibreNMS. We will go through the main directories and provide information on how and when they are used.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Creating-Documentation.md
|
source: Developing/Creating-Documentation.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Creating Documentation
|
# Creating Documentation
|
||||||
|
|
||||||
One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation.
|
One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Creating-Release.md
|
source: Developing/Creating-Release.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Creating a release
|
# Creating a release
|
||||||
|
|
||||||
### GitHub
|
### GitHub
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Dynamic-Config.md
|
source: Developing/Dynamic-Config.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Adding new config options to WebUI
|
# Adding new config options to WebUI
|
||||||
|
|
||||||
Adding support for users to update a new config option via the WebUI is now a lot easier for general options. This
|
Adding support for users to update a new config option via the WebUI is now a lot easier for general options. This
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
## Contributor Agreement
|
## Contributor Agreement
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
By contributing code to LibreNMS (whether by a GitHub pull request, or by
|
By contributing code to LibreNMS (whether by a GitHub pull request, or by
|
||||||
any other means), you assert that:
|
any other means), you assert that:
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Merging-Pull-Requests.md
|
source: Developing/Merging-Pull-Requests.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Merging Pull Requests
|
# Merging Pull Requests
|
||||||
|
|
||||||
### GitHub
|
### GitHub
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/SNMP-Traps.md
|
source: Developing/SNMP-Traps.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Creating snmp trap handlers
|
# Creating snmp trap handlers
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Sensor-State-Support.md
|
source: Developing/Sensor-State-Support.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Sensor State Support
|
# Sensor State Support
|
||||||
|
|
||||||
### Introduction
|
### Introduction
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Style-Guidelines.md
|
source: Developing/Style-Guidelines.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Style guidelines
|
# Style guidelines
|
||||||
|
|
||||||
This document is here to help style standards for contributions towards LibreNMS. These aren't strict rules but it is in
|
This document is here to help style standards for contributions towards LibreNMS. These aren't strict rules but it is in
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Support-New-OS.md
|
source: Developing/Support-New-OS.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
This document is broken down into the relevant sections depending on what support you are adding.
|
This document is broken down into the relevant sections depending on what support you are adding.
|
||||||
During all of these examples we will be using the OS of `pulse` as the example OS we will add.
|
During all of these examples we will be using the OS of `pulse` as the example OS we will add.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Using-Git.md
|
source: Developing/Using-Git.md
|
||||||
|
path: blob/master/doc/
|
||||||
Git can have a bit of a steep learning curve, stick with it as it is worth learning the [basics][1][2] at least.
|
Git can have a bit of a steep learning curve, stick with it as it is worth learning the [basics][1][2] at least.
|
||||||
|
|
||||||
If you want to help develop LibreNMS and haven't really used Git before then this quick primer will help you get started.
|
If you want to help develop LibreNMS and haven't really used Git before then this quick primer will help you get started.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/Validating-Code.md
|
source: Developing/Validating-Code.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
#### Validating Code
|
#### Validating Code
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/index.md
|
source: General/index.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Copyright and Licensing
|
# Copyright and Licensing
|
||||||
All contributors to LibreNMS retain copyright to their own code and are not
|
All contributors to LibreNMS retain copyright to their own code and are not
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Custom-Graphs.md
|
source: Developing/os/Custom-Graphs.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
If you are adding custom graphs, please add the following to `includes/definitions.inc.php`:
|
If you are adding custom graphs, please add the following to `includes/definitions.inc.php`:
|
||||||
```php
|
```php
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Health-Information.md
|
source: Developing/os/Health-Information.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
#### Sensors
|
#### Sensors
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Initial-Detection.md
|
source: Developing/os/Initial-Detection.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
This document will provide the information you should need to add basic detection for a new OS.
|
This document will provide the information you should need to add basic detection for a new OS.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Mem-CPU-Information.md
|
source: Developing/os/Mem-CPU-Information.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
This document will guide you through adding detection for Memory / Processor for your new device.
|
This document will guide you through adding detection for Memory / Processor for your new device.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: os/Settings.md
|
source: os/Settings.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Optional OS Settings
|
# Optional OS Settings
|
||||||
|
|
||||||
This page documents settings that can be set in the os yaml files or in config.php.
|
This page documents settings that can be set in the os yaml files or in config.php.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Test-Units.md
|
source: Developing/os/Test-Units.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Tests
|
# Tests
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Developing/os/Wireless-Sensors.md
|
source: Developing/os/Wireless-Sensors.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
This document will guide you through adding wireless sensors for your new wireless device.
|
This document will guide you through adding wireless sensors for your new wireless device.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Agent-Setup.md
|
source: Extensions/Agent-Setup.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
The agent can be used to gather data from remote systems you can use LibreNMS in combination with check_mk (found [here](https://github.com/librenms/librenms-agent)).
|
The agent can be used to gather data from remote systems you can use LibreNMS in combination with check_mk (found [here](https://github.com/librenms/librenms-agent)).
|
||||||
The agent can be extended to include data about [applications](Applications.md) on the remote system.
|
The agent can be extended to include data about [applications](Applications.md) on the remote system.
|
||||||
|
@ -1,2 +1,3 @@
|
|||||||
source: Extensions/Alerting.md
|
source: Extensions/Alerting.md
|
||||||
|
path: blob/master/doc/
|
||||||
<meta http-equiv="refresh" content="0; url=/Alerting/Alerting/" />
|
<meta http-equiv="refresh" content="0; url=/Alerting/Alerting/" />
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Applications.md
|
source: Extensions/Applications.md
|
||||||
|
path: blob/master/doc/
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
You can use Application support to graph performance statistics of many applications.
|
You can use Application support to graph performance statistics of many applications.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Authentication.md
|
source: Extensions/Authentication.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Authentication modules
|
# Authentication modules
|
||||||
|
|
||||||
LibreNMS supports multiple authentication modules along with [Two Factor Auth](http://docs.librenms.org/Extensions/Two-Factor-Auth/).
|
LibreNMS supports multiple authentication modules along with [Two Factor Auth](http://docs.librenms.org/Extensions/Two-Factor-Auth/).
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Auto-Discovery.md
|
source: Extensions/Auto-Discovery.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Auto Discovery Support
|
# Auto Discovery Support
|
||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Billing-Module.md
|
source: Extensions/Billing-Module.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Billing Module
|
# Billing Module
|
||||||
|
|
||||||
With the billing module you can create a bill, assign a quota to it and add ports to it.
|
With the billing module you can create a bill, assign a quota to it and add ports to it.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Component.md
|
source: Extensions/Component.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Dashboards.md
|
source: Extensions/Dashboards.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Dashboards
|
# Dashboards
|
||||||
Create customised dashboards in LibreNMS per user. You can share dashboards with other users. You can also make a custom dashboard and
|
Create customised dashboards in LibreNMS per user. You can share dashboards with other users. You can also make a custom dashboard and
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Dell-OpenManage.md
|
source: Extensions/Dell-OpenManage.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Dell OpenManage Support
|
# Dell OpenManage Support
|
||||||
-----------------------
|
-----------------------
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Device-Groups.md
|
source: Extensions/Device-Groups.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
LibreNMS supports grouping your devices together in much the same way as you can configure alerts. This document will hopefully help you get started.
|
LibreNMS supports grouping your devices together in much the same way as you can configure alerts. This document will hopefully help you get started.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Distributed-Poller.md
|
source: Extensions/Distributed-Poller.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Distributed Poller
|
# Distributed Poller
|
||||||
LibreNMS has the ability to distribute polling of devices to other machines.
|
LibreNMS has the ability to distribute polling of devices to other machines.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Fast-Ping-Check.md
|
source: Extensions/Fast-Ping-Check.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
## Fast up/down checking
|
## Fast up/down checking
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Gateone.md
|
source: Extensions/Gateone.md
|
||||||
|
path: blob/master/doc/
|
||||||
# GateOne integration
|
# GateOne integration
|
||||||
|
|
||||||
We have simple integration for [GateOne](https://github.com/liftoff/GateOne), you will be redirected to your Gateone command line frontend to access your equipment. (Currently this only works with SSH)
|
We have simple integration for [GateOne](https://github.com/liftoff/GateOne), you will be redirected to your Gateone command line frontend to access your equipment. (Currently this only works with SSH)
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Graylog.md
|
source: Extensions/Graylog.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Graylog integration
|
# Graylog integration
|
||||||
|
|
||||||
We have simple integration for Graylog, you will be able to view any logs from within LibreNMS that have been parsed by the syslog input from within
|
We have simple integration for Graylog, you will be able to view any logs from within LibreNMS that have been parsed by the syslog input from within
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/IRC-Bot-Extensions.md
|
source: Extensions/IRC-Bot-Extensions.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Quick Guide
|
# Quick Guide
|
||||||
|
|
||||||
Okay this is a very quick walk-through in writing own `commands` for the IRC-Bot.
|
Okay this is a very quick walk-through in writing own `commands` for the IRC-Bot.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/IRC-Bot.md
|
source: Extensions/IRC-Bot.md
|
||||||
|
path: blob/master/doc/
|
||||||
[TOC]
|
[TOC]
|
||||||
|
|
||||||
# About
|
# About
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Interface-Description-Parsing.md
|
source: Extensions/Interface-Description-Parsing.md
|
||||||
|
path: blob/master/doc/
|
||||||
## About
|
## About
|
||||||
Librenms can interpret, display and group certain additional information on ports.
|
Librenms can interpret, display and group certain additional information on ports.
|
||||||
This is done based on the format that the port description is written although it's possible
|
This is done based on the format that the port description is written although it's possible
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/MIB-based-polling.md
|
source: Extensions/MIB-based-polling.md
|
||||||
|
path: blob/master/doc/
|
||||||
## WARNING ##
|
## WARNING ##
|
||||||
|
|
||||||
MIB-based polling is unmaintained and may be removed in the future. It might overload your LibreNMS server,
|
MIB-based polling is unmaintained and may be removed in the future. It might overload your LibreNMS server,
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Metric-Storage.md
|
source: Extensions/Metric-Storage.md
|
||||||
|
path: blob/master/doc/
|
||||||
hide_toc: true
|
hide_toc: true
|
||||||
|
|
||||||
### Metric storage
|
### Metric storage
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/NFSen.md
|
source: Extensions/NFSen.md
|
||||||
|
path: blob/master/doc/
|
||||||
# NFSen
|
# NFSen
|
||||||
|
|
||||||
> The installation of NFSen is out of scope for this document / LibreNMS
|
> The installation of NFSen is out of scope for this document / LibreNMS
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Network-Map.md
|
source: Extensions/Network-Map.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Network Map
|
# Network Map
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Oxidized.md
|
source: Extensions/Oxidized.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Oxidized intro
|
# Oxidized intro
|
||||||
---
|
---
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/PeeringDB.md
|
source: Extensions/PeeringDB.md
|
||||||
|
path: blob/master/doc/
|
||||||
# PeeringDB Support
|
# PeeringDB Support
|
||||||
|
|
||||||
LibreNMS has integration with PeeringDB to match up your BGP sessions with the peering exchanges you are connected to.
|
LibreNMS has integration with PeeringDB to match up your BGP sessions with the peering exchanges you are connected to.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Plugin-System.md
|
source: Extensions/Plugin-System.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Developing for the Plugin System
|
# Developing for the Plugin System
|
||||||
|
|
||||||
> This will most likely be deprecated in favour of adding the possible extensions to the core code base.
|
> This will most likely be deprecated in favour of adding the possible extensions to the core code base.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Poller-Service.md
|
source: Extensions/Poller-Service.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Poller Service
|
# Poller Service
|
||||||
|
|
||||||
> Status: BETA
|
> Status: BETA
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Proxmox.md
|
source: Extensions/Proxmox.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Proxmox graphing
|
# Proxmox graphing
|
||||||
It is possible to create graphs of the Proxmox **VMs** that run on your monitored machines. Currently, only traffic graphs are created. One for each interface on each VM. Possibly, IO graphs will be added later on.
|
It is possible to create graphs of the Proxmox **VMs** that run on your monitored machines. Currently, only traffic graphs are created. One for each interface on each VM. Possibly, IO graphs will be added later on.
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
### Securing with nginx
|
### Securing with nginx
|
||||||
|
path: blob/master/doc/
|
||||||
According to the [man page](https://linux.die.net/man/1/rrdcached), under "SECURITY CONSIDERATIONS", rrdcached has no authentication or security except for running under a unix socket. If you choose to use a network socket instead of a unix socket, you will need to secure your rrdcached installation. To do so you can proxy rrdcached using nginx to allow only specific IPs to connect.
|
According to the [man page](https://linux.die.net/man/1/rrdcached), under "SECURITY CONSIDERATIONS", rrdcached has no authentication or security except for running under a unix socket. If you choose to use a network socket instead of a unix socket, you will need to secure your rrdcached installation. To do so you can proxy rrdcached using nginx to allow only specific IPs to connect.
|
||||||
|
|
||||||
using the same setup above, using nginx version 1.9.0 or later, you can follow this setup to proxy the default rrdcached port to the local unix socket.
|
using the same setup above, using nginx version 1.9.0 or later, you can follow this setup to proxy the default rrdcached port to the local unix socket.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/RRDCached.md
|
source: Extensions/RRDCached.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Setting up RRDCached
|
# Setting up RRDCached
|
||||||
|
|
||||||
This document will explain how to setup RRDCached for LibreNMS.
|
This document will explain how to setup RRDCached for LibreNMS.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/RRDTune.md
|
source: Extensions/RRDTune.md
|
||||||
|
path: blob/master/doc/
|
||||||
# RRDTune?
|
# RRDTune?
|
||||||
|
|
||||||
When we create rrd files for ports, we currently do so with a max value of 12500000000 (100G). Because of this if a device sends us bad data back then it can appear as though
|
When we create rrd files for ports, we currently do so with a max value of 12500000000 (100G). Because of this if a device sends us bad data back then it can appear as though
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Rancid.md
|
source: Extensions/Rancid.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Rancid integration
|
# Rancid integration
|
||||||
|
|
||||||
Librenms can generate a list of hosts that can be monitored by RANCID.
|
Librenms can generate a list of hosts that can be monitored by RANCID.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/SNMP-Proxy.md
|
source: Extensions/SNMP-Proxy.md
|
||||||
|
path: blob/master/doc/
|
||||||
# SNMP Proxy
|
# SNMP Proxy
|
||||||
|
|
||||||
If you have machines that you want to monitor but are not reachable directly, you can use [SNMPD Proxy](http://www.net-snmp.org/wiki/index.php/Snmpd_proxy). This will use the reachable SNMPD to proxy requests to the unreachable SNMPD.
|
If you have machines that you want to monitor but are not reachable directly, you can use [SNMPD Proxy](http://www.net-snmp.org/wiki/index.php/Snmpd_proxy). This will use the reachable SNMPD to proxy requests to the unreachable SNMPD.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/SNMP-Trap-Handler.md
|
source: Extensions/SNMP-Trap-Handler.md
|
||||||
|
path: blob/master/doc/
|
||||||
# SNMP trap handling
|
# SNMP trap handling
|
||||||
|
|
||||||
Currently, librenms only supports linkUp/linkDown (port up/down), bgpEstablished/bgpBackwardTransition (BGP Sessions Up/Down) and authenticationFailure SNMP traps.
|
Currently, librenms only supports linkUp/linkDown (port up/down), bgpEstablished/bgpBackwardTransition (BGP Sessions Up/Down) and authenticationFailure SNMP traps.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Services.md
|
source: Extensions/Services.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Setting up Services
|
# Setting up Services
|
||||||
|
|
||||||
Services within LibreNMS provides the ability to use Nagios plugins to perform additional monitoring outside of SNMP.
|
Services within LibreNMS provides the ability to use Nagios plugins to perform additional monitoring outside of SNMP.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Smokeping.md
|
source: Extensions/Smokeping.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Smokeping integration
|
# Smokeping integration
|
||||||
|
|
||||||
[SmokePing](https://oss.oetiker.ch/smokeping/) is a tool which lets us keep track of network latency, and visualise this through RRD graphs.
|
[SmokePing](https://oss.oetiker.ch/smokeping/) is a tool which lets us keep track of network latency, and visualise this through RRD graphs.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Sub-Directory.md
|
source: Extensions/Sub-Directory.md
|
||||||
|
path: blob/master/doc/
|
||||||
To run LibreNMS under a subdirectory on your Apache server, the directives for the LibreNMS directory are placed in the base server configuration, or in a virtual host
|
To run LibreNMS under a subdirectory on your Apache server, the directives for the LibreNMS directory are placed in the base server configuration, or in a virtual host
|
||||||
container of your choosing. If using a virtual host, place the directives in the file where the virtual host is configured. If using the base server on RHEL distributions
|
container of your choosing. If using a virtual host, place the directives in the file where the virtual host is configured. If using the base server on RHEL distributions
|
||||||
(CentOS, Scientific Linux, etc.) the directives can be placed in `/etc/httpd/conf.d/librenms.conf`. For Debian distributions (Ubuntu, etc.) place the directives in
|
(CentOS, Scientific Linux, etc.) the directives can be placed in `/etc/httpd/conf.d/librenms.conf`. For Debian distributions (Ubuntu, etc.) place the directives in
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Syslog.md
|
source: Extensions/Syslog.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Setting up syslog support
|
# Setting up syslog support
|
||||||
|
|
||||||
This document will explain how to send syslog data to LibreNMS.
|
This document will explain how to send syslog data to LibreNMS.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Two-Factor-Auth.md
|
source: Extensions/Two-Factor-Auth.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Varnish.md
|
source: Extensions/Varnish.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Varnish Installation Guide #
|
# Varnish Installation Guide #
|
||||||
|
|
||||||
This document explains how to install Varnish Reverse Proxy for LibreNMS.
|
This document explains how to install Varnish Reverse Proxy for LibreNMS.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/Weathermap.md
|
source: Extensions/Weathermap.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
# Network-WeatherMap with LibreNMS
|
# Network-WeatherMap with LibreNMS
|
||||||
Integrating LibreNMS with Network-Weathermap, allows you to build network maps to help visulaize network traffic flow rates.
|
Integrating LibreNMS with Network-Weathermap, allows you to build network maps to help visulaize network traffic flow rates.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/World-Map.md
|
source: Extensions/World-Map.md
|
||||||
|
path: blob/master/doc/
|
||||||
# World Map Configuration
|
# World Map Configuration
|
||||||
|
|
||||||
LibreNMS comes with a configurable Geo Map based on World Map Widget to visualize where your equipment is located geographically.
|
LibreNMS comes with a configurable Geo Map based on World Map Widget to visualize where your equipment is located geographically.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/metrics/Graphite.md
|
source: Extensions/metrics/Graphite.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Enabling support for Graphite.
|
# Enabling support for Graphite.
|
||||||
|
|
||||||
This module sends all metrics to a remote graphite service. You need something like Grafana for graphing.
|
This module sends all metrics to a remote graphite service. You need something like Grafana for graphing.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/metrics/InfluxDB.md
|
source: Extensions/metrics/InfluxDB.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Enabling support for InfluxDB.
|
# Enabling support for InfluxDB.
|
||||||
|
|
||||||
Before we get started it is important that you know and understand that InfluxDB support is currently alpha at best.
|
Before we get started it is important that you know and understand that InfluxDB support is currently alpha at best.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/metrics/OpenTSDB.md
|
source: Extensions/metrics/OpenTSDB.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Enabling support for OpenTSDB.
|
# Enabling support for OpenTSDB.
|
||||||
|
|
||||||
This module sends all metrics to OpenTSDB server. You need something like Grafana for graphing.
|
This module sends all metrics to OpenTSDB server. You need something like Grafana for graphing.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: Extensions/metrics/Prometheus.md
|
source: Extensions/metrics/Prometheus.md
|
||||||
|
path: blob/master/doc/
|
||||||
# Enabling support for Prometheus.
|
# Enabling support for Prometheus.
|
||||||
|
|
||||||
Please be aware Prometheus support is alpha at best, It hasn't been extensively tested and is still in development
|
Please be aware Prometheus support is alpha at best, It hasn't been extensively tested and is still in development
|
||||||
|
@ -1,4 +1,6 @@
|
|||||||
source: General/Acknowledgement.md
|
source: General/Acknowledgement.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
LibreNMS wouldn't be what it is today without the use of some other amazing projects.
|
LibreNMS wouldn't be what it is today without the use of some other amazing projects.
|
||||||
We list below what we make use of including the license compliance.
|
We list below what we make use of including the license compliance.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/CODE_OF_CONDUCT.md
|
source: General/CODE_OF_CONDUCT.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/Callback-Stats-and-Privacy.md
|
source: General/Callback-Stats-and-Privacy.md
|
||||||
|
path: blob/master/doc/
|
||||||
## Stats data and your privacy ##
|
## Stats data and your privacy ##
|
||||||
|
|
||||||
This document has been put together to explain what LibreNMS does when it calls back home to report some anonymous statistics.
|
This document has been put together to explain what LibreNMS does when it calls back home to report some anonymous statistics.
|
||||||
|
@ -1,2 +1,3 @@
|
|||||||
source: General/Contributing.md
|
source: General/Contributing.md
|
||||||
|
path: blob/master/doc/
|
||||||
<meta http-equiv="refresh" content="0; url=/Developing/" />
|
<meta http-equiv="refresh" content="0; url=/Developing/" />
|
||||||
|
@ -1,2 +1,3 @@
|
|||||||
source: General/Credits.md
|
source: General/Credits.md
|
||||||
|
path: blob/master/doc/
|
||||||
<meta http-equiv="refresh" content="0; url=/General/Acknowledgement/" />
|
<meta http-equiv="refresh" content="0; url=/General/Acknowledgement/" />
|
@ -1,4 +1,5 @@
|
|||||||
source: General/Releases.md
|
source: General/Releases.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
#### Introduction
|
#### Introduction
|
||||||
We try to ensure that breaking changes aren't introduced by utilising various automated
|
We try to ensure that breaking changes aren't introduced by utilising various automated
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/Security.md
|
source: General/Security.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
### General
|
### General
|
||||||
Like any good software we take security seriously. However, bugs do make it into the software
|
Like any good software we take security seriously. However, bugs do make it into the software
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/Updating.md
|
source: General/Updating.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
By default, LibreNMS is set to automatically update. If you have disabled this feature then you can
|
By default, LibreNMS is set to automatically update. If you have disabled this feature then you can
|
||||||
perform a manual update.
|
perform a manual update.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
source: General/Welcome-to-Observium-users.md
|
source: General/Welcome-to-Observium-users.md
|
||||||
|
path: blob/master/doc/
|
||||||
|
|
||||||
LibreNMS is a fork of Observium. The reason for the fork has nothing to do
|
LibreNMS is a fork of Observium. The reason for the fork has nothing to do
|
||||||
with Observium's [move to community vs. paid versions][1]. It is simply
|
with Observium's [move to community vs. paid versions][1]. It is simply
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user