homelab/traefik
1
0
Fork 0
Code Activity

Clean Documentation

Browse source
This commit is contained in:
Nicolas Mengin 2025-08-25 14:35:04 +02:00 • committed by GitHub
parent 8ac8473554
commit 1997bc7432
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
77 changed files with 2561 additions and 1247 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/content/reference/install-configuration/observability/healthcheck/cli.md Normal file
View file

@ -0,0 +1,28 @@
---
title: "Traefik Health Check CLI Command Documentation"
description: "In Traefik Proxy, the healthcheck CLI command lets you check the health of your Traefik instances. Read the technical documentation for configuration examples and options."
---
# Healthcheck Command
Checking the Health of your Traefik Instances.
{: .subtitle }
## Usage
The healthcheck command allows you to make a request to the `/ping` endpoint (defined in the install (static) configuration) to check the health of Traefik. Its exit status is `0` if Traefik is healthy and `1` otherwise.
This can be used with [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) instruction or any other health check orchestration mechanism.
```sh
traefik healthcheck [command] [flags] [arguments]
```
Example:
```sh
$ traefik healthcheck
OK: http://:8082/ping
```
The command uses the [ping](./ping.md) endpoint that is defined in the Traefik install (static) configuration.