You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ traefik*
32
32
##### Setting up your `go` environment
33
33
34
34
- You need `go` v1.9+
35
-
- It is recommended you clone Træfik into a directory like `~/go/src/github.com/containous/traefik` (This is the official golang workspace hierarchy, and will allow dependencies to resolve properly)
35
+
- It is recommended you clone Traefik into a directory like `~/go/src/github.com/containous/traefik` (This is the official golang workspace hierarchy, and will allow dependencies to resolve properly)
36
36
- Set your `GOPATH` and `PATH` variable to be set to `~/go` via:
37
37
38
38
```bash
@@ -56,9 +56,9 @@ GORACE=""
56
56
## more go env's will be listed
57
57
```
58
58
59
-
##### Build Træfik
59
+
##### Build Traefik
60
60
61
-
Once your environment is set up and the Træfik repository cloned you can build Træfik. You need get `go-bindata` once to be able to use `go generate` command as part of the build. The steps to build are:
61
+
Once your environment is set up and the Traefik repository cloned you can build Traefik. You need get `go-bindata` once to be able to use `go generate` command as part of the build. The steps to build are:
62
62
63
63
```bash
64
64
cd~/go/src/github.com/containous/traefik
@@ -77,7 +77,7 @@ go build ./cmd/traefik
77
77
# run other commands like tests
78
78
```
79
79
80
-
You will find the Træfik executable in the `~/go/src/github.com/containous/traefik` folder as `traefik`.
80
+
You will find the Traefik executable in the `~/go/src/github.com/containous/traefik` folder as `traefik`.
[](https://semaphoreci.com/containous/traefik)
Træfik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy.
16
-
Træfik integrates with your existing infrastructure components ([Docker](https://www.docker.com/), [Swarm mode](https://docs.docker.com/engine/swarm/), [Kubernetes](https://kubernetes.io), [Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Rancher](https://rancher.com), [Amazon ECS](https://aws.amazon.com/ecs), ...) and configures itself automatically and dynamically.
17
-
Pointing Træfik at your orchestrator should be the _only_ configuration step you need.
15
+
Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy.
16
+
Traefik integrates with your existing infrastructure components ([Docker](https://www.docker.com/), [Swarm mode](https://docs.docker.com/engine/swarm/), [Kubernetes](https://kubernetes.io), [Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Rancher](https://rancher.com), [Amazon ECS](https://aws.amazon.com/ecs), ...) and configures itself automatically and dynamically.
17
+
Pointing Traefik at your orchestrator should be the _only_ configuration step you need.
18
18
19
19
---
20
20
@@ -43,12 +43,12 @@ Now you want users to access these microservices, and you need a reverse proxy.
43
43
Traditional reverse-proxies require that you configure _each_ route that will connect paths and subdomains to _each_ microservice.
44
44
In an environment where you add, remove, kill, upgrade, or scale your services _many_ times a day, the task of keeping the routes up to date becomes tedious.
45
45
46
-
**This is when Træfik can help you!**
46
+
**This is when Traefik can help you!**
47
47
48
-
Træfik listens to your service registry/orchestrator API and instantly generates the routes so your microservices are connected to the outside world -- without further intervention from your part.
48
+
Traefik listens to your service registry/orchestrator API and instantly generates the routes so your microservices are connected to the outside world -- without further intervention from your part.
49
49
50
-
**Run Træfik and let it do the work for you!**
51
-
_(But if you'd rather configure some of your routes manually, Træfik supports that too!)_
50
+
**Run Traefik and let it do the work for you!**
51
+
_(But if you'd rather configure some of your routes manually, Traefik supports that too!)_
52
52
53
53

54
54
@@ -85,28 +85,28 @@ _(But if you'd rather configure some of your routes manually, Træfik supports t
85
85
86
86
## Quickstart
87
87
88
-
To get your hands on Træfik, you can use the [5-Minute Quickstart](http://docs.traefik.io/#the-trfik-quickstart-using-docker) in our documentation (you will need Docker).
88
+
To get your hands on Traefik, you can use the [5-Minute Quickstart](http://docs.traefik.io/#the-traefik-quickstart-using-docker) in our documentation (you will need Docker).
89
89
90
-
Alternatively, if you don't want to install anything on your computer, you can try Træfik online in this great [Katacoda tutorial](https://www.katacoda.com/courses/traefik/deploy-load-balancer) that shows how to load balance requests between multiple Docker containers.
90
+
Alternatively, if you don't want to install anything on your computer, you can try Traefik online in this great [Katacoda tutorial](https://www.katacoda.com/courses/traefik/deploy-load-balancer) that shows how to load balance requests between multiple Docker containers.
91
91
92
92
If you are looking for a more comprehensive and real use-case example, you can also check [Play-With-Docker](http://training.play-with-docker.com/traefik-load-balancing/) to see how to load balance between multiple nodes.
93
93
94
94
## Web UI
95
95
96
-
You can access the simple HTML frontend of Træfik.
96
+
You can access the simple HTML frontend of Traefik.
97
97
98
98

99
99

100
100
101
101
## Documentation
102
102
103
103
You can find the complete documentation at [https://docs.traefik.io](https://docs.traefik.io).
104
-
A collection of contributions around Træfik can be found at [https://awesome.traefik.io](https://awesome.traefik.io).
104
+
A collection of contributions around Traefik can be found at [https://awesome.traefik.io](https://awesome.traefik.io).
105
105
106
106
## Support
107
107
108
108
To get community support, you can:
109
-
- join the Træfik community Slack channel: [](https://slack.traefik.io)
109
+
- join the Traefik community Slack channel: [](https://slack.traefik.io)
110
110
- use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik) (using the `traefik` tag)
111
111
112
112
If you need commercial support, please contact [Containo.us](https://containo.us) by mail: <mailto:support@containo.us>.
Copy file name to clipboardexpand all lines: docs/basics.md
+19-19
Original file line number
Diff line number
Diff line change
@@ -14,20 +14,20 @@ Let's take our example from the [overview](/#overview) again:
14
14
15
15
> 
16
16
17
-
Let's zoom on Træfik and have an overview of its internal architecture:
17
+
Let's zoom on Traefik and have an overview of its internal architecture:
18
18
19
19
20
20

21
21
22
-
- Incoming requests end on [entrypoints](#entrypoints), as the name suggests, they are the network entry points into Træfik (listening port, SSL, traffic redirection...).
22
+
- Incoming requests end on [entrypoints](#entrypoints), as the name suggests, they are the network entry points into Traefik (listening port, SSL, traffic redirection...).
23
23
- Traffic is then forwarded to a matching [frontend](#frontends). A frontend defines routes from [entrypoints](#entrypoints) to [backends](#backends).
24
24
Routes are created using requests fields (`Host`, `Path`, `Headers`...) and can match or not a request.
25
25
- 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.
26
26
- Finally, the [server](#servers) will forward the request to the corresponding microservice in the private network.
27
27
28
28
### Entrypoints
29
29
30
-
Entrypoints are the network entry points into Træfik.
30
+
Entrypoints are the network entry points into Traefik.
31
31
They can be defined using:
32
32
33
33
- a port (80, 443...)
@@ -514,16 +514,16 @@ Additional http headers and hostname to health check request can be specified, f
514
514
515
515
## Configuration
516
516
517
-
Træfik's configuration has two parts:
517
+
Traefik's configuration has two parts:
518
518
519
-
- The [static Træfik configuration](/basics#static-trfik-configuration) which is loaded only at the beginning.
520
-
- The [dynamic Træfik configuration](/basics#dynamic-trfik-configuration) which can be hot-reloaded (no need to restart the process).
519
+
- The [static Traefik configuration](/basics#static-traefik-configuration) which is loaded only at the beginning.
520
+
- The [dynamic Traefik configuration](/basics#dynamic-traefik-configuration) which can be hot-reloaded (no need to restart the process).
521
521
522
-
### Static Træfik configuration
522
+
### Static Traefik configuration
523
523
524
524
The static configuration is the global configuration which is setting up connections to configuration backends and entrypoints.
525
525
526
-
Træfik can be configured using many configuration sources with the following precedence order.
526
+
Traefik can be configured using many configuration sources with the following precedence order.
527
527
Each item takes precedence over the item below it:
528
528
529
529
-[Key-value store](/basics/#key-value-stores)
@@ -539,7 +539,7 @@ It means that arguments override configuration file, and key-value store overrid
539
539
540
540
#### Configuration file
541
541
542
-
By default, Træfik will try to find a `traefik.toml` in the following places:
542
+
By default, Traefik will try to find a `traefik.toml` in the following places:
543
543
544
544
-`/etc/traefik/`
545
545
-`$HOME/.traefik/`
@@ -565,7 +565,7 @@ Note that all default values will be displayed as well.
565
565
566
566
#### Key-value stores
567
567
568
-
Træfik supports several Key-value stores:
568
+
Traefik supports several Key-value stores:
569
569
570
570
-[Consul](https://consul.io)
571
571
-[etcd](https://coreos.com/etcd/)
@@ -574,7 +574,7 @@ Træfik supports several Key-value stores:
574
574
575
575
Please refer to the [User Guide Key-value store configuration](/user-guide/kv-config/) section to get documentation on it.
576
576
577
-
### Dynamic Træfik configuration
577
+
### Dynamic Traefik configuration
578
578
579
579
The dynamic configuration concerns :
580
580
@@ -583,9 +583,9 @@ The dynamic configuration concerns :
583
583
-[Servers](/basics/#servers)
584
584
- HTTPS Certificates
585
585
586
-
Træfik can hot-reload those rules which could be provided by [multiple configuration backends](/configuration/commons).
586
+
Traefik can hot-reload those rules which could be provided by [multiple configuration backends](/configuration/commons).
587
587
588
-
We only need to enable `watch` option to make Træfik watch configuration backend changes and generate its configuration automatically.
588
+
We only need to enable `watch` option to make Traefik watch configuration backend changes and generate its configuration automatically.
589
589
Routes to services will be created and updated instantly at any changes.
590
590
591
591
Please refer to the [configuration backends](/configuration/commons) section to get documentation on it.
@@ -599,10 +599,10 @@ Usage:
599
599
traefik [command] [--flag=flag_argument]
600
600
```
601
601
602
-
List of Træfik available commands with description :
602
+
List of Traefik available commands with description :
603
603
604
604
-`version` : Print version
605
-
-`storeconfig` : Store the static Traefik configuration into a Key-value stores. Please refer to the [Store Træfik configuration](/user-guide/kv-config/#store-configuration-in-key-value-store) section to get documentation on it.
605
+
-`storeconfig` : Store the static Traefik configuration into a Key-value stores. Please refer to the [Store Traefik configuration](/user-guide/kv-config/#store-configuration-in-key-value-store) section to get documentation on it.
606
606
-`bug`: The easiest way to submit a pre-filled issue.
607
607
-`healthcheck`: Calls Traefik `/ping` to check health.
608
608
@@ -627,7 +627,7 @@ docker run traefik[:version] --help
627
627
628
628
### Command: bug
629
629
630
-
Here is the easiest way to submit a pre-filled issue on [Træfik GitHub](https://github.com/containous/traefik).
630
+
Here is the easiest way to submit a pre-filled issue on [Traefik GitHub](https://github.com/containous/traefik).
631
631
632
632
```bash
633
633
traefik bug
@@ -660,14 +660,14 @@ You can read the public proposal on this topic [here](https://github.com/contain
660
660
661
661
### Why ?
662
662
663
-
In order to help us learn more about how Træfik is being used and improve it, we collect anonymous usage statistics from running instances.
663
+
In order to help us learn more about how Traefik is being used and improve it, we collect anonymous usage statistics from running instances.
664
664
Those data help us prioritize our developments and focus on what's more important (for example, which configuration backend is used and which is not used).
665
665
666
666
### What ?
667
667
668
-
Once a day (the first call begins 10 minutes after the start of Træfik), we collect:
668
+
Once a day (the first call begins 10 minutes after the start of Traefik), we collect:
669
669
670
-
- the Træfik version
670
+
- the Traefik version
671
671
- a hash of the configuration
672
672
- an **anonymous version** of the static configuration:
673
673
- token, user name, password, URL, IP, domain, email, etc, are removed
|[name.com](https://www.name.com/)|`namedotcom`|`NAMECOM_USERNAME`, `NAMECOM_API_TOKEN`, `NAMECOM_SERVER`| Not tested yet |
285
285
|[Netcup](https://www.netcup.eu/)|`netcup`|`NETCUP_CUSTOMER_NUMBER`, `NETCUP_API_KEY`, `NETCUP_API_PASSWORD`| Not tested yet |
@@ -299,7 +299,7 @@ Here is a list of supported `provider`s, that can automate the DNS verification,
299
299
### `domains`
300
300
301
301
You can provide SANs (alternative domains) to each main domain.
302
-
All domains must have A/AAAA records pointing to Træfik.
302
+
All domains must have A/AAAA records pointing to Traefik.
303
303
Each domain & SAN will lead to a certificate request.
304
304
305
305
```toml
@@ -341,7 +341,7 @@ Due to ACME limitation it is not possible to define wildcards in SANs (alternati
341
341
Most likely the root domain should receive a certificate too, so it needs to be specified as SAN and 2 `DNS-01` challenges are executed.
342
342
In this case the generated DNS TXT record for both domains is the same.
343
343
Eventhough this behaviour is [DNS RFC](https://community.letsencrypt.org/t/wildcard-issuance-two-txt-records-for-the-same-name/54528/2) compliant, it can lead to problems as all DNS providers keep DNS records cached for a certain time (TTL) and this TTL can be superior to the challenge timeout making the `DNS-01` challenge fail.
344
-
The Træfik ACME client library [LEGO](https://github.com/xenolf/lego) supports some but not all DNS providers to work around this issue.
344
+
The Traefik ACME client library [LEGO](https://github.com/xenolf/lego) supports some but not all DNS providers to work around this issue.
345
345
The [`provider` table](/configuration/acme/#provider) indicates if they allow generating certificates for a wildcard domain and its root domain.
346
346
347
347
### `onDemand` (Deprecated)
@@ -421,7 +421,7 @@ docker run -v "/my/host/acme:/etc/traefik/acme" traefik
421
421
```
422
422
423
423
!!! warning
424
-
This file cannot be shared across multiple instances of Træfik at the same time. Please use a [KV Store entry](/configuration/acme/#as-a-key-value-store-entry) instead.
424
+
This file cannot be shared across multiple instances of Traefik at the same time. Please use a [KV Store entry](/configuration/acme/#as-a-key-value-store-entry) instead.
425
425
426
426
#### As a Key Value Store Entry
427
427
@@ -443,8 +443,8 @@ During migration from ACME v1 to ACME v2, using a storage file, a backup of the
443
443
For example: if `acme.storage`'s value is `/etc/traefik/acme/acme.json`, the backup file will be `/etc/traefik/acme/acme.json.bak`.
444
444
445
445
!!! note
446
-
When Træfik is launched in a container, the storage file's parent directory needs to be mounted to be able to access the backup file on the host.
447
-
Otherwise the backup file will be deleted when the container is stopped. Træfik will only generate it once!
446
+
When Traefik is launched in a container, the storage file's parent directory needs to be mounted to be able to access the backup file on the host.
447
+
Otherwise the backup file will be deleted when the container is stopped. Traefik will only generate it once!
448
448
449
449
### `dnsProvider` (Deprecated)
450
450
@@ -465,4 +465,4 @@ If Let's Encrypt is not reachable, these certificates will be used:
465
465
1. Provided certificates
466
466
467
467
!!! note
468
-
For new (sub)domains which need Let's Encrypt authentification, the default Træfik certificate will be used until Træfik is restarted.
468
+
For new (sub)domains which need Let's Encrypt authentification, the default Traefik certificate will be used until Traefik is restarted.
0 commit comments