56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
|
# Ping
|
||
|
|
|
||
|
|
Checking the Health of Your Traefik Instances
|
||
|
|
{: .subtitle }
|
||
|
|
|
||
|
|
## Configuration Examples
|
||
|
|
|
||
|
|
??? example "Enabling /ping on the http EntryPoint"
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[entryPoints]
|
||
|
|
[entrypoints.http]
|
||
|
|
address = ":80"
|
||
|
|
|
||
|
|
[ping]
|
||
|
|
entryPoint = "http"
|
||
|
|
```
|
||
|
|
|
||
|
|
??? example "Enabling /ping on the https EntryPoint"
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[entryPoints]
|
||
|
|
[entryPoints.http]
|
||
|
|
address = ":80"
|
||
|
|
|
||
|
|
[entryPoints.https]
|
||
|
|
address = ":443"
|
||
|
|
[entryPoints.https.tls]
|
||
|
|
|
||
|
|
[ping]
|
||
|
|
entryPoint = "https"
|
||
|
|
```
|
||
|
|
|
||
|
|
??? example "Enabling /ping on a dedicated EntryPoint"
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[entryPoints]
|
||
|
|
[entryPoints.http]
|
||
|
|
address = ":80"
|
||
|
|
|
||
|
|
[entryPoints.ping]
|
||
|
|
address = ":8082"
|
||
|
|
|
||
|
|
[ping]
|
||
|
|
entryPoint = "ping"
|
||
|
|
```
|
||
|
|
|
||
|
|
| Path | Method | Description |
|
||
|
|
|---------|---------------|----------------------------------------------------------------------------------------------------|
|
||
|
|
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` |
|
||
|
|
|
||
|
|
## Configuration Options
|
||
|
|
|
||
|
|
The `/ping` health-check URL is enabled with the command-line `--ping` or config file option `[ping]`.
|
||
|
|
|
||
|
|
You can customize the `entryPoint` where the `/ping` is active with the `entryPoint` option (default value: `traefik`)
|