From bf93f72d2711c599bf5922d696e1a8983bb7d00e Mon Sep 17 00:00:00 2001 From: Sascha Date: Mon, 6 Jul 2026 13:35:24 +0200 Subject: [PATCH] Document Docker healthcheck configuration Added Docker healthcheck instructions for newt client. --- manage/sites/install-site.mdx | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/manage/sites/install-site.mdx b/manage/sites/install-site.mdx index 5003439..ae241d9 100644 --- a/manage/sites/install-site.mdx +++ b/manage/sites/install-site.mdx @@ -199,6 +199,22 @@ services: - --endpoint https://app.pangolin.net ``` +#### Docker healthcheck +The newt cliens suports healthchecks as described in [Configure Sites](/manage/sites/configure-site#param-health-file). This file can be used to do a +healthcheck from within docker (compose file). + +We need to define the `HEALTH_FILE` environment variable as well as the healthcheck itself: +```bash + environment: + - HEALTH_FILE=/tmp/healthy + healthcheck: + test: ["CMD-SHELL", "[ -f /tmp/healthy ]"] + interval: 30s + timeout: 5s + start_period: 30s + retries: 3 +``` + Start the service: ```bash @@ -284,4 +300,4 @@ After installation, click on the router app link at the top of the page to confi -A complete config file is located at `/etc/newt/settings` on the router. You can edit this file directly to change credentials or add additional configuration options. After making changes, restart the router app to apply the new configuration. An example settings file can be found at: https://github.com/fosrl/newt/blob/main/packages/advantech/merge/etc/defaults \ No newline at end of file +A complete config file is located at `/etc/newt/settings` on the router. You can edit this file directly to change credentials or add additional configuration options. After making changes, restart the router app to apply the new configuration. An example settings file can be found at: https://github.com/fosrl/newt/blob/main/packages/advantech/merge/etc/defaults