Merge pull request #280 from containous/add-doc-site
Add docs.traefik.io
This commit is contained in:
Vincent Demeester
commit
ab0d648a03
27 changed files with 9497 additions and 1235 deletions
|
|
@ -1,3 +1,4 @@
|
||||||
dist/
|
dist/
|
||||||
vendor/
|
vendor/
|
||||||
!dist/traefik
|
!dist/traefik
|
||||||
|
site/
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -10,3 +10,4 @@ traefik.toml
|
||||||
vendor/
|
vendor/
|
||||||
static/
|
static/
|
||||||
.vscode/
|
.vscode/
|
||||||
|
site/
|
||||||
34
.travis.yml
34
.travis.yml
|
|
@ -1,6 +1,6 @@
|
||||||
branches:
|
branches:
|
||||||
except:
|
except:
|
||||||
- /^v\d\.\d\.\d.*$/
|
- /^v\d\.\d\.\d.*$/
|
||||||
|
|
||||||
env:
|
env:
|
||||||
REPO: $TRAVIS_REPO_SLUG
|
REPO: $TRAVIS_REPO_SLUG
|
||||||
|
|
@ -9,23 +9,31 @@ env:
|
||||||
sudo: required
|
sudo: required
|
||||||
|
|
||||||
services:
|
services:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
|
before_install:
|
||||||
|
- openssl aes-256-cbc -K $encrypted_27087ae1f4db_key -iv $encrypted_27087ae1f4db_iv -in .travis/traefik.id_rsa.enc -out ~/.ssh/traefik.id_rsa -d
|
||||||
|
- eval "$(ssh-agent -s)"
|
||||||
|
- chmod 600 ~/.ssh/traefik.id_rsa
|
||||||
|
- ssh-add ~/.ssh/traefik.id_rsa
|
||||||
|
|
||||||
install:
|
install:
|
||||||
- sudo service docker stop
|
- sudo service docker stop
|
||||||
- sudo curl https://get.docker.com/builds/Linux/x86_64/docker-1.10.1 -o /usr/bin/docker
|
- sudo curl https://get.docker.com/builds/Linux/x86_64/docker-1.10.1 -o /usr/bin/docker
|
||||||
- sudo chmod +x /usr/bin/docker
|
- sudo chmod +x /usr/bin/docker
|
||||||
- sudo service docker start
|
- sudo service docker start
|
||||||
|
- pip install --user mkdocs
|
||||||
|
- pip install --user pymdown-extensions
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- make validate
|
- make validate
|
||||||
- make binary
|
- make binary
|
||||||
|
|
||||||
script:
|
script:
|
||||||
- make test-unit
|
- make test-unit
|
||||||
- make test-integration
|
- make test-integration
|
||||||
- make crossbinary
|
- make crossbinary
|
||||||
- make image
|
- make image
|
||||||
|
|
||||||
after_success:
|
after_success:
|
||||||
- make deploy
|
- make deploy
|
||||||
BIN
.travis/traefik.id_rsa.enc
Normal file
BIN
.travis/traefik.id_rsa.enc
Normal file
Binary file not shown.
34
README.md
34
README.md
|
|
@ -1,18 +1,42 @@
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="http://traefik.github.io/traefik.logo.svg" alt="Træfɪk" title="Træfɪk" />
|
<img src="docs/img/traefik.logo.png" alt="Træfɪk" title="Træfɪk" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[](https://travis-ci.org/containous/traefik)
|
[](https://travis-ci.org/containous/traefik)
|
||||||
[](http://goreportcard.com/report/containous/traefik)
|
[](https://docs.traefik.io)
|
||||||
|
[](http://goreportcard.com/report/containous/traefik)
|
||||||
[](https://github.com/containous/traefik/blob/master/LICENSE.md)
|
[](https://github.com/containous/traefik/blob/master/LICENSE.md)
|
||||||
[](https://traefik.herokuapp.com)
|
[](https://traefik.herokuapp.com)
|
||||||
[](https://twitter.com/intent/follow?screen_name=traefikproxy)
|
[](https://twitter.com/intent/follow?screen_name=traefikproxy)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
|
Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
|
||||||
It supports several backends ([Docker :whale:](https://www.docker.com/), [Swarm :whale: :whale:](https://docs.docker.com/swarm), [Mesos/Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Zookeeper](https://zookeeper.apache.org), [BoltDB](https://github.com/boltdb/bolt), Rest API, file...) to manage its configuration automatically and dynamically.
|
It supports several backends ([Docker](https://www.docker.com/), [Swarm](https://docs.docker.com/swarm), [Mesos/Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Zookeeper](https://zookeeper.apache.org), [BoltDB](https://github.com/boltdb/bolt), Rest API, file...) to manage its configuration automatically and dynamically.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Imagine that you have deployed a bunch of microservices on your infrastructure. You probably used a service registry (like etcd or consul) and/or an orchestrator (swarm, Mesos/Marathon) to manage all these services.
|
||||||
|
If you want your users to access some of your microservices from the Internet, you will have to use a reverse proxy and configure it using virtual hosts or prefix paths:
|
||||||
|
|
||||||
|
- domain `api.domain.com` will point the microservice `api` in your private network
|
||||||
|
- path `domain.com/web` will point the microservice `web` in your private network
|
||||||
|
- domain `backoffice.domain.com` will point the microservices `backoffice` in your private network, load-balancing between your multiple instances
|
||||||
|
|
||||||
|
But a microservices architecture is dynamic... Services are added, removed, killed or upgraded often, eventually several times a day.
|
||||||
|
|
||||||
|
Traditional reverse-proxies are not natively dynamic. You can't change their configuration and hot-reload easily.
|
||||||
|
|
||||||
|
Here enters Træfɪk.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Træfɪk can listen to your service registry/orchestrator API, and knows each time a microservice is added, removed, killed or upgraded, and can generate its configuration automatically.
|
||||||
|
Routes to your services will be created instantly.
|
||||||
|
|
||||||
|
Run it and forget it!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
@ -79,7 +103,7 @@ git clone https://github.com/containous/traefik
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
You can find the complete documentation [here](docs/index.md).
|
You can find the complete documentation [here](https://docs.traefik.io).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
1
docs/CNAME
Normal file
1
docs/CNAME
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
docs.traefik.io
|
||||||
181
docs/basics.md
Normal file
181
docs/basics.md
Normal file
|
|
@ -0,0 +1,181 @@
|
||||||
|
|
||||||
|
# Concepts
|
||||||
|
|
||||||
|
Let's take our example from the [overview](https://docs.traefik.io/#overview) again:
|
||||||
|
|
||||||
|
|
||||||
|
> Imagine that you have deployed a bunch of microservices on your infrastructure. You probably used a service registry (like etcd or consul) and/or an orchestrator (swarm, Mesos/Marathon) to manage all these services.
|
||||||
|
> If you want your users to access some of your microservices from the Internet, you will have to use a reverse proxy and configure it using virtual hosts or prefix paths:
|
||||||
|
|
||||||
|
> - domain `api.domain.com` will point the microservice `api` in your private network
|
||||||
|
> - path `domain.com/web` will point the microservice `web` in your private network
|
||||||
|
> - domain `backoffice.domain.com` will point the microservices `backoffice` in your private network, load-balancing between your multiple instances
|
||||||
|
|
||||||
|
> 
|
||||||
|
|
||||||
|
Let's zoom on Træfɪk and have an overview of its internal architecture:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- Incoming requests end on [entrypoints](#entrypoints), as the name suggests, they are the network entry points into Træfɪk (listening port, SSL, traffic redirection...).
|
||||||
|
- Traffic is then forwared to a matching [frontend](#frontends). A frontend defines routes from [entrypoints](#entrypoints) to [backends](#backends).
|
||||||
|
Routes are created using requests fields (`Host`, `Path`, `Headers`...) and can match or not a request.
|
||||||
|
- The [frontend](#frontends) will then send the request to a [backend](#backends). A backend can be composed by one or more [servers](#servers), and by a load-balancing strategy.
|
||||||
|
- Finally, the [server](#servers) will forward the request to the corresponding microservice in the private network.
|
||||||
|
|
||||||
|
## Entrypoints
|
||||||
|
|
||||||
|
Entrypoints are the network entry points into Træfɪk.
|
||||||
|
They can be defined using:
|
||||||
|
|
||||||
|
- a port (80, 443...)
|
||||||
|
- SSL (Certificates. Keys...)
|
||||||
|
- redirection to another entrypoint (redirect `HTTP` to `HTTPS`)
|
||||||
|
|
||||||
|
Here is an example of entrypoints definition:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
[entryPoints.http.redirect]
|
||||||
|
entryPoint = "https"
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
certFile = "tests/traefik.crt"
|
||||||
|
keyFile = "tests/traefik.key"
|
||||||
|
```
|
||||||
|
|
||||||
|
- Two entrypoints are defined `http` and `https`.
|
||||||
|
- `http` listens on port `80` et `https` on port `443`.
|
||||||
|
- We enable SSL en `https` by giving a certificate and a key.
|
||||||
|
- We also redirect all the traffic from entrypoint `http` to `https`.
|
||||||
|
|
||||||
|
## Frontends
|
||||||
|
|
||||||
|
A frontend is a set of rules that forwards the incoming traffic from an entrypoint to a backend.
|
||||||
|
Frontends can be defined using the following rules:
|
||||||
|
|
||||||
|
- `Headers`: Headers adds a matcher for request header values. It accepts a sequence of key/value pairs to be matched. For example: `Content-Type, application/json`
|
||||||
|
- `HeadersRegexp`: Regular expressions can be used with headers as well. It accepts a sequence of key/value pairs, where the value has regex support. For example: `Content-Type, application/(text|json)`
|
||||||
|
- `Host`: Host adds a matcher for the URL host. It accepts a template with zero or more URL variables enclosed by `{}`. Variables can define an optional regexp pattern to be matched: `www.traefik.io`, `{subdomain:[a-z]+}.traefik.io`
|
||||||
|
- `Methods`: Methods adds a matcher for HTTP methods. It accepts a sequence of one or more methods to be matched, e.g.: `GET`, `POST`, `PUT`
|
||||||
|
- `Path`: Path adds a matcher for the URL path. It accepts a template with zero or more URL variables enclosed by `{}`. The template must start with a `/`. For exemple `/products/` `/articles/{category}/{id:[0-9]+}`
|
||||||
|
- `PathStrip`: Same as `Path` but strip the given prefix from the request URL's Path.
|
||||||
|
- `PathPrefix`: PathPrefix adds a matcher for the URL path prefix. This matches if the given template is a prefix of the full URL path.
|
||||||
|
- `PathPrefixStrip`: Same as `PathPrefix` but strip the given prefix from the request URL's Path.
|
||||||
|
|
||||||
|
You can optionally enable `passHostHeader` to forward client `Host` header to the backend.
|
||||||
|
|
||||||
|
Here is an example of frontends definition:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[frontends]
|
||||||
|
[frontends.frontend1]
|
||||||
|
backend = "backend2"
|
||||||
|
[frontends.frontend1.routes.test_1]
|
||||||
|
rule = "Host:test.localhost"
|
||||||
|
[frontends.frontend2]
|
||||||
|
backend = "backend1"
|
||||||
|
passHostHeader = true
|
||||||
|
entrypoints = ["https"] # overrides defaultEntryPoints
|
||||||
|
[frontends.frontend2.routes.test_1]
|
||||||
|
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||||||
|
[frontends.frontend3]
|
||||||
|
backend = "backend2"
|
||||||
|
rule = "Path:/test"
|
||||||
|
```
|
||||||
|
|
||||||
|
- Three frontends are defined: `frontend1`, `frontend2` and `frontend3`
|
||||||
|
- `frontend1` will forward the traffic to the `backend2` if the rule `Host:test.localhost` is matched
|
||||||
|
- `frontend2` will forward the traffic to the `backend1` if the rule `Host:{subdomain:[a-z]+}.localhost` is matched (forwarding client `Host` header to the backend)
|
||||||
|
- `frontend3` will forward the traffic to the `backend2` if the rule `Path:/test` is matched
|
||||||
|
|
||||||
|
## Backends
|
||||||
|
|
||||||
|
A backend is responsible to load-balance the traffic coming from one or more frontends to a set of http servers.
|
||||||
|
Various methods of load-balancing is supported:
|
||||||
|
|
||||||
|
- `wrr`: Weighted Round Robin
|
||||||
|
- `drr`: Dynamic Round Robin: increases weights on servers that perform better than others. It also rolls back to original weights if the servers have changed.
|
||||||
|
|
||||||
|
A circuit breaker can also be applied to a backend, preventing high loads on failing servers.
|
||||||
|
Initial state is Standby. CB observes the statistics and does not modify the request.
|
||||||
|
In case if condition matches, CB enters Tripped state, where it responds with predefines code or redirects to another frontend.
|
||||||
|
Once Tripped timer expires, CB enters Recovering state and resets all stats.
|
||||||
|
In case if the condition does not match and recovery timer expries, CB enters Standby state.
|
||||||
|
|
||||||
|
It can be configured using:
|
||||||
|
|
||||||
|
- Methods: `LatencyAtQuantileMS`, `NetworkErrorRatio`, `ResponseCodeRatio`
|
||||||
|
- Operators: `AND`, `OR`, `EQ`, `NEQ`, `LT`, `LE`, `GT`, `GE`
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
- `NetworkErrorRatio() > 0.5`: watch error ratio over 10 second sliding window for a frontend
|
||||||
|
- `LatencyAtQuantileMS(50.0) > 50`: watch latency at quantile in milliseconds.
|
||||||
|
- `ResponseCodeRatio(500, 600, 0, 600) > 0.5`: ratio of response codes in range [500-600) to [0-600)
|
||||||
|
|
||||||
|
## Servers
|
||||||
|
|
||||||
|
Servers are simply defined using a `URL`. You can also apply a custom `weight` to each server (this will be used by load-balacning).
|
||||||
|
|
||||||
|
Here is an example of backends and servers definition:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[backends]
|
||||||
|
[backends.backend1]
|
||||||
|
[backends.backend1.circuitbreaker]
|
||||||
|
expression = "NetworkErrorRatio() > 0.5"
|
||||||
|
[backends.backend1.servers.server1]
|
||||||
|
url = "http://172.17.0.2:80"
|
||||||
|
weight = 10
|
||||||
|
[backends.backend1.servers.server2]
|
||||||
|
url = "http://172.17.0.3:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2]
|
||||||
|
[backends.backend2.LoadBalancer]
|
||||||
|
method = "drr"
|
||||||
|
[backends.backend2.servers.server1]
|
||||||
|
url = "http://172.17.0.4:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2.servers.server2]
|
||||||
|
url = "http://172.17.0.5:80"
|
||||||
|
weight = 2
|
||||||
|
```
|
||||||
|
|
||||||
|
- Two backends are defined: `backend1` and `backend2`
|
||||||
|
- `backend1` will forward the traffic to two servers: `http://172.17.0.2:80"` with weight `10` and `http://172.17.0.3:80` with weight `1` using default `wrr` load-balancing strategy.
|
||||||
|
- `backend2` will forward the traffic to two servers: `http://172.17.0.4:80"` with weight `1` and `http://172.17.0.5:80` with weight `2` using `drr` load-balancing strategy.
|
||||||
|
- a circuit breaker is added on `backend1` using the expression `NetworkErrorRatio() > 0.5`: watch error ratio over 10 second sliding window
|
||||||
|
|
||||||
|
# Launch
|
||||||
|
|
||||||
|
Træfɪk can be configured using a TOML file configuration, arguments, or both.
|
||||||
|
By default, Træfɪk will try to find a `traefik.toml` in the following places:
|
||||||
|
|
||||||
|
- `/etc/traefik/`
|
||||||
|
- `$HOME/.traefik/`
|
||||||
|
- `.` *the working directory*
|
||||||
|
|
||||||
|
You can override this by setting a `configFile` argument:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ traefik --configFile=foo/bar/myconfigfile.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
Træfɪk uses the following precedence order. Each item takes precedence over the item below it:
|
||||||
|
|
||||||
|
- arguments
|
||||||
|
- configuration file
|
||||||
|
- default
|
||||||
|
|
||||||
|
It means that arguments overrides configuration file.
|
||||||
|
Each argument is described in the help section:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ traefik --help
|
||||||
|
```
|
||||||
70
docs/benchmarks.md
Normal file
70
docs/benchmarks.md
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
# Benchmarks
|
||||||
|
|
||||||
|
Here are some early Benchmarks between Nginx, HA-Proxy and Træfɪk acting as simple load balancers between two servers.
|
||||||
|
|
||||||
|
- Nginx:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ docker run -d -e VIRTUAL_HOST=test.nginx.localhost emilevauge/whoami
|
||||||
|
$ docker run -d -e VIRTUAL_HOST=test.nginx.localhost emilevauge/whoami
|
||||||
|
$ docker run --log-driver=none -d -p 80:80 -v /var/run/docker.sock:/tmp/docker.sock:ro jwilder/nginx-proxy
|
||||||
|
$ wrk -t12 -c400 -d60s -H "Host: test.nginx.localhost" --latency http://127.0.0.1:80
|
||||||
|
Running 1m test @ http://127.0.0.1:80
|
||||||
|
12 threads and 400 connections
|
||||||
|
Thread Stats Avg Stdev Max +/- Stdev
|
||||||
|
Latency 162.61ms 203.34ms 1.72s 91.07%
|
||||||
|
Req/Sec 277.57 107.67 790.00 67.53%
|
||||||
|
Latency Distribution
|
||||||
|
50% 128.19ms
|
||||||
|
75% 218.22ms
|
||||||
|
90% 342.12ms
|
||||||
|
99% 1.08s
|
||||||
|
197991 requests in 1.00m, 82.32MB read
|
||||||
|
Socket errors: connect 0, read 0, write 0, timeout 18
|
||||||
|
Requests/sec: 3296.04
|
||||||
|
Transfer/sec: 1.37MB
|
||||||
|
```
|
||||||
|
|
||||||
|
- HA-Proxy:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ docker run -d --name web1 -e VIRTUAL_HOST=test.haproxy.localhost emilevauge/whoami
|
||||||
|
$ docker run -d --name web2 -e VIRTUAL_HOST=test.haproxy.localhost emilevauge/whoami
|
||||||
|
$ docker run -d -p 80:80 --link web1:web1 --link web2:web2 dockercloud/haproxy
|
||||||
|
$ wrk -t12 -c400 -d60s -H "Host: test.haproxy.localhost" --latency http://127.0.0.1:80
|
||||||
|
Running 1m test @ http://127.0.0.1:80
|
||||||
|
12 threads and 400 connections
|
||||||
|
Thread Stats Avg Stdev Max +/- Stdev
|
||||||
|
Latency 158.08ms 187.88ms 1.75s 89.61%
|
||||||
|
Req/Sec 281.33 120.47 0.98k 65.88%
|
||||||
|
Latency Distribution
|
||||||
|
50% 121.77ms
|
||||||
|
75% 227.10ms
|
||||||
|
90% 351.98ms
|
||||||
|
99% 1.01s
|
||||||
|
200462 requests in 1.00m, 59.65MB read
|
||||||
|
Requests/sec: 3337.66
|
||||||
|
Transfer/sec: 0.99MB
|
||||||
|
```
|
||||||
|
|
||||||
|
- Træfɪk:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ docker run -d -l traefik.backend=test1 -l traefik.frontend.rule=Host -l traefik.frontend.value=test.traefik.localhost emilevauge/whoami
|
||||||
|
$ docker run -d -l traefik.backend=test1 -l traefik.frontend.rule=Host -l traefik.frontend.value=test.traefik.localhost emilevauge/whoami
|
||||||
|
$ docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/traefik.toml -v /var/run/docker.sock:/var/run/docker.sock containous/traefik
|
||||||
|
$ wrk -t12 -c400 -d60s -H "Host: test.traefik.localhost" --latency http://127.0.0.1:80
|
||||||
|
Running 1m test @ http://127.0.0.1:80
|
||||||
|
12 threads and 400 connections
|
||||||
|
Thread Stats Avg Stdev Max +/- Stdev
|
||||||
|
Latency 132.93ms 121.89ms 1.20s 66.62%
|
||||||
|
Req/Sec 280.95 104.88 740.00 68.26%
|
||||||
|
Latency Distribution
|
||||||
|
50% 128.71ms
|
||||||
|
75% 214.15ms
|
||||||
|
90% 281.45ms
|
||||||
|
99% 498.44ms
|
||||||
|
200734 requests in 1.00m, 80.02MB read
|
||||||
|
Requests/sec: 3340.13
|
||||||
|
Transfer/sec: 1.33MB
|
||||||
|
```
|
||||||
43
docs/css/traefik.css
Normal file
43
docs/css/traefik.css
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
a {
|
||||||
|
color: #37ABC8;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover, a:focus {
|
||||||
|
color: #25606F;
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, H4 {
|
||||||
|
color: #37ABC8;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default {
|
||||||
|
background-color: #37ABC8;
|
||||||
|
border-color: #25606F;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default .navbar-nav>.active>a, .navbar-default .navbar-nav>.active>a:hover, .navbar-default .navbar-nav>.active>a:focus {
|
||||||
|
color: #fff;
|
||||||
|
background-color: #25606F;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default .navbar-nav>li>a:hover, .navbar-default .navbar-nav>li>a:focus {
|
||||||
|
color: #fff;
|
||||||
|
background-color: #25606F;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default .navbar-toggle {
|
||||||
|
border-color: #25606F;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default .navbar-toggle:hover, .navbar-default .navbar-toggle:focus .navbar-toggle {
|
||||||
|
background-color: #25606F;
|
||||||
|
}
|
||||||
|
.navbar-default .navbar-collapse, .navbar-default .navbar-form {
|
||||||
|
border-color: #25606F;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote p {
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
BIN
docs/img/architecture.png
Normal file
BIN
docs/img/architecture.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 354 KiB |
2407
docs/img/architecture.svg
Normal file
2407
docs/img/architecture.svg
Normal file
File diff suppressed because it is too large
Load diff
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/img/internal.png
Normal file
BIN
docs/img/internal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 323 KiB |
172
docs/img/letsencrypt-logo-horizontal.svg
Normal file
172
docs/img/letsencrypt-logo-horizontal.svg
Normal file
|
|
@ -0,0 +1,172 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
width="337.37802"
|
||||||
|
height="107.921"
|
||||||
|
id="svg2"
|
||||||
|
version="1.1"
|
||||||
|
inkscape:version="0.48.4 r9939"
|
||||||
|
sodipodi:docname="letsencrypt-logo-horizontal.svg">
|
||||||
|
<metadata
|
||||||
|
id="metadata37">
|
||||||
|
<rdf:RDF>
|
||||||
|
<cc:Work
|
||||||
|
rdf:about="">
|
||||||
|
<dc:format>image/svg+xml</dc:format>
|
||||||
|
<dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||||
|
</cc:Work>
|
||||||
|
</rdf:RDF>
|
||||||
|
</metadata>
|
||||||
|
<defs
|
||||||
|
id="defs35" />
|
||||||
|
<sodipodi:namedview
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1"
|
||||||
|
objecttolerance="10"
|
||||||
|
gridtolerance="10"
|
||||||
|
guidetolerance="10"
|
||||||
|
inkscape:pageopacity="0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:window-width="640"
|
||||||
|
inkscape:window-height="480"
|
||||||
|
id="namedview33"
|
||||||
|
showgrid="false"
|
||||||
|
fit-margin-bottom="30"
|
||||||
|
fit-margin-top="0"
|
||||||
|
fit-margin-left="0"
|
||||||
|
fit-margin-right="0"
|
||||||
|
inkscape:zoom="0.72861357"
|
||||||
|
inkscape:cx="168.57"
|
||||||
|
inkscape:cy="69.027001"
|
||||||
|
inkscape:window-x="0"
|
||||||
|
inkscape:window-y="30"
|
||||||
|
inkscape:window-maximized="0"
|
||||||
|
inkscape:current-layer="svg2" />
|
||||||
|
<g
|
||||||
|
id="g4"
|
||||||
|
transform="translate(-0.930001,-1.606)">
|
||||||
|
<title
|
||||||
|
id="title6">Layer 1</title>
|
||||||
|
<g
|
||||||
|
id="svg_1">
|
||||||
|
<g
|
||||||
|
id="svg_2">
|
||||||
|
<g
|
||||||
|
id="svg_3">
|
||||||
|
<path
|
||||||
|
id="svg_4"
|
||||||
|
d="m 76.621002,68.878998 0,-31.406998 7.629997,0 0,24.796997 12.153999,0 0,6.609001 -19.783997,0 0,9.99e-4 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_5"
|
||||||
|
d="m 121.547,58.098999 c 0,0.295998 0,0.592003 0,0.888 0,0.295997 -0.015,0.576004 -0.044,0.843002 l -16.01301,0 c 0.059,0.620995 0.244,1.182999 0.555,1.685997 0.311,0.502998 0.71,0.938004 1.197,1.308998 0.488,0.370003 1.035,0.658005 1.642,0.864006 0.605,0.208 1.234,0.310997 1.885,0.310997 1.153,0 2.13,-0.213997 2.928,-0.642998 0.799,-0.429001 1.449,-0.983002 1.952,-1.664001 l 5.05699,3.194 c -1.03498,1.507996 -2.40199,2.668999 -4.10299,3.482002 -1.701,0.811996 -3.676,1.219994 -5.922,1.219994 -1.657,0 -3.224,-0.259995 -4.702,-0.775993 -1.479,-0.518005 -2.772,-1.271004 -3.882,-2.263 -1.108,-0.990005 -1.981,-2.210007 -2.616996,-3.659004 -0.635994,-1.448997 -0.953003,-3.104996 -0.953003,-4.969002 0,-1.802994 0.309998,-3.437996 0.931,-4.900997 0.620999,-1.463001 1.463999,-2.706001 2.528999,-3.726002 1.064,-1.021 2.32,-1.811996 3.771,-2.373997 1.448,-0.561001 3.016,-0.843002 4.701,-0.843002 1.626,0 3.12,0.274002 4.48,0.820999 1.36,0.546997 2.528,1.338001 3.505,2.373001 0.976,1.035 1.73599,2.292 2.284,3.771 0.546,1.478001 0.819,3.165001 0.819,5.056 z m -6.698,-2.794998 c 0,-1.153 -0.362,-2.144001 -1.087,-2.972 -0.725,-0.827 -1.812,-1.242001 -3.26,-1.242001 -0.71,0 -1.36,0.111 -1.952,0.333 -0.59199,0.222 -1.108,0.525002 -1.553,0.909 -0.443,0.384998 -0.798,0.835999 -1.064,1.354 -0.266,0.517998 -0.414,1.057999 -0.443,1.618 l 9.359,0 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_6"
|
||||||
|
d="m 133.168,52.200001 0,8.461002 c 0,1.038994 0.2,1.816994 0.60001,2.337997 0.39799,0.519997 1.11499,0.778 2.151,0.778 0.35399,0 0.73098,-0.028 1.13099,-0.089 0.39901,-0.05901 0.73101,-0.147003 0.998,-0.266006 l 0.089,5.323006 c -0.50299,0.176994 -1.13899,0.332001 -1.90699,0.465996 -0.76999,0.133003 -1.538,0.199005 -2.307,0.199005 -1.479,0 -2.722,-0.186005 -3.727,-0.556007 C 129.19,68.484002 128.384,67.949998 127.77901,67.252 127.172,66.556001 126.73599,65.725999 126.47,64.762002 126.203,63.799005 126.071,62.724 126.071,61.538003 l 0,-9.338001 -3.549,0 0,-5.412003 3.504,0 0,-5.810997 7.142,0 0,5.810997 5.19,0 0,5.412003 -5.19,0 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_7"
|
||||||
|
d="m 161.91299,53.307999 c -0.59201,-0.560997 -1.28601,-1.034 -2.085,-1.418999 -0.79801,-0.383999 -1.64099,-0.577 -2.528,-0.577 -0.681,0 -1.30899,0.133999 -1.885,0.398998 -0.57699,0.267002 -0.865,0.726002 -0.865,1.375 0,0.621002 0.317,1.064003 0.953,1.331001 0.636,0.266998 1.664,0.562 3.08299,0.887001 0.82801,0.177998 1.664,0.43 2.50701,0.754997 0.843,0.324997 1.604,0.754005 2.28399,1.286003 0.68001,0.531998 1.22701,1.182999 1.64202,1.951996 0.41299,0.769005 0.62098,1.686005 0.62098,2.75 0,1.391006 -0.28099,2.565002 -0.84298,3.526001 -0.56201,0.960999 -1.29401,1.737 -2.19602,2.329002 -0.902,0.592002 -1.91499,1.019997 -3.03799,1.286003 -1.12399,0.266998 -2.248,0.398994 -3.371,0.398994 -1.80499,0 -3.571,-0.287994 -5.302,-0.864998 C 149.161,68.146002 147.719,67.294996 146.566,66.170995 l 4.08099,-4.303001 c 0.649,0.710007 1.448,1.302002 2.395,1.774002 0.946,0.473999 1.952,0.709999 3.017,0.709999 0.592,0 1.176,-0.140999 1.752,-0.421997 0.577,-0.279999 0.86501,-0.776001 0.86501,-1.485001 0,-0.681 -0.35401,-1.182999 -1.06401,-1.509003 -0.71,-0.324997 -1.818,-0.664993 -3.327,-1.020996 -0.769,-0.177002 -1.53799,-0.413002 -2.30699,-0.709 -0.77001,-0.295998 -1.457,-0.694 -2.06202,-1.197998 -0.60598,-0.502007 -1.10199,-1.123001 -1.48599,-1.863007 -0.384,-0.737995 -0.576,-1.625996 -0.576,-2.660995 0,-1.331001 0.28,-2.462002 0.843,-3.394001 0.562,-0.931999 1.286,-1.692001 2.174,-2.284 0.88701,-0.591999 1.87001,-1.027 2.949,-1.308998 1.079,-0.281998 2.151,-0.422001 3.217,-0.422001 1.655,0 3.274,0.259998 4.856,0.776001 1.582,0.517998 2.921,1.293999 4.015,2.328999 l -3.995,4.127998 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_8"
|
||||||
|
d="m 179.56799,68.878998 0,-31.406998 21.114,0 0,6.388 -13.795,0 0,5.944 13.041,0 0,6.077 -13.041,0 0,6.521 14.594,0 0,6.476997 -21.913,0 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_9"
|
||||||
|
d="m 220.675,68.878998 0,-12.065994 c 0,-0.621002 -0.053,-1.212002 -0.155,-1.774002 -0.104,-0.562 -0.274,-1.057003 -0.511,-1.486 -0.237,-0.428001 -0.569,-0.769001 -0.998,-1.021 -0.429,-0.25 -0.96899,-0.377003 -1.619,-0.377003 -0.65001,0 -1.22,0.127003 -1.70799,0.377003 -0.487,0.251999 -0.89501,0.599998 -1.22001,1.042999 -0.32499,0.443001 -0.569,0.953999 -0.731,1.529999 -0.16299,0.577 -0.244,1.175999 -0.244,1.797001 l 0,11.976997 -7.319,0 0,-22.091 7.05301,0 0,3.061001 0.089,0 c 0.26699,-0.473 0.613,-0.938 1.043,-1.396 0.428,-0.459 0.932,-0.850998 1.50801,-1.175999 0.57699,-0.325001 1.20498,-0.591999 1.88598,-0.799 0.68001,-0.206001 1.40401,-0.311001 2.17301,-0.311001 1.479,0 2.735,0.266998 3.77099,0.799 1.036,0.532002 1.87001,1.220001 2.50701,2.062 0.636,0.842999 1.09401,1.812 1.375,2.904999 0.28,1.095001 0.421,2.189003 0.421,3.283001 l 0,13.661999 -7.321,0 0,9.99e-4 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_10"
|
||||||
|
d="m 246.71301,53.929001 c -0.41501,-0.532001 -0.977,-0.959999 -1.686,-1.285999 -0.70999,-0.325001 -1.43601,-0.488003 -2.174,-0.488003 -0.77,0 -1.464,0.155003 -2.085,0.466 -0.62101,0.310997 -1.153,0.726002 -1.59701,1.242001 -0.44299,0.518002 -0.79199,1.117001 -1.04299,1.797001 -0.251,0.681004 -0.377,1.404003 -0.377,2.174 0,0.768997 0.11799,1.493004 0.35499,2.173004 0.23601,0.681 0.58301,1.279999 1.04201,1.796997 0.45799,0.517998 1.005,0.924995 1.642,1.220001 0.636,0.295998 1.35299,0.443001 2.151,0.443001 0.73801,0 1.47099,-0.139999 2.19501,-0.421005 0.72401,-0.281006 1.30899,-0.687996 1.75198,-1.220001 l 4.03702,4.924004 c -0.91703,0.887001 -2.10102,1.582001 -3.54901,2.084999 -1.44899,0.501999 -2.987,0.753998 -4.61299,0.753998 -1.74501,0 -3.37401,-0.266998 -4.88701,-0.798996 -1.512,-0.531998 -2.82601,-1.308998 -3.941,-2.329002 -1.11599,-1.019997 -1.99299,-2.253998 -2.63299,-3.702995 -0.64,-1.448997 -0.959,-3.090004 -0.959,-4.924004 0,-1.804001 0.31898,-3.431 0.959,-4.880001 0.64,-1.447998 1.51699,-2.683998 2.63299,-3.703999 1.11499,-1.021 2.43,-1.804001 3.941,-2.351002 1.513,-0.546997 3.127,-0.820999 4.843,-0.820999 0.798,0 1.589,0.074 2.373,0.223 0.783,0.147003 1.53699,0.348 2.26199,0.599003 0.72501,0.251003 1.39002,0.562 1.996,0.931999 0.60599,0.369999 1.13202,0.776001 1.57502,1.219997 l -4.21201,4.877003 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_11"
|
||||||
|
d="m 268.03201,52.776001 c -0.32599,-0.089 -0.64401,-0.146999 -0.95401,-0.177002 -0.30999,-0.03 -0.61398,-0.045 -0.90899,-0.045 -0.97599,0 -1.797,0.177998 -2.46201,0.530998 -0.66498,0.354 -1.19699,0.781002 -1.59698,1.283001 -0.39902,0.500999 -0.68802,1.047001 -0.86503,1.636997 -0.177,0.589996 -0.26599,1.105003 -0.26599,1.548004 l 0,11.324997 -7.27499,0 0,-22.063999 7.009,0 0,3.194 0.089,0 c 0.56201,-1.132 1.35901,-2.055 2.396,-2.77 1.03402,-0.715 2.23202,-1.071999 3.59302,-1.071999 0.29498,0 0.58398,0.016 0.86499,0.045 0.27999,0.029 0.51001,0.074 0.68801,0.133003 L 268.03201,52.776 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_12"
|
||||||
|
d="m 285.12201,72.206001 c -0.44299,1.153 -0.939,2.181 -1.48599,3.083 -0.547,0.901001 -1.19702,1.669998 -1.95102,2.306999 -0.754,0.636002 -1.642,1.114998 -2.66199,1.441002 -1.01999,0.324997 -2.22601,0.487999 -3.61499,0.487999 -0.681,0 -1.38299,-0.045 -2.10602,-0.134003 -0.72598,-0.089 -1.354,-0.207001 -1.88598,-0.353996 L 272.215,72.916 c 0.354,0.116997 0.746,0.213997 1.17602,0.288002 0.42798,0.073 0.81998,0.110001 1.17499,0.110001 1.12399,0 1.93701,-0.259003 2.44,-0.776001 0.50199,-0.518005 0.931,-1.249001 1.28601,-2.195 l 0.70999,-1.818001 -9.22699,-21.736 8.073,0 4.92398,14.195 0.133,0 4.392,-14.195 7.71802,0 -9.89301,25.417 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_13"
|
||||||
|
d="m 321.496,57.745003 c 0,1.537994 -0.237,3.016998 -0.70999,4.435997 -0.474,1.419998 -1.16101,2.668999 -2.06201,3.748001 -0.90201,1.080002 -2.004,1.945 -3.30499,2.596001 -1.30201,0.649002 -2.78,0.975998 -4.43702,0.975998 -1.35998,0 -2.64599,-0.273003 -3.85901,-0.82 -1.21301,-0.546997 -2.15799,-1.293999 -2.83898,-2.239998 l -0.088,0 0,13.085999 -7.27502,0 0,-32.739002 6.92001,0 0,2.706001 0.133,0 c 0.681,-0.887001 1.61899,-1.662998 2.81698,-2.328999 C 307.98801,46.5 309.39999,46.167 311.02701,46.167 c 1.59698,0 3.04498,0.311001 4.34698,0.931999 1.301,0.621002 2.40201,1.464001 3.305,2.528 0.90298,1.063999 1.59701,2.299999 2.08502,3.704002 0.488,1.404999 0.73199,2.876999 0.73199,4.414001 z m -7.05301,0 c 0,-0.709999 -0.11001,-1.403999 -0.332,-2.085003 -0.22201,-0.68 -0.548,-1.278999 -0.97699,-1.797001 -0.42901,-0.516998 -0.96902,-0.938 -1.61902,-1.264 -0.64999,-0.326 -1.40399,-0.487999 -2.26199,-0.487999 -0.828,0 -1.56799,0.162998 -2.21799,0.487999 -0.651,0.325001 -1.20602,0.754002 -1.664,1.285999 -0.45901,0.532001 -0.81302,1.139 -1.06402,1.818001 -0.25199,0.681004 -0.37699,1.375004 -0.37699,2.085003 0,0.709999 0.125,1.404999 0.37699,2.084999 0.251,0.681 0.60501,1.285995 1.06402,1.818001 0.45798,0.531998 1.013,0.961998 1.664,1.286995 0.64899,0.325005 1.38999,0.487 2.21799,0.487 0.85699,0 1.61099,-0.161995 2.26199,-0.487 0.651,-0.325005 1.19001,-0.754997 1.61902,-1.286995 0.42902,-0.531998 0.75498,-1.146004 0.97699,-1.841003 0.22101,-0.693001 0.332,-1.394997 0.332,-2.104996 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_14"
|
||||||
|
d="m 333.11801,52.200001 0,8.461002 c 0,1.038994 0.20001,1.816994 0.60001,2.337997 0.39798,0.519997 1.11499,0.778 2.151,0.778 0.354,0 0.73099,-0.028 1.13098,-0.089 0.39902,-0.05901 0.73102,-0.147003 0.99802,-0.266006 l 0.089,5.323006 c -0.50299,0.176994 -1.139,0.332001 -1.90698,0.465996 -0.77002,0.133003 -1.53802,0.199005 -2.307,0.199005 -1.47901,0 -2.72202,-0.186005 -3.72702,-0.556007 -1.00599,-0.369995 -1.81199,-0.903999 -2.417,-1.601997 -0.60699,-0.695999 -1.043,-1.526001 -1.30899,-2.489998 C 326.15302,63.799005 326.021,62.724 326.021,61.538003 l 0,-9.338001 -3.54898,0 0,-5.412003 3.50399,0 0,-5.810997 7.142,0 0,5.810997 5.19,0 0,5.412003 -5.19,0 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<path
|
||||||
|
id="svg_15"
|
||||||
|
d="m 145.00999,36.869999 c -2.18299,0 -3.89199,1.573002 -3.89199,3.582001 0,2.116001 1.43899,3.536999 3.582,3.536999 0.183,0 0.35599,-0.017 0.51899,-0.05 -0.343,1.566002 -1.852,2.690002 -3.27799,2.915001 l -0.29001,0.046 0,3.376999 0.376,-0.036 c 1.73,-0.165001 3.439,-0.951 4.691,-2.157001 1.632,-1.572998 2.49501,-3.843998 2.49501,-6.568001 0,-2.691998 -1.76799,-4.646 -4.20301,-4.646 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
</g>
|
||||||
|
<g
|
||||||
|
id="svg_16">
|
||||||
|
<path
|
||||||
|
id="svg_17"
|
||||||
|
d="m 46.488998,37.568001 -8.039997,0 0,-4.128002 c 0,-3.296997 -2.683002,-5.979 -5.98,-5.979 -3.297001,0 -5.979,2.683002 -5.979,5.979 l 0,4.128002 -8.040001,0 0,-4.128002 c 0,-7.73 6.288998,-14.019999 14.02,-14.019999 7.731002,0 14.02,6.289 14.02,14.019999 l 0,4.128002 -0.001,0 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
</g>
|
||||||
|
<path
|
||||||
|
id="svg_18"
|
||||||
|
d="m 49.731998,37.568001 -34.524998,0 c -1.474001,0 -2.68,1.205997 -2.68,2.68 l 0,25.540001 c 0,1.473999 1.205999,2.68 2.68,2.68 l 34.524998,0 c 1.474003,0 2.68,-1.206001 2.68,-2.68 l 0,-25.540001 c 0,-1.474003 -1.205997,-2.68 -2.68,-2.68 z m -15.512997,16.769001 0,3.460995 c 0,0.966003 -0.784,1.749001 -1.749001,1.749001 -0.965001,0 -1.749001,-0.783997 -1.749001,-1.749001 l 0,-3.459995 c -1.076,-0.611 -1.803001,-1.764 -1.803001,-3.09 0,-1.962002 1.591,-3.552002 3.552002,-3.552002 1.961998,0 3.551998,1.591 3.551998,3.552002 0,1.325001 -0.727001,2.478001 -1.802998,3.089001 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#2c3c69" />
|
||||||
|
<path
|
||||||
|
id="svg_19"
|
||||||
|
d="m 11.707001,33.759998 -8.331,0 c -1.351001,0 -2.446,-1.094997 -2.446,-2.445999 0,-1.351002 1.094999,-2.445999 2.446,-2.445999 l 8.331,0 c 1.351,0 2.445999,1.095001 2.445999,2.445999 0,1.350998 -1.096001,2.445999 -2.445999,2.445999 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
<path
|
||||||
|
id="svg_20"
|
||||||
|
d="m 17.575001,20.655001 c -0.546001,0 -1.097,-0.182001 -1.552,-0.557001 l -6.59,-5.418999 C 8.39,13.820999 8.239001,12.280001 9.098,11.236 9.956,10.193001 11.497,10.042 12.541001,10.9 l 6.59,5.419001 c 1.042999,0.858 1.194,2.399 0.334999,3.442999 -0.483,0.589001 -1.184,0.893002 -1.890999,0.893002 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
<path
|
||||||
|
id="svg_21"
|
||||||
|
d="m 32.469002,14.895 c -1.351002,0 -2.446003,-1.095001 -2.446003,-2.446001 l 0,-8.396999 c 0,-1.351 1.095001,-2.446 2.446003,-2.446 1.351002,0 2.445999,1.095 2.445999,2.446 l 0,8.396999 c 0,1.351 -1.095001,2.446001 -2.445999,2.446001 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
<g
|
||||||
|
id="svg_22">
|
||||||
|
<g
|
||||||
|
id="svg_23">
|
||||||
|
<path
|
||||||
|
id="svg_24"
|
||||||
|
d="M 47.362999,20.655001 C 46.655998,20.655001 45.956001,20.351 45.472,19.761999 44.613998,18.719 44.764,17.177 45.806999,16.319 l 6.59,-5.419001 c 1.044003,-0.858 2.585003,-0.706999 3.442997,0.336 0.858002,1.042999 0.708,2.584999 -0.334999,3.443001 l -6.589996,5.418999 C 48.459999,20.472999 47.91,20.655 47.362999,20.655 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<path
|
||||||
|
id="svg_25"
|
||||||
|
d="m 61.563004,33.759998 -8.410004,0 c -1.351002,0 -2.445999,-1.094997 -2.445999,-2.445999 0,-1.351002 1.094997,-2.445999 2.445999,-2.445999 l 8.410004,0 c 1.350998,0 2.445999,1.095001 2.445999,2.445999 0,1.350998 -1.095001,2.445999 -2.445999,2.445999 z"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#f9a11d" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 16 KiB |
5394
docs/img/overview.svg
Normal file
5394
docs/img/overview.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 218 KiB |
BIN
docs/img/traefik.icon.png
Normal file
BIN
docs/img/traefik.icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2 KiB |
BIN
docs/img/traefik.logo.png
Normal file
BIN
docs/img/traefik.logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
1317
docs/index.md
1317
docs/index.md
File diff suppressed because it is too large
Load diff
994
docs/toml.md
Normal file
994
docs/toml.md
Normal file
|
|
@ -0,0 +1,994 @@
|
||||||
|
|
||||||
|
# Global configuration
|
||||||
|
|
||||||
|
## Main section
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# traefik.toml
|
||||||
|
################################################################
|
||||||
|
# Global configuration
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Traefik logs file
|
||||||
|
# If not defined, logs to stdout
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# traefikLogsFile = "log/traefik.log"
|
||||||
|
|
||||||
|
# Access logs file
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# accessLogsFile = "log/access.log"
|
||||||
|
|
||||||
|
# Log level
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: "ERROR"
|
||||||
|
#
|
||||||
|
# logLevel = "ERROR"
|
||||||
|
|
||||||
|
# Backends throttle duration: minimum duration between 2 events from providers
|
||||||
|
# before applying a new configuration. It avoids unnecessary reloads if multiples events
|
||||||
|
# are sent in a short amount of time.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: "2s"
|
||||||
|
#
|
||||||
|
# ProvidersThrottleDuration = "5s"
|
||||||
|
|
||||||
|
# If non-zero, controls the maximum idle (keep-alive) to keep per-host. If zero, DefaultMaxIdleConnsPerHost is used.
|
||||||
|
# If you encounter 'too many open files' errors, you can either change this value, or change `ulimit` value.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: http.DefaultMaxIdleConnsPerHost
|
||||||
|
#
|
||||||
|
# MaxIdleConnsPerHost = 200
|
||||||
|
|
||||||
|
# Entrypoints to be used by frontends that do not specify any entrypoint.
|
||||||
|
# Each frontend can specify its own entrypoints.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: ["http"]
|
||||||
|
#
|
||||||
|
# defaultEntryPoints = ["http", "https"]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Entrypoints definition
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# Entrypoints definition
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default:
|
||||||
|
# [entryPoints]
|
||||||
|
# [entryPoints.http]
|
||||||
|
# address = ":80"
|
||||||
|
#
|
||||||
|
# To redirect an http entrypoint to an https entrypoint (with SNI support):
|
||||||
|
# [entryPoints]
|
||||||
|
# [entryPoints.http]
|
||||||
|
# address = ":80"
|
||||||
|
# [entryPoints.http.redirect]
|
||||||
|
# entryPoint = "https"
|
||||||
|
# [entryPoints.https]
|
||||||
|
# address = ":443"
|
||||||
|
# [entryPoints.https.tls]
|
||||||
|
# [[entryPoints.https.tls.certificates]]
|
||||||
|
# CertFile = "integration/fixtures/https/snitest.com.cert"
|
||||||
|
# KeyFile = "integration/fixtures/https/snitest.com.key"
|
||||||
|
# [[entryPoints.https.tls.certificates]]
|
||||||
|
# CertFile = "integration/fixtures/https/snitest.org.cert"
|
||||||
|
# KeyFile = "integration/fixtures/https/snitest.org.key"
|
||||||
|
#
|
||||||
|
# To redirect an entrypoint rewriting the URL:
|
||||||
|
# [entryPoints]
|
||||||
|
# [entryPoints.http]
|
||||||
|
# address = ":80"
|
||||||
|
# [entryPoints.http.redirect]
|
||||||
|
# regex = "^http://localhost/(.*)"
|
||||||
|
# replacement = "http://mydomain/$1"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Retry configuration
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# Enable retry sending request if network error
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [retry]
|
||||||
|
|
||||||
|
# Number of attempts
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: (number servers in backend) -1
|
||||||
|
#
|
||||||
|
# attempts = 3
|
||||||
|
|
||||||
|
# Sets the maximum request body to be stored in memory in Mo
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: 2
|
||||||
|
#
|
||||||
|
# maxMem = 3
|
||||||
|
```
|
||||||
|
|
||||||
|
## ACME (Let's Encrypt) configuration
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# Enable ACME (Let's Encrypt): automatic SSL
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [acme]
|
||||||
|
|
||||||
|
# Email address used for registration
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# email = "test@traefik.io"
|
||||||
|
|
||||||
|
# File used for certificates storage.
|
||||||
|
# WARNING, if you use Traefik in Docker, don't forget to mount this file as a volume.
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# storageFile = "acme.json"
|
||||||
|
|
||||||
|
# Entrypoint to proxy acme challenge to.
|
||||||
|
# WARNING, must point to an entrypoint on port 443
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# entryPoint = "https"
|
||||||
|
|
||||||
|
# Enable on demand certificate. This will request a certificate from Let's Encrypt during the first TLS handshake for a hostname that does not yet have a certificate.
|
||||||
|
# WARNING, TLS handshakes will be slow when requesting a hostname certificate for the first time, this can leads to DoS attacks.
|
||||||
|
# WARNING, Take note that Let's Encrypt have rate limiting: https://community.letsencrypt.org/t/quick-start-guide/1631
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# onDemand = true
|
||||||
|
|
||||||
|
# CA server to use
|
||||||
|
# Uncomment the line to run on the staging let's encrypt server
|
||||||
|
# Leave comment to go to prod
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# caServer = "https://acme-staging.api.letsencrypt.org/directory"
|
||||||
|
|
||||||
|
# Domains list
|
||||||
|
# You can provide SANs (alternative domains) to each main domain
|
||||||
|
# WARNING, Take note that Let's Encrypt have rate limiting: https://community.letsencrypt.org/t/quick-start-guide/1631
|
||||||
|
# Each domain & SANs will lead to a certificate request.
|
||||||
|
#
|
||||||
|
# [[acme.domains]]
|
||||||
|
# main = "local1.com"
|
||||||
|
# sans = ["test1.local1.com", "test2.local1.com"]
|
||||||
|
# [[acme.domains]]
|
||||||
|
# main = "local2.com"
|
||||||
|
# sans = ["test1.local2.com", "test2x.local2.com"]
|
||||||
|
# [[acme.domains]]
|
||||||
|
# main = "local3.com"
|
||||||
|
# [[acme.domains]]
|
||||||
|
# main = "local4.com"
|
||||||
|
```
|
||||||
|
|
||||||
|
# Configuration backends
|
||||||
|
|
||||||
|
## File backend
|
||||||
|
|
||||||
|
Like any other reverse proxy, Træfɪk can be configured with a file. You have two choices:
|
||||||
|
|
||||||
|
- simply add your configuration at the end of the global configuration file `traefik.toml` :
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# traefik.toml
|
||||||
|
logLevel = "DEBUG"
|
||||||
|
defaultEntryPoints = ["http", "https"]
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
[entryPoints.http.redirect]
|
||||||
|
entryPoint = "https"
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.com.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.com.key"
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.org.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.org.key"
|
||||||
|
|
||||||
|
[file]
|
||||||
|
|
||||||
|
# rules
|
||||||
|
[backends]
|
||||||
|
[backends.backend1]
|
||||||
|
[backends.backend1.circuitbreaker]
|
||||||
|
expression = "NetworkErrorRatio() > 0.5"
|
||||||
|
[backends.backend1.servers.server1]
|
||||||
|
url = "http://172.17.0.2:80"
|
||||||
|
weight = 10
|
||||||
|
[backends.backend1.servers.server2]
|
||||||
|
url = "http://172.17.0.3:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2]
|
||||||
|
[backends.backend2.LoadBalancer]
|
||||||
|
method = "drr"
|
||||||
|
[backends.backend2.servers.server1]
|
||||||
|
url = "http://172.17.0.4:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2.servers.server2]
|
||||||
|
url = "http://172.17.0.5:80"
|
||||||
|
weight = 2
|
||||||
|
|
||||||
|
[frontends]
|
||||||
|
[frontends.frontend1]
|
||||||
|
backend = "backend2"
|
||||||
|
[frontends.frontend1.routes.test_1]
|
||||||
|
rule = "Host:test.localhost"
|
||||||
|
[frontends.frontend2]
|
||||||
|
backend = "backend1"
|
||||||
|
passHostHeader = true
|
||||||
|
entrypoints = ["https"] # overrides defaultEntryPoints
|
||||||
|
[frontends.frontend2.routes.test_1]
|
||||||
|
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||||||
|
[frontends.frontend3]
|
||||||
|
entrypoints = ["http", "https"] # overrides defaultEntryPoints
|
||||||
|
backend = "backend2"
|
||||||
|
rule = "Path:/test"
|
||||||
|
```
|
||||||
|
|
||||||
|
- or put your rules in a separate file, for example `rules.tml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# traefik.toml
|
||||||
|
logLevel = "DEBUG"
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
[entryPoints.http.redirect]
|
||||||
|
entryPoint = "https"
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.com.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.com.key"
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.org.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.org.key"
|
||||||
|
|
||||||
|
[file]
|
||||||
|
filename = "rules.toml"
|
||||||
|
```
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# rules.toml
|
||||||
|
[backends]
|
||||||
|
[backends.backend1]
|
||||||
|
[backends.backend1.circuitbreaker]
|
||||||
|
expression = "NetworkErrorRatio() > 0.5"
|
||||||
|
[backends.backend1.servers.server1]
|
||||||
|
url = "http://172.17.0.2:80"
|
||||||
|
weight = 10
|
||||||
|
[backends.backend1.servers.server2]
|
||||||
|
url = "http://172.17.0.3:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2]
|
||||||
|
[backends.backend2.LoadBalancer]
|
||||||
|
method = "drr"
|
||||||
|
[backends.backend2.servers.server1]
|
||||||
|
url = "http://172.17.0.4:80"
|
||||||
|
weight = 1
|
||||||
|
[backends.backend2.servers.server2]
|
||||||
|
url = "http://172.17.0.5:80"
|
||||||
|
weight = 2
|
||||||
|
|
||||||
|
[frontends]
|
||||||
|
[frontends.frontend1]
|
||||||
|
backend = "backend2"
|
||||||
|
[frontends.frontend1.routes.test_1]
|
||||||
|
rule = "Host:test.localhost"
|
||||||
|
[frontends.frontend2]
|
||||||
|
backend = "backend1"
|
||||||
|
passHostHeader = true
|
||||||
|
entrypoints = ["https"] # overrides defaultEntryPoints
|
||||||
|
[frontends.frontend2.routes.test_1]
|
||||||
|
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||||||
|
[frontends.frontend3]
|
||||||
|
entrypoints = ["http", "https"] # overrides defaultEntryPoints
|
||||||
|
backend = "backend2"
|
||||||
|
rule = "Path:/test"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want Træfɪk to watch file changes automatically, just add:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[file]
|
||||||
|
watch = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## API backend
|
||||||
|
|
||||||
|
Træfik can be configured using a restful api.
|
||||||
|
To enable it:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[web]
|
||||||
|
address = ":8080"
|
||||||
|
|
||||||
|
# SSL certificate and key used
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# CertFile = "traefik.crt"
|
||||||
|
# KeyFile = "traefik.key"
|
||||||
|
#
|
||||||
|
# Set REST API to read-only mode
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# ReadOnly = false
|
||||||
|
```
|
||||||
|
|
||||||
|
- `/`: provides a simple HTML frontend of Træfik
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- `/health`: `GET` json metrics
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ curl -s "http://localhost:8080/health" | jq .
|
||||||
|
{
|
||||||
|
// Træfɪk PID
|
||||||
|
"pid": 2458,
|
||||||
|
// Træfɪk server uptime (formated time)
|
||||||
|
"uptime": "39m6.885931127s",
|
||||||
|
// Træfɪk server uptime in seconds
|
||||||
|
"uptime_sec": 2346.885931127,
|
||||||
|
// current server date
|
||||||
|
"time": "2015-10-07 18:32:24.362238909 +0200 CEST",
|
||||||
|
// current server date in seconds
|
||||||
|
"unixtime": 1444235544,
|
||||||
|
// count HTTP response status code in realtime
|
||||||
|
"status_code_count": {
|
||||||
|
"502": 1
|
||||||
|
},
|
||||||
|
// count HTTP response status code since Træfɪk started
|
||||||
|
"total_status_code_count": {
|
||||||
|
"200": 7,
|
||||||
|
"404": 21,
|
||||||
|
"502": 13
|
||||||
|
},
|
||||||
|
// count HTTP response
|
||||||
|
"count": 1,
|
||||||
|
// count HTTP response
|
||||||
|
"total_count": 41,
|
||||||
|
// sum of all response time (formated time)
|
||||||
|
"total_response_time": "35.456865605s",
|
||||||
|
// sum of all response time in seconds
|
||||||
|
"total_response_time_sec": 35.456865605,
|
||||||
|
// average response time (formated time)
|
||||||
|
"average_response_time": "864.8016ms",
|
||||||
|
// average response time in seconds
|
||||||
|
"average_response_time_sec": 0.8648016000000001
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `/api`: `GET` configuration for all providers
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ curl -s "http://localhost:8080/api" | jq .
|
||||||
|
{
|
||||||
|
"file": {
|
||||||
|
"frontends": {
|
||||||
|
"frontend2": {
|
||||||
|
"routes": {
|
||||||
|
"test_2": {
|
||||||
|
"rule": "Path:/test"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"backend": "backend1"
|
||||||
|
},
|
||||||
|
"frontend1": {
|
||||||
|
"routes": {
|
||||||
|
"test_1": {
|
||||||
|
"rule": "Host:test.localhost"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"backend": "backend2"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"backends": {
|
||||||
|
"backend2": {
|
||||||
|
"loadBalancer": {
|
||||||
|
"method": "drr"
|
||||||
|
},
|
||||||
|
"servers": {
|
||||||
|
"server2": {
|
||||||
|
"weight": 2,
|
||||||
|
"URL": "http://172.17.0.5:80"
|
||||||
|
},
|
||||||
|
"server1": {
|
||||||
|
"weight": 1,
|
||||||
|
"url": "http://172.17.0.4:80"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"backend1": {
|
||||||
|
"loadBalancer": {
|
||||||
|
"method": "wrr"
|
||||||
|
},
|
||||||
|
"circuitBreaker": {
|
||||||
|
"expression": "NetworkErrorRatio() > 0.5"
|
||||||
|
},
|
||||||
|
"servers": {
|
||||||
|
"server2": {
|
||||||
|
"weight": 1,
|
||||||
|
"url": "http://172.17.0.3:80"
|
||||||
|
},
|
||||||
|
"server1": {
|
||||||
|
"weight": 10,
|
||||||
|
"url": "http://172.17.0.2:80"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `/api/providers`: `GET` providers
|
||||||
|
- `/api/providers/{provider}`: `GET` or `PUT` provider
|
||||||
|
- `/api/providers/{provider}/backends`: `GET` backends
|
||||||
|
- `/api/providers/{provider}/backends/{backend}`: `GET` a backend
|
||||||
|
- `/api/providers/{provider}/backends/{backend}/servers`: `GET` servers in a backend
|
||||||
|
- `/api/providers/{provider}/backends/{backend}/servers/{server}`: `GET` a server in a backend
|
||||||
|
- `/api/providers/{provider}/frontends`: `GET` frontends
|
||||||
|
- `/api/providers/{provider}/frontends/{frontend}`: `GET` a frontend
|
||||||
|
- `/api/providers/{provider}/frontends/{frontend}/routes`: `GET` routes in a frontend
|
||||||
|
- `/api/providers/{provider}/frontends/{frontend}/routes/{route}`: `GET` a route in a frontend
|
||||||
|
|
||||||
|
|
||||||
|
## Docker backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use Docker as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Docker configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Docker configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
[docker]
|
||||||
|
|
||||||
|
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
endpoint = "unix:///var/run/docker.sock"
|
||||||
|
|
||||||
|
# Default domain used.
|
||||||
|
# Can be overridden by setting the "traefik.domain" label on a container.
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
domain = "docker.localhost"
|
||||||
|
|
||||||
|
# Enable watch docker changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
watch = true
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "docker.tmpl"
|
||||||
|
|
||||||
|
# Enable docker TLS connection
|
||||||
|
#
|
||||||
|
# [docker.tls]
|
||||||
|
# ca = "/etc/ssl/ca.crt"
|
||||||
|
# cert = "/etc/ssl/docker.crt"
|
||||||
|
# key = "/etc/ssl/docker.key"
|
||||||
|
# insecureskipverify = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Labels can be used on containers to override default behaviour:
|
||||||
|
|
||||||
|
- `traefik.backend=foo`: assign the container to `foo` backend
|
||||||
|
- `traefik.port=80`: register this port. Useful when the container exposes multiples ports.
|
||||||
|
- `traefik.protocol=https`: override the default `http` protocol
|
||||||
|
- `traefik.weight=10`: assign this weight to the container
|
||||||
|
- `traefik.enable=false`: disable this container in Træfɪk
|
||||||
|
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}`). See [frontends](#frontends).
|
||||||
|
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||||||
|
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||||||
|
* `traefik.domain=traefik.localhost`: override the default domain
|
||||||
|
|
||||||
|
|
||||||
|
## Marathon backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use Marathon as a backend configuration:
|
||||||
|
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Mesos/Marathon configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Marathon configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
[marathon]
|
||||||
|
|
||||||
|
# Marathon server endpoint.
|
||||||
|
# You can also specify multiple endpoint for Marathon:
|
||||||
|
# endpoint := "http://10.241.1.71:8080,10.241.1.72:8080,10.241.1.73:8080"
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
endpoint = "http://127.0.0.1:8080"
|
||||||
|
|
||||||
|
# Enable watch Marathon changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
watch = true
|
||||||
|
|
||||||
|
# Default domain used.
|
||||||
|
# Can be overridden by setting the "traefik.domain" label on an application.
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
domain = "marathon.localhost"
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "marathon.tmpl"
|
||||||
|
|
||||||
|
# Expose Marathon apps by default in traefik
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
# Default: false
|
||||||
|
#
|
||||||
|
# ExposedByDefault = true
|
||||||
|
|
||||||
|
# Enable Marathon basic authentication
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [marathon.basic]
|
||||||
|
# httpBasicAuthUser = "foo"
|
||||||
|
# httpBasicPassword = "bar"
|
||||||
|
|
||||||
|
# TLS client configuration. https://golang.org/pkg/crypto/tls/#Config
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [marathon.TLS]
|
||||||
|
# InsecureSkipVerify = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Labels can be used on containers to override default behaviour:
|
||||||
|
|
||||||
|
- `traefik.backend=foo`: assign the application to `foo` backend
|
||||||
|
- `traefik.portIndex=1`: register port by index in the application's ports array. Useful when the application exposes multiple ports.
|
||||||
|
- `traefik.port=80`: register the explicit application port value. Cannot be used alongside `traefik.portIndex`.
|
||||||
|
- `traefik.protocol=https`: override the default `http` protocol
|
||||||
|
- `traefik.weight=10`: assign this weight to the application
|
||||||
|
- `traefik.enable=false`: disable this application in Træfɪk
|
||||||
|
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}`). See [frontends](#frontends).
|
||||||
|
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||||||
|
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||||||
|
* `traefik.domain=traefik.localhost`: override the default domain
|
||||||
|
|
||||||
|
## Consul backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use Consul as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Consul KV configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Consul KV configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
[consul]
|
||||||
|
|
||||||
|
# Consul server endpoint
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
endpoint = "127.0.0.1:8500"
|
||||||
|
|
||||||
|
# Enable watch Consul changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
watch = true
|
||||||
|
|
||||||
|
# Prefix used for KV store.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
prefix = "traefik"
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "consul.tmpl"
|
||||||
|
|
||||||
|
# Enable consul TLS connection
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [consul.tls]
|
||||||
|
# ca = "/etc/ssl/ca.crt"
|
||||||
|
# cert = "/etc/ssl/consul.crt"
|
||||||
|
# key = "/etc/ssl/consul.key"
|
||||||
|
# insecureskipverify = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Please refer to the [Key Value storage structure](#key-value-storage-structure) section to get documentation en traefik KV structure.
|
||||||
|
|
||||||
|
## Consul catalog backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use service discovery catalog of Consul as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Consul Catalog configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Consul Catalog configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
[consulCatalog]
|
||||||
|
|
||||||
|
# Consul server endpoint
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
endpoint = "127.0.0.1:8500"
|
||||||
|
|
||||||
|
# Default domain used.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
domain = "consul.localhost"
|
||||||
|
```
|
||||||
|
|
||||||
|
This backend will create routes matching on hostname based on the service name
|
||||||
|
used in consul.
|
||||||
|
|
||||||
|
|
||||||
|
## Etcd backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use Etcd as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Etcd configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Etcd configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [etcd]
|
||||||
|
|
||||||
|
# Etcd server endpoint
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# endpoint = "127.0.0.1:4001"
|
||||||
|
|
||||||
|
# Enable watch Etcd changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# watch = true
|
||||||
|
|
||||||
|
# Prefix used for KV store.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# prefix = "/traefik"
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "etcd.tmpl"
|
||||||
|
|
||||||
|
# Enable etcd TLS connection
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [etcd.tls]
|
||||||
|
# ca = "/etc/ssl/ca.crt"
|
||||||
|
# cert = "/etc/ssl/etcd.crt"
|
||||||
|
# key = "/etc/ssl/etcd.key"
|
||||||
|
# insecureskipverify = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Please refer to the [Key Value storage structure](#key-value-storage-structure) section to get documentation en traefik KV structure.
|
||||||
|
|
||||||
|
|
||||||
|
## Zookeeper backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use Zookeeper as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# Zookeeper configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable Zookeeperconfiguration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [zookeeper]
|
||||||
|
|
||||||
|
# Zookeeper server endpoint
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# endpoint = "127.0.0.1:2181"
|
||||||
|
|
||||||
|
# Enable watch Zookeeper changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# watch = true
|
||||||
|
|
||||||
|
# Prefix used for KV store.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# prefix = "/traefik"
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "zookeeper.tmpl"
|
||||||
|
```
|
||||||
|
|
||||||
|
Please refer to the [Key Value storage structure](#key-value-storage-structure) section to get documentation en traefik KV structure.
|
||||||
|
|
||||||
|
## BoltDB backend
|
||||||
|
|
||||||
|
Træfɪk can be configured to use BoltDB as a backend configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
################################################################
|
||||||
|
# BoltDB configuration backend
|
||||||
|
################################################################
|
||||||
|
|
||||||
|
# Enable BoltDB configuration backend
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# [boltdb]
|
||||||
|
|
||||||
|
# BoltDB file
|
||||||
|
#
|
||||||
|
# Required
|
||||||
|
#
|
||||||
|
# endpoint = "/my.db"
|
||||||
|
|
||||||
|
# Enable watch BoltDB changes
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# watch = true
|
||||||
|
|
||||||
|
# Prefix used for KV store.
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# prefix = "/traefik"
|
||||||
|
|
||||||
|
# Override default configuration template. For advanced users :)
|
||||||
|
#
|
||||||
|
# Optional
|
||||||
|
#
|
||||||
|
# filename = "boltdb.tmpl"
|
||||||
|
```
|
||||||
|
|
||||||
|
Please refer to the [Key Value storage structure](#key-value-storage-structure) section to get documentation en traefik KV structure.
|
||||||
|
|
||||||
|
## Key-value storage structure
|
||||||
|
|
||||||
|
The Keys-Values structure should look (using `prefix = "/traefik"`):
|
||||||
|
|
||||||
|
- backend 1
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|--------------------------------------------------------|-----------------------------|
|
||||||
|
| `/traefik/backends/backend1/circuitbreaker/expression` | `NetworkErrorRatio() > 0.5` |
|
||||||
|
| `/traefik/backends/backend1/servers/server1/url` | `http://172.17.0.2:80` |
|
||||||
|
| `/traefik/backends/backend1/servers/server1/weight` | `10` |
|
||||||
|
| `/traefik/backends/backend1/servers/server2/url` | `http://172.17.0.3:80` |
|
||||||
|
| `/traefik/backends/backend1/servers/server2/weight` | `1` |
|
||||||
|
|
||||||
|
- backend 2
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|-----------------------------------------------------|------------------------|
|
||||||
|
| `/traefik/backends/backend2/loadbalancer/method` | `drr` |
|
||||||
|
| `/traefik/backends/backend2/servers/server1/url` | `http://172.17.0.4:80` |
|
||||||
|
| `/traefik/backends/backend2/servers/server1/weight` | `1` |
|
||||||
|
| `/traefik/backends/backend2/servers/server2/url` | `http://172.17.0.5:80` |
|
||||||
|
| `/traefik/backends/backend2/servers/server2/weight` | `2` |
|
||||||
|
|
||||||
|
- frontend 1
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|---------------------------------------------------|-----------------------|
|
||||||
|
| `/traefik/frontends/frontend1/backend` | `backend2` |
|
||||||
|
| `/traefik/frontends/frontend1/routes/test_1/rule` | `Host:test.localhost` |
|
||||||
|
|
||||||
|
- frontend 2
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|----------------------------------------------------|--------------|
|
||||||
|
| `/traefik/frontends/frontend2/backend` | `backend1` |
|
||||||
|
| `/traefik/frontends/frontend2/passHostHeader` | `true` |
|
||||||
|
| `/traefik/frontends/frontend2/entrypoints` | `http,https` |
|
||||||
|
| `/traefik/frontends/frontend2/routes/test_2/rule` | `Path:/test` |
|
||||||
|
|
||||||
|
## Atomic configuration changes
|
||||||
|
|
||||||
|
The [Etcd](https://github.com/coreos/etcd/issues/860) and [Consul](https://github.com/hashicorp/consul/issues/886) backends do not support updating multiple keys atomically. As a result, it may be possible for Træfɪk to read an intermediate configuration state despite judicious use of the `--providersThrottleDuration` flag. To solve this problem, Træfɪk supports a special key called `/traefik/alias`. If set, Træfɪk use the value as an alternative key prefix.
|
||||||
|
|
||||||
|
Given the key structure below, Træfɪk will use the `http://172.17.0.2:80` as its only backend (frontend keys have been omitted for brevity).
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|-------------------------------------------------------------------------|-----------------------------|
|
||||||
|
| `/traefik/alias` | `/traefik_configurations/1` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/url` | `http://172.17.0.2:80` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/weight` | `10` |
|
||||||
|
|
||||||
|
When an atomic configuration change is required, you may write a new configuration at an alternative prefix. Here, although the `/traefik_configurations/2/...` keys have been set, the old configuration is still active because the `/traefik/alias` key still points to `/traefik_configurations/1`:
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|-------------------------------------------------------------------------|-----------------------------|
|
||||||
|
| `/traefik/alias` | `/traefik_configurations/1` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/url` | `http://172.17.0.2:80` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/weight` | `10` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server1/url` | `http://172.17.0.2:80` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server1/weight` | `5` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server2/url` | `http://172.17.0.3:80` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server2/weight` | `5` |
|
||||||
|
|
||||||
|
Once the `/traefik/alias` key is updated, the new `/traefik_configurations/2` configuration becomes active atomically. Here, we have a 50% balance between the `http://172.17.0.3:80` and the `http://172.17.0.4:80` hosts while no traffic is sent to the `172.17.0.2:80` host:
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|-------------------------------------------------------------------------|-----------------------------|
|
||||||
|
| `/traefik/alias` | `/traefik_configurations/2` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/url` | `http://172.17.0.2:80` |
|
||||||
|
| `/traefik_configurations/1/backends/backend1/servers/server1/weight` | `10` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server1/url` | `http://172.17.0.3:80` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server1/weight` | `5` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server2/url` | `http://172.17.0.4:80` |
|
||||||
|
| `/traefik_configurations/2/backends/backend1/servers/server2/weight` | `5` |
|
||||||
|
|
||||||
|
Note that Træfɪk *will not watch for key changes in the `/traefik_configurations` prefix*. It will only watch for changes in the `/traefik` prefix. Further, if the `/traefik/alias` key is set, all other sibling keys with the `/traefik` prefix are ignored.
|
||||||
|
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
## HTTP only
|
||||||
|
|
||||||
|
```
|
||||||
|
defaultEntryPoints = ["http"]
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
```
|
||||||
|
|
||||||
|
## HTTP + HTTPS (with SNI)
|
||||||
|
|
||||||
|
```
|
||||||
|
defaultEntryPoints = ["http", "https"]
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.com.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.com.key"
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
CertFile = "integration/fixtures/https/snitest.org.cert"
|
||||||
|
KeyFile = "integration/fixtures/https/snitest.org.key"
|
||||||
|
```
|
||||||
|
|
||||||
|
## HTTP redirect on HTTPS
|
||||||
|
|
||||||
|
```
|
||||||
|
defaultEntryPoints = ["http", "https"]
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":80"
|
||||||
|
[entryPoints.http.redirect]
|
||||||
|
entryPoint = "https"
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
certFile = "tests/traefik.crt"
|
||||||
|
keyFile = "tests/traefik.key"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Let's Encrypt support
|
||||||
|
|
||||||
|
```
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.https]
|
||||||
|
address = ":443"
|
||||||
|
[entryPoints.https.tls]
|
||||||
|
# certs used as default certs
|
||||||
|
[[entryPoints.https.tls.certificates]]
|
||||||
|
certFile = "tests/traefik.crt"
|
||||||
|
keyFile = "tests/traefik.key"
|
||||||
|
[acme]
|
||||||
|
email = "test@traefik.io"
|
||||||
|
storageFile = "acme.json"
|
||||||
|
onDemand = true
|
||||||
|
caServer = "http://172.18.0.1:4000/directory"
|
||||||
|
entryPoint = "https"
|
||||||
|
|
||||||
|
[[acme.domains]]
|
||||||
|
main = "local1.com"
|
||||||
|
sans = ["test1.local1.com", "test2.local1.com"]
|
||||||
|
[[acme.domains]]
|
||||||
|
main = "local2.com"
|
||||||
|
sans = ["test1.local2.com", "test2x.local2.com"]
|
||||||
|
[[acme.domains]]
|
||||||
|
main = "local3.com"
|
||||||
|
[[acme.domains]]
|
||||||
|
main = "local4.com"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Override entrypoints in frontends
|
||||||
|
|
||||||
|
```
|
||||||
|
[frontends]
|
||||||
|
[frontends.frontend1]
|
||||||
|
backend = "backend2"
|
||||||
|
[frontends.frontend1.routes.test_1]
|
||||||
|
rule = "Host:test.localhost"
|
||||||
|
[frontends.frontend2]
|
||||||
|
backend = "backend1"
|
||||||
|
passHostHeader = true
|
||||||
|
entrypoints = ["https"] # overrides defaultEntryPoints
|
||||||
|
[frontends.frontend2.routes.test_1]
|
||||||
|
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||||||
|
[frontends.frontend3]
|
||||||
|
entrypoints = ["http", "https"] # overrides defaultEntryPoints
|
||||||
|
backend = "backend2"
|
||||||
|
rule = "Path:/test"
|
||||||
|
```
|
||||||
21
examples/compose-traefik.yml
Normal file
21
examples/compose-traefik.yml
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
traefik:
|
||||||
|
image: containous/traefik
|
||||||
|
command: --web --docker --docker.domain=docker.localhost --logLevel=DEBUG
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
- "8080:8080"
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
- /dev/null:/traefik.toml
|
||||||
|
|
||||||
|
whoami1:
|
||||||
|
image: emilevauge/whoami
|
||||||
|
labels:
|
||||||
|
- "traefik.backend=whoami"
|
||||||
|
- "traefik.frontend.rule=Host:whoami.docker.localhost"
|
||||||
|
|
||||||
|
whoami2:
|
||||||
|
image: emilevauge/whoami
|
||||||
|
labels:
|
||||||
|
- "traefik.backend=whoami"
|
||||||
|
- "traefik.frontend.rule=Host:whoami.docker.localhost"
|
||||||
49
mkdocs.yml
Normal file
49
mkdocs.yml
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
site_name: Traefik
|
||||||
|
site_description: Traefik Documentation
|
||||||
|
site_author: containo.us
|
||||||
|
site_url: https://docs.traefik.io
|
||||||
|
|
||||||
|
repo_name: 'GitHub'
|
||||||
|
repo_url: 'https://github.com/containous/traefik'
|
||||||
|
|
||||||
|
# Documentation and theme
|
||||||
|
docs_dir: 'docs'
|
||||||
|
theme: united
|
||||||
|
# theme: readthedocs
|
||||||
|
# theme: 'material'
|
||||||
|
# theme: bootstrap
|
||||||
|
|
||||||
|
site_favicon: 'img/traefik.icon.png'
|
||||||
|
|
||||||
|
# Copyright
|
||||||
|
copyright: Copyright (c) 2016 Containous SAS
|
||||||
|
|
||||||
|
# Options
|
||||||
|
extra:
|
||||||
|
# version: 0.2.2
|
||||||
|
logo: img/traefik.logo.png
|
||||||
|
# author:
|
||||||
|
# twitter: traefikproxy
|
||||||
|
palette:
|
||||||
|
primary: 'blue'
|
||||||
|
accent: 'light blue'
|
||||||
|
i18n:
|
||||||
|
prev: 'Previous'
|
||||||
|
next: 'Next'
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
# - codehilite(css_class=code)
|
||||||
|
- admonition
|
||||||
|
# - toc:
|
||||||
|
# permalink: '##'
|
||||||
|
# - fenced_code
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- css/traefik.css
|
||||||
|
|
||||||
|
# Page tree
|
||||||
|
pages:
|
||||||
|
- Getting Started: index.md
|
||||||
|
- Basics: basics.md
|
||||||
|
- traefik.toml: toml.md
|
||||||
|
- Benchmarks: benchmarks.md
|
||||||
|
|
@ -16,16 +16,19 @@ sudo chmod +x /usr/bin/ghr
|
||||||
# github release and tag
|
# github release and tag
|
||||||
ghr -t $GITHUB_TOKEN -u containous -r traefik --prerelease ${VERSION} dist/
|
ghr -t $GITHUB_TOKEN -u containous -r traefik --prerelease ${VERSION} dist/
|
||||||
|
|
||||||
|
# update docs.traefik.io
|
||||||
|
mkdocs gh-deploy --clean
|
||||||
|
|
||||||
# update traefik-library-image repo (official Docker image)
|
# update traefik-library-image repo (official Docker image)
|
||||||
git config --global user.email "emile@vauge.com"
|
git config --global user.email "emile@vauge.com"
|
||||||
git config --global user.name "Emile Vauge"
|
git config --global user.name "Emile Vauge"
|
||||||
git clone https://github.com/containous/traefik-library-image.git
|
git clone git@github.com:containous/traefik-library-image.git
|
||||||
cd traefik-library-image
|
cd traefik-library-image
|
||||||
./update.sh $VERSION
|
./update.sh $VERSION
|
||||||
git add -A
|
git add -A
|
||||||
echo $VERSION | git commit --file -
|
echo $VERSION | git commit --file -
|
||||||
echo $VERSION | git tag -a $VERSION --file -
|
echo $VERSION | git tag -a $VERSION --file -
|
||||||
git push -q --follow-tags https://emilevauge:${GITHUB_TOKEN}@github.com/containous/traefik-library-image.git
|
git push -q --follow-tags -u origin master
|
||||||
|
|
||||||
# create docker image emilevauge/traefik (compatibility)
|
# create docker image emilevauge/traefik (compatibility)
|
||||||
docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS
|
docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue