From 8f2c202fb5213de8910a42f21f061b10e224cf64 Mon Sep 17 00:00:00 2001 From: Shan Desai Date: Tue, 6 Jun 2023 13:36:12 +0200 Subject: [PATCH 1/2] docs: update README.md typos + information about `config` and `creds` YAML files --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c249bea..bf952dc 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,12 @@ Currently the following services are available to configure and run: | __Grafana__ | `9.5.1` | | __QuestDB__ | `7.1.1` | +These services can be further tuned using the files under the `vars` directory: + +| File | Purpose | +|:---------------|:------------------------------------------------| +| `config.yml` | Core service configuration (API) endpoints
and container image versions | +| `creds.yml` | Credentials for services (Username/Passwords/Databases) | ### Complete Komponist Stack @@ -107,7 +113,7 @@ You can bring the stack up using: docker compose --project-directory=deploy up -d ``` -### Service Endpoints +### Service Endpoints / Information The following service names can be used to obtain log information using: @@ -118,7 +124,7 @@ docker compose --project-directory=deploy logs -f | Service Name | URL | |:------------:|:-----------------------------:| | `nodered` | `http://localhost/nodered` | -| `mosquito` | `mqtt://localhost:1883` | +| `mosquitto` | `mqtt://localhost:1883` | | `traefik` | N/A | | `influxdvb1` | `http://localhost/influxdbv1` | | `influxdbv2` | `http://influxdbv2.localhost` | @@ -142,4 +148,3 @@ Komponist is licensed under __Affero GNU Public License v3.0__. [0]: https://docs.docker.com/compose/compose-v2/ [1]: https://docs.docker.com/get-docker/ [2]: docs/Development.md - From f14571e12bdbf210a7918d82a5f8407539fce803 Mon Sep 17 00:00:00 2001 From: Shantanoo 'Shan' Desai Date: Tue, 25 Jul 2023 21:19:08 +0200 Subject: [PATCH 2/2] docs: update README.md Signed-off-by: Shantanoo 'Shan' Desai --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf952dc..f6a878f 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ abstraction. The following are required to make Komponist work: | Name | Version | Purpose | |:-----------|:----------:|:-----------------------------------------------------------------:| -| `docker` | `24.0.x` | Container Runtime where your compose stacks will run | -| `docker compose` | `2.18.1` | Docker Compose V2 Plugin for Docker Engine | +| `docker` | `>= 24.0.2` | Container Runtime where your compose stacks will run | +| `docker compose` | `>= 2.20.0` | Docker Compose V2 Plugin for Docker Engine | Install them on your host accordingly. See [Docker Documentations][1] @@ -21,7 +21,7 @@ Install them on your host accordingly. See [Docker Documentations][1] | Name | Version | Purpose | |:----------|:-------:|:----------------------------------------------------------------------------:| -| `ansible` | `> 2.14.x` | Almost _all_ things within Komponist are achieved via ansible | +| `ansible` | `>= 2.15.x` | Almost _all_ things within Komponist are achieved via ansible | | `passlib` | `1.7.x` | required for password encryption hashing requirements for certain containers | | `docker` | `>5.x.x`| required to control single container instances | @@ -42,6 +42,7 @@ Currently the following services are available to configure and run: | __Traefik Reverse-Proxy__ | `2.9.8` | | __InfluxDB__ | `1.8`
`2.6`| | __TimescaleDB__ | `v15` | +| __Telegraf__ | `1.27.2`| | __Grafana__ | `9.5.1` | | __QuestDB__ | `7.1.1` | @@ -126,6 +127,7 @@ docker compose --project-directory=deploy logs -f | `nodered` | `http://localhost/nodered` | | `mosquitto` | `mqtt://localhost:1883` | | `traefik` | N/A | +| `telegraf` | N/A | | `influxdvb1` | `http://localhost/influxdbv1` | | `influxdbv2` | `http://influxdbv2.localhost` | | `timescaledb` | Not Configured to an API |