No description
Find a file
2018-02-19 10:54:03 +01:00
.github New PR template 2017-10-30 16:38:03 +01:00
.semaphoreci Prepare release v1.5.0-rc1 2017-11-28 14:50:06 +01:00
.travis Update traefik SSH key take 2 (#2023) 2017-08-29 09:37:47 +02:00
acme Merge branch 'v1.5' into master 2018-02-07 16:20:40 +01:00
api Fix data races. 2018-01-15 11:46:04 +01:00
autogen Homogenization of templates: Eureka 2018-02-13 09:20:04 +01:00
cluster Migrate from libkv to valkeyrie library 2018-01-24 17:52:03 +01:00
cmd/traefik refactor: use positive error code. 2018-02-19 10:54:03 +01:00
collector Stats collection. 2017-11-25 13:36:03 +01:00
configuration Add new options to the CLI entrypoint definition. 2018-02-08 09:30:06 +01:00
contrib dumpcerts.sh: Fix call to "base64" for Alpine 2017-11-02 15:52:04 +01:00
docs Split security labels and custom labels documentation. 2018-02-16 16:04:05 +01:00
examples Merge 'v1.5.2' into master 2018-02-12 15:39:12 +01:00
healthcheck extend metrics and rebuild prometheus exporting logic 2018-01-26 11:58:03 +01:00
integration refactor: some minor changes. 2018-02-19 10:54:03 +01:00
job Import order as goimports does 2016-12-30 19:04:02 +01:00
log refactor: some minor changes. 2018-02-19 10:54:03 +01:00
metrics extend metrics and rebuild prometheus exporting logic 2018-01-26 11:58:03 +01:00
middlewares refactor: some minor changes. 2018-02-19 10:54:03 +01:00
ping Use contants from http package. 2017-11-20 09:40:03 +01:00
provider refactor: some minor changes. 2018-02-19 10:54:03 +01:00
safe Add unit tests for package safe 2017-05-01 16:21:26 +02:00
script Merge 'v1.5.2' into master 2018-02-12 15:39:12 +01:00
server Logger and Leaks 2018-02-12 17:24:03 +01:00
templates Homogenization of templates: Eureka 2018-02-13 09:20:04 +01:00
testhelpers extend metrics and rebuild prometheus exporting logic 2018-01-26 11:58:03 +01:00
tls Merge 'v1.5.1' into master 2018-01-29 17:12:23 +01:00
types Redirection: permanent move option. 2018-01-31 19:10:04 +01:00
vendor Correct conditional setting of buffering retry expression. 2018-02-15 16:06:03 +01:00
version Use contants from http package. 2017-11-20 09:40:03 +01:00
webui Add status code text to webui bar chart tooltip 2018-01-25 16:54:03 +01:00
whitelist Add TrustForwardHeader options. 2017-10-16 12:46:03 +02:00
.dockerignore Re-exclude /dist/traefik from .dockerignore. 2017-04-26 10:01:43 +02:00
.gitattributes Update Lego (Gandi API v5, cloudxns, ...) 2018-02-12 18:10:05 +01:00
.gitignore Add Let's Encrypt HTTP Challenge 2018-01-15 16:04:05 +01:00
.pre-commit-config.yaml add errcheck validation 2016-03-23 16:39:09 +01:00
.travis.yml Rebuild experimental image 2018-01-29 16:08:03 +01:00
build.Dockerfile Migrate to dep 0.4 2018-02-07 23:30:05 +01:00
CHANGELOG.md Prepare release v1.5.2 2018-02-12 11:46:03 +01:00
CODE_OF_CONDUCT.md Adopt the Code Of Coduct from http://contributor-covenant.org 2016-08-26 10:26:41 +01:00
CONTRIBUTING.md Migrate to dep 0.4 2018-02-07 23:30:05 +01:00
Dockerfile Adding expose for default port 2015-12-03 17:15:01 +01:00
docs.Dockerfile Add docker things for documentation 2017-10-11 14:46:03 +02:00
generate.go Add option -s to gofmt for autogen 2017-11-30 08:52:03 +01:00
Gopkg.lock Correct conditional setting of buffering retry expression. 2018-02-15 16:06:03 +01:00
Gopkg.toml Bump kubernetes/client-go 2018-02-14 09:56:04 +01:00
LICENSE.md Upgrade docs dependencies and adapt configuration 2018-01-02 11:28:02 +01:00
MAINTAINER.md Add mmatur to maintainers 2017-10-24 13:18:03 +02:00
Makefile Migrate to dep 0.4 2018-02-07 23:30:05 +01:00
mkdocs.yml Merge branch 'v1.5' into master 2018-01-24 15:11:21 +01:00
README.md Grammar 2017-12-13 18:22:05 +01:00
requirements.txt Upgrade docs dependencies and adapt configuration 2018-01-02 11:28:02 +01:00
traefik.sample.toml add json format support for traefik logs 2017-09-21 10:42:02 +02:00

Træfik

Build Status SemaphoreCI Docs Go Report Card License Join the chat at https://traefik.herokuapp.com Twitter

Træfik (pronounced like traffic) is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends (Docker, Swarm mode, Kubernetes, Marathon, Consul, Etcd, Rancher, Amazon ECS, and a lot more) to manage its configuration automatically and dynamically.


. Overview . Features . Supported backends . Quickstart . Web UI . Test it . Documentation .

. Support . Release cycle . Contributing . Maintainers . Plumbing . Credits .


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

Microservices are often deployed in dynamic environments where services are added, removed, killed, upgraded or scaled many times a day.

Traditional reverse-proxies are not natively dynamic. You can't change their configuration and hot-reload easily.

Here enters Træfik.

Architecture

Træfik 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

  • It's fast
  • No dependency hell, single binary made with go
  • Tiny official docker image
  • Rest API
  • Hot-reloading of configuration. No need to restart the process
  • Circuit breakers, retry
  • Round Robin, rebalancer load-balancers
  • Metrics (Rest, Prometheus, Datadog, Statsd, InfluxDB)
  • Clean AngularJS Web UI
  • Websocket, HTTP/2, GRPC ready
  • Access Logs (JSON, CLF)
  • Let's Encrypt support (Automatic HTTPS with renewal)
  • Proxy Protocol support
  • High Availability with cluster mode (beta)

Supported backends

Quickstart

You can have a quick look at Træfik in this Katacoda tutorial that shows how to load balance requests between multiple Docker containers. If you are looking for a more comprehensive and real use-case example, you can also check Play-With-Docker to see how to load balance between multiple nodes.

Here is a talk given by Emile Vauge at GopherCon 2017. You will learn Træfik basics in less than 10 minutes.

Traefik GopherCon 2017

Here is a talk given by Ed Robinson at ContainerCamp UK conference. You will learn fundamental Træfik features and see some demos with Kubernetes.

Traefik ContainerCamp UK

Web UI

You can access the simple HTML frontend of Træfik.

Web UI Providers Web UI Health

Test it

./traefik --configFile=traefik.toml
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik
  • From sources:
git clone https://github.com/containous/traefik

Documentation

You can find the complete documentation at https://docs.traefik.io. A collection of contributions around Træfik can be found at https://awesome.traefik.io.

Support

To get basic support, you can:

  • join the Træfik community Slack channel: Join the chat at https://traefik.herokuapp.com
  • use Stack Overflow (using the traefik tag)

If you prefer commercial support, please contact containo.us by mail: mailto:support@containo.us.

Release cycle

  • Release: We try to release a new version every 2 months
    • i.e.: 1.3.0, 1.4.0, 1.5.0
  • Release candidate: we do RC (1.x.0-rcy) before the final release (1.x.0)
    • i.e.: 1.1.0-rc1 -> 1.1.0-rc2 -> 1.1.0-rc3 -> 1.1.0-rc4 -> 1.1.0
  • Bug-fixes: For each version we release bug fixes
    • i.e.: 1.1.1, 1.1.2, 1.1.3
    • those versions contain only bug-fixes
    • no additional features are delivered in those versions
  • Each version is supported until the next one is released
    • i.e.: 1.1.x will be supported until 1.2.0 is out
  • We use Semantic Versioning

Contributing

Please refer to contributing documentation.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Maintainers

Information about process and maintainers

Plumbing

Credits

Kudos to Peka for his awesome work on the logo logo. Traefik's logo licensed under the Creative Commons 3.0 Attributions license.

Traefik's logo was inspired by the gopher stickers made by Takuya Ueda (https://twitter.com/tenntenn). The original Go gopher was designed by Renee French (http://reneefrench.blogspot.com/).