From 4f9227f10078923aefaa29e6e2bb114f853fe8c9 Mon Sep 17 00:00:00 2001
From: "Anders B. Hansen" <anders@birkoe.com>
Date: Mon, 27 Feb 2023 12:49:52 +0100
Subject: [PATCH 1/3] docker: Revert health check addition from #555

---
 Dockerfile | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 52ccff6a..6916cabc 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -3,7 +3,5 @@ MAINTAINER Philipp C. Heckel <philipp.heckel@gmail.com>
 
 COPY ntfy /usr/bin
 
-HEALTHCHECK --interval=60s --timeout=10s CMD wget -q --tries=1 http://localhost/v1/health -O - | grep -Eo '"healthy"\s*:\s*true' || exit 1
-
 EXPOSE 80/tcp
 ENTRYPOINT ["ntfy"]

From c3f6077f95d37c2f98b434ed2333bda97e658726 Mon Sep 17 00:00:00 2001
From: "Anders B. Hansen" <anders@birkoe.com>
Date: Mon, 27 Feb 2023 13:53:37 +0100
Subject: [PATCH 2/3] docs: Add optional health check to docker-compose config
 example

---
 docs/install.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/install.md b/docs/install.md
index 53a1368d..1f39c17d 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -266,7 +266,7 @@ docker run \
   serve
 ```
 
-Using docker-compose with non-root user:
+Using docker-compose with non-root user and healthchecks enabled:
 ```yaml
 version: "2.1"
 
@@ -284,6 +284,12 @@ services:
       - /etc/ntfy:/etc/ntfy
     ports:
       - 80:80
+    healthcheck: # optional: remember to adapt the host:port to your environment
+        test: ["CMD-SHELL", "wget -q --tries=1 http://localhost:80/v1/health -O - | grep -Eo '\"healthy\"\\s*:\\s*true' || exit 1"]
+        interval: 60s
+        timeout: 10s
+        retries: 3
+        start_period: 40s
     restart: unless-stopped
 ```
 

From 221004af3919a431f08bcc801a0d491b747383ea Mon Sep 17 00:00:00 2001
From: "Anders B. Hansen" <anders@birkoe.com>
Date: Mon, 27 Feb 2023 15:03:09 +0100
Subject: [PATCH 3/3] docs: Add documentation for health check API endpoint

---
 docs/config.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/config.md b/docs/config.md
index 5fca3ebe..7b7e9738 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -1067,6 +1067,16 @@ and [here](https://easyengine.io/tutorials/nginx/block-wp-login-php-bruteforce-a
     maxretry = 10
     ```
 
+## Health checks
+A preliminary health check API endpoint is exposed at `"/v1/health"`. The endpoint returns a `json` response in the format shown below.
+If a non-200 HTTP status code is returned or if the returned `health` field is `false` the ntfy service should be considered as unhealthy.
+
+```json
+{"health":true}
+```
+
+See [Installalation/Docker](install.md#docker) for an example of how this could be used in a `docker-compose` environment.
+
 ## Logging & debugging
 By default, ntfy logs to the console (stderr), with an `info` log level, and in a human-readable text format.