Skip to content

Commit 9bbe8f1

Browse files
committed
update README
1 parent caf8468 commit 9bbe8f1

1 file changed

Lines changed: 11 additions & 22 deletions

File tree

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,7 @@ Image: librenms/librenms:latest
148148

149149
### Dispatcher service
150150

151-
> **Warning**
152-
>
151+
> [!WARNING]
153152
> Only used if you enable and run a [sidecar dispatcher container](#dispatcher-service-container).
154153
155154
* `SIDECAR_DISPATCHER`: Set to `1` to enable sidecar dispatcher mode for this container (default `0`)
@@ -158,16 +157,14 @@ Image: librenms/librenms:latest
158157

159158
### Syslog-ng
160159

161-
> **Warning**
162-
>
160+
> [!WARNING]
163161
> Only used if you enable and run a [sidecar syslog-ng container](#syslog-ng-container).
164162
165163
* `SIDECAR_SYSLOGNG`: Set to `1` to enable sidecar syslog-ng mode for this container (default `0`)
166164

167165
### Snmptrapd
168166

169-
> **Warning**
170-
>
167+
> [!WARNING]
171168
> Only used if you enable and run a [sidecar snmptrapd container](#snmptrapd-container).
172169
173170
* `SIDECAR_SNMPTRAPD`: Set to `1` to enable sidecar snmptrapd mode for this container (default `0`)
@@ -205,8 +202,7 @@ Image: librenms/librenms:latest
205202

206203
* `/data`: Contains configuration, plugins, rrd database, logs, additional Monitoring plugins, additional syslog-ng config files
207204

208-
> **Warning**
209-
>
205+
> [!WARNING]
210206
> Note that the volume should be owned by the user/group with the specified
211207
> `PUID` and `PGID`. If you don't give the volume correct permissions, the
212208
> container may not start.
@@ -242,8 +238,7 @@ $ docker run -d -p 8000:8000 --name librenms \
242238
librenms/librenms:latest
243239
```
244240

245-
> **Warning**
246-
>
241+
> [!WARNING]
247242
> `db` must be a running MySQL instance.
248243
249244
### First launch
@@ -358,8 +353,7 @@ $ docker run -d --name librenms_dispatcher \
358353
librenms/librenms:latest
359354
```
360355

361-
> **Warning**
362-
>
356+
> [!WARNING]
363357
> `librenms` must be a valid volume already attached to a LibreNMS container.
364358

365359
### Syslog-ng container
@@ -377,8 +371,7 @@ $ docker run -d --name librenms_syslog \
377371
librenms/librenms:latest
378372
```
379373

380-
> **Warning**
381-
>
374+
> [!WARNING]
382375
> `librenms` must be a valid volume already attached to a LibreNMS container.
383376

384377
You have to create a configuration file to enable syslog in LibreNMS too. Create
@@ -403,8 +396,7 @@ $ docker run -d --name librenms_snmptrapd \
403396
librenms/librenms:latest
404397
```
405398

406-
> **Warning**
407-
>
399+
> [!WARNING]
408400
> `librenms` must be a valid volume already attached to a LibreNMS container.
409401

410402
### Add a LibreNMS plugin
@@ -413,8 +405,7 @@ You can add [plugins for LibreNMS](https://docs.librenms.org/Extensions/Plugin-S
413405
in `/data/plugins/`. If you add a plugin that already exists in LibreNMS, it
414406
will be removed and yours will be used (except for Weathermap).
415407

416-
> **Warning**
417-
>
408+
> [!WARNING]
418409
> Container has to be restarted to propagate changes.
419410

420411
### Additional Monitoring plugins
@@ -424,17 +415,15 @@ You can add a custom Monitoring plugin in `/data/monitoring-plugins/`.
424415
Some plugins can be found in the [Monitoring Plugins](https://github.com/monitoring-plugins/monitoring-plugins#readme)
425416
repo, or in the [unofficial fork for Nagios](https://github.com/nagios-plugins/nagios-plugins#readme).
426417

427-
> **Warning**
428-
>
418+
> [!WARNING]
429419
> Container has to be restarted to propagate changes.
430420

431421
### Custom alert templates
432422

433423
You can add [Laravel alert templates](https://docs.librenms.org/Alerting/Templates/#base-templates)
434424
in `/data/alert-templates/`.
435425

436-
> **Warning**
437-
>
426+
> [!WARNING]
438427
> Container has to be restarted to propagate changes.
439428

440429
## Contributing

0 commit comments

Comments
 (0)