traefik/docs/content/operations/dashboard.md
2019-09-12 16:22:03 +02:00

1.6 KiB

The Dashboard

See What's Going On {: .subtitle }

The dashboard is the central place that shows you the current active routes handled by Traefik.

Dashboard - Providers
The dashboard in action

By default, the dashboard is available on / on port :8080.

!!! note "Did You Know?" It is possible to customize the dashboard endpoint. To learn how, refer to the API documentation

Enabling the Dashboard

To enable the dashboard, you need to enable Traefik's API.

[api]
  # Dashboard
  #
  # Optional
  # Default: true
  #
  dashboard = true
api:
  # Dashboard
  #
  # Optional
  # Default: true
  #
  dashboard: true
# Dashboard
#
# Optional
# Default: true
#
--api.dashboard=true

!!! important "API/Dashboard Security"

To secure your dashboard, the use of a `service` named `api@internal` is mandatory and requires the definition of a router using one or more security [middlewares](../middlewares/overview.md)
like authentication ([basicAuth](../middlewares/basicauth.md) , [digestAuth](../middlewares/digestauth.md), [forwardAuth](../middlewares/forwardauth.md)) or [whitelisting](../middlewares/ipwhitelist.md).  
More information about `api@internal` can be found in the [API documentation](./api.md#configuration)

!!! note "Did You Know?" The API provides more features than the Dashboard. To learn more about it, refer to the API documentation