From bd91c3d85346da36064579aa79131602166d8a2c Mon Sep 17 00:00:00 2001 From: bugficks Date: Wed, 23 Aug 2023 14:14:39 +0700 Subject: [PATCH] Update docs/arguments.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: nils måsén --- docs/arguments.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/arguments.md b/docs/arguments.md index 5aa6e59..fb2e9af 100644 --- a/docs/arguments.md +++ b/docs/arguments.md @@ -367,7 +367,10 @@ Environment Variable: WATCHTOWER_WARN_ON_HEAD_FAILURE ## Health check -Run health check and exit. +Returns a success exit code to enable usage with docker `HEALTHCHECK`. This check is naive and only returns checks whether there is another process running inside the container, as it is the only known form of failure state for watchtowers container. + +!!! note "Only for HEALTHCHECK use" + Never put this on the main container executable command line as it is only meant to be run from docker HEALTHCHECK. ```text Argument: --health-check