The Cloud Native Edge Router
Clone or download
Permalink
Failed to load latest commit information.
.github Update Slack URL. Jun 12, 2018
.semaphoreci Prepare release 1.7.0-rc1 Jul 9, 2018
.travis Update traefik SSH key take 2 (#2023) Aug 29, 2017
acme Support custom DNS resolvers for Let's Encrypt. Oct 25, 2018
anonymize Merge branch 'v1.7.2' into master Oct 5, 2018
api Global configuration log at start Oct 1, 2018
autogen/gentemplates Merge tag 'v1.7.4' into master Oct 30, 2018
cluster Merge branch 'v1.7' into master Aug 28, 2018
cmd Merge tag 'v1.7.4' into master Oct 30, 2018
collector Separate command from the main package Mar 1, 2018
configuration Merge tag 'v1.7.4' into master Oct 30, 2018
contrib Adding grafana dashboards based on prometheus metrics Jun 6, 2018
docs Merge tag 'v1.7.4' into master Oct 30, 2018
examples Merge tag 'v1.7.4' into master Oct 30, 2018
h2c H2C: Remove buggy line in init to make verbose switch working Jul 31, 2018
healthcheck Merge tag 'v1.7.4' into master Oct 30, 2018
hostresolver Small code enhancements Aug 6, 2018
integration Merge tag 'v1.7.4' into master Oct 30, 2018
ip Merge branch 'v1.7.2' into master Oct 5, 2018
job Import order as goimports does Dec 30, 2016
log Add interface to Træfik logger Sep 14, 2018
metrics Merge current v1.7 into master Aug 6, 2018
middlewares Merge tag 'v1.7.4' into master Oct 30, 2018
ping Extract internal router creation from server Apr 23, 2018
provider Merge tag 'v1.7.4' into master Oct 30, 2018
rules Case insensitive host rule Oct 25, 2018
safe Log stack when panic Oct 12, 2018
script Improve the CLI help (Update of the Flaeg dependency) Oct 10, 2018
server Merge tag 'v1.7.4' into master Oct 30, 2018
templates Merge tag 'v1.7.4' into master Oct 30, 2018
testhelpers Remove deprecated elements Aug 6, 2018
tls Merge tag 'v1.7.4' into master Oct 30, 2018
types Merge tag 'v1.7.4' into master Oct 30, 2018
vendor Merge tag 'v1.7.4' into master Oct 30, 2018
version Small code enhancements Aug 6, 2018
webui Merge tag 'v1.7.4' into master Oct 30, 2018
.dockerignore Re-exclude /dist/traefik from .dockerignore. Apr 26, 2017
.gitattributes Fix: Add TTL and custom Timeout in DigitalOcean DNS provider Apr 6, 2018
.gitignore New web ui Apr 27, 2018
.golangci.toml Small code enhancements Aug 6, 2018
.gometalinter.json chore: add gometlinter configuration. Feb 19, 2018
.pre-commit-config.yaml add errcheck validation Mar 23, 2016
.travis.yml Documentation: Introduces a check stage to validate HTML and links Jul 12, 2018
CHANGELOG.md Prepare release v1.7.4 Oct 30, 2018
CODE_OF_CONDUCT.md Adopt the Code Of Coduct from http://contributor-covenant.org Aug 26, 2016
CONTRIBUTING.md Uses ASCII characters to spell Traefik Oct 17, 2018
Dockerfile Add missing tmp directory to scratch image Oct 24, 2018
Gopkg.lock Merge tag 'v1.7.4' into master Oct 30, 2018
Gopkg.toml Merge 'v1.7.3' into master Oct 15, 2018
LICENSE.md Upgrade docs dependencies and adapt configuration Jan 2, 2018
MAINTAINER.md Merge tag 'v1.7.4' into master Oct 30, 2018
Makefile Documentation: Introduces a check stage to validate HTML and links Jul 12, 2018
README.md Merge tag 'v1.7.4' into master Oct 30, 2018
build.Dockerfile fix: golint. Oct 12, 2018
docs.Dockerfile Documentation: Introduces a check stage to validate HTML and links Jul 12, 2018
generate.go Add option -s to gofmt for autogen Nov 30, 2017
mkdocs.yml Merge tag 'v1.7.4' into master Oct 30, 2018
requirements.txt Freeze mkdocs version Aug 6, 2018
traefik.sample.toml Normalize parameter names in configs Apr 6, 2018

README.md

Traefik

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

Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. Traefik integrates with your existing infrastructure components (Docker, Swarm mode, Kubernetes, Marathon, Consul, Etcd, Rancher, Amazon ECS, ...) and configures itself automatically and dynamically. Pointing Traefik at your orchestrator should be the only configuration step you need.


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

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


🚧 As stated in the 1.7 release note, a significant update is in progress on the master branch. This branch will remain in constant evolution and prone to change with little notice, so use it for test purposes only.

Overview

Imagine that you have deployed a bunch of microservices with the help of an orchestrator (like Swarm or Kubernetes) or a service registry (like etcd or consul). Now you want users to access these microservices, and you need a reverse proxy.

Traditional reverse-proxies require that you configure each route that will connect paths and subdomains to each microservice. 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.

This is when Traefik can help you!

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.

Run Traefik and let it do the work for you! (But if you'd rather configure some of your routes manually, Traefik supports that too!)

Architecture

Features

  • Continuously updates its configuration (No restarts!)
  • Supports multiple load balancing algorithms
  • Provides HTTPS to your microservices by leveraging Let's Encrypt (wildcard certificates support)
  • Circuit breakers, retry
  • High Availability with cluster mode (beta)
  • See the magic through its clean web UI
  • Websocket, HTTP/2, GRPC ready
  • Provides metrics (Rest, Prometheus, Datadog, Statsd, InfluxDB)
  • Keeps access logs (JSON, CLF)
  • Fast
  • Exposes a Rest API
  • Packaged as a single binary file (made with ❤️ with go) and available as a tiny official docker image

Supported Backends

Quickstart

To get your hands on Traefik, you can use the 5-Minute Quickstart in our documentation (you will need Docker).

Alternatively, if you don't want to install anything on your computer, you can try Traefik online in this great 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.

Web UI

You can access the simple HTML frontend of Traefik.

Web UI Providers Web UI Health

Documentation

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

Support

To get community support, you can:

  • join the Traefik community Slack channel: Join the chat at https://slack.traefik.io
  • use Stack Overflow (using the traefik tag)

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

Download

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

Introductory Videos

Here is a talk given by Emile Vauge at GopherCon 2017. You will learn Traefik 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 Traefik features and see some demos with Kubernetes.

Traefik ContainerCamp UK

Maintainers

Information about process and maintainers

Contributing

If you'd like to contribute to the project, refer to the contributing documentation.

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.

Release Cycle

  • We release a new version (e.g. 1.1.0, 1.2.0, 1.3.0) every other month.
  • Release Candidates are available before the release (e.g. 1.1.0-rc1, 1.1.0-rc2, 1.1.0-rc3, 1.1.0-rc4, before 1.1.0)
  • Bug-fixes (e.g. 1.1.1, 1.1.2, 1.2.1, 1.2.3) are released as needed (no additional features are delivered in those versions, bug-fixes only)

Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out)

We use Semantic Versioning

Mailing lists

Credits

Kudos to Peka for his awesome work on the logo logo.

Traefik's logo is 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/).