energy/opendtu-logger
1
0
Fork 0
Code Issues Pull requests Projects Releases 11 Packages 1 Wiki Activity Actions

.env clarification
All checks were successful
Build Docker image / build (push) Successful in 1m33s
Details
Build Golang packages / release (push) Has been skipped
Details

Browse source
This commit is contained in:
Pieter Hollander 2024-03-27 23:10:35 +01:00
parent 49f3396c10
commit 04b60a3b2c
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -34,6 +34,8 @@ Copy `example.with-database.env` to `.env`. E.g.:
cp example.with-database.env .env cp example.with-database.env .env
``` ```
In the `.env` file:
- Edit the `REMOTE_URL` to point to your OpenDTU. - Edit the `REMOTE_URL` to point to your OpenDTU.
- In `DB_URL` alter the `password` field. Set the same value in. `PG_PASSWORD` - In `DB_URL` alter the `password` field. Set the same value in. `PG_PASSWORD`
@ -153,7 +155,7 @@ TZ="Europe/Amsterdam"
- `TIMESCALEDB_ENABLED` should be set to `true` or `false`. - `TIMESCALEDB_ENABLED` should be set to `true` or `false`.
- `TZ` is used to ensure data is recorded with the right timestamp. Choose the timezone valid for your location from [this Wikipedia page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). - `TZ` is used to ensure data is recorded with the right timestamp. Choose the timezone valid for your location from [this Wikipedia page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
## Grafana ## Grafana dashboards
The `grafana` folder contains example dashboards which can be imported into existing Grafana installs, or into the provided Docker Compose with Grafana setup. The `grafana` folder contains example dashboards which can be imported into existing Grafana installs, or into the provided Docker Compose with Grafana setup.
@ -164,4 +166,4 @@ The `grafana` folder contains example dashboards which can be imported into exis
## Known limitations ## Known limitations
- The logger will currently log every event posted by OpenDTU to the websocket. Checks still need to be added to determine the uniqueness of an event. For more information, see also [this OpenDTU Github issue](https://github.com/tbnobody/OpenDTU/issues/1800). - The logger will currently log every event posted by OpenDTU to the websocket. Checks still need to be added to determine the uniqueness of an event. For more information, see also [this OpenDTU Github issue](https://github.com/tbnobody/OpenDTU/issues/1800).
- Upon restart of the OpenDTU, the OpenDTU Logger binary will need to be restarted as well. When using the provided `compose.yml` files with Docker, or using the `systemd` service file when using the binary, ensures this happens automatically. - Upon restart of the OpenDTU, the OpenDTU Logger binary will need to be restarted as well. When using the provided `compose.yml` files with Docker, or using the `systemd` service file when using the binary, this will happen automatically.