mirror of
https://github.com/traefik/traefik.git
synced 2025-10-31 00:11:38 +01:00
203 lines
3.5 KiB
Markdown
203 lines
3.5 KiB
Markdown
---
|
|
title: "Traefik HTTP Documentation"
|
|
description: "Provide your dynamic configuration via an HTTP(S) endpoint and let Traefik Proxy do the rest. Read the technical documentation."
|
|
---
|
|
|
|
# Traefik & HTTP
|
|
|
|
Provide your [dynamic configuration](./overview.md) via an HTTP(S) endpoint and let Traefik do the rest!
|
|
|
|
## Routing Configuration
|
|
|
|
The HTTP provider uses the same configuration as the [File Provider](./file.md) in YAML or JSON format.
|
|
|
|
## Provider Configuration
|
|
|
|
### `endpoint`
|
|
|
|
_Required_
|
|
|
|
Defines the HTTP(S) endpoint to poll.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
endpoint: "http://127.0.0.1:9000/api"
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http]
|
|
endpoint = "http://127.0.0.1:9000/api"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.endpoint=http://127.0.0.1:9000/api
|
|
```
|
|
|
|
### `pollInterval`
|
|
|
|
_Optional, Default="5s"_
|
|
|
|
Defines the polling interval.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
pollInterval: "5s"
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http]
|
|
pollInterval = "5s"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.pollInterval=5s
|
|
```
|
|
|
|
### `pollTimeout`
|
|
|
|
_Optional, Default="5s"_
|
|
|
|
Defines the polling timeout when connecting to the endpoint.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
pollTimeout: "5s"
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http]
|
|
pollTimeout = "5s"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.pollTimeout=5s
|
|
```
|
|
|
|
### `headers`
|
|
|
|
_Optional_
|
|
|
|
Defines custom headers to be sent to the endpoint.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
headers:
|
|
name: value
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http.headers]
|
|
name = "value"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.headers.name=value
|
|
```
|
|
|
|
### `tls`
|
|
|
|
_Optional_
|
|
|
|
Defines the TLS configuration used for the secure connection to the endpoint.
|
|
|
|
#### `ca`
|
|
|
|
_Optional_
|
|
|
|
`ca` is the path to the certificate authority used for the secure connection to the endpoint,
|
|
it defaults to the system bundle.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
tls:
|
|
ca: path/to/ca.crt
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http.tls]
|
|
ca = "path/to/ca.crt"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.tls.ca=path/to/ca.crt
|
|
```
|
|
|
|
#### `cert`
|
|
|
|
_Optional_
|
|
|
|
`cert` is the path to the public certificate used for the secure connection to the endpoint.
|
|
When using this option, setting the `key` option is required.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
tls:
|
|
cert: path/to/foo.cert
|
|
key: path/to/foo.key
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http.tls]
|
|
cert = "path/to/foo.cert"
|
|
key = "path/to/foo.key"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.tls.cert=path/to/foo.cert
|
|
--providers.http.tls.key=path/to/foo.key
|
|
```
|
|
|
|
#### `key`
|
|
|
|
_Optional_
|
|
|
|
`key` is the path to the private key used for the secure connection to the endpoint.
|
|
When using this option, setting the `cert` option is required.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
tls:
|
|
cert: path/to/foo.cert
|
|
key: path/to/foo.key
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http.tls]
|
|
cert = "path/to/foo.cert"
|
|
key = "path/to/foo.key"
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.tls.cert=path/to/foo.cert
|
|
--providers.http.tls.key=path/to/foo.key
|
|
```
|
|
|
|
#### `insecureSkipVerify`
|
|
|
|
_Optional, Default=false_
|
|
|
|
If `insecureSkipVerify` is `true`, the TLS connection to the endpoint accepts any certificate presented by the server regardless of the hostnames it covers.
|
|
|
|
```yaml tab="File (YAML)"
|
|
providers:
|
|
http:
|
|
tls:
|
|
insecureSkipVerify: true
|
|
```
|
|
|
|
```toml tab="File (TOML)"
|
|
[providers.http.tls]
|
|
insecureSkipVerify = true
|
|
```
|
|
|
|
```bash tab="CLI"
|
|
--providers.http.tls.insecureSkipVerify=true
|
|
```
|