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

Updated docs to have source to use for edit github (#4185)

Browse Source 
* Added source link for edit on github

* Updated formatting issues

* Updated formatting issues

* Updated formatting issues
This commit is contained in:
Neil Lathwood 2016-08-24 08:12:20 +01:00 committed by GitHub
parent e54341857f
commit 383c50b4f4
72 changed files with 74 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/API/API-Docs.md
View File

@ -1,3 +1,4 @@
source: API/API-Docs.md
- API
<a name="top"></a>
- [`Structure`](#api-structure)

1
doc/Developing/Code-Guidelines.md
View File

@ -1,3 +1,4 @@
source: Developing/Code-Guidelines.md
# 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.

3
doc/Developing/Code-Structure.md
View File

@ -1,3 +1,4 @@
source: Developing/Code-Structure.md
# 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.
@ -54,5 +55,3 @@ Simple enough, this is where all of the rrd files are created. They are stored i
### sql-schema/
In here are all of the SQL schema files. These are used to setup a new instance of LibreNMS automatically when build-base.php is called or when an update is done and includes/sql-schema/update.php is called.

3
doc/Developing/Creating-Documentation.md
View File

@ -1,3 +1,4 @@
source: Developing/Creating-Documentation.md
# 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.
@ -15,5 +16,3 @@ simple to do this:
Please ensure you add the document to the relevant section within `pages` of `mkdocs.yml` so that it's in the correct menu and is built.
Forgetting this step will result in your document never seeing the light of day :)

1
doc/Developing/Dynamic-Config.md
View File

@ -1,3 +1,4 @@
source: Developing/Dynamic-Config.md
# 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

1
doc/Developing/Sensor-State-Support.md
View File

@ -1,3 +1,4 @@
source: Developing/Sensor-State-Support.md
# Sensor State Support
### Introduction

2
doc/Developing/Style-Guidelines.md
View File

@ -1,3 +1,4 @@
source: Developing/Style-Guidelines.md
# Style guidelines
This document is here to help style standards for contributions towards LibreNMS. These aren't strict rules but it is in
@ -59,4 +60,3 @@ $config['dateformat']['mysql']['compact'] = "%Y-%m-%d %H:%i:%s";
$config['dateformat']['mysql']['date'] = "%Y-%m-%d";
$config['dateformat']['mysql']['time'] = "%H:%i:%s";
```

1
doc/Developing/Using-Git.md
View File

@ -1,3 +1,4 @@
source: Developing/Using-Git.md
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.

1
doc/Extensions/Alerting.md
View File

@ -1,3 +1,4 @@
source: Extensions/Alerting.md
Table of Content:
- [About](#about)

1
doc/Extensions/Applications.md
View File

@ -1,3 +1,4 @@
source: Extensions/Applications.md
Applications
------------
You can use Application support to graph performance statistics from many applications.

1
doc/Extensions/Authentication.md
View File

@ -1,3 +1,4 @@
source: Extensions/Authentication.md
# Authentication modules
LibreNMS supports multiple authentication modules along with [Two Factor Auth](http://docs.librenms.org/Extensions/Two-Factor-Auth/).

1
doc/Extensions/Auto-Discovery.md
View File

@ -1,3 +1,4 @@
source: Extensions/Auto-Discovery.md
# Auto discovery support
### Getting started with auto discovery.

1
doc/Extensions/Billing-Module.md
View File

@ -1,3 +1,4 @@
source: Extensions/Billing-Module.md
# Billing Module
With the billing module you can create a bill, assign a quota to it and add ports to it.

2
doc/Extensions/Component.md
View File

@ -1,3 +1,4 @@
source: Extensions/Component.md
Table of Content:
- [About](#about)
@ -305,4 +306,3 @@ To see an example of how the component module can used, please see the following
- includes/polling/cisco-otv.inc.php
- html/includes/graphs/device/cisco-otv-mac.inc.php
- html/pages/routing/cisco-otv.inc.php

1
doc/Extensions/Dell-OpenManage.md
View File

@ -1,3 +1,4 @@
source: Extensions/Dell-OpenManage.md
Dell OpenManage Support
-----------------------

1
doc/Extensions/Device-Groups.md
View File

@ -1,3 +1,4 @@
source: Extensions/Device-Groups.md
# Device Groups
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
doc/Extensions/Distributed-Poller.md
View File

@ -1,3 +1,4 @@
source: Extensions/Distributed-Poller.md
# Distributed Poller
LibreNMS has the ability to distribute polling of devices to other machines.

2
doc/Extensions/Email-Alerting.md
View File

@ -1,4 +1,4 @@
source: Extensions/Email-Alerting.md
### **This page is deprecated**
#### Please see [The new alerting docs](http://docs.librenms.org/Extensions/Alerting/#transports-email)

3
doc/Extensions/Globe-Frontpage.md
View File

@ -1,3 +1,4 @@
source: Extensions/Globe-Frontpage.md
# Globe Frontpage Configuration
LibreNMS comes with a configurable geochart based frontpage to visualize where your gear is located geographically.
@ -65,5 +66,3 @@ You can use any of these config-parameters to adjust some aspects of it:
- `$config['frontpage_globe']['markers']` is used to change what is being shown on the Markers of the map. It can be either `devices` or `ports`
- `$config['frontpage_globe']['region']` defines the Region to chart. Any region supported by Google's GeoChart API is allowed (https://developers.google.com/chart/interactive/docs/gallery/geochart#continent-hierarchy-and-codes)
- `$config['frontpage_globe']['resolution']` can be 'countries', 'provinces' or 'metros' (latter two are mostly US only due to google-limits).

1
doc/Extensions/Graylog.md
View File

@ -1,3 +1,4 @@
source: Extensions/Graylog.md
# 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

3
doc/Extensions/IRC-Bot-Extensions.md
View File

@ -1,3 +1,4 @@
source: Extensions/IRC-Bot-Extensions.md
# Quick Guide
Okay this is a very quick walk-through in writing own `commands` for the IRC-Bot.
@ -77,4 +78,4 @@ Attribute | Type | Description
...
$config['irc_external'][] = "join-ng";
...
```
```

1
doc/Extensions/IRC-Bot.md
View File

@ -1,3 +1,4 @@
source: Extensions/IRC-Bot.md
Table of Content:
- [About](#about)
- [Configuration](#config)

1
doc/Extensions/InfluxDB.md
View File

@ -1,3 +1,4 @@
source: Extensions/InfluxDB.md
# Enabling support for InfluxDB.
Before we get started it is important that you know and understand that InfluxDB support is currently alpha at best.

1
doc/Extensions/Interface-Description-Parsing.md
View File

@ -1,3 +1,4 @@
source: Extensions/Interface-Description-Parsing.md
Table of Content:
- [About](#about)
- [Setup](#setup)

1
doc/Extensions/MIB-based-polling.md
View File

@ -1,3 +1,4 @@
source: Extensions/MIB-based-polling.md
## WARNING ##
MIB-based polling is experimental. It might overload your LibreNMS server,

1
doc/Extensions/Memcached.md
View File

@ -1,3 +1,4 @@
source: Extensions/Memcached.md
# Memcached
LibreNMS can store SQL results in memcached to achieve performance advantages of in-memory value storage and removing work load for frequent queries off the MySQL backend.

1
doc/Extensions/Network-Map.md
View File

@ -1,3 +1,4 @@
source: Extensions/Network-Map.md
# Network Map
## LibreNMS has the ability to show you a network map based on:

1
doc/Extensions/Oxidized.md
View File

@ -1,3 +1,4 @@
source: Extensions/Oxidized.md
# Oxidized integration
You can integrate LibreNMS with [Oxidized](https://github.com/ytti/oxidized-web) in two ways:

3
doc/Extensions/Plugin-System.md
View File

@ -1,3 +1,4 @@
source: Extensions/Plugin-System.md
# Developing for the Plugin System
This documentation will hopefully give you a basis for how to write a plugin for LibreNMS.
@ -58,4 +59,4 @@ This would then add the name and a link to your plugin.
The following system hooks are currently available:
menu()
* This is called to build the plugin menu system and you can use this to link to your plugin (you don't have to).
* This is called to build the plugin menu system and you can use this to link to your plugin (you don't have to).

2
doc/Extensions/Poller-Service.md
View File

@ -1,3 +1,4 @@
source: Extensions/Poller-Service.md
# Poller Service
# WARNING: THIS IS HIGHLY EXPERIMENTAL AND MAY NOT WORK
@ -38,4 +39,3 @@ An upstart configuration file can be found in `scripts/librenms-poller-service.c
An LSB init script can be found in `scripts/librenms-poller-service.init`. To install run `cp /opt/librenms/scripts/librenms-poller-service.init /etc/init.d/librenms-poller-service && update-rc.d librenms-poller-service defaults`.
### systemd
A systemd unit file can be found in `scripts/librenms-poller-service.init`. To install run `cp /opt/librenms/scripts/librenms-poller-service.service /etc/systemd/system/librenms-poller-service.service && systemctl enable librenms-poller-service.service`.

1
doc/Extensions/Port-Description-Parser.md
View File

@ -1,3 +1,4 @@
source: Extensions/Port-Description-Parser.md
# Configuring interface descriptions for parsing.
LibreNMS includes the ability to parse your interface descriptions for set information to display and segment in the WebUI.

1
doc/Extensions/Proxmox.md
View File

@ -1,3 +1,4 @@
source: Extensions/Proxmox.md
# 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.

1
doc/Extensions/RRDCached.md
View File

@ -1,3 +1,4 @@
source: Extensions/RRDCached.md
# Setting up RRDCached
This document will explain how to setup RRDCached for LibreNMS.

1
doc/Extensions/RRDTune.md
View File

@ -1,3 +1,4 @@
source: Extensions/RRDTune.md
# 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

3
doc/Extensions/SNMP-Proxy.md
View File

@ -1,3 +1,4 @@
source: Extensions/SNMP-Proxy.md
# 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.
@ -25,5 +26,3 @@ On ```unreachable.example.com```:
You can now poll community ```private``` on ```unreachable.example.com``` via community ```unreachable``` on host ```hereweare.example.com```. Please note that requests on ```unreachable.example.com``` will be coming from ```hereweare.example.com```, not your poller.

2
doc/Extensions/SNMP-Trap-Handler.md
View File

@ -1,3 +1,4 @@
source: Extensions/SNMP-Trap-Handler.md
# SNMP trap handling
Currently, librenms only supports port up/down SNMP traps. Traps are handled via snmptrapd.
@ -13,4 +14,3 @@ traphandle default /opt/librenms/snmptrap.php
```
Along with any necessary configuration to receive the traps from your devices (community, etc.)

1
doc/Extensions/Services.md
View File

@ -1,3 +1,4 @@
source: Extensions/Services.md
# Setting up Services
Services within LibreNMS provides the ability to use Nagios plugins to perform additional monitoring outside of SNMP.

1
doc/Extensions/Smokeping.md
View File

@ -1,3 +1,4 @@
source: Extensions/Smokeping.md
# Smokeping integration
We currently have two ways to use Smokeping with LibreNMS, the first is using the included script generator to generate the config for Smokeping. The

1
doc/Extensions/Sub-Directory.md
View File

@ -1,3 +1,4 @@
source: Extensions/Sub-Directory.md
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
(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
doc/Extensions/Syslog.md
View File

@ -1,3 +1,4 @@
source: Extensions/Syslog.md
# Setting up syslog support
This document will explain how to send syslog data to LibreNMS.

2
doc/Extensions/Two-Factor-Auth.md
View File

@ -1,3 +1,4 @@
source: Extensions/Two-Factor-Auth.md
Table of Content:
- [About](#about)
- [Types](#types)
@ -68,4 +69,3 @@ Usage:
- Create a key like described above
- Scan provided QR or click on 'Manual' and type down the Secret
- On next login, enter the passcode that the App provides

1
doc/Extensions/Varnish.md
View File

@ -1,3 +1,4 @@
source: Extensions/Varnish.md
# Varnish Installation Guide #
This document explains how to install Varnish Reverse Proxy for LibreNMS.

3
doc/General/Acknowledgement.md
View File

@ -1,3 +1,4 @@
source: General/Acknowledgement.md
LibreNMS 3rd party acknowledgements
-----------------------------------
@ -36,5 +37,3 @@ LibreNMS 3rd party acknowledgements
- overLIB (html/js/overlib_mini.js): modified Artistic 1.0?
- scripts/*/mysql: GPLv2 only
- check_mk (scripts/check_mk*): GPLv2

2
doc/General/Callback-Stats-and-Privacy.md
View File

@ -1,3 +1,4 @@
source: General/Callback-Stats-and-Privacy.md
## 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.
@ -30,4 +31,3 @@ Hopefully this answers the questions you might have on why and what we are doing
#### How do I enable stats submission? ####
If you're happy with all of this - please consider switching the call back system on, you can do this within the About LibreNMS page within your control panel. In the Statistics section you will find a toggle switch to enable / disable the feature. If you've previously had it switched on and want to opt out and remove your data, click the 'Clear remote stats' button and on the next submission all the data you've sent us will be removed!

1
doc/General/Changelog.md
View File

@ -1,3 +1,4 @@
source: General/Changelog.md
### July 2016
#### Bug fixes

1
doc/General/Contributing.md
View File

@ -1,3 +1,4 @@
source: General/Contributing.md
All contributors to LibreNMS retain copyright to their own code and are not
required to sign over their rights to any other party.

2
doc/General/Credits.md
View File

@ -1,3 +1,4 @@
source: General/Credits.md
LibreNMS is a fork of the last GPL-licensed revision of Observium.
http://observium.org/
Copyright 2006-2012 Adam Armstrong <adama@memetic.org>.
@ -55,4 +56,3 @@ Other components (needs details filled in):
- check_mk (scripts/observium_agent*): GPLv2
- qTip (html/css/jquery.qtip.min.css and html/js/qtip/jquery.qtip.min.js): GPLv2

1
doc/General/Updating.md
View File

@ -1,3 +1,4 @@
source: General/Updating.md
## Updating your install ##
If you would like to perform a manual update

2
doc/General/Welcome-to-Observium-users.md
View File

@ -1,3 +1,4 @@
source: General/Welcome-to-Observium-users.md
Welcome to Observium users
--------------------------
@ -72,4 +73,3 @@ Reasons why you might want to use LibreNMS instead of Observium:
"LibreNMS issue database at GitHub"
[10]: https://vlan50.com/2015/04/17/migrating-from-observium-to-librenms/
"Migrating from Observium to LibreNMS"

1
doc/Installation/CentOS-image.md
View File

@ -1,3 +1,4 @@
source: Installation/CentOS-image.md
> NOTE: We highly advice that you change all passwords on this image when you deploy it!!
> NOTE: Read the above note again!

1
doc/Installation/Installation-(Debian-Ubuntu).md
View File

@ -1 +1,2 @@
source: Installation/Installation-(Debian-Ubuntu).md
<meta http-equiv="refresh" content="0; url=/Installation/Installation-Ubuntu-1604-Apache/" />

1
doc/Installation/Installation-(RHEL-CentOS).md
View File

@ -1 +1,2 @@
source: Installation/Installation-(RHEL-CentOS).md
<meta http-equiv="refresh" content="0; url=/Installation/Installation-CentOS-7-Apache/" />

1
doc/Installation/Installation-CentOS-6-Apache-Nginx.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-CentOS-6-Apache-Nginx.md
NOTE: What follows is a very rough list of commands. This works on a fresh install of CentOS 6.x.
NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to all shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s`.

1
doc/Installation/Installation-CentOS-7-Apache.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-CentOS-7-Apache.md
> NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to the shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s` or `sudo -i`.
### DB Server ###

1
doc/Installation/Installation-CentOS-7-Nginx.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-CentOS-7-Nginx.md
> NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to the shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s` or `sudo -i`.
### DB Server ###

1
doc/Installation/Installation-Ubuntu-1404-Apache.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-Ubuntu-1404-Apache.md
> NOTE: These instructions have been tested on a fresh install of Ubuntu 12.04 and 14.04.

1
doc/Installation/Installation-Ubuntu-1404-Lighttpd.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-Ubuntu-1404-Lighttpd.md
> NOTE: What follows is a very rough list of commands. I have taken the INSTALL.md and modified it for Lighttpd on Debian 7
> NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to all shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s`.

1
doc/Installation/Installation-Ubuntu-1404-Nginx.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-Ubuntu-1404-Nginx.md
> NOTE: These instructions have been tested on a fresh install of Ubuntu 12.04 and 14.04.

1
doc/Installation/Installation-Ubuntu-1604-Apache.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-Ubuntu-1604-Apache.md
> NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to the shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s` or `sudo -i`.
### DB Server ###

1
doc/Installation/Installation-Ubuntu-1604-Nginx.md
View File

@ -1,3 +1,4 @@
source: Installation/Installation-Ubuntu-1604-Nginx.md
> NOTE: These instructions assume you are the root user. If you are not, prepend `sudo` to the shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s` or `sudo -i`.
### DB Server ###

1
doc/Installation/Installing-LibreNMS.md
View File

@ -1,3 +1,4 @@
source: Installation/Installing-LibreNMS.md
# Installing LibreNMS
We have some pre-built VirtualBox images you can use to get started:

1
doc/Installation/Migrating-from-Observium.md
View File

@ -1,3 +1,4 @@
source: Installation/Migrating-from-Observium.md
## Migrating from Observium to LibreNMS
A LibreNMS user, [Dan](https://twitter.com/thedanbrown), has kindly provided full details and scripts to be able to migrate from Observium to LibreNMS.

1
doc/Installation/Ubuntu-image.md
View File

@ -1,3 +1,4 @@
source: Installation/Ubuntu-image.md
> NOTE: We highly advice that you change all passwords on this image when you deploy it!!
> NOTE: Read the above note again!

1
doc/Support/Configuration.md
View File

@ -1,3 +1,4 @@
source: Support/Configuration.md
The options shown below also contain the default values.
If you would like to alter any of these then please add your config option to `config.php`.

1
doc/Support/Discovery Support.md
View File

@ -1,3 +1,4 @@
source: Support/Discovery Support.md
### discovery.php
This document will explain how to use discovery.php to debug issues or manually running to process data.

1
doc/Support/FAQ.md
View File

@ -1,3 +1,4 @@
source: Support/FAQ.md
### Getting started
- [How do I install LibreNMS?](#faq1)
- [How do I add a device?](#faq2)

1
doc/Support/Features.md
View File

@ -1,3 +1,4 @@
source: Support/Features.md
### Features
Here's a brief list of supported features, some might be missing.

1
doc/Support/Install Validation.md
View File

@ -1,3 +1,4 @@
source: Install Validation.md
Install validation
------------------

3
doc/Support/Performance.md
View File

@ -1,3 +1,4 @@
source: Support/Performance.md
# Performance optimisations
This document will give you some guidance on optimising your setup.
@ -57,5 +58,3 @@ The default 16 threads that `poller-wrapper.py` runs as isn't necessarily the op
If your install uses hostnames for devices and you have quite a lot then it's advisable to setup a local recursive dns instance on the
LibreNMS server. Something like pdns-recursor can be used and then configure `/etc/resolv.conf` to use 127.0.0.1 for queries.

1
doc/Support/Poller Support.md
View File

@ -1,3 +1,4 @@
source: Support/Poller Support.md
### poller.php
This document will explain how to use poller.php to debug issues or manually running to process data.

1
doc/Support/Support-New-OS.md
View File

@ -1,3 +1,4 @@
source: Support/Support-New-OS.md
This document will explain how to add basic and full support for a new OS. **Some knowledge in PHP is needed for the full support.**

3
doc/index.md
View File

@ -1,3 +1,4 @@
source: index.md
### Welcome to the LibreNMS docs
Some of these docs are work in progress or may be missing configuration examples for varying distros.
@ -11,5 +12,3 @@ The docs should provide you with information on various elements to the software
- [Contributing to LibreNMS](http://docs.librenms.org/General/Contributing/)
- Developing for LibreNMS
- Available extensions (features)