README

nmsnoteswidget - A LibreNMS plugin package to show notes widget on the device overview page.

Installation

Without Docker

Go to the LibreNMS base directory and run the following commands as librenms user:

./lnms plugin:add dot-mike/nmsnoteswidget
php artisan route:clear
php lnms --force -n migrate

With Docker

If you are using LibreNMS with Docker, you can install the plugin by customizing the Dockerfile.

Example Dockerfile:

ARG VERSION=librenms:23.8.2
FROM librenms/$VERSION

RUN apk --update --no-cache add -t build-dependencies php-xmlwriter
RUN mkdir -p "${LIBRENMS_PATH}/vendor"

RUN echo $'#!/usr/bin/with-contenv sh\n\
set -e\n\
if [ "$SIDECAR_DISPATCHER" = "1" ] || [ "$SIDECAR_SYSLOGNG" = "1" ] || [ "$SIDECAR_SNMPTRAPD" = "1" ]; then\n\
  exit 0\n\
fi\n\
chown -R librenms:librenms "${LIBRENMS_PATH}/composer.json" "${LIBRENMS_PATH}/composer.lock" "${LIBRENMS_PATH}/vendor"\n\
lnms plugin:add dot-mike/nmsnoteswidget\n\
php artisan route:clear\n\
php lnms --force -n migrate\n\
' > /etc/cont-init.d/99-nmsnoteswidget.sh

Usage

To get started, open LibreNMS and enable the plugin by navigating to Overview->Plugins->Plugins Admin and enable the nmsnoteswidget plugin.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Thanks to the LibreNMS team and the exampleplugin ExamplePlugin for the inspiration.

dot-mike / nmsnoteswidget

Maintainers

Details