From 083a2f266715e29671a20cc5e61b718c5ad215b3 Mon Sep 17 00:00:00 2001 From: Pieter Hollander Date: Wed, 27 Mar 2024 23:13:28 +0100 Subject: [PATCH] more documentation work. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 323db2a..0c51b50 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ Preferably, run the Docker image using the Docker compose examples provided in t #### Docker Compose -The `docker` folder in this [repository](https://git.hollander.online/energy/opendtu-logger) contains example Docker compose files. The `compose.with-database-grafana.yml` file contains a setup suitable for a complete deployment. +The `docker` folder in this [repository](https://git.hollander.online/energy/opendtu-logger) contains example Docker compose files. The `compose.with-database-grafana.yml` file contains a full setup suitable for a standalone deployment. The other compose files are aimed at integration into existing environments. -To use it, take the following steps +To use the standalone deployment, take the following steps Enter the `docker` folder @@ -51,7 +51,7 @@ Docker should now start downloading the required containers and bring up OpenDTU docker compose -f compose.with-database-grafana.yml up -d ``` -The `-d` flag ensures that the containers are started in the background, so you can safely close your terminal window. Containers running in the background can be stopped by running compose again with the `down` command. +The `-d` flag ensures that the containers are started in the background, so you can safely close your terminal window. If desired, containers running in the background can be stopped by running compose again with the `down` command. ```sh docker compose -f compose.with-database-grafana.yml down @@ -59,7 +59,7 @@ docker compose -f compose.with-database-grafana.yml down #### Setting up Grafana -Grafana should be available at . +After deploying OpenDTU Logger with Docker Compose, Grafana should be available at . The initial login username and password are `admin:admin`. After the initial login, Grafana will request you to change the password to something more secure.