Skip to content

Healthcheck

This docker container includes the ability to run health checks between the container api and outside services such as Portainer, or any other app that has the ability to query the endpoint api/health.



API

1.4.0

This container includes the ability to run health checks utilizing the built-in API. You can directly access the health check and view a json formatted result with the url https://tvapp2.domain.lan/api/health

/api/health
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "ip": "172.18.2.1",
    "gateway": "172.18.0.1",
    "uptime": 5903.549082501,
    "message": "healthy",
    "status": "healthy",
    "ref": "/api/health",
    "method": "GET",
    "code": 200,
    "timestamp": 1744386346242
}


Numerous aliases have been added; you can use any of the following URLs to access the same health check results as they go to the same endpoint:



Portainer

1.3.0

To run a health check between TVApp2 and Portainer, apply the following lines of code to your TVApp2 docker-compose.yml. Two examples have been provided, you can use either one; wget or curl:

docker-compose.yml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
services:
    tvapp2:
        container_name: tvapp2
        image: ghcr.io/thebinaryninja/tvapp2:latest
        restart: unless-stopped
        volumes:
            - /etc/timezone:/etc/timezone:ro
            - /etc/localtime:/etc/localtime:ro
            - /var/run/docker.sock:/var/run/docker.sock
            - ./config:/config
            - ./app:/usr/bin/app
        environment:
            - TZ=Etc/UTC
        health check:
            test: "curl --fail --silent http://127.0.0.1:4124/api/health | grep -i healthy || exit 1"
            interval: 15s
            timeout: 10s
            retries: 3
docker-compose.yml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
services:
    tvapp2:
        container_name: tvapp2
        image: ghcr.io/thebinaryninja/tvapp2:latest
        restart: unless-stopped
        volumes:
            - /etc/timezone:/etc/timezone:ro
            - /etc/localtime:/etc/localtime:ro
            - /var/run/docker.sock:/var/run/docker.sock
            - ./config:/config
            - ./app:/usr/bin/app
        environment:
            - TZ=Etc/UTC
        health check:
            test: "wget -qO- http://127.0.0.1:4124/api/health | grep -i healthy || exit 1"
            interval: 15s
            timeout: 10s
            retries: 3



Web Interface

1.4.0

The TVApp2 web interface is equip with its own health check which is ran every 10 minutes by default. Users will notice a health indicator in the top right of the header navigation bar which is represented by the icon.

When the health check is ran every 10 minutes; a toast notification will appear in the lower-right side of the page:

Image settings
Health check toast notification


Health Check Duration

1.4.0 600000

By default, a health check between the TVApp2 container and the web interface is done every 10 minutes, but you can change this duration to something less or more. Be aware that if you set the time too low, you will constantly be spammed with toast notifications.

To change the health check delay, add the environment variable HEALTH_TIMER to your TVApp2 docker-compose.yml. Duration is in milliseconds.


docker-compose.yml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
services:
    tvapp2:
        container_name: tvapp2
        image: ghcr.io/thebinaryninja/tvapp2:latest
        restart: unless-stopped
        volumes:
            - /etc/timezone:/etc/timezone:ro
            - /etc/localtime:/etc/localtime:ro
            - /var/run/docker.sock:/var/run/docker.sock
            - ./config:/config
            - ./app:/usr/bin/app
        environment:
            - HEALTH_TIMER=600000 # (1)
  1. ℹ Defines how often to perform health checks between the container and the web interface. Time is in milliseconds.

    Default value is 600000 (10 minutes)
HEALTH_TIMER Value Delay Between Checks
HEALTH_TIMER=300000 5 minutes
HEALTH_TIMER=600000 10 minutes
HEALTH_TIMER=1200000 20 minutes
HEALTH_TIMER=1800000 30 minutes
HEALTH_TIMER=3600000 1 hour