Documentation cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections (#13018)

* TOC cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections
This commit is contained in:
rhinoau
2021-07-10 03:34:01 +08:00
committed by GitHub
parent fbf653f02e
commit 02c2cd47b3
31 changed files with 403 additions and 389 deletions

View File

@@ -1,8 +1,7 @@
source: Extensions/IRC-Bot.md
path: blob/master/doc/
[TOC]
# About
# IRC Bot
LibreNMS has an easy to use IRC-Interface for basic tasks like viewing
last log-entry, current device/port status and such.
@@ -40,7 +39,7 @@ Option | Default-Value | Notes
`$config['irc_ctcp_version']` | `LibreNMS IRCbot. https://www.librenms.org/` | Optional; Reply-string to CTCP VERSION requests
`$config['irc_auth']` | | Optional; Array of hostmasks that are automatically authenticated.
### IRC-Commands
## IRC-Commands
Command | Description
--- | ---
@@ -59,9 +58,9 @@ Command | Description
( __/!\\__ All commands are case-_insensitive_ but their arguments are case-_sensitive_)
# Examples
## Examples
## Server examples
### Server examples
Unencrypted Connection to `irc.freenode.org`:
@@ -91,7 +90,7 @@ SSL-Encrypted Connection to `irc.localdomain` with Server-Password and odd port:
...
```
## Channel notations
### Channel notations
Channels can be defined using Array-Notation like:
@@ -111,7 +110,7 @@ Or using a single string using `,` as delimiter between various channels:
...
```
## Hostmask authentication
### Hostmask authentication
```php
...
@@ -126,7 +125,7 @@ be authenticated as the "admin" user in LibreNMS, and clients matching
the last line will be authenticated as the user "john" in LibreNMS,
without using .auth and a waiting for a valid token.
# Extensions?!
## Extensions?!
The bot is coded in a unified way.
This makes writing extensions by far less painful.
@@ -161,7 +160,7 @@ File: includes/ircbot/echo.inc.php
}
```
# Systemd start up script
## Systemd start up script
Basic systemd start up script to be placed in /etc/systemd/system/ to
start irc service at boot.