118 lines
5.2 KiB
Markdown
118 lines
5.2 KiB
Markdown
<!--
|
||
|
||
********************************************************************************
|
||
|
||
WARNING:
|
||
|
||
DO NOT EDIT "traefik/README.md"
|
||
|
||
IT IS AUTO-GENERATED
|
||
|
||
(from the other files in "traefik/" combined with a set of templates)
|
||
|
||
********************************************************************************
|
||
|
||
-->
|
||
|
||
# Supported tags and respective `Dockerfile` links
|
||
|
||
- [`v1.4.0-rc2`, `1.4.0-rc2`, `v1.4`, `1.4`, `roquefort` (*scratch/amd64/Dockerfile*)](https://github.com/containous/traefik-library-image/blob/57f83af9d2719e5f25e6c769fd2640f973b519dc/scratch/amd64/Dockerfile)
|
||
- [`v1.4.0-rc2-alpine`, `1.4.0-rc2-alpine`, `v1.4-alpine`, `1.4-alpine`, `roquefort-alpine` (*alpine/Dockerfile*)](https://github.com/containous/traefik-library-image/blob/57f83af9d2719e5f25e6c769fd2640f973b519dc/alpine/Dockerfile)
|
||
- [`v1.3.8`, `1.3.8`, `v1.3`, `1.3`, `raclette`, `latest` (*scratch/amd64/Dockerfile*)](https://github.com/containous/traefik-library-image/blob/cfa3fa48bed342b86b143006e61d9bdf7db07901/scratch/amd64/Dockerfile)
|
||
- [`v1.3.8-alpine`, `1.3.8-alpine`, `v1.3-alpine`, `1.3-alpine`, `raclette-alpine`, `alpine` (*alpine/Dockerfile*)](https://github.com/containous/traefik-library-image/blob/cfa3fa48bed342b86b143006e61d9bdf7db07901/alpine/Dockerfile)
|
||
|
||
# Quick reference
|
||
|
||
- **Where to get help**:
|
||
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
|
||
|
||
- **Where to file issues**:
|
||
[https://github.com/containous/traefik-library-image/issues](https://github.com/containous/traefik-library-image/issues)
|
||
|
||
- **Maintained by**:
|
||
[the Træfik Project](https://github.com/containous/traefik-library-image)
|
||
|
||
- **Published image artifact details**:
|
||
[repo-info repo's `repos/traefik/` directory](https://github.com/docker-library/repo-info/blob/master/repos/traefik) ([history](https://github.com/docker-library/repo-info/commits/master/repos/traefik))
|
||
(image metadata, transfer size, etc)
|
||
|
||
- **Image updates**:
|
||
[official-images PRs with label `library/traefik`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Ftraefik)
|
||
[official-images repo's `library/traefik` file](https://github.com/docker-library/official-images/blob/master/library/traefik) ([history](https://github.com/docker-library/official-images/commits/master/library/traefik))
|
||
|
||
- **Source of this description**:
|
||
[docs repo's `traefik/` directory](https://github.com/docker-library/docs/tree/master/traefik) ([history](https://github.com/docker-library/docs/commits/master/traefik))
|
||
|
||
- **Supported Docker versions**:
|
||
[the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)
|
||
|
||
|
||
|
||
[Træfɪk](https://github.com/containous/traefik) is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends ([Docker :whale:](https://www.docker.com/), [Swarm :whale::whale:](https://github.com/docker/swarm), [Mesos/Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Zookeeper](https://zookeeper.apache.org), [BoltDB](https://github.com/boltdb/bolt), Rest API, file...) to manage its configuration automatically and dynamically.
|
||
|
||
# Example usage
|
||
|
||
Grab a [sample configuration file](https://raw.githubusercontent.com/containous/traefik/master/traefik.sample.toml) and rename it to `traefik.toml`. Enable `docker` provider and web UI:
|
||
|
||
```toml
|
||
################################################################
|
||
# Web configuration backend
|
||
################################################################
|
||
[web]
|
||
address = ":8080"
|
||
################################################################
|
||
# Docker configuration backend
|
||
################################################################
|
||
[docker]
|
||
domain = "docker.local"
|
||
watch = true
|
||
```
|
||
|
||
Start Træfɪk:
|
||
|
||
```bash
|
||
docker run -d -p 8080:8080 -p 80:80 \
|
||
-v $PWD/traefik.toml:/etc/traefik/traefik.toml \
|
||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||
traefik
|
||
```
|
||
|
||
Start a backend server, named `test`:
|
||
|
||
```bash
|
||
docker run -d --name test emilevauge/whoami
|
||
```
|
||
|
||
And finally, you can access to your `whoami` server throught Træfɪk, on the domain name `{containerName}.{configuredDomain}`:
|
||
|
||
```bash
|
||
curl --header 'Host: test.docker.local' 'http://localhost:80/'
|
||
Hostname: 117c5530934d
|
||
IP: 127.0.0.1
|
||
IP: ::1
|
||
IP: 172.17.0.3
|
||
IP: fe80::42:acff:fe11:3
|
||
GET / HTTP/1.1
|
||
Host: 172.17.0.3:80
|
||
User-Agent: curl/7.35.0
|
||
Accept: */*
|
||
Accept-Encoding: gzip
|
||
X-Forwarded-For: 172.17.0.1
|
||
X-Forwarded-Host: 172.17.0.3:80
|
||
X-Forwarded-Proto: http
|
||
X-Forwarded-Server: f2e05c433120
|
||
|
||
```
|
||
|
||
The web UI [http://localhost:8080](http://localhost:8080) will give you an overview of the frontends/backends and also a health dashboard.
|
||
|
||
|
||
|
||
# Documentation
|
||
|
||
You can find the complete documentation [here](https://docs.traefik.io).
|
||
|
||
# License
|
||
|
||
View [license information](https://github.com/containous/traefik/blob/master/LICENSE.md) for the software contained in this image.
|