more documentation work.
All checks were successful
Build Docker image / build (push) Successful in 1m16s
Build Golang packages / release (push) Has been skipped

This commit is contained in:
Pieter Hollander 2024-03-27 23:13:28 +01:00
parent 04b60a3b2c
commit 083a2f2667
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg

View file

@ -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 <http://localhost:3000>.
After deploying OpenDTU Logger with Docker Compose, Grafana should be available at <http://localhost:3000>.
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.