From 4d343e3541064ecbf838c8959246280796091a10 Mon Sep 17 00:00:00 2001 From: Wouter van Elten Date: Fri, 11 Jul 2025 08:14:32 +0200 Subject: [PATCH 1/2] Update README.md for health check Added explanation of health_file --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d88096..997745e 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ When Newt receives WireGuard control messages, it will use the information encod - `tls-client-cert` (optional): Client certificate (p12 or pfx) for mTLS. See [mTLS](#mtls) - `docker-socket` (optional): Set the Docker socket to use the container discovery integration - `docker-enforce-network-validation` (optional): Validate the container target is on the same network as the newt process +- `health_file` (optional): Check if connection to WG server (pangolin) is ok. creates a file if ok, removes it if not ok. Can be used with docker healtcheck to restart newt - Example: @@ -61,7 +62,8 @@ services: environment: - PANGOLIN_ENDPOINT=https://example.com - NEWT_ID=2ix2t8xk22ubpfy - - NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2 + - NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2 + - HEALTH_FILE=/tmp/healthy ``` You can also pass the CLI args to the container: @@ -76,6 +78,7 @@ services: - --id 31frd0uzbjvp721 - --secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6 - --endpoint https://example.com + - --health_file /tmp/healthy ``` ### Docker Socket Integration From 663e28329b19ff9948f55f162ed21e4e6da576b6 Mon Sep 17 00:00:00 2001 From: Owen Date: Sun, 13 Jul 2025 16:08:32 -0700 Subject: [PATCH 2/2] Fix typo with _ --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 997745e..dd776f7 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ When Newt receives WireGuard control messages, it will use the information encod - `tls-client-cert` (optional): Client certificate (p12 or pfx) for mTLS. See [mTLS](#mtls) - `docker-socket` (optional): Set the Docker socket to use the container discovery integration - `docker-enforce-network-validation` (optional): Validate the container target is on the same network as the newt process -- `health_file` (optional): Check if connection to WG server (pangolin) is ok. creates a file if ok, removes it if not ok. Can be used with docker healtcheck to restart newt +- `health-file` (optional): Check if connection to WG server (pangolin) is ok. creates a file if ok, removes it if not ok. Can be used with docker healtcheck to restart newt - Example: @@ -78,7 +78,7 @@ services: - --id 31frd0uzbjvp721 - --secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6 - --endpoint https://example.com - - --health_file /tmp/healthy + - --health-file /tmp/healthy ``` ### Docker Socket Integration