The Wayback Machine - https://web.archive.org/web/20190529083653/https://github.com/containous/traefik
Skip to content
The Cloud Native Edge Router
Branch: master
Clone or download
Latest commit 11f04a4 Apr 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github log.loglevel becomes log.level in configuration Apr 16, 2019
.semaphoreci Prepare release v2.0.0-alpha1 Mar 18, 2019
.travis Update traefik SSH key take 2 (#2023) Aug 29, 2017
cmd log.loglevel becomes log.level in configuration Apr 16, 2019
contrib Remove dumpcerts.sh Apr 17, 2019
docs k8s static configuration explanation Apr 17, 2019
integration log.loglevel becomes log.level in configuration Apr 16, 2019
old/docs Clean old Mar 18, 2019
pkg Improve log message about redundant TLS certificate Apr 17, 2019
script Update certificates for some Docker images Apr 1, 2019
vendor Remove github.com/satori/go.uuid. Apr 5, 2019
webui change docs and adjust dashboard for v2 alpha Mar 19, 2019
.dockerignore Re-exclude /dist/traefik from .dockerignore. Apr 26, 2017
.gitattributes Migrate to go-acme/lego. Mar 14, 2019
.gitignore Move code to pkg Mar 15, 2019
.golangci.toml fix: validation system Apr 1, 2019
.goreleaser.yml Checksum file name. Apr 16, 2019
.travis.yml Get Structor version from CI env var. Apr 8, 2019
CHANGELOG.md Prepare release v2.0.0-alpha4. Apr 17, 2019
CODE_OF_CONDUCT.md Documentation Revamp Feb 26, 2019
CONTRIBUTING.md Documentation Revamp Feb 26, 2019
Dockerfile Add missing tmp directory to scratch image Oct 24, 2018
Gopkg.lock Remove github.com/satori/go.uuid. Apr 5, 2019
Gopkg.toml Remove github.com/satori/go.uuid. Apr 5, 2019
LICENSE.md Upgrade docs dependencies and adapt configuration Jan 2, 2018
Makefile fix: validation system Apr 1, 2019
README.md Update to v2.0 readme links Apr 1, 2019
build.Dockerfile Update certificates for some Docker images Apr 1, 2019
exp.Dockerfile Update certificates for some Docker images Apr 1, 2019
generate.go Move code to pkg Mar 15, 2019
netlify.toml Documentation Revamp Feb 26, 2019
traefik.sample.toml log.loglevel becomes log.level in configuration Apr 16, 2019

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 .


⚠️ Please be aware that the old configurations for Traefik v1.X are NOT compatible with the v2.X config as of now. If you're testing out v2, please ensure you are using a v2 configuration.

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

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.

⚠️ If you're testing out v2, please ensure you are using the v2 documentation.

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

⚠️ Please be aware that these videos are for v1.X. The old configurations for Traefik v1.X are NOT compatible with Traefik v2. If you're testing out v2, please ensure you are using a v2 configuration.

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

You can’t perform that action at this time.