Add documentation about entry points definition with CLI.

This commit is contained in:
Ludovic Fernandez 2018-02-05 08:54:03 +01:00 committed by Traefiker
parent 26dc2f4d61
commit be4aeaacde
2 changed files with 40 additions and 7 deletions

View file

@ -2,6 +2,8 @@
## Reference ## Reference
### TOML
```toml ```toml
[entryPoints] [entryPoints]
[entryPoints.http] [entryPoints.http]
@ -63,6 +65,37 @@
# ... # ...
``` ```
### CLI
For more information about the CLI, see the documentation about [Traefik command](/basics/#traefik).
```shell
--entryPoints='Name:http Address::80'
--entryPoints='Name:https Address::443 TLS'
```
!!! note
Whitespace is used as option separator and `,` is used as value separator for the list.
The names of the options are case-insensitive.
All available options:
```ini
Name:foo
Address::80
TLS:goo,gii
TLS
CA:car
CA.Optional:true
Redirect.EntryPoint:https
Redirect.Regex:http://localhost/(.*)
Redirect.Replacement:http://mydomain/$1
Compress:true
WhiteListSourceRange:10.42.0.0/16,152.89.1.33/32,afed:be44::/16
ProxyProtocol.TrustedIPs:192.168.0.1
ProxyProtocol.Insecure:tue
ForwardedHeaders.TrustedIPs:10.0.0.3/24,20.0.0.3/24
```
## Basic ## Basic

View file

@ -35,14 +35,14 @@ TL;DR:
```shell ```shell
$ traefik \ $ traefik \
--entrypoints=Name:http Address::80 Redirect.EntryPoint:https \ --entrypoints='Name:http Address::80 Redirect.EntryPoint:https' \
--entrypoints=Name:https Address::443 TLS \ --entrypoints='Name:https Address::443 TLS' \
--defaultentrypoints=http,https --defaultentrypoints=http,https
``` ```
To listen to different ports, we need to create an entry point for each. To listen to different ports, we need to create an entry point for each.
The CLI syntax is `--entrypoints=Name:a_name Address:an_ip_or_empty:a_port options`. The CLI syntax is `--entrypoints='Name:a_name Address:an_ip_or_empty:a_port options'`.
If you want to redirect traffic from one entry point to another, it's the option `Redirect.EntryPoint:entrypoint_name`. If you want to redirect traffic from one entry point to another, it's the option `Redirect.EntryPoint:entrypoint_name`.
By default, we don't want to configure all our services to listen on http and https, we add a default entry point configuration: `--defaultentrypoints=http,https`. By default, we don't want to configure all our services to listen on http and https, we add a default entry point configuration: `--defaultentrypoints=http,https`.
@ -94,8 +94,8 @@ services:
image: traefik:1.5 image: traefik:1.5
command: command:
- "--api" - "--api"
- "--entrypoints=Name:http Address::80 Redirect.EntryPoint:https" - "--entrypoints='Name:http Address::80 Redirect.EntryPoint:https'"
- "--entrypoints=Name:https Address::443 TLS" - "--entrypoints='Name:https Address::443 TLS'"
- "--defaultentrypoints=http,https" - "--defaultentrypoints=http,https"
- "--acme" - "--acme"
- "--acme.storage=/etc/traefik/acme/acme.json" - "--acme.storage=/etc/traefik/acme/acme.json"
@ -204,8 +204,8 @@ services:
command: command:
- "storeconfig" - "storeconfig"
- "--api" - "--api"
- "--entrypoints=Name:http Address::80 Redirect.EntryPoint:https" - "--entrypoints='Name:http Address::80 Redirect.EntryPoint:https'"
- "--entrypoints=Name:https Address::443 TLS" - "--entrypoints='Name:https Address::443 TLS'"
- "--defaultentrypoints=http,https" - "--defaultentrypoints=http,https"
- "--acme" - "--acme"
- "--acme.storage=traefik/acme/account" - "--acme.storage=traefik/acme/account"