Gérald Croës ac6b11037d Documentation Revamp

Co-authored-by: jbdoumenjou <jb.doumenjou@gmail.com>

2019-02-26 14:50:07 +01:00

CLI

The Traefik Command Line {: .subtitle }

General

traefik [command] [--flag=flag_argument]

Available commands:

version : Print version
storeconfig : Store the static Traefik configuration into a Key-value stores. Please refer to the Store Traefik configuration(TODO: add doc and link) section to get documentation on it.
bug: The easiest way to submit a pre-filled issue.
healthcheck: Calls Traefik /ping to check health.

Each command can have additional flags.

All those flags will be displayed with:

traefik [command] --help

Each command is described at the beginning of the help section:

traefik --help

# or

docker run traefik[:version] --help
# ex: docker run traefik:1.5 --help

The easiest way to submit a pre-filled issue on Traefik GitHub! Watch this demo for more information.

traefik bug

Checks the health of Traefik. Its exit status is 0 if Traefik is healthy and 1 if it is unhealthy.

This can be used with Docker HEALTHCHECK instruction or any other health check orchestration mechanism.

!!! note The ping endpoint must be enabled to allow the healthcheck command to call /ping.

traefik healthcheck

OK: http://:8082/ping