[Feature Request] Support Healthcheck for custom apps

TrueNAS General
,
1

Please support healthcheck with custom app Installed via YAML.

It makes the dependency migrated from compose fully compatible.

2

You’re in luck, there is already support for it.

If you add the appropriate code to validate the health of your app right there in the YAML the GUI will show a nice green checkbox if the heathcheck reports back okay.

apphealth
apphealth779×188 27 KB

Relevant parts of the YAMLs:

services:
  heimdall:
    container_name: heimdall
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=[redacted]
    healthcheck:
      interval: 1m
      test:
        - CMD-SHELL
        - curl http://127.0.0.1:80
<snip>

services:
  jellyfin:
    container_name: jellyfin
    environment:
      - PUID=568
      - PGID=568
      - TZ=[redacted]
    healthcheck:
      interval: 1m
      test:
        - CMD-SHELL
        - curl http://127.0.0.1:8096
    image: lscr.io/linuxserver/jellyfin:latest
<snip>

services:
  kiwix-serve:
    command:
      - '*.zim'
    container_name: kiwix-serve
    healthcheck:
      interval: 1m
      test:
        - CMD-SHELL
        - >-
          wget --no-verbose --tries=1 --output-document=/dev/null
          http://127.0.0.1:8080/ &> /dev/null || exit 1
    image: ghcr.io/kiwix/kiwix-serve:latest
<snip>

What the healthcheck actually does to verify the container health obviously depends on the app. Many apps mention this in their Docker install instructions, or include sample code in their example Docker Compose files. Others you will need to figure out on your own.

1 Like
3

Thank you.

I mixed up the error caused by the curl command used in the [service].healthcheck.test requires authentication. :flushed:

1 Like