Docs: Adding warnings and solution about the configuration exposure
This commit is contained in:
parent
a7bb768e98
commit
f062ee80c8
2 changed files with 24 additions and 1 deletions
|
@ -4,6 +4,9 @@
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# API definition
|
# API definition
|
||||||
|
# Warning: Enabling API will expose Træfik's configuration and secret.
|
||||||
|
# It is not recommended in production,
|
||||||
|
# unless secured by authentication and authorizations
|
||||||
[api]
|
[api]
|
||||||
# Name of the related entry point
|
# Name of the related entry point
|
||||||
#
|
#
|
||||||
|
@ -12,7 +15,7 @@
|
||||||
#
|
#
|
||||||
entryPoint = "traefik"
|
entryPoint = "traefik"
|
||||||
|
|
||||||
# Enabled Dashboard
|
# Enable Dashboard
|
||||||
#
|
#
|
||||||
# Optional
|
# Optional
|
||||||
# Default: true
|
# Default: true
|
||||||
|
@ -38,6 +41,22 @@ For more customization, see [entry points](/configuration/entrypoints/) document
|
||||||
|
|
||||||
![Web UI Health](/img/traefik-health.png)
|
![Web UI Health](/img/traefik-health.png)
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
Enabling the API will expose all configuration elements,
|
||||||
|
including secret.
|
||||||
|
|
||||||
|
It is not recommended in production,
|
||||||
|
unless secured by authentication and authorizations.
|
||||||
|
|
||||||
|
A good sane default (but not exhaustive) set of recommendations
|
||||||
|
would be to apply the following protection mechanism:
|
||||||
|
|
||||||
|
* _At application level:_ enabling HTTP [Basic Authentication](#authentication)
|
||||||
|
* _At transport level:_ NOT exposing publicly the API's port,
|
||||||
|
keeping it restricted over internal networks
|
||||||
|
(restricted networks as in https://en.wikipedia.org/wiki/Principle_of_least_privilege).
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
| Path | Method | Description |
|
| Path | Method | Description |
|
||||||
|
|
|
@ -86,6 +86,10 @@ services:
|
||||||
- /var/run/docker.sock:/var/run/docker.sock # So that Traefik can listen to the Docker events
|
- /var/run/docker.sock:/var/run/docker.sock # So that Traefik can listen to the Docker events
|
||||||
```
|
```
|
||||||
|
|
||||||
|
!!! warning
|
||||||
|
Enabling the Web UI with the `--api` flag might exposes configuration elements. You can read more about this on the [API/Dashboard's Security section](/configuration/api#security).
|
||||||
|
|
||||||
|
|
||||||
**That's it. Now you can launch Træfik!**
|
**That's it. Now you can launch Træfik!**
|
||||||
|
|
||||||
Start your `reverse-proxy` with the following command:
|
Start your `reverse-proxy` with the following command:
|
||||||
|
|
Loading…
Reference in a new issue