No description
Find a file
Emile Vauge 4bc2f17b08 Merge pull request #1368 from containous/update-doc
License 2017, Træfɪk => Træfik
2017-04-24 16:20:55 +02:00
.github License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
.travis Fix SSH key, I hope... 2016-04-06 15:28:25 +02:00
acme remove dot from regex 2017-03-07 15:21:08 +01:00
autogen Refactor traefik with package 2015-11-02 18:35:55 +01:00
cluster Fix panic in k8s loadIngresses 2017-02-03 09:46:27 +01:00
cmd/traefik Extract some code in packages 2017-04-20 10:06:41 +02:00
contrib/systemd Add systemd watchdog feature 2017-02-04 19:06:24 +01:00
docs License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
examples Add documentation for k8s RBAC configuration 2017-04-13 00:27:16 +02:00
healthcheck Correct typo and use Godoc convention in comment. 2017-04-20 14:02:29 -04:00
integration Extract providers to their own package 2017-04-18 13:24:17 +02:00
job Import order as goimports does 2016-12-30 19:04:02 +01:00
log Import order as goimports does 2016-12-30 19:04:02 +01:00
middlewares First stage of access logging middleware. Initially without any output appenders. 2017-04-23 00:46:45 +02:00
mocks IP-per-task: (#841) 2017-01-06 16:26:50 +01:00
provider Fix typo in command line help. 2017-04-21 14:01:45 +02:00
safe Lint files 2017-02-03 09:55:47 +01:00
script Extract some code in packages 2017-04-20 10:06:41 +02:00
server refactor: clean code 2017-04-24 10:04:57 +02:00
templates Add Basic Auth per Frontend for Rancher & Docker Dynamic Provider 2017-04-19 21:05:43 +02:00
types Add Basic Auth per Frontend for Rancher & Docker Dynamic Provider 2017-04-19 21:05:43 +02:00
vendor Update golang.org/x/sys to fix windows compilation 2017-04-17 20:08:40 +02:00
version Merge v1.2.1-master 2017-04-11 22:36:56 +02:00
webui License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
.dockerignore Prepare for dependency vendoring. 2017-03-08 22:21:12 +01:00
.gitignore Prepare for dependency vendoring. 2017-03-08 22:21:12 +01:00
.pre-commit-config.yaml add errcheck validation 2016-03-23 16:39:09 +01:00
.travis.yml Don't run binary twice 2017-04-17 18:51:37 +02:00
build.Dockerfile Bump go 1.8 2017-03-23 22:39:53 +01:00
CHANGELOG.md Prepare release v1.2.1 2017-04-11 22:36:55 +02:00
CODE_OF_CONDUCT.md Adopt the Code Of Coduct from http://contributor-covenant.org 2016-08-26 10:26:41 +01:00
Dockerfile Adding expose for default port 2015-12-03 17:15:01 +01:00
generate.go Move version.go in its own package… 2016-07-21 16:33:49 +02:00
glide.lock Update golang.org/x/sys to fix windows compilation 2017-04-17 20:08:40 +02:00
glide.yaml Update golang.org/x/sys to fix windows compilation 2017-04-17 20:08:40 +02:00
LICENSE.md License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
Makefile Pull images before running CI 2017-04-17 17:28:34 +02:00
mkdocs.yml License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
README.md Traefik logo license 2017-04-24 15:34:12 +02:00
requirements.txt Fix docs build and add missing benchmarks page (#1017) 2017-01-09 15:12:11 +01:00
traefik.sample.toml Fix Rancher backend left in uncommented state 2017-04-18 15:00:18 +10:00

Træfik

Build Status 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, Kubernetes, Marathon, Mesos, Consul, Etcd, Zookeeper, BoltDB, Eureka, Amazon DynamoDB, 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æ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
  • Rest API
  • Multiple backends supported: Docker, Swarm, Kubernetes, Marathon, Mesos, Consul, Etcd, and more to come
  • Watchers for backends, can listen for changes in backends to apply a new configuration automatically
  • Hot-reloading of configuration. No need to restart the process
  • Graceful shutdown http connections
  • Circuit breakers on backends
  • Round Robin, rebalancer load-balancers
  • Rest Metrics
  • Tiny official docker image included
  • SSL backends support
  • SSL frontend support (with SNI)
  • Clean AngularJS Web UI
  • Websocket support
  • HTTP/2 support
  • Retry request if network error
  • Let's Encrypt support (Automatic HTTPS with renewal)
  • High Availability with cluster mode

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.

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

Traefik ContainerCamp UK

Here is a talk (in French) given by Emile Vauge at the Devoxx France 2016 conference. You will learn fundamental Træfik features and see some demos with Docker, Mesos/Marathon and Let's Encrypt.

Traefik Devoxx France

Web UI

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

Web UI Providers Web UI Health

Plumbing

Test it

./traefik --configFile=traefik.toml
  • Use the tiny Docker image:
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 here.

Contributing

Please refer to this section.

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.

Support

You can join Join the chat at https://traefik.herokuapp.com to get basic support. If you prefer commercial support, please contact containo.us by mail: mailto:support@containo.us.

Maintainers

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