1
0
mirror of https://github.com/containous/traefik.git synced 2024-12-23 17:34:13 +03:00
traefik mirror
Go to file
2015-10-08 21:21:51 +02:00
docs docs(dashboard): add screenshot 2015-10-05 23:30:33 +02:00
Godeps libkv docs 2015-10-04 18:50:54 +02:00
integration refactor(dashboard): font definition correction 2015-10-06 21:00:53 +02:00
middlewares Configuration on cicuitbreakers and load balancers 2015-09-28 23:16:32 +02:00
providerTemplates Added traefik.domain label. Corrects https://github.com/EmileVauge/traefik/issues/50 2015-10-08 21:21:51 +02:00
script Update build toolchain to the use of docker… 2015-09-28 20:27:59 +02:00
static docs(webui): add documentation 2015-10-07 14:09:11 +02:00
templates libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
tests libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
.gitignore feat(dashboard): add vendor dependencies 2015-10-05 23:30:32 +02:00
adapters.go Fix some typos, fmt and imports :) 2015-09-24 17:16:13 +02:00
boltdb.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
build.Dockerfile Update build toolchain to the use of docker… 2015-09-28 20:27:59 +02:00
circle.yml Corrects release management in Docker Hub 2015-10-08 19:45:36 +02:00
configuration.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
consul.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
docker.go Added traefik.domain label. Corrects https://github.com/EmileVauge/traefik/issues/50 2015-10-08 21:21:51 +02:00
Dockerfile Corrects https://github.com/EmileVauge/traefik/issues/21 2015-09-25 17:46:52 +02:00
etcd.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
file_test.go Update building stuff 2015-09-15 23:09:48 +02:00
file.go Add /api/providers API 2015-10-03 16:50:53 +02:00
generate.go Negroni middlewares 2015-09-12 15:10:03 +02:00
kv.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
LICENSE.md Licence 2015-09-10 10:02:51 +02:00
Makefile libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
marathon.go Added traefik.domain label. Corrects https://github.com/EmileVauge/traefik/issues/50 2015-10-08 21:21:51 +02:00
provider.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
README.md docs(dashboard): add screenshot 2015-10-05 23:30:33 +02:00
traefik.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00
traefik.sample.toml libkv docs 2015-10-04 18:50:54 +02:00
web.go feat: API REST endpoint review 2015-10-05 23:23:08 +02:00
zk.go libkv support https://github.com/EmileVauge/traefik/issues/25 https://github.com/EmileVauge/traefik/issues/9 2015-10-02 11:36:16 +02:00

Træfɪk


Circle CI License Join the chat at https://gitter.im/EmileVauge/traefik

Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends (Docker 🐳, Mesos/Marathon, Consul, Etcd, Zookeeper, BoltDB, Rest API, file...) to manage its configuration automatically and dynamically.

Features

  • No dependency hell, single binary made with go
  • Simple json Rest API
  • Simple TOML file configuration
  • Multiple backends supported: Docker, Mesos/Marathon, Consul, Etcd, and more to come
  • Watchers for backends, can listen change in backends to apply a new configuration automatically
  • Hot-reloading of configuration. No need to restart the process
  • Graceful shutdown http connections during hot-reloads
  • Circuit breakers on backends
  • Round Robin, rebalancer load-balancers
  • Rest Metrics
  • Tiny docker image included
  • SSL backends support
  • SSL frontend support
  • WebUI

Demo

Here is a demo of Træfɪk using Docker backend, showing a load-balancing between two servers, hot reloading of configuration, and graceful shutdown.

asciicast

Plumbing

  • Oxy: an awsome proxy library made by Mailgun guys
  • Gorilla mux: famous request router
  • Negroni: web middlewares made simple
  • Manners: graceful shutdown of http.Handler servers

Quick start

./traefik traefik.toml
  • Use the tiny Docker image:
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/traefik.toml emilevauge/traefik
  • From sources:
git clone https://github.com/EmileVauge/traefik

Documentation

You can find the complete documentation here.

Benchmarks

Refer to the benchmarks section in the documentation.

Web UI

You can access to a simple HTML frontend of Træfik.

HTML frontend

Contributing

Building

You need either Docker and make, or go and godep in order to build traefik.

Using Docker and Makefile

You need to run the binary target. This will create binaries for linux and darwin platforms in the dist folder.

$ make binary
docker build -t "traefik-dev:your-feature-branch" -f build.Dockerfile .
# […]
docker run --rm -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/vincent/src/github/vdemeester/traefik/dist:/go/src/github.com/emilevauge/traefik/dist" "traefik-dev:your-feature-branch" ./script/make.sh generate binary
---> Making bundle: generate (in .)
removed 'gen.go'

---> Making bundle: binary (in .)
Number of parallel builds: 8

-->       linux/arm: github.com/emilevauge/traefik
-->    darwin/amd64: github.com/emilevauge/traefik
-->      darwin/386: github.com/emilevauge/traefik
-->       linux/386: github.com/emilevauge/traefik
-->     linux/amd64: github.com/emilevauge/traefik

$ ls dist/
traefik*  traefik_darwin-386*  traefik_darwin-amd64*  traefik_linux-386*  traefik_linux-amd64*  traefik_linux-arm*

Using godep

The idea behind godep is the following :

  • when checkout(ing) a project, run godep restore to install (go get …) the dependencies in the GOPATH.
  • if you need another dependency, go get it, import and use it in the source, and run godep save ./... to save it in Godeps/Godeps.json.
$ godep restore
# Generate
$ godep go generate
# Simple go build
$ godep go build
# Using gox to build multiple platform
$ GOPATH=`godep path`:$GOPATH gox "linux darwin" "386 amd64 arm" \
    -output="dist/traefik_{{.OS}}-{{.Arch}}"
# run other commands like tests
$ godep go test ./...
ok      _/home/vincent/src/github/vdemeester/traefik    0.004s

Tests

You can run unit tests using the test-unit target and the integration test using the test-integration target.

$ make test-unit
docker build -t "traefik-dev:your-feature-branch" -f build.Dockerfile .
# […]
docker run --rm -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/vincent/src/github/vdemeester/traefik/dist:/go/src/github.com/emilevauge/traefik/dist" "traefik-dev:your-feature-branch" ./script/make.sh generate test-unit
---> Making bundle: generate (in .)
removed 'gen.go'

---> Making bundle: test-unit (in .)
+ go test -cover -coverprofile=cover.out .
ok      github.com/emilevauge/traefik   0.005s  coverage: 4.1% of statements

Test success