From 9bbe8f1d1dd55691cceddbef7c34da0fde04bebd Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Wed, 1 May 2024 14:57:29 +0200 Subject: [PATCH] update README --- README.md | 33 +++++++++++---------------------- 1 file changed, 11 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index fc2147c..3eb69f1 100644 --- a/README.md +++ b/README.md @@ -148,8 +148,7 @@ Image: librenms/librenms:latest ### Dispatcher service -> **Warning** -> +> [!WARNING] > Only used if you enable and run a [sidecar dispatcher container](#dispatcher-service-container). * `SIDECAR_DISPATCHER`: Set to `1` to enable sidecar dispatcher mode for this container (default `0`) @@ -158,16 +157,14 @@ Image: librenms/librenms:latest ### Syslog-ng -> **Warning** -> +> [!WARNING] > Only used if you enable and run a [sidecar syslog-ng container](#syslog-ng-container). * `SIDECAR_SYSLOGNG`: Set to `1` to enable sidecar syslog-ng mode for this container (default `0`) ### Snmptrapd -> **Warning** -> +> [!WARNING] > Only used if you enable and run a [sidecar snmptrapd container](#snmptrapd-container). * `SIDECAR_SNMPTRAPD`: Set to `1` to enable sidecar snmptrapd mode for this container (default `0`) @@ -205,8 +202,7 @@ Image: librenms/librenms:latest * `/data`: Contains configuration, plugins, rrd database, logs, additional Monitoring plugins, additional syslog-ng config files -> **Warning** -> +> [!WARNING] > Note that the volume should be owned by the user/group with the specified > `PUID` and `PGID`. If you don't give the volume correct permissions, the > container may not start. @@ -242,8 +238,7 @@ $ docker run -d -p 8000:8000 --name librenms \ librenms/librenms:latest ``` -> **Warning** -> +> [!WARNING] > `db` must be a running MySQL instance. ### First launch @@ -358,8 +353,7 @@ $ docker run -d --name librenms_dispatcher \ librenms/librenms:latest ``` -> **Warning** -> +> [!WARNING] > `librenms` must be a valid volume already attached to a LibreNMS container. ### Syslog-ng container @@ -377,8 +371,7 @@ $ docker run -d --name librenms_syslog \ librenms/librenms:latest ``` -> **Warning** -> +> [!WARNING] > `librenms` must be a valid volume already attached to a LibreNMS container. You have to create a configuration file to enable syslog in LibreNMS too. Create @@ -403,8 +396,7 @@ $ docker run -d --name librenms_snmptrapd \ librenms/librenms:latest ``` -> **Warning** -> +> [!WARNING] > `librenms` must be a valid volume already attached to a LibreNMS container. ### Add a LibreNMS plugin @@ -413,8 +405,7 @@ You can add [plugins for LibreNMS](https://docs.librenms.org/Extensions/Plugin-S in `/data/plugins/`. If you add a plugin that already exists in LibreNMS, it will be removed and yours will be used (except for Weathermap). -> **Warning** -> +> [!WARNING] > Container has to be restarted to propagate changes. ### Additional Monitoring plugins @@ -424,8 +415,7 @@ You can add a custom Monitoring plugin in `/data/monitoring-plugins/`. Some plugins can be found in the [Monitoring Plugins](https://github.com/monitoring-plugins/monitoring-plugins#readme) repo, or in the [unofficial fork for Nagios](https://github.com/nagios-plugins/nagios-plugins#readme). -> **Warning** -> +> [!WARNING] > Container has to be restarted to propagate changes. ### Custom alert templates @@ -433,8 +423,7 @@ repo, or in the [unofficial fork for Nagios](https://github.com/nagios-plugins/n You can add [Laravel alert templates](https://docs.librenms.org/Alerting/Templates/#base-templates) in `/data/alert-templates/`. -> **Warning** -> +> [!WARNING] > Container has to be restarted to propagate changes. ## Contributing