From c9f13f439864dd571d3e22fef5aa8735b6a351c2 Mon Sep 17 00:00:00 2001 From: Jason Kulatunga Date: Tue, 29 Nov 2022 21:07:51 -0800 Subject: [PATCH] update README to correctly call-out the influxdb requirement in hub-spoke deployments. references #409 --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cb1c60b..0beddc1 100644 --- a/README.md +++ b/README.md @@ -91,10 +91,14 @@ docker run -it --rm -p 8080:8080 -p 8086:8086 \ ### Hub/Spoke Deployment -In addition to the Omnibus image (available under the `latest` tag) there are 2 other Docker images available: - -- `ghcr.io/analogj/scrutiny:master-collector` - Contains the Scrutiny data collector, `smartctl` binary and cron-like scheduler. You can run one collector on each server. -- `ghcr.io/analogj/scrutiny:master-web` - Contains the Web UI, API and Database. Only one container necessary +In addition to the Omnibus image (available under the `latest` tag) you can deploy in Hub/Spoke mode, which requires 3 +other Docker images: + +- `ghcr.io/analogj/scrutiny:master-collector` - Contains the Scrutiny data collector, `smartctl` binary and cron-like + scheduler. You can run one collector on each server. +- `ghcr.io/analogj/scrutiny:master-web` - Contains the Web UI and API. Only one container necessary +- `influxdb:2.2` - InfluxDB image, used by the Web container to persist SMART data. + See [docs/TROUBLESHOOTING_INFLUXDB.md](./docs/TROUBLESHOOTING_INFLUXDB.md) > See [docker/example.hubspoke.docker-compose.yml](./docker/example.hubspoke.docker-compose.yml) for a docker-compose file.