From dccc075f2c12bc8053085ee07eb58a488a733d85 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Wed, 4 Mar 2020 16:48:05 +0100 Subject: [PATCH] Add some missing doc. --- docs/content/https/acme.md | 17 +++++++------ docs/content/providers/docker.md | 24 +++++++++++++++++++ .../reference/static-configuration/cli-ref.md | 2 +- .../reference/static-configuration/env-ref.md | 2 +- pkg/provider/docker/docker.go | 2 +- 5 files changed, 37 insertions(+), 10 deletions(-) diff --git a/docs/content/https/acme.md b/docs/content/https/acme.md index 9ed02473f..b4c4aa50e 100644 --- a/docs/content/https/acme.md +++ b/docs/content/https/acme.md @@ -396,6 +396,13 @@ As described in [Let's Encrypt's post](https://community.letsencrypt.org/t/stagi ### `caServer` +_Required, Default="https://acme-v02.api.letsencrypt.org/directory"_ + +The CA server to use: + +- Let's Encrypt production server: https://acme-v02.api.letsencrypt.org/directory +- Let's Encrypt staging server: https://acme-staging-v02.api.letsencrypt.org/directory + ??? example "Using the Let's Encrypt staging server" ```toml tab="File (TOML)" @@ -422,6 +429,8 @@ As described in [Let's Encrypt's post](https://community.letsencrypt.org/t/stagi ### `storage` +_Required, Default="acme.json"_ + The `storage` option sets the location where your ACME certificates are saved to. ```toml tab="File (TOML)" @@ -446,13 +455,7 @@ certificatesResolvers: # ... ``` -The value can refer to some kinds of storage: - -- a JSON file - -#### In a File - -ACME certificates can be stored in a JSON file that needs to have a `600` file mode . +ACME certificates are stored in a JSON file that needs to have a `600` file mode. In Docker you can mount either the JSON file, or the folder containing it: diff --git a/docs/content/providers/docker.md b/docs/content/providers/docker.md index 5151872a0..fc0e6058d 100644 --- a/docs/content/providers/docker.md +++ b/docs/content/providers/docker.md @@ -452,6 +452,30 @@ providers: Defines the polling interval (in seconds) in Swarm Mode. +### `watch` + +_Optional, Default=true_ + +```toml tab="File (TOML)" +[providers.docker] + watch = false + # ... +``` + +```yaml tab="File (YAML)" +providers: + docker: + watch: false + # ... +``` + +```bash tab="CLI" +--providers.docker.watch=false +# ... +``` + +Watch Docker Swarm events. + ### `constraints` _Optional, Default=""_ diff --git a/docs/content/reference/static-configuration/cli-ref.md b/docs/content/reference/static-configuration/cli-ref.md index 29c04ca27..7bfd845a1 100644 --- a/docs/content/reference/static-configuration/cli-ref.md +++ b/docs/content/reference/static-configuration/cli-ref.md @@ -346,7 +346,7 @@ TLS key Use the ip address from the bound port, rather than from the inner network. (Default: ```false```) `--providers.docker.watch`: -Watch provider. (Default: ```true```) +Watch Docker Swarm events. (Default: ```true```) `--providers.file.debugloggeneratedtemplate`: Enable debug logging of generated configuration template. (Default: ```false```) diff --git a/docs/content/reference/static-configuration/env-ref.md b/docs/content/reference/static-configuration/env-ref.md index 18ddad5d3..6335db991 100644 --- a/docs/content/reference/static-configuration/env-ref.md +++ b/docs/content/reference/static-configuration/env-ref.md @@ -346,7 +346,7 @@ TLS key Use the ip address from the bound port, rather than from the inner network. (Default: ```false```) `TRAEFIK_PROVIDERS_DOCKER_WATCH`: -Watch provider. (Default: ```true```) +Watch Docker Swarm events. (Default: ```true```) `TRAEFIK_PROVIDERS_FILE_DEBUGLOGGENERATEDTEMPLATE`: Enable debug logging of generated configuration template. (Default: ```false```) diff --git a/pkg/provider/docker/docker.go b/pkg/provider/docker/docker.go index 15c8bba1f..e91b03ef9 100644 --- a/pkg/provider/docker/docker.go +++ b/pkg/provider/docker/docker.go @@ -46,7 +46,7 @@ var _ provider.Provider = (*Provider)(nil) // Provider holds configurations of the provider. type Provider struct { Constraints string `description:"Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container." json:"constraints,omitempty" toml:"constraints,omitempty" yaml:"constraints,omitempty" export:"true"` - Watch bool `description:"Watch provider." json:"watch,omitempty" toml:"watch,omitempty" yaml:"watch,omitempty" export:"true"` + Watch bool `description:"Watch Docker Swarm events." json:"watch,omitempty" toml:"watch,omitempty" yaml:"watch,omitempty" export:"true"` Endpoint string `description:"Docker server endpoint. Can be a tcp or a unix socket endpoint." json:"endpoint,omitempty" toml:"endpoint,omitempty" yaml:"endpoint,omitempty"` DefaultRule string `description:"Default rule." json:"defaultRule,omitempty" toml:"defaultRule,omitempty" yaml:"defaultRule,omitempty"` TLS *types.ClientTLS `description:"Enable Docker TLS support." json:"tls,omitempty" toml:"tls,omitempty" yaml:"tls,omitempty" export:"true"`