From 49ced24f84b0d91bff9f2c865f0a3942eddc711f Mon Sep 17 00:00:00 2001 From: Guilhem Saurel Date: Sat, 8 Apr 2023 14:58:53 +0200 Subject: [PATCH] README: move healthcheck into docker-compose section --- README.md | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 8f4224a..d924d5d 100644 --- a/README.md +++ b/README.md @@ -56,26 +56,6 @@ options: -v, --verbose increment verbosity level ``` -### Healthcheck - -For load balancers which require a healthcheck endpoint to validate the availability of the service, the `/health` path can be used. The endpoint will return a **HTTP 200** status and a json document. - -Using the Healthcheck endpoint with Traefik and docker-compose: - -```yaml -version: '3' - -... - -services: - bot: - ... - labels: - traefik.enable: "true" - traefik.http.routers.matrix-webhook.rule: "Host(`${CHATONS_SERVICE:-matrixwebhook}.${CHATONS_DOMAIN:-localhost}`)" - traefik.http.services.matrix-webhook.loadbalancer.healthcheck.path: /health -``` - ## Dev ``` @@ -97,6 +77,20 @@ A `docker-compose.yml` is provided: docker-compose up -d ``` +### Healthcheck + +For load balancers which require a healthcheck endpoint to validate the availability of the service, the `/health` path can be used. +The endpoint will return a **HTTP 200** status and a json document. + +To the Healthcheck endpoint with Traefik and docker-compose, you can add: + +```yaml +services: + bot: + labels: + traefik.http.services.matrix-webhook.loadbalancer.healthcheck.path: /health +``` + ## Test / Usage ```