Skip to content

Commit e6a88f3

Browse files
geraldcroestraefiker
authored andcommitted
Uses ASCII characters to spell Traefik
1 parent 95d86d8 commit e6a88f3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+320
-320
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ traefik*
3232
##### Setting up your `go` environment
3333

3434
- 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)
3636
- Set your `GOPATH` and `PATH` variable to be set to `~/go` via:
3737

3838
```bash
@@ -56,9 +56,9 @@ GORACE=""
5656
## more go env's will be listed
5757
```
5858

59-
##### Build Træfik
59+
##### Build Traefik
6060

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:
6262

6363
```bash
6464
cd ~/go/src/github.com/containous/traefik
@@ -77,7 +77,7 @@ go build ./cmd/traefik
7777
# run other commands like tests
7878
```
7979

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`.
8181

8282
### Updating the templates
8383

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
<p align="center">
3-
<img src="docs/img/traefik.logo.png" alt="Træfik" title="Træfik" />
3+
<img src="docs/img/traefik.logo.png" alt="Traefik" title="Traefik" />
44
</p>
55

66
[![Build Status SemaphoreCI](https://semaphoreci.com/api/v1/containous/traefik/branches/master/shields_badge.svg)](https://semaphoreci.com/containous/traefik)
@@ -12,9 +12,9 @@
1212
[![Twitter](https://img.shields.io/twitter/follow/traefik.svg?style=social)](https://twitter.com/intent/follow?screen_name=traefik)
1313

1414

15-
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.
1818

1919
---
2020

@@ -43,12 +43,12 @@ Now you want users to access these microservices, and you need a reverse proxy.
4343
Traditional reverse-proxies require that you configure _each_ route that will connect paths and subdomains to _each_ microservice.
4444
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.
4545

46-
**This is when Træfik can help you!**
46+
**This is when Traefik can help you!**
4747

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.
4949

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!)_
5252

5353
![Architecture](docs/img/architecture.png)
5454

@@ -85,28 +85,28 @@ _(But if you'd rather configure some of your routes manually, Træfik supports t
8585

8686
## Quickstart
8787

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).
8989

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.
9191

9292
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.
9393

9494
## Web UI
9595

96-
You can access the simple HTML frontend of Træfik.
96+
You can access the simple HTML frontend of Traefik.
9797

9898
![Web UI Providers](docs/img/web.frontend.png)
9999
![Web UI Health](docs/img/traefik-health.png)
100100

101101
## Documentation
102102

103103
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).
105105

106106
## Support
107107

108108
To get community support, you can:
109-
- join the Træfik community Slack channel: [![Join the chat at https://slack.traefik.io](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://slack.traefik.io)
109+
- join the Traefik community Slack channel: [![Join the chat at https://slack.traefik.io](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://slack.traefik.io)
110110
- use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik) (using the `traefik` tag)
111111

112112
If you need commercial support, please contact [Containo.us](https://containo.us) by mail: <mailto:support@containo.us>.
@@ -134,12 +134,12 @@ git clone https://github.com/containous/traefik
134134
## Introductory Videos
135135

136136
Here is a talk given by [Emile Vauge](https://github.com/emilevauge) at [GopherCon 2017](https://gophercon.com/).
137-
You will learn Træfik basics in less than 10 minutes.
137+
You will learn Traefik basics in less than 10 minutes.
138138

139139
[![Traefik GopherCon 2017](https://img.youtube.com/vi/RgudiksfL-k/0.jpg)](https://www.youtube.com/watch?v=RgudiksfL-k)
140140

141141
Here is a talk given by [Ed Robinson](https://github.com/errm) at [ContainerCamp UK](https://container.camp) conference.
142-
You will learn fundamental Træfik features and see some demos with Kubernetes.
142+
You will learn fundamental Traefik features and see some demos with Kubernetes.
143143

144144
[![Traefik ContainerCamp UK](https://img.youtube.com/vi/aFtpIShV60I/0.jpg)](https://www.youtube.com/watch?v=aFtpIShV60I)
145145

docs/basics.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ Let's take our example from the [overview](/#overview) again:
1414
1515
> ![Architecture](img/architecture.png)
1616
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:
1818

1919

2020
![Architecture](img/internal.png)
2121

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...).
2323
- Traffic is then forwarded to a matching [frontend](#frontends). A frontend defines routes from [entrypoints](#entrypoints) to [backends](#backends).
2424
Routes are created using requests fields (`Host`, `Path`, `Headers`...) and can match or not a request.
2525
- 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.
2626
- Finally, the [server](#servers) will forward the request to the corresponding microservice in the private network.
2727

2828
### Entrypoints
2929

30-
Entrypoints are the network entry points into Træfik.
30+
Entrypoints are the network entry points into Traefik.
3131
They can be defined using:
3232

3333
- a port (80, 443...)
@@ -514,16 +514,16 @@ Additional http headers and hostname to health check request can be specified, f
514514

515515
## Configuration
516516

517-
Træfik's configuration has two parts:
517+
Traefik's configuration has two parts:
518518

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).
521521

522-
### Static Træfik configuration
522+
### Static Traefik configuration
523523

524524
The static configuration is the global configuration which is setting up connections to configuration backends and entrypoints.
525525

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.
527527
Each item takes precedence over the item below it:
528528

529529
- [Key-value store](/basics/#key-value-stores)
@@ -539,7 +539,7 @@ It means that arguments override configuration file, and key-value store overrid
539539

540540
#### Configuration file
541541

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:
543543

544544
- `/etc/traefik/`
545545
- `$HOME/.traefik/`
@@ -565,7 +565,7 @@ Note that all default values will be displayed as well.
565565

566566
#### Key-value stores
567567

568-
Træfik supports several Key-value stores:
568+
Traefik supports several Key-value stores:
569569

570570
- [Consul](https://consul.io)
571571
- [etcd](https://coreos.com/etcd/)
@@ -574,7 +574,7 @@ Træfik supports several Key-value stores:
574574

575575
Please refer to the [User Guide Key-value store configuration](/user-guide/kv-config/) section to get documentation on it.
576576

577-
### Dynamic Træfik configuration
577+
### Dynamic Traefik configuration
578578

579579
The dynamic configuration concerns :
580580

@@ -583,9 +583,9 @@ The dynamic configuration concerns :
583583
- [Servers](/basics/#servers)
584584
- HTTPS Certificates
585585

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).
587587

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.
589589
Routes to services will be created and updated instantly at any changes.
590590

591591
Please refer to the [configuration backends](/configuration/commons) section to get documentation on it.
@@ -599,10 +599,10 @@ Usage:
599599
traefik [command] [--flag=flag_argument]
600600
```
601601

602-
List of Træfik available commands with description :
602+
List of Traefik available commands with description :
603603

604604
- `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.
606606
- `bug`: The easiest way to submit a pre-filled issue.
607607
- `healthcheck`: Calls Traefik `/ping` to check health.
608608

@@ -627,7 +627,7 @@ docker run traefik[:version] --help
627627

628628
### Command: bug
629629

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).
631631

632632
```bash
633633
traefik bug
@@ -660,14 +660,14 @@ You can read the public proposal on this topic [here](https://github.com/contain
660660

661661
### Why ?
662662

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.
664664
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).
665665

666666
### What ?
667667

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:
669669

670-
- the Træfik version
670+
- the Traefik version
671671
- a hash of the configuration
672672
- an **anonymous version** of the static configuration:
673673
- token, user name, password, URL, IP, domain, email, etc, are removed

docs/configuration/acme.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Here is a list of supported `provider`s, that can automate the DNS verification,
279279
| [Lightsail](https://aws.amazon.com/lightsail/) | `lightsail` | `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `DNS_ZONE` | Not tested yet |
280280
| [Linode](https://www.linode.com) | `linode` | `LINODE_API_KEY` | Not tested yet |
281281
| [Linode v4](https://www.linode.com) | `linodev4` | `LINODE_TOKEN` | Not tested yet |
282-
| manual | - | none, but you need to run Træfik interactively, turn on `acmeLogging` to see instructions and press <kbd>Enter</kbd>. | YES |
282+
| manual | - | none, but you need to run Traefik interactively, turn on `acmeLogging` to see instructions and press <kbd>Enter</kbd>. | YES |
283283
| [Namecheap](https://www.namecheap.com) | `namecheap` | `NAMECHEAP_API_USER`, `NAMECHEAP_API_KEY` | YES |
284284
| [name.com](https://www.name.com/) | `namedotcom` | `NAMECOM_USERNAME`, `NAMECOM_API_TOKEN`, `NAMECOM_SERVER` | Not tested yet |
285285
| [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,
299299
### `domains`
300300

301301
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.
303303
Each domain & SAN will lead to a certificate request.
304304

305305
```toml
@@ -341,7 +341,7 @@ Due to ACME limitation it is not possible to define wildcards in SANs (alternati
341341
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.
342342
In this case the generated DNS TXT record for both domains is the same.
343343
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.
345345
The [`provider` table](/configuration/acme/#provider) indicates if they allow generating certificates for a wildcard domain and its root domain.
346346

347347
### `onDemand` (Deprecated)
@@ -421,7 +421,7 @@ docker run -v "/my/host/acme:/etc/traefik/acme" traefik
421421
```
422422

423423
!!! 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.
425425

426426
#### As a Key Value Store Entry
427427

@@ -443,8 +443,8 @@ During migration from ACME v1 to ACME v2, using a storage file, a backup of the
443443
For example: if `acme.storage`'s value is `/etc/traefik/acme/acme.json`, the backup file will be `/etc/traefik/acme/acme.json.bak`.
444444

445445
!!! 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!
448448

449449
### `dnsProvider` (Deprecated)
450450

@@ -465,4 +465,4 @@ If Let's Encrypt is not reachable, these certificates will be used:
465465
1. Provided certificates
466466

467467
!!! 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

Comments
 (0)