homelab/traefik
1
0
Fork 0
Code Activity

Improve documentation about API and Dashboard.

Browse source
This commit is contained in:
Ludovic Fernandez 2019-09-12 16:22:03 +02:00 • committed by Traefiker Bot
parent 7357d5eae2
commit 887826ee68
17 changed files with 27 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/content/operations/dashboard.md
View file

@ -12,13 +12,13 @@ The dashboard is the central place that shows you the current active routes hand
By default, the dashboard is available on `/` on port `:8080`.
!!! tip "Did You Know?"
!!! note "Did You Know?"
It is possible to customize the dashboard endpoint.
To learn how, refer to the [API documentation](./api.md)
## Enabling the Dashboard
To enable the dashboard, you need to enable Traefik's API.
To enable the dashboard, you need to enable [Traefik's API](./api.md).
```toml tab="File (TOML)"
[api]
@ -49,10 +49,12 @@ api:
--api.dashboard=true
```
{!more-on-command-line.md!}
!!! 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)
{!more-on-configuration-file.md!}
!!! tip "Did You Know?"
!!! note "Did You Know?"
The API provides more features than the Dashboard.
To learn more about it, refer to the [API documentation](./api.md)