Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation about API and Dashboard. #5364

Merged
merged 1 commit into from
Sep 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ services:
# The official v2.0 Traefik docker image
image: traefik:v2.0
# Enables the web UI and tells Traefik to listen to docker
command: --api --providers.docker
command: --api.insecure=true --providers.docker
ports:
# The HTTP port
- "80:80"
# The Web UI (enabled by --api)
# The Web UI (enabled by --api.insecure=true)
- "8080:8080"
volumes:
# So that Traefik can listen to the Docker events
Expand Down
4 changes: 0 additions & 4 deletions docs/content/includes/.markdownlint.json

This file was deleted.

1 change: 0 additions & 1 deletion docs/content/includes/more-on-command-line.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/content/includes/more-on-configuration-file.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/content/includes/more-on-entrypoints.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/content/includes/more-on-key-value-store.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/content/includes/more-on-routers.md

This file was deleted.

14 changes: 8 additions & 6 deletions docs/content/operations/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -49,10 +49,12 @@ api:
--api.dashboard=true
```

{!more-on-command-line.md!}

{!more-on-configuration-file.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)

!!! 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)
2 changes: 1 addition & 1 deletion docs/content/user-guides/crd-acme/03-deployments.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
- name: traefik
image: traefik:v2.0
args:
- --api
- --api.insecure
- --accesslog
- --entrypoints.web.Address=:8000
- --entrypoints.websecure.Address=:4443
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ version: "3.3"
services:

traefik:
image: "traefik:v2.0.0-beta1"
image: "traefik:v2.0.0-rc3"
container_name: "traefik"
command:
#- "--log.level=DEBUG"
- "--api=true"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ secrets:
services:

traefik:
image: "traefik:v2.0.0-beta1"
image: "traefik:v2.0.0-rc3"
container_name: "traefik"
command:
#- "--log.level=DEBUG"
- "--api=true"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ version: "3.3"
services:

traefik:
image: "traefik:v2.0.0-beta1"
image: "traefik:v2.0.0-rc3"
container_name: "traefik"
command:
#- "--log.level=DEBUG"
- "--api=true"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ version: "3.3"
services:

traefik:
image: "traefik:v2.0.0-beta1"
image: "traefik:v2.0.0-rc3"
container_name: "traefik"
command:
#- "--log.level=DEBUG"
- "--api=true"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.websecure.address=:443"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ version: "3.3"
services:

traefik:
image: "traefik:v2.0.0-beta1"
image: "traefik:v2.0.0-rc3"
container_name: "traefik"
command:
#- "--log.level=DEBUG"
- "--api=true"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ ports:
```yaml
command:
# Traefik will listen on port 8080 by default for API request.
- "--api=true"
- "--api.insecure=true"

ports:
- "8080:8080"
Expand Down
4 changes: 2 additions & 2 deletions docs/content/user-guides/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ api: {}
```yaml tab="CLI"
--entryPoints.web.address=":80"
--providers.file.filename=dynamic_conf.toml
--api=true
--api.insecure=true
```

`dynamic_conf.{toml,yml}`:
Expand Down Expand Up @@ -157,7 +157,7 @@ api: {}
# For secure connection on backend.local
--serversTransport.rootCAs=./backend.cert
--providers.file.filename=dynamic_conf.toml
--api=true
--api.insecure=true
```

`dynamic_conf.{toml,yml}`:
Expand Down
6 changes: 3 additions & 3 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ markdown_extensions:
- pymdownx.tasklist
- pymdownx.snippets:
check_paths: true
- markdown_include.include:
base_path: content/includes/
encoding: utf-8
# - markdown_include.include:
# base_path: content/includes/
# encoding: utf-8
- toc:
permalink: true

Expand Down