traefik/README.md

181 lines
9 KiB
Markdown
Raw Normal View History

2016-02-29 17:27:09 +00:00
<p align="center">
<img src="docs/img/traefik.logo.png" alt="Træfik" title="Træfik" />
2016-02-29 17:27:09 +00:00
</p>
2015-09-13 17:34:05 +00:00
2017-05-18 20:36:10 +00:00
[![Build Status SemaphoreCI](https://semaphoreci.com/api/v1/containous/traefik/branches/master/shields_badge.svg)](https://semaphoreci.com/containous/traefik)
[![Docs](https://img.shields.io/badge/docs-current-brightgreen.svg)](https://docs.traefik.io)
[![Go Report Card](https://goreportcard.com/badge/containous/traefik)](http://goreportcard.com/report/containous/traefik)
2016-09-30 13:04:37 +00:00
[![](https://images.microbadger.com/badges/image/traefik.svg)](https://microbadger.com/images/traefik)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/containous/traefik/blob/master/LICENSE.md)
2015-10-28 10:39:24 +00:00
[![Join the chat at https://traefik.herokuapp.com](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://traefik.herokuapp.com)
2016-02-18 09:25:59 +00:00
[![Twitter](https://img.shields.io/twitter/follow/traefikproxy.svg?style=social)](https://twitter.com/intent/follow?screen_name=traefikproxy)
2015-09-22 14:07:49 +00:00
2018-03-22 11:34:03 +00:00
Træfik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy.
Træfik integrates with your existing infrastructure components ([Docker](https://www.docker.com/), [Swarm mode](https://docs.docker.com/engine/swarm/), [Kubernetes](https://kubernetes.io), [Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Rancher](https://rancher.com), [Amazon ECS](https://aws.amazon.com/ecs), ...) and configures itself automatically and dynamically.
Telling Træfik where your orchestrator is could be the _only_ configuration step you need to do.
2017-08-10 15:29:32 +00:00
---
2017-09-11 17:10:04 +00:00
. **[Overview](#overview)** .
**[Features](#features)** .
**[Supported backends](#supported-backends)** .
**[Quickstart](#quickstart)** .
**[Web UI](#web-ui)** .
**[Test it](#test-it)** .
**[Documentation](#documentation)** .
. **[Support](#support)** .
**[Release cycle](#release-cycle)** .
**[Contributing](#contributing)** .
**[Maintainers](#maintainers)** .
**[Plumbing](#plumbing)** .
**[Credits](#credits)** .
2017-08-10 15:29:32 +00:00
---
## Overview
2018-03-22 11:34:03 +00:00
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.
2018-03-22 11:34:03 +00:00
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.
2018-03-22 11:34:03 +00:00
**This is when Træfik can help you!**
2018-03-22 11:34:03 +00:00
Træfik 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.
2018-03-22 11:34:03 +00:00
**Run Træfik and let it do the work for you!**
_(But if you'd rather configure some of your routes manually, Træfik supports that too!)_
![Architecture](docs/img/architecture.png)
## Features
2018-03-22 11:34:03 +00:00
- Continuously updates its configuration (No restarts!)
- Supports multiple load balancing algorithms
- Provides HTTPS to your microservices by leveraging [Let's Encrypt](https://letsencrypt.org)
2017-08-25 18:40:03 +00:00
- Circuit breakers, retry
2017-08-25 19:32:03 +00:00
- High Availability with cluster mode (beta)
2018-03-22 11:34:03 +00:00
- 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](https://docs.traefik.io/benchmarks) ... which is nice
- Exposes a Rest API
- Packaged as a single binary file (made with :heart: with go) and available as a [tiny](https://microbadger.com/images/traefik) [official](https://hub.docker.com/r/_/traefik/) docker image
## Supported Backends
- [Docker](docs/configuration/backends/docker/) / [Swarm mode](docs/configuration/backends/docker/#docker-swarm-mode)
- [Kubernetes](docs/configuration/backends/kubernetes/)
- [Mesos](docs/configuration/backends/mesos/) / [Marathon](docs/configuration/backends/marathon/)
- [Rancher](docs/configuration/backends/rancher/) (API, Metadata)
- [Service Fabric](docs/configuration/backends/servicefabric/)
- [Consul Catalog](docs/configuration/backends/consulcatalog/)
- [Consul](docs/configuration/backends/consul/) / [Etcd](docs/configuration/backends/etcd/) / [Zookeeper](docs/configuration/backends/zookeeper/) / [BoltDB](docs/configuration/backends/boltdb/)
- [Eureka](docs/configuration/backends/eureka/)
- [Amazon ECS](docs/configuration/backends/ecs/)
- [Amazon DynamoDB](docs/configuration/backends/dynamodb/)
- [File](docs/configuration/backends/file/)
- [Rest](docs/configuration/backends/rest/)
2017-08-10 15:29:32 +00:00
2016-09-20 12:49:43 +00:00
## Quickstart
2015-09-28 16:25:41 +00:00
2018-03-22 11:34:03 +00:00
To get your hands on Træfik, you can use the [5-Minute Quickstart](http://docs.traefik.io/#the-trfik-quickstart-using-docker) in our documentation (you will need Docker).
2015-09-28 16:25:41 +00:00
2018-03-22 11:34:03 +00:00
Alternatively, if you don't want to install anything on your computer, you can try Træfik online in this great [Katacoda tutorial](https://www.katacoda.com/courses/traefik/deploy-load-balancer) that shows how to load balance requests between multiple Docker containers.
2015-09-28 16:25:41 +00:00
2018-03-22 11:34:03 +00:00
If you are looking for a more comprehensive and real use-case example, you can also check [Play-With-Docker](http://training.play-with-docker.com/traefik-load-balancing/) to see how to load balance between multiple nodes.
2017-08-10 15:29:32 +00:00
2015-10-13 16:05:50 +00:00
## Web UI
2017-04-18 20:12:17 +00:00
You can access the simple HTML frontend of Træfik.
2015-10-13 16:05:50 +00:00
![Web UI Providers](docs/img/web.frontend.png)
![Web UI Health](docs/img/traefik-health.png)
2018-03-22 11:34:03 +00:00
## Documentation
You can find the complete documentation at [https://docs.traefik.io](https://docs.traefik.io).
A collection of contributions around Træfik can be found at [https://awesome.traefik.io](https://awesome.traefik.io).
## Support
To get community support, you can:
- join the Træfik community Slack channel: [![Join the chat at https://traefik.herokuapp.com](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://traefik.herokuapp.com)
- use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik) (using the `traefik` tag)
If you need commercial support, please contact [Containo.us](https://containo.us) by mail: <mailto:support@containo.us>.
2015-09-13 17:34:05 +00:00
2018-03-22 11:34:03 +00:00
## Download
2015-09-13 17:34:05 +00:00
2018-03-22 11:34:03 +00:00
- Grab the latest binary from the [releases](https://github.com/containous/traefik/releases) page and run it with the [sample configuration file](https://raw.githubusercontent.com/containous/traefik/master/traefik.sample.toml):
2015-09-13 17:34:05 +00:00
```shell
./traefik --configFile=traefik.toml
2015-09-13 17:34:05 +00:00
```
2015-09-14 12:38:21 +00:00
2018-03-22 11:34:03 +00:00
- Or use the official tiny Docker image and run it with the [sample configuration file](https://raw.githubusercontent.com/containous/traefik/master/traefik.sample.toml):
2015-09-13 17:34:05 +00:00
```shell
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik
2015-09-13 17:34:05 +00:00
```
2018-03-22 11:34:03 +00:00
- Or get the sources:
2015-09-22 08:50:33 +00:00
```shell
git clone https://github.com/containous/traefik
2015-09-22 08:50:33 +00:00
```
2018-03-22 11:34:03 +00:00
## Introductory Videos
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
Here is a talk given by [Emile Vauge](https://github.com/emilevauge) at [GopherCon 2017](https://gophercon.com/).
You will learn Træfik basics in less than 10 minutes.
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
[![Traefik GopherCon 2017](https://img.youtube.com/vi/RgudiksfL-k/0.jpg)](https://www.youtube.com/watch?v=RgudiksfL-k)
2018-03-22 11:34:03 +00:00
Here is a talk given by [Ed Robinson](https://github.com/errm) at [ContainerCamp UK](https://container.camp) conference.
You will learn fundamental Træfik features and see some demos with Kubernetes.
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
[![Traefik ContainerCamp UK](https://img.youtube.com/vi/aFtpIShV60I/0.jpg)](https://www.youtube.com/watch?v=aFtpIShV60I)
2017-06-30 15:35:26 +00:00
2018-03-22 11:34:03 +00:00
## Maintainers
2017-06-30 15:35:26 +00:00
2018-03-22 11:34:03 +00:00
[Information about process and maintainers](MAINTAINER.md)
2017-06-30 15:35:26 +00:00
2017-08-10 15:29:32 +00:00
## Contributing
2018-03-22 11:34:03 +00:00
If you'd like to contribute to the project, refer to the [contributing documentation](CONTRIBUTING.md).
2017-08-10 15:29:32 +00:00
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
2018-03-22 11:34:03 +00:00
By participating in this project, you agree to abide by its terms.
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
## Release Cycle
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
- 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)
2018-03-22 11:34:03 +00:00
Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out)
2017-08-10 15:29:32 +00:00
2018-03-22 11:34:03 +00:00
We use [Semantic Versioning](http://semver.org/)
2017-08-10 15:29:32 +00:00
## Plumbing
- [Oxy](https://github.com/vulcand/oxy): an awesome proxy library made by Mailgun folks
- [Gorilla mux](https://github.com/gorilla/mux): famous request router
- [Negroni](https://github.com/urfave/negroni): web middlewares made simple
- [Lego](https://github.com/xenolf/lego): the best [Let's Encrypt](https://letsencrypt.org) library in go
## Credits
Kudos to [Peka](http://peka.byethost11.com/photoblog/) for his awesome work on the logo ![logo](docs/img/traefik.icon.png).
2018-03-22 11:34:03 +00:00
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).
2018-03-22 11:34:03 +00:00
The original Go gopher was designed by Renee French (http://reneefrench.blogspot.com/).