Skip to content
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

Jump to bottom

docs: set additional env configuration #401

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

docs: set additional env configuration #401

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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ ___
* [Live Config](#live-config)
* [Notes](#notes)
* [LNMS command](#lnms-command)
* [Additional env configuration](#additional-env-configuration)
* [Validate](#validate)
* [Dispatcher service container](#dispatcher-service-container)
* [Syslog-ng container](#syslog-ng-container)
Expand Down Expand Up @@ -319,6 +320,33 @@ manage users, database migration, and more, type:
$ docker compose exec librenms lnms
```

### Additional env configuration

After the first launch, `/data/.env` file is created and contains the following
environment variables:

```
APP_KEY=base64:...
NODE_ID=...
```

You can add additional environment variables in this file. For example, if you
want to set VAPID keys for Web push notifications (required for browser
authentication), you can do:

```console
$ docker compose exec librenms sh -c "lnms webpush:vapid --show >> /data/.env"
```

Content of `/data/.env` file will look like this:

```
APP_KEY=base64:...
NODE_ID=...
VAPID_PUBLIC_KEY=...
VAPID_PRIVATE_KEY=...
```

### Validate

If you want to validate your installation from the CLI, type the following
Expand Down