diff --git a/README.md b/README.md new file mode 100644 index 0000000..aee955c --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# OpenDTU logger + +OpenDTU logger connects to the OpenDTU livedata websocket and captures metrics. +These metrics are inserted into a PostgreSQL database. +Optionally, TimescaleDB can be used for better performance. + +## Environment variables + +```conf +REMOTE_URL="opendtu:80" +DB_URL="host=localhost port=5432 user=postgres password=secret dbname=dtu sslmode=disable" +TIMESCALEDB_ENABLED="true" +TZ="Europe/Amsterdam" +```