Skip to content

Document how to add plugins that persists between restarts #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jellyfrog wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document how to add plugins that persists between restarts #587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,22 @@ will be removed and yours will be used.
> [!WARNING]
> Container has to be restarted to propagate changes.

### Add a LibreNMS plugin package

To add a [plugin package](https://docs.librenms.org/Extensions/Plugin-System/#plugin-package),
build your own image on top of the official image:

```dockerfile
FROM librenms/librenms:latest
RUN gosu librenms ./lnms plugin:add socialiteproviders/saml2
```

```console
$ docker build -t librenms-with-plugins .
```

Use this image instead of `librenms/librenms` in your `compose.yml`.

### Additional Monitoring plugins

You can add a custom Monitoring plugin in `/data/monitoring-plugins/`.
Expand Down