baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix some minors errors on the documentation

Browse source
This commit is contained in:
Jean-Baptiste Doumenjou 2019-03-26 16:32:06 +01:00 committed by Traefiker Bot
parent 3e76c25887
commit fd26cf265d
9 changed files with 23 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/middlewares/digestauth.md
View file

@ -14,7 +14,8 @@ The DigestAuth middleware is a quick way to restrict access to your services to
```toml
[http.middlewares]
[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"

2
docs/content/middlewares/overview.md
View file

@ -23,7 +23,7 @@ Pieces of middleware can be combined in chains to fit every scenario.
[http.routers.router1]
Service = "myService"
Middlewares = ["foo-add-prefix"]
Rule = "Host: example.com"
Rule = "Host(`example.com`)"
[http.middlewares]
[http.middlewares.foo-add-prefix.AddPrefix]

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

@ -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.
??? note "Dashboard WIP"
!!! warning "Dashboard WIP"
Currently, the dashboard is in a Work In Progress State while being reconstructed for v2.
Therefore, the dashboard is currently not working.

24
docs/content/operations/ping.md
View file

@ -5,30 +5,10 @@ Checking the Health of Your Traefik Instances
## Configuration Examples
??? example "Enabling /ping on the http EntryPoint"
??? example "Enabling /ping"
```toml
[entrypoints]
[entrypoints.web]
address = ":80"
[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"
@ -46,7 +26,7 @@ Checking the Health of Your Traefik Instances
```
| Path | Method | Description |
|---------|---------------|----------------------------------------------------------------------------------------------------|
|---------|---------------|-----------------------------------------------------------------------------------------------------|
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` |
## Configuration Options

2
docs/content/providers/docker.md
View file

@ -17,7 +17,7 @@ Attach labels to your containers and let Traefik do the rest!
Enabling the docker provider
```toml
[docker]
[providers.docker]
endpoint = "unix:///var/run/docker.sock"
```

7
docs/content/routing/entrypoints.md
View file

@ -29,11 +29,6 @@ They define the port which will receive the requests (whether HTTP or TCP).
[entrypoints.web-secure]
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`.
@ -51,7 +46,7 @@ Entrypoints are part of the [static configuration](../getting-started/configurat
```shell
--entryPoints='Name:http Address::80'
--entryPoints='Name:https Address::443 TLS'
--entryPoints='Name:https Address::443'
```
!!! note

10
docs/content/routing/routers/index.md
View file

@ -15,7 +15,7 @@ In the process, routers may use pieces of [middleware](../../middlewares/overvie
```toml
[http.routers]
[http.routers.my-router]
rule = "Path(/foo)"
rule = "Path(`/foo`)"
service = "service-foo"
```
@ -24,7 +24,7 @@ In the process, routers may use pieces of [middleware](../../middlewares/overvie
```toml
[http.routers]
[http.routers.my-router]
rule = "Path(/foo)"
rule = "Path(`/foo`)"
middlewares = ["authentication"] # declared elsewhere
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.Router-1]
# By default, routers listen to every entrypoints
rule = "Host(traefik.io)"
rule = "Host(`traefik.io`)"
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.Router-1]
entryPoints = ["web-secure", "other"] # won't listen to entrypoint web
rule = "Host(traefik.io)"
rule = "Host(`traefik.io`)"
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 | Description |
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
|------------------------------|-------------------------------------------------------------------------|
| ``HostSNI(`domain-1`, ...)`` | Check if the Server Name Indication corresponds to the given `domains`. |
!!! important "HostSNI & TLS"

3
docs/content/routing/services/index.md
View file

@ -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.servers]]
url = "http://private-ip-server-1/"
weight = 1
```
#### Load-balancing
@ -97,8 +98,10 @@ Various methods of load balancing are supported:
method = "drr"
[[http.services.my-service.LoadBalancer.servers]]
url = "http://private-ip-server-1/"
weight = 1
[[http.services.my-service.LoadBalancer.servers]]
url = "http://private-ip-server-1/"
weight = 1
```
#### Sticky sessions