traefik/docs/content/operations/dashboard.md

59 lines
1.1 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 `/` on port `:8080`.
!!! tip "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.
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
```
2019-07-22 07:58:04 +00:00
{!more-on-command-line.md!}
2019-07-22 07:58:04 +00:00
{!more-on-configuration-file.md!}
!!! tip "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)