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

Consistent entryPoints capitalization in CLI flag usage

Browse source
This commit is contained in:
Jesper Noordsij 2024-04-22 17:24:04 +02:00 committed by GitHub
parent fe0af1ec4b
commit f84e00e481
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 83 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/content/getting-started/faq.md
View file

@ -93,7 +93,7 @@ The example below is a file provider only version (`yaml`) of what this configur
```yaml tab="Static configuration" ```yaml tab="Static configuration"
# traefik.yml # traefik.yml
entrypoints: entryPoints:
web: web:
address: :80 address: :80

8
docs/content/https/acme.md
View file

@ -116,8 +116,8 @@ Please check the [configuration examples below](#configuration-examples) for mor
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
# ... # ...
--certificatesresolvers.myresolver.acme.email=your-email@example.com --certificatesresolvers.myresolver.acme.email=your-email@example.com
--certificatesresolvers.myresolver.acme.storage=acme.json --certificatesresolvers.myresolver.acme.storage=acme.json
@ -241,8 +241,8 @@ when using the `HTTP-01` challenge, `certificatesresolvers.myresolver.acme.httpc
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
# ... # ...
--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web --certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web
``` ```

16
docs/content/migration/v1-to-v2.md
View file

@ -354,7 +354,7 @@ To apply a redirection:
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints=Name:web Address::80 Redirect.EntryPoint:websecure --entryPoints=Name:web Address::80 Redirect.EntryPoint:websecure
--entryPoints='Name:websecure Address::443 TLS' --entryPoints='Name:websecure Address::443 TLS'
``` ```
@ -394,10 +394,10 @@ To apply a redirection:
```bash tab="CLI" ```bash tab="CLI"
## static configuration ## static configuration
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.web.http.redirections.entrypoint.to=websecure --entryPoints.web.http.redirections.entrypoint.to=websecure
--entrypoints.web.http.redirections.entrypoint.scheme=https --entryPoints.web.http.redirections.entrypoint.scheme=https
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--providers.docker=true --providers.docker=true
``` ```
@ -750,8 +750,8 @@ with the path `/admin` stripped, e.g. to `http://<IP>:<port>/`. In this case, yo
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--certificatesresolvers.myresolver.acme.email=your-email@example.com --certificatesresolvers.myresolver.acme.email=your-email@example.com
--certificatesresolvers.myresolver.acme.storage=acme.json --certificatesresolvers.myresolver.acme.storage=acme.json
--certificatesresolvers.myresolver.acme.tlschallenge=true --certificatesresolvers.myresolver.acme.tlschallenge=true
@ -1078,7 +1078,7 @@ To activate the dashboard, you can either:
routers: routers:
api: api:
rule: Host(`traefik.docker.localhost`) rule: Host(`traefik.docker.localhost`)
entrypoints: entryPoints:
- websecure - websecure
service: api@internal service: api@internal
middlewares: middlewares:

4
docs/content/reference/dynamic-configuration/kubernetes-gateway-traefik-lb-svc.yml
View file

@ -27,8 +27,8 @@ spec:
- name: traefik - name: traefik
image: traefik:v2.11 image: traefik:v2.11
args: args:
- --entrypoints.web.address=:80 - --entryPoints.web.address=:80
- --entrypoints.websecure.address=:443 - --entryPoints.websecure.address=:443
- --experimental.kubernetesgateway - --experimental.kubernetesgateway
- --providers.kubernetesgateway - --providers.kubernetesgateway

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

@ -227,8 +227,8 @@ If both TCP and UDP are wanted for the same port, two entryPoints definitions ar
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.specificIPv4.address=192.168.2.7:8888 --entryPoints.specificIPv4.address=192.168.2.7:8888
--entrypoints.specificIPv6.address=[2001:db8::1]:8888 --entryPoints.specificIPv6.address=[2001:db8::1]:8888
``` ```
Full details for how to specify `address` can be found in [net.Listen](https://golang.org/pkg/net/#Listen) (and [net.Dial](https://golang.org/pkg/net/#Dial)) of the doc for go. Full details for how to specify `address` can be found in [net.Listen](https://golang.org/pkg/net/#Listen) (and [net.Dial](https://golang.org/pkg/net/#Dial)) of the doc for go.
@ -295,7 +295,7 @@ In most scenarios, this entryPoint is the same as the one used for TLS traffic.
```bash tab="CLI" ```bash tab="CLI"
--experimental.http3=true --experimental.http3=true
--entrypoints.name.http3 --entryPoints.name.http3
``` ```
#### `advertisedPort` #### `advertisedPort`
@ -326,7 +326,7 @@ It can be used to override the authority in the `alt-svc` header, for example if
```bash tab="CLI" ```bash tab="CLI"
--experimental.http3=true --experimental.http3=true
--entrypoints.name.http3.advertisedport=443 --entryPoints.name.http3.advertisedport=443
``` ```
### Forwarded Headers ### Forwarded Headers
@ -763,10 +763,10 @@ This whole section is dedicated to options, keyed by entry point, that will appl
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.web.http.redirections.entryPoint.to=websecure --entryPoints.web.http.redirections.entryPoint.to=websecure
--entrypoints.web.http.redirections.entryPoint.scheme=https --entryPoints.web.http.redirections.entryPoint.scheme=https
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
``` ```
#### `entryPoint` #### `entryPoint`
@ -801,7 +801,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.foo.http.redirections.entryPoint.to=websecure --entryPoints.foo.http.redirections.entryPoint.to=websecure
``` ```
??? info "`entryPoint.scheme`" ??? info "`entryPoint.scheme`"
@ -831,7 +831,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.foo.http.redirections.entryPoint.scheme=https --entryPoints.foo.http.redirections.entryPoint.scheme=https
``` ```
??? info "`entryPoint.permanent`" ??? info "`entryPoint.permanent`"
@ -861,7 +861,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.foo.http.redirections.entrypoint.permanent=true --entryPoints.foo.http.redirections.entrypoint.permanent=true
``` ```
??? info "`entryPoint.priority`" ??? info "`entryPoint.priority`"
@ -891,7 +891,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.foo.http.redirections.entrypoint.priority=10 --entryPoints.foo.http.redirections.entrypoint.priority=10
``` ```
### EncodeQuerySemicolons ### EncodeQuerySemicolons
@ -919,8 +919,8 @@ entryPoints:
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.websecure.http.encodequerysemicolons=true --entryPoints.websecure.http.encodequerysemicolons=true
``` ```
#### Examples #### Examples
@ -955,8 +955,8 @@ entryPoints:
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.websecure.http.middlewares=auth@file,strip@file --entryPoints.websecure.http.middlewares=auth@file,strip@file
``` ```
### TLS ### TLS
@ -1002,13 +1002,13 @@ entryPoints:
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.websecure.http.tls.options=foobar --entryPoints.websecure.http.tls.options=foobar
--entrypoints.websecure.http.tls.certResolver=leresolver --entryPoints.websecure.http.tls.certResolver=leresolver
--entrypoints.websecure.http.tls.domains[0].main=example.com --entryPoints.websecure.http.tls.domains[0].main=example.com
--entrypoints.websecure.http.tls.domains[0].sans=foo.example.com,bar.example.com --entryPoints.websecure.http.tls.domains[0].sans=foo.example.com,bar.example.com
--entrypoints.websecure.http.tls.domains[1].main=test.com --entryPoints.websecure.http.tls.domains[1].main=test.com
--entrypoints.websecure.http.tls.domains[1].sans=foo.test.com,bar.test.com --entryPoints.websecure.http.tls.domains[1].sans=foo.test.com,bar.test.com
``` ```
??? example "Let's Encrypt" ??? example "Let's Encrypt"
@ -1031,8 +1031,8 @@ entryPoints:
``` ```
```bash tab="CLI" ```bash tab="CLI"
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.websecure.http.tls.certResolver=leresolver --entryPoints.websecure.http.tls.certResolver=leresolver
``` ```
## UDP Options ## UDP Options
@ -1063,8 +1063,8 @@ entryPoints:
``` ```
```bash tab="CLI" ```bash tab="CLI"
entrypoints.foo.address=:8000/udp --entryPoints.foo.address=:8000/udp
entrypoints.foo.udp.timeout=10s --entryPoints.foo.udp.timeout=10s
``` ```
{!traefik-for-business-applications.md!} {!traefik-for-business-applications.md!}

6
docs/content/routing/providers/kubernetes-crd.md
View file

@ -53,9 +53,9 @@ The Kubernetes Ingress Controller, The Custom Resource Way.
- --log.level=DEBUG - --log.level=DEBUG
- --api - --api
- --api.insecure - --api.insecure
- --entrypoints.web.address=:80 - --entryPoints.web.address=:80
- --entrypoints.tcpep.address=:8000 - --entryPoints.tcpep.address=:8000
- --entrypoints.udpep.address=:9000/udp - --entryPoints.udpep.address=:9000/udp
- --providers.kubernetescrd - --providers.kubernetescrd
ports: ports:
- name: web - name: web

12
docs/content/routing/providers/kubernetes-ingress.md
View file

@ -149,7 +149,7 @@ which in turn will create the resulting routers, services, handlers, etc.
- name: traefik - name: traefik
image: traefik:v2.11 image: traefik:v2.11
args: args:
- --entrypoints.web.address=:80 - --entryPoints.web.address=:80
- --providers.kubernetesingress - --providers.kubernetesingress
ports: ports:
- name: web - name: web
@ -396,8 +396,8 @@ TLS can be enabled through the [HTTP options](../entrypoints.md#tls) of an Entry
```bash tab="CLI" ```bash tab="CLI"
# Static configuration # Static configuration
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.websecure.http.tls --entryPoints.websecure.http.tls
``` ```
```yaml tab="File (YAML)" ```yaml tab="File (YAML)"
@ -552,8 +552,8 @@ This way, any Ingress attached to this Entrypoint will have TLS termination by d
- name: traefik - name: traefik
image: traefik:v2.11 image: traefik:v2.11
args: args:
- --entrypoints.websecure.address=:443 - --entryPoints.websecure.address=:443
- --entrypoints.websecure.http.tls - --entryPoints.websecure.http.tls
- --providers.kubernetesingress - --providers.kubernetesingress
ports: ports:
- name: websecure - name: websecure
@ -762,7 +762,7 @@ For more options, please refer to the available [annotations](#on-ingress).
- name: traefik - name: traefik
image: traefik:v2.11 image: traefik:v2.11
args: args:
- --entrypoints.websecure.address=:443 - --entryPoints.websecure.address=:443
- --providers.kubernetesingress - --providers.kubernetesingress
ports: ports:
- name: websecure - name: websecure

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

@ -146,9 +146,9 @@ If you want to limit the router scope to a set of entry points, set the `entryPo
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.other.address=:9090 --entryPoints.other.address=:9090
``` ```
??? example "Listens to Specific EntryPoints" ??? example "Listens to Specific EntryPoints"
@ -204,9 +204,9 @@ If you want to limit the router scope to a set of entry points, set the `entryPo
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.other.address=:9090 --entryPoints.other.address=:9090
``` ```
### Rule ### Rule
@ -756,9 +756,9 @@ If you want to limit the router scope to a set of entry points, set the entry po
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.other.address=:9090 --entryPoints.other.address=:9090
``` ```
??? example "Listens to Specific Entry Points" ??? example "Listens to Specific Entry Points"
@ -820,9 +820,9 @@ If you want to limit the router scope to a set of entry points, set the entry po
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=:80 --entryPoints.web.address=:80
--entrypoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entrypoints.other.address=:9090 --entryPoints.other.address=:9090
``` ```
### Rule ### Rule
@ -1280,9 +1280,9 @@ If one wants to limit the router scope to a set of entry points, one should set
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=":80" --entryPoints.web.address=":80"
--entrypoints.other.address=":9090/udp" --entryPoints.other.address=":9090/udp"
--entrypoints.streaming.address=":9191/udp" --entryPoints.streaming.address=":9191/udp"
``` ```
??? example "Listens to Specific Entry Points" ??? example "Listens to Specific Entry Points"
@ -1337,9 +1337,9 @@ If one wants to limit the router scope to a set of entry points, one should set
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entrypoints.web.address=":80" --entryPoints.web.address=":80"
--entrypoints.other.address=":9090/udp" --entryPoints.other.address=":9090/udp"
--entrypoints.streaming.address=":9191/udp" --entryPoints.streaming.address=":9191/udp"
``` ```
### Services ### Services

4
docs/content/user-guides/crd-acme/03-deployments.yml
View file

@ -30,8 +30,8 @@ spec:
args: args:
- --api.insecure - --api.insecure
- --accesslog - --accesslog
- --entrypoints.web.Address=:8000 - --entryPoints.web.Address=:8000
- --entrypoints.websecure.Address=:4443 - --entryPoints.websecure.Address=:4443
- --providers.kubernetescrd - --providers.kubernetescrd
- --certificatesresolvers.myresolver.acme.tlschallenge - --certificatesresolvers.myresolver.acme.tlschallenge
- --certificatesresolvers.myresolver.acme.email=foo@you.com - --certificatesresolvers.myresolver.acme.email=foo@you.com

4
docs/content/user-guides/docker-compose/acme-dns/docker-compose.yml
View file

@ -10,8 +10,8 @@ services:
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80" - "--entryPoints.web.address=:80"
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
- "--certificatesresolvers.myresolver.acme.dnschallenge=true" - "--certificatesresolvers.myresolver.acme.dnschallenge=true"
- "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh" - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh"
#- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"

4
docs/content/user-guides/docker-compose/acme-dns/docker-compose_secrets.yml
View file

@ -20,8 +20,8 @@ services:
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80" - "--entryPoints.web.address=:80"
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
- "--certificatesresolvers.myresolver.acme.dnschallenge=true" - "--certificatesresolvers.myresolver.acme.dnschallenge=true"
- "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh" - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh"
#- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"

2
docs/content/user-guides/docker-compose/acme-dns/index.md
View file

@ -64,7 +64,7 @@ What changed between the initial setup:
```yaml ```yaml
command: command:
# Traefik will listen to incoming request on the port 443 (https) # Traefik will listen to incoming request on the port 443 (https)
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
ports: ports:
- "443:443" - "443:443"
``` ```

4
docs/content/user-guides/docker-compose/acme-http/docker-compose.yml
View file

@ -10,8 +10,8 @@ services:
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80" - "--entryPoints.web.address=:80"
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
- "--certificatesresolvers.myresolver.acme.httpchallenge=true" - "--certificatesresolvers.myresolver.acme.httpchallenge=true"
- "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web" - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web"
#- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"

2
docs/content/user-guides/docker-compose/acme-http/index.md
View file

@ -50,7 +50,7 @@ What changed between the basic example:
```yaml ```yaml
command: command:
# Traefik will listen to incoming request on the port 443 (https) # Traefik will listen to incoming request on the port 443 (https)
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
ports: ports:
- "443:443" - "443:443"
``` ```

2
docs/content/user-guides/docker-compose/acme-tls/docker-compose.yml
View file

@ -10,7 +10,7 @@ services:
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
- "--certificatesresolvers.myresolver.acme.tlschallenge=true" - "--certificatesresolvers.myresolver.acme.tlschallenge=true"
#- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"
- "--certificatesresolvers.myresolver.acme.email=postmaster@example.com" - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com"

2
docs/content/user-guides/docker-compose/acme-tls/index.md
View file

@ -50,7 +50,7 @@ What changed between the basic example:
```yaml ```yaml
command: command:
# Traefik will listen to incoming request on the port 443 (https) # Traefik will listen to incoming request on the port 443 (https)
- "--entrypoints.websecure.address=:443" - "--entryPoints.websecure.address=:443"
ports: ports:
- "443:443" - "443:443"
``` ```

2
docs/content/user-guides/docker-compose/basic-example/docker-compose.yml
View file

@ -10,7 +10,7 @@ services:
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80" - "--entryPoints.web.address=:80"
ports: ports:
- "80:80" - "80:80"
- "8080:8080" - "8080:8080"

2
docs/content/user-guides/docker-compose/basic-example/index.md
View file

@ -86,7 +86,7 @@ Second, you define an entry point, along with the exposure of the matching port
```yaml ```yaml
command: command:
# Traefik will listen to incoming request on the port 80 (HTTP) # Traefik will listen to incoming request on the port 80 (HTTP)
- "--entrypoints.web.address=:80" - "--entryPoints.web.address=:80"
ports: ports:
- "80:80" - "80:80"