From 04b60a3b2c1a1a70f5317673c2427b17ebafe2b0 Mon Sep 17 00:00:00 2001 From: Pieter Hollander Date: Wed, 27 Mar 2024 23:10:35 +0100 Subject: [PATCH] .env clarification --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e98c2fb..323db2a 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ Copy `example.with-database.env` to `.env`. E.g.: cp example.with-database.env .env ``` +In the `.env` file: + - Edit the `REMOTE_URL` to point to your OpenDTU. - 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`. - `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. @@ -164,4 +166,4 @@ The `grafana` folder contains example dashboards which can be imported into exis ## 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). -- 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.