traefik/docs/content/operations/dashboard.md

63 lines
1.8 KiB
Markdown
Raw Normal View History

# The Dashboard
See What's Going On
{: .subtitle }
The dashboard is the central place that shows you the current active routes handled by Traefik.
<figure>
2019-09-10 12:40:05 +00:00
<img src="../../assets/img/webui-dashboard.png" alt="Dashboard - Providers" />
<figcaption>The dashboard in action</figcaption>
</figure>
By default, the dashboard is available on `/dashboard` on port `:8080`.
There is also a redirect of `/` to `/dashboard`, but one should not rely on that property as it is bound to change,
and it might make for confusing routing rules anyway.
2019-09-23 12:32:04 +00:00
!!! info "Did You Know?"
It is possible to customize the dashboard endpoint.
2019-09-10 12:40:05 +00:00
To learn how, refer to the [API documentation](./api.md)
## Enabling the Dashboard
To enable the dashboard, you need to enable [Traefik's API](./api.md).
2019-07-22 07:58:04 +00:00
```toml tab="File (TOML)"
[api]
# Dashboard
#
# Optional
# Default: true
#
dashboard = true
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
api:
# Dashboard
#
# Optional
# Default: true
#
dashboard: true
```
2019-07-22 07:58:04 +00:00
```bash tab="CLI"
# 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)
2019-09-23 12:32:04 +00:00
!!! info "Did You Know?"
The API provides more features than the Dashboard.
2019-09-10 12:40:05 +00:00
To learn more about it, refer to the [API documentation](./api.md)