Docs tweaking (#13792)

* Tweak updating page

* Cleanup docs
This commit is contained in:
Jellyfrog
2022-02-16 02:43:48 +01:00
committed by GitHub
parent 7c99599b2a
commit 681c994ca1
8 changed files with 38 additions and 32 deletions

View File

@@ -20,7 +20,7 @@ To update the javascript translation files, run:
./lnms translation:generate
# Definition Format
## Definition Format
For snmp.community, this is the definition:
@@ -59,7 +59,7 @@ types can be defined and implemented in a vue.js component
* `email`: Will validate the input is the correct format for an email
* `password`: Will mask the value of the input (but does not keep it fully private)
# Custom Types
## Custom Types
You may set the type field to a custom type and define a Vue.js component to display it to the user.

View File

@@ -8,7 +8,7 @@ discovery/poller modules.
It provides a status (Nagios convention), the ability to Disable (do
not poll), or Ignore (do not Alert).
# Database Structure
## Database Structure
The database structure contains the component table:
@@ -45,7 +45,7 @@ mysql> select * from component_prefs limit 1;
2 rows in set (0.00 sec)
```
## Reserved Fields
### Reserved Fields
When this data from both the `component` and `component_prefs` tables
is returned in one single consolidated array, there is the potential
@@ -55,7 +55,7 @@ fields of the `component` table are reserved, they cannot be used as
custom attributes, if you update these the module will attempt to
write them to the `component` table, not the `component_prefs` table.
# Using Components
## Using Components
Create an instance of the component class:
@@ -63,7 +63,7 @@ Create an instance of the component class:
$COMPONENT = new LibreNMS\Component();
```
## Retrieving Components
### Retrieving Components
Now you can retrieve an array of the available components:

View File

@@ -17,16 +17,16 @@ For more information see
* It's recommended that all servers be similar in hardware performance, cluster performance can be affected by the slowest server in the cluster.
* Backup the database before starting, and backing up the database regularly is still recommended even in a working cluster environment.
# Install and Configure Galera
## Install and Configure Galera
## Install Galera4 and MariaDB Server
### Install Galera4 and MariaDB Server
These can be obtained from your OS package manager. For example in Ubuntu.
```bash
sudo apt-get install mariadb-server mariadb-client galera-4
```
## Create Galera Config
### Create Galera Config
Create a new file /etc/mysql/conf.d/galera.conf on each node
@@ -58,7 +58,7 @@ Change the following values for your environment.
* wsrep_node_address - IP address of this node.
* wsrep_node_name - Name of this node.
## Edit LibreNMS .env
### Edit LibreNMS .env
LibreNMS supports up to 9 galera nodes, you define these nodes in the .env file. For each node we have the ability to define if this librenms installation/poller is able to write, read or both to that node.
The galera nodes you define here can be the same or differnt for each librenms poller. If you have a poller you only want to write/read to one galera node, you would simply add one DB_HOST, and omit all the rest. This allows you to precisely control what galera nodes a librenms poller is reading and or writing too.
@@ -95,7 +95,7 @@ The above .env on a librenms installation/poller would communicate to each galer
* 192.168.1.38 - Read Only
* 192.168.1.39 - Read Only
## Starting Galera Cluster for the first time.
### Starting Galera Cluster for the first time.
1) Shutdown MariaDB server on ALL nodes.
```bash
@@ -110,7 +110,7 @@ The above .env on a librenms installation/poller would communicate to each galer
sudo systemctl start mariadb-server
```
## Galera Cluster Status
### Galera Cluster Status
To see some stats on how the Galera cluster is preforming run the following.
@@ -132,7 +132,7 @@ SHOW GLOBAL STATUS LIKE 'wsrep_%';
## Restarting the Entire Cluster
### Restarting the Entire Cluster
In a cluster environment, steps should be taken to ensure that ALL nodes are not offline at the same time. Failed nodes can recover without issue as long as one node remains online.
In the event that ALL nodes are offline, the following should be done to ensure you are starting the cluster with the most up-to-date database. To do this login to each node and running the following

View File

@@ -10,7 +10,7 @@ This documentation will give you a basis for writing a plugin for
LibreNMS. An example plugin is included in the LibreNMS distribution.
# Version 2 Plugin System structure
## Version 2 Plugin System structure
Plugins in version 2 need to be installed into app/Plugins
@@ -92,7 +92,7 @@ abstract class DeviceOverviewHook
...
```
# Version 1 Plugin System structure (legacy verion)
## Version 1 Plugin System structure (legacy verion)
Plugins need to be installed into html/plugins
@@ -139,7 +139,7 @@ class Test {
?>
```
# System Hooks
## System Hooks
System hooks are called as functions within your plugin class. The
following system hooks are currently available:

View File

@@ -5,7 +5,7 @@ make it into the software along with the history of the code base we
inherited. It's how we deal with identified vulnerabilities that
should show that we take things seriously.
# Securing your install
## Securing your install
As with any system of this nature, we highly recommend that you
restrict access to the install via a firewall or VPN.
@@ -15,7 +15,7 @@ an SSL certificate such as ones provided by [LetsEncrypt](http://www.letsencrypt
Please ensure you keep your install [up to date](Updating.md).
## Trusted Proxies
### Trusted Proxies
When using a reverse proxy, you may restrict the hosts allowed to forward
headers to LibreNMS. By default this allows all proxies, due to legacy reasons.
@@ -23,7 +23,7 @@ headers to LibreNMS. By default this allows all proxies, due to legacy reasons.
Set APP_TRUSTED_PROXIES in your .env to an empty string or the urls to
the proxies allowed to forward.
# Reporting vulnerabilities
## Reporting vulnerabilities
Like anyone, we appreciate the work people put in to find flaws in
software and welcome anyone to do so with LibreNMS, this will lead to

View File

@@ -26,10 +26,16 @@ php includes/sql-schema/update.php
./validate.php
```
You should continue to run daily.sh. This does database cleanup and
other processes in addition to updating. You can disable the daily.sh
update process as described below.
## Disabling automatic updates
LibreNMS by default performs updates on a daily basis. This can be disabled in the WebUI Global Settings under System -> Updates, or using lnms: `./lnms config:set update false`
LibreNMS by default performs updates on a daily basis.
This can be disabled in the WebUI Global Settings under System -> Updates, or using lnms
!!! warning
You should never remove daily.sh from the cronjob!
This does database cleanup and other processes in addition to updating.
!!! setting "settings/system/updates"
```bash
lnms config:set update false
```

View File

@@ -38,7 +38,7 @@ from snmp.
`-m` This enables you to specify the module you want to run for discovery.
# Discovery wrapper
## Discovery wrapper
We have a `discovery-wrapper.py` script which is based on
`poller-wrapper.py` by [Job Snijders](https://github.com/job). This
@@ -56,7 +56,7 @@ With:
`33 */6 * * * librenms /opt/librenms/discovery.php -h all >> /dev/null 2>&1`
# Discovery config
## Discovery config
These are the default discovery config items. You can globally disable
a module by setting it to 0. If you just want to disable it for one
@@ -189,7 +189,7 @@ device, with history data.
`charge`: APC Charge detection and support.
# Running
## Running
Here are some examples of running discovery from within your install directory.
@@ -199,7 +199,7 @@ Here are some examples of running discovery from within your install directory.
./discovery.php -h localhost -m ports
```
# Debugging
## Debugging
To provide debugging output you will need to run the discovery process
with the `-d` flag. You can do this either against all modules, single

View File

@@ -41,7 +41,7 @@ from snmp.
`-m` This enables you to specify the module you want to run for poller.
# Poller Wrapper
## Poller Wrapper
We have a `poller-wrapper.py` script by [Job
Snijders](https://github.com/job). This script is currently the
@@ -51,7 +51,7 @@ If you need to debug the output of poller-wrapper.py then you can add
`-d` to the end of the command - it is NOT recommended to do this in
cron.
# Poller config
## Poller config
These are the default poller config items. You can globally disable a
module by setting it to 0. If you just want to
@@ -193,7 +193,7 @@ configured to be ignored by config options.
`mib`: Support for generic MIB parsing.
# Running
## Running
Here are some examples of running poller from within your install directory.
@@ -203,7 +203,7 @@ Here are some examples of running poller from within your install directory.
./poller.php -h localhost -m ports
```
# Debugging
## Debugging
To provide debugging output you will need to run the poller process
with the `-d` flag. You can do this either against