Fix some minors errors on the documentation
This commit is contained in:
parent
3e76c25887
commit
fd26cf265d
9 changed files with 23 additions and 44 deletions
|
@ -14,7 +14,8 @@ The DigestAuth middleware is a quick way to restrict access to your services to
|
||||||
```toml
|
```toml
|
||||||
[http.middlewares]
|
[http.middlewares]
|
||||||
[http.middlewares.test-auth.digestauth]
|
[http.middlewares.test-auth.digestauth]
|
||||||
users = ["test:traefik:a2688e031edb4be6a3797f3882655c05", "test2:traefik:518845800f9e2bfb1f1f740ec24f074e"]
|
users = ["test:traefik:a2688e031edb4be6a3797f3882655c05",
|
||||||
|
"test2:traefik:518845800f9e2bfb1f1f740ec24f074e"]
|
||||||
```
|
```
|
||||||
|
|
||||||
??? example "Docker -- Using an external file for the authorized users"
|
??? example "Docker -- Using an external file for the authorized users"
|
||||||
|
|
|
@ -23,7 +23,7 @@ Pieces of middleware can be combined in chains to fit every scenario.
|
||||||
[http.routers.router1]
|
[http.routers.router1]
|
||||||
Service = "myService"
|
Service = "myService"
|
||||||
Middlewares = ["foo-add-prefix"]
|
Middlewares = ["foo-add-prefix"]
|
||||||
Rule = "Host: example.com"
|
Rule = "Host(`example.com`)"
|
||||||
|
|
||||||
[http.middlewares]
|
[http.middlewares]
|
||||||
[http.middlewares.foo-add-prefix.AddPrefix]
|
[http.middlewares.foo-add-prefix.AddPrefix]
|
||||||
|
|
|
@ -5,7 +5,7 @@ See What's Going On
|
||||||
|
|
||||||
The dashboard is the central place that shows you the current active routes handled by Traefik.
|
The dashboard is the central place that shows you the current active routes handled by Traefik.
|
||||||
|
|
||||||
??? note "Dashboard WIP"
|
!!! warning "Dashboard WIP"
|
||||||
Currently, the dashboard is in a Work In Progress State while being reconstructed for v2.
|
Currently, the dashboard is in a Work In Progress State while being reconstructed for v2.
|
||||||
Therefore, the dashboard is currently not working.
|
Therefore, the dashboard is currently not working.
|
||||||
|
|
||||||
|
|
|
@ -5,30 +5,10 @@ Checking the Health of Your Traefik Instances
|
||||||
|
|
||||||
## Configuration Examples
|
## Configuration Examples
|
||||||
|
|
||||||
??? example "Enabling /ping on the http EntryPoint"
|
??? example "Enabling /ping"
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[entrypoints]
|
|
||||||
[entrypoints.web]
|
|
||||||
address = ":80"
|
|
||||||
|
|
||||||
[ping]
|
[ping]
|
||||||
entryPoint = "http"
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Enabling /ping on the https EntryPoint"
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[entrypoints]
|
|
||||||
[entrypoints.web]
|
|
||||||
address = ":80"
|
|
||||||
|
|
||||||
[entrypoints.web-secure]
|
|
||||||
address = ":443"
|
|
||||||
[entrypoints.web-secure.tls]
|
|
||||||
|
|
||||||
[ping]
|
|
||||||
entryPoint = "https"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
??? example "Enabling /ping on a dedicated EntryPoint"
|
??? example "Enabling /ping on a dedicated EntryPoint"
|
||||||
|
@ -46,7 +26,7 @@ Checking the Health of Your Traefik Instances
|
||||||
```
|
```
|
||||||
|
|
||||||
| Path | Method | Description |
|
| Path | Method | Description |
|
||||||
|---------|---------------|----------------------------------------------------------------------------------------------------|
|
|---------|---------------|-----------------------------------------------------------------------------------------------------|
|
||||||
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` |
|
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` |
|
||||||
|
|
||||||
## Configuration Options
|
## Configuration Options
|
||||||
|
|
|
@ -17,7 +17,7 @@ Attach labels to your containers and let Traefik do the rest!
|
||||||
Enabling the docker provider
|
Enabling the docker provider
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[docker]
|
[providers.docker]
|
||||||
endpoint = "unix:///var/run/docker.sock"
|
endpoint = "unix:///var/run/docker.sock"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -29,11 +29,6 @@ They define the port which will receive the requests (whether HTTP or TCP).
|
||||||
|
|
||||||
[entrypoints.web-secure]
|
[entrypoints.web-secure]
|
||||||
address = ":443"
|
address = ":443"
|
||||||
|
|
||||||
[entrypoints.web-secure.tls]
|
|
||||||
[[entrypoints.web-secure.tls.certificates]]
|
|
||||||
certFile = "tests/traefik.crt"
|
|
||||||
keyFile = "tests/traefik.key"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Two entrypoints are defined: one called `web`, and the other called `web-secure`.
|
- Two entrypoints are defined: one called `web`, and the other called `web-secure`.
|
||||||
|
@ -51,7 +46,7 @@ Entrypoints are part of the [static configuration](../getting-started/configurat
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
--entryPoints='Name:http Address::80'
|
--entryPoints='Name:http Address::80'
|
||||||
--entryPoints='Name:https Address::443 TLS'
|
--entryPoints='Name:https Address::443'
|
||||||
```
|
```
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
|
|
|
@ -15,7 +15,7 @@ In the process, routers may use pieces of [middleware](../../middlewares/overvie
|
||||||
```toml
|
```toml
|
||||||
[http.routers]
|
[http.routers]
|
||||||
[http.routers.my-router]
|
[http.routers.my-router]
|
||||||
rule = "Path(/foo)"
|
rule = "Path(`/foo`)"
|
||||||
service = "service-foo"
|
service = "service-foo"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ In the process, routers may use pieces of [middleware](../../middlewares/overvie
|
||||||
```toml
|
```toml
|
||||||
[http.routers]
|
[http.routers]
|
||||||
[http.routers.my-router]
|
[http.routers.my-router]
|
||||||
rule = "Path(/foo)"
|
rule = "Path(`/foo`)"
|
||||||
middlewares = ["authentication"] # declared elsewhere
|
middlewares = ["authentication"] # declared elsewhere
|
||||||
service = "service-foo"
|
service = "service-foo"
|
||||||
```
|
```
|
||||||
|
@ -67,7 +67,7 @@ If you want to limit the router scope to a set of entrypoint, set the entrypoint
|
||||||
[http.routers]
|
[http.routers]
|
||||||
[http.routers.Router-1]
|
[http.routers.Router-1]
|
||||||
# By default, routers listen to every entrypoints
|
# By default, routers listen to every entrypoints
|
||||||
rule = "Host(traefik.io)"
|
rule = "Host(`traefik.io`)"
|
||||||
service = "service-1"
|
service = "service-1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -85,7 +85,7 @@ If you want to limit the router scope to a set of entrypoint, set the entrypoint
|
||||||
[http.routers]
|
[http.routers]
|
||||||
[http.routers.Router-1]
|
[http.routers.Router-1]
|
||||||
entryPoints = ["web-secure", "other"] # won't listen to entrypoint web
|
entryPoints = ["web-secure", "other"] # won't listen to entrypoint web
|
||||||
rule = "Host(traefik.io)"
|
rule = "Host(`traefik.io`)"
|
||||||
service = "service-1"
|
service = "service-1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -249,7 +249,7 @@ If you want to limit the router scope to a set of entrypoints, set the entrypoin
|
||||||
### Rule
|
### Rule
|
||||||
|
|
||||||
| Rule | Description |
|
| Rule | Description |
|
||||||
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
|
|------------------------------|-------------------------------------------------------------------------|
|
||||||
| ``HostSNI(`domain-1`, ...)`` | Check if the Server Name Indication corresponds to the given `domains`. |
|
| ``HostSNI(`domain-1`, ...)`` | Check if the Server Name Indication corresponds to the given `domains`. |
|
||||||
|
|
||||||
!!! important "HostSNI & TLS"
|
!!! important "HostSNI & TLS"
|
||||||
|
|
|
@ -80,6 +80,7 @@ The `weight` option defines the weight of the server for the load balancing algo
|
||||||
[http.services.my-service.LoadBalancer]
|
[http.services.my-service.LoadBalancer]
|
||||||
[[http.services.my-service.LoadBalancer.servers]]
|
[[http.services.my-service.LoadBalancer.servers]]
|
||||||
url = "http://private-ip-server-1/"
|
url = "http://private-ip-server-1/"
|
||||||
|
weight = 1
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Load-balancing
|
#### Load-balancing
|
||||||
|
@ -97,8 +98,10 @@ Various methods of load balancing are supported:
|
||||||
method = "drr"
|
method = "drr"
|
||||||
[[http.services.my-service.LoadBalancer.servers]]
|
[[http.services.my-service.LoadBalancer.servers]]
|
||||||
url = "http://private-ip-server-1/"
|
url = "http://private-ip-server-1/"
|
||||||
|
weight = 1
|
||||||
[[http.services.my-service.LoadBalancer.servers]]
|
[[http.services.my-service.LoadBalancer.servers]]
|
||||||
url = "http://private-ip-server-1/"
|
url = "http://private-ip-server-1/"
|
||||||
|
weight = 1
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Sticky sessions
|
#### Sticky sessions
|
||||||
|
|
Loading…
Add table
Reference in a new issue