Skip to content
Permalink
Browse files

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
  • Loading branch information...
laf committed Oct 27, 2018
1 parent c37786d commit 1ee2e8e0e0c647f4c60a20accb42cdc90541af5f
Showing with 296 additions and 149 deletions.
  1. +1 −1 .travis.yml
  2. +1 −0 doc/API/ARP.md
  3. +1 −0 doc/API/Alerts.md
  4. +1 −0 doc/API/Bills.md
  5. +1 −0 doc/API/DeviceGroups.md
  6. +1 −0 doc/API/Devices.md
  7. +1 −0 doc/API/Inventory.md
  8. +1 −0 doc/API/Logs.md
  9. +1 −0 doc/API/PortGroups.md
  10. +1 −0 doc/API/Ports.md
  11. +1 −0 doc/API/Routing.md
  12. +1 −0 doc/API/Services.md
  13. +1 −0 doc/API/Switching.md
  14. +1 −0 doc/API/System.md
  15. +1 −0 doc/API/index.md
  16. +1 −0 doc/Alerting/Creating-Transport.md
  17. +1 −0 doc/Alerting/Device-Dependencies.md
  18. +1 −0 doc/Alerting/Entities.md
  19. +1 −0 doc/Alerting/Introduction.md
  20. +1 −0 doc/Alerting/Macros.md
  21. +1 −0 doc/Alerting/Old_Templates.md
  22. +1 −0 doc/Alerting/Rules.md
  23. +1 −0 doc/Alerting/Templates.md
  24. +1 −0 doc/Alerting/Testing.md
  25. +1 −0 doc/Alerting/Transports.md
  26. +1 −0 doc/Alerting/index.md
  27. +1 −0 doc/Developing/Code-Guidelines.md
  28. +1 −0 doc/Developing/Code-Structure.md
  29. +1 −0 doc/Developing/Creating-Documentation.md
  30. +1 −0 doc/Developing/Creating-Release.md
  31. +1 −0 doc/Developing/Dynamic-Config.md
  32. +1 −0 doc/Developing/Licensing.md
  33. +1 −0 doc/Developing/Merging-Pull-Requests.md
  34. +1 −0 doc/Developing/SNMP-Traps.md
  35. +1 −0 doc/Developing/Sensor-State-Support.md
  36. +1 −0 doc/Developing/Style-Guidelines.md
  37. +1 −0 doc/Developing/Support-New-OS.md
  38. +1 −0 doc/Developing/Using-Git.md
  39. +1 −0 doc/Developing/Validating-Code.md
  40. +1 −0 doc/Developing/index.md
  41. +1 −0 doc/Developing/os/Custom-Graphs.md
  42. +1 −0 doc/Developing/os/Health-Information.md
  43. +1 −0 doc/Developing/os/Initial-Detection.md
  44. +1 −0 doc/Developing/os/Mem-CPU-Information.md
  45. +1 −0 doc/Developing/os/Settings.md
  46. +1 −0 doc/Developing/os/Test-Units.md
  47. +1 −0 doc/Developing/os/Wireless-Sensors.md
  48. +1 −0 doc/Extensions/Agent-Setup.md
  49. +1 −0 doc/Extensions/Alerting.md
  50. +1 −0 doc/Extensions/Applications.md
  51. +1 −0 doc/Extensions/Authentication.md
  52. +1 −0 doc/Extensions/Auto-Discovery.md
  53. +1 −0 doc/Extensions/Billing-Module.md
  54. +1 −0 doc/Extensions/Component.md
  55. +1 −0 doc/Extensions/Dashboards.md
  56. +1 −0 doc/Extensions/Dell-OpenManage.md
  57. +1 −0 doc/Extensions/Device-Groups.md
  58. +1 −0 doc/Extensions/Distributed-Poller.md
  59. +1 −0 doc/Extensions/Fast-Ping-Check.md
  60. +1 −0 doc/Extensions/Gateone.md
  61. +1 −0 doc/Extensions/Graylog.md
  62. +1 −0 doc/Extensions/IRC-Bot-Extensions.md
  63. +1 −0 doc/Extensions/IRC-Bot.md
  64. +1 −0 doc/Extensions/Interface-Description-Parsing.md
  65. +1 −0 doc/Extensions/MIB-based-polling.md
  66. +1 −0 doc/Extensions/Metric-Storage.md
  67. +1 −0 doc/Extensions/NFSen.md
  68. +1 −0 doc/Extensions/Network-Map.md
  69. +1 −0 doc/Extensions/Oxidized.md
  70. +1 −0 doc/Extensions/PeeringDB.md
  71. +1 −0 doc/Extensions/Plugin-System.md
  72. +1 −0 doc/Extensions/Poller-Service.md
  73. +1 −0 doc/Extensions/Proxmox.md
  74. +1 −0 doc/Extensions/RRDCached-Security.md
  75. +1 −0 doc/Extensions/RRDCached.md
  76. +1 −0 doc/Extensions/RRDTune.md
  77. +1 −0 doc/Extensions/Rancid.md
  78. +1 −0 doc/Extensions/SNMP-Proxy.md
  79. +1 −0 doc/Extensions/SNMP-Trap-Handler.md
  80. +1 −0 doc/Extensions/Services.md
  81. +1 −0 doc/Extensions/Smokeping.md
  82. +1 −0 doc/Extensions/Sub-Directory.md
  83. +1 −0 doc/Extensions/Syslog.md
  84. +1 −0 doc/Extensions/Two-Factor-Auth.md
  85. +1 −0 doc/Extensions/Varnish.md
  86. +1 −0 doc/Extensions/Weathermap.md
  87. +1 −0 doc/Extensions/World-Map.md
  88. +1 −0 doc/Extensions/metrics/Graphite.md
  89. +1 −0 doc/Extensions/metrics/InfluxDB.md
  90. +1 −0 doc/Extensions/metrics/OpenTSDB.md
  91. +1 −0 doc/Extensions/metrics/Prometheus.md
  92. +2 −0 doc/General/Acknowledgement.md
  93. +1 −0 doc/General/CODE_OF_CONDUCT.md
  94. +1 −0 doc/General/Callback-Stats-and-Privacy.md
  95. +1 −0 doc/General/Contributing.md
  96. +1 −0 doc/General/Credits.md
  97. +1 −0 doc/General/Releases.md
  98. +1 −0 doc/General/Security.md
  99. +1 −0 doc/General/Updating.md
  100. +1 −0 doc/General/Welcome-to-Observium-users.md
  101. +1 −0 doc/Installation/CentOS-image.md
  102. +1 −0 doc/Installation/Installation-(Debian-Ubuntu).md
  103. +1 −0 doc/Installation/Installation-(RHEL-CentOS).md
  104. +1 −0 doc/Installation/Installation-CentOS-6-Apache-Nginx.md
  105. +1 −0 doc/Installation/Installation-CentOS-7-Apache.md
  106. +1 −0 doc/Installation/Installation-CentOS-7-Nginx.md
  107. +1 −0 doc/Installation/Installation-Ubuntu-1404-Apache.md
  108. +1 −0 doc/Installation/Installation-Ubuntu-1404-Lighttpd.md
  109. +1 −0 doc/Installation/Installation-Ubuntu-1404-Nginx.md
  110. +1 −0 doc/Installation/Installation-Ubuntu-1604-Apache.md
  111. +1 −0 doc/Installation/Installation-Ubuntu-1604-Nginx.md
  112. +1 −0 doc/Installation/Installation-Ubuntu-1804-Apache.md
  113. +1 −0 doc/Installation/Installation-Ubuntu-1804-Nginx.md
  114. +1 −0 doc/Installation/Migrating-from-Observium.md
  115. +1 −0 doc/Installation/Ubuntu-image.md
  116. +1 −0 doc/Installation/index.md
  117. +1 −0 doc/Support/1-Minute-Polling.md
  118. +1 −0 doc/Support/Adding-a-Device.md
  119. +1 −0 doc/Support/CLI-Tools.md
  120. +1 −0 doc/Support/Cleanup-options.md
  121. +1 −0 doc/Support/Configuration.md
  122. +1 −0 doc/Support/Device-Notes/Carel-pCOweb-Devices.md
  123. +1 −0 doc/Support/Device-Notes/index.md
  124. +1 −0 doc/Support/Device-Sensors.md
  125. +1 −0 doc/Support/Device-Troubleshooting.md
  126. +1 −0 doc/Support/Discovery Support.md
  127. +1 −0 doc/Support/Environment-Variables.md
  128. +1 −0 doc/Support/Example-Hardware-Setup.md
  129. +1 −0 doc/Support/FAQ.md
  130. +1 −0 doc/Support/Features.md
  131. +1 −0 doc/Support/Install Validation.md
  132. +1 −0 doc/Support/Performance.md
  133. +1 −0 doc/Support/Poller Support.md
  134. +1 −0 doc/Support/Remote-Monitoring-VPN.md
  135. +1 −0 doc/Support/SNMP-Configuration-Examples.md
  136. +1 −0 doc/Support/SSL-Configuration.md
  137. +1 −0 doc/Support/Support-New-OS.md
  138. +1 −0 doc/Support/index.md
  139. +60 −81 doc/index.md
  140. +50 −25 doc/librenms.css
  141. +13 −28 mkdocs.yml
  142. +8 −13 scripts/deploy-docs.sh
  143. +26 −1 tests/DocsTest.php
@@ -27,7 +27,7 @@ cache:

before_install:
- 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;'
- cp tests/config/config.test.php config.php

@@ -1,4 +1,5 @@
source: API/ARP.md
path: blob/master/doc/

### `list_arp`

@@ -1,4 +1,5 @@
source: API/Alerts.md
path: blob/master/doc/

### `get_alert`

@@ -1,4 +1,5 @@
source: API/Bills.md
path: blob/master/doc/

### `list_bills`

@@ -1,4 +1,5 @@
source: API/DeviceGroups.md
path: blob/master/doc/

### `get_devicegroups`

@@ -1,4 +1,5 @@
source: API/Devices.md
path: blob/master/doc/

### `del_device`

@@ -1,4 +1,5 @@
source: API/Inventory.md
path: blob/master/doc/

### `get_inventory`

@@ -1,4 +1,5 @@
source: API/Logs.md
path: blob/master/doc/

All the `list_*logs` calls are aliased to `list_logs`.

@@ -1,4 +1,5 @@
source: API/PortGroups.md
path: blob/master/doc/

### `get_graph_by_portgroup`

@@ -1,4 +1,5 @@
source: API/Devices.md
path: blob/master/doc/

### `get_all_ports`

@@ -1,4 +1,5 @@
source: API/Routing.md
path: blob/master/doc/

### `list_bgp`

@@ -1,4 +1,5 @@
source: API/Services.md
path: blob/master/doc/

### `list_services`

@@ -1,4 +1,5 @@
source: API/Switching.md
path: blob/master/doc/

### `list_vlans`

@@ -1,4 +1,5 @@
source: API/System.md
path: blob/master/doc/

### `system`

@@ -1,4 +1,5 @@
source: API/index.md
path: blob/master/doc/

## Versioning

@@ -1,4 +1,5 @@
source: Alerting/Creating-Transport.md
path: blob/master/doc/

# Creating a new Transport.

@@ -1,4 +1,5 @@
source: Alerting/Device-Dependencies.md
path: blob/master/doc/

# Device Dependencies

@@ -1,4 +1,5 @@
source: Alerting/Entities.md
path: blob/master/doc/

# Entities

@@ -1,4 +1,5 @@
source: Alerting/Introduction.md
path: blob/master/doc/

# Introduction

@@ -1,4 +1,5 @@
source: Alerting/Macros.md
path: blob/master/doc/

# Macros

@@ -1,4 +1,5 @@
source: Alerting/Templates.md
path: blob/master/doc/

# Templates

@@ -1,4 +1,5 @@
source: Alerting/Rules.md
path: blob/master/doc/

# Rules
Rules are defined using a logical language.
@@ -1,4 +1,5 @@
source: Alerting/Templates.md
path: blob/master/doc/

# Templates

@@ -1,4 +1,5 @@
source: Alerting/Testing.md
path: blob/master/doc/

### Rules

@@ -1,4 +1,5 @@
source: Alerting/Transports.md
path: blob/master/doc/

# Transports

@@ -1,4 +1,5 @@
source: Alerting/index.md
path: blob/master/doc/

# About

@@ -1,4 +1,5 @@
source: Developing/Code-Guidelines.md
path: blob/master/doc/
# 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.
@@ -1,4 +1,5 @@
source: Developing/Code-Structure.md
path: blob/master/doc/
# 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.
@@ -1,4 +1,5 @@
source: Developing/Creating-Documentation.md
path: blob/master/doc/
# 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.
@@ -1,4 +1,5 @@
source: Developing/Creating-Release.md
path: blob/master/doc/
# Creating a release

### GitHub
@@ -1,4 +1,5 @@
source: Developing/Dynamic-Config.md
path: blob/master/doc/
# 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,4 +1,5 @@
## Contributor Agreement
path: blob/master/doc/

By contributing code to LibreNMS (whether by a GitHub pull request, or by
any other means), you assert that:
@@ -1,4 +1,5 @@
source: Developing/Merging-Pull-Requests.md
path: blob/master/doc/
# Merging Pull Requests

### GitHub
@@ -1,4 +1,5 @@
source: Developing/SNMP-Traps.md
path: blob/master/doc/

# Creating snmp trap handlers

@@ -1,4 +1,5 @@
source: Developing/Sensor-State-Support.md
path: blob/master/doc/
# Sensor State Support

### Introduction
@@ -1,4 +1,5 @@
source: Developing/Style-Guidelines.md
path: blob/master/doc/
# Style guidelines

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
path: blob/master/doc/

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.
@@ -1,4 +1,5 @@
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.

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
path: blob/master/doc/

#### Validating Code

@@ -1,4 +1,5 @@
source: General/index.md
path: blob/master/doc/

# Copyright and Licensing
All contributors to LibreNMS retain copyright to their own code and are not
@@ -1,4 +1,5 @@
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`:
```php
@@ -1,4 +1,5 @@
source: Developing/os/Health-Information.md
path: blob/master/doc/

#### Sensors

@@ -1,4 +1,5 @@
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.

@@ -1,4 +1,5 @@
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.

@@ -1,4 +1,5 @@
source: os/Settings.md
path: blob/master/doc/
# Optional OS Settings

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
path: blob/master/doc/

# Tests

@@ -1,4 +1,5 @@
source: Developing/os/Wireless-Sensors.md
path: blob/master/doc/

This document will guide you through adding wireless sensors for your new wireless device.

@@ -1,4 +1,5 @@
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 extended to include data about [applications](Applications.md) on the remote system.
@@ -1,2 +1,3 @@
source: Extensions/Alerting.md
path: blob/master/doc/
<meta http-equiv="refresh" content="0; url=/Alerting/Alerting/" />
@@ -1,4 +1,5 @@
source: Extensions/Applications.md
path: blob/master/doc/
## Introduction

You can use Application support to graph performance statistics of many applications.
@@ -1,4 +1,5 @@
source: Extensions/Authentication.md
path: blob/master/doc/
# Authentication modules

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
path: blob/master/doc/
# Auto Discovery Support

### Getting Started
@@ -1,4 +1,5 @@
source: Extensions/Billing-Module.md
path: blob/master/doc/
# Billing Module

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
path: blob/master/doc/

# About

@@ -1,4 +1,5 @@
source: Extensions/Dashboards.md
path: blob/master/doc/

# Dashboards
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
path: blob/master/doc/

# Dell OpenManage Support
-----------------------
@@ -1,4 +1,5 @@
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.

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

@@ -1,4 +1,5 @@
source: Extensions/Fast-Ping-Check.md
path: blob/master/doc/

## Fast up/down checking

@@ -1,4 +1,5 @@
source: Extensions/Gateone.md
path: blob/master/doc/
# 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)
@@ -1,4 +1,5 @@
source: Extensions/Graylog.md
path: blob/master/doc/
# 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
@@ -1,4 +1,5 @@
source: Extensions/IRC-Bot-Extensions.md
path: blob/master/doc/
# Quick Guide

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
path: blob/master/doc/
[TOC]

# About
@@ -1,4 +1,5 @@
source: Extensions/Interface-Description-Parsing.md
path: blob/master/doc/
## About
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
@@ -1,4 +1,5 @@
source: Extensions/MIB-based-polling.md
path: blob/master/doc/
## WARNING ##

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
path: blob/master/doc/
hide_toc: true

### Metric storage

0 comments on commit 1ee2e8e

Please sign in to comment.
You can’t perform that action at this time.