From be4aeaacde494b23ae15f17d91939d6be92660bd Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Mon, 5 Feb 2018 08:54:03 +0100 Subject: [PATCH] Add documentation about entry points definition with CLI. --- docs/configuration/entrypoints.md | 33 ++++++++++++++++++++++++ docs/user-guide/cluster-docker-consul.md | 14 +++++----- 2 files changed, 40 insertions(+), 7 deletions(-) diff --git a/docs/configuration/entrypoints.md b/docs/configuration/entrypoints.md index dddaf8370..28e5cc049 100644 --- a/docs/configuration/entrypoints.md +++ b/docs/configuration/entrypoints.md @@ -2,6 +2,8 @@ ## Reference +### TOML + ```toml [entryPoints] [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 diff --git a/docs/user-guide/cluster-docker-consul.md b/docs/user-guide/cluster-docker-consul.md index 48c5de9e1..4fb9027f1 100644 --- a/docs/user-guide/cluster-docker-consul.md +++ b/docs/user-guide/cluster-docker-consul.md @@ -35,14 +35,14 @@ TL;DR: ```shell $ traefik \ - --entrypoints=Name:http Address::80 Redirect.EntryPoint:https \ - --entrypoints=Name:https Address::443 TLS \ + --entrypoints='Name:http Address::80 Redirect.EntryPoint:https' \ + --entrypoints='Name:https Address::443 TLS' \ --defaultentrypoints=http,https ``` 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`. 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 command: - "--api" - - "--entrypoints=Name:http Address::80 Redirect.EntryPoint:https" - - "--entrypoints=Name:https Address::443 TLS" + - "--entrypoints='Name:http Address::80 Redirect.EntryPoint:https'" + - "--entrypoints='Name:https Address::443 TLS'" - "--defaultentrypoints=http,https" - "--acme" - "--acme.storage=/etc/traefik/acme/acme.json" @@ -204,8 +204,8 @@ services: command: - "storeconfig" - "--api" - - "--entrypoints=Name:http Address::80 Redirect.EntryPoint:https" - - "--entrypoints=Name:https Address::443 TLS" + - "--entrypoints='Name:http Address::80 Redirect.EntryPoint:https'" + - "--entrypoints='Name:https Address::443 TLS'" - "--defaultentrypoints=http,https" - "--acme" - "--acme.storage=traefik/acme/account"