From f743cd8bff970c76c3f9483aac0f9ed40f0d6cf5 Mon Sep 17 00:00:00 2001 From: emile Date: Tue, 22 Sep 2015 10:50:33 +0200 Subject: [PATCH] Docs corrections --- .gitignore | 3 ++- README.md | 6 ++++++ docs/index.md | 14 +++++++------- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 2393c5b95..4c6ba5a5a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ gen.go .idea log *.iml -./traefik \ No newline at end of file +./traefik +traefik.toml diff --git a/README.md b/README.md index 31d769b0d..a65166e51 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,12 @@ It supports several backends ([Docker :whale:](https://www.docker.com/), [Mesos/ 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](docs/index.md). diff --git a/docs/index.md b/docs/index.md index d4bf2d5d7..ebd118122 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ ___ * [Consul backend](#consul) -## :anchor: Basics +## Basics Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. @@ -45,7 +45,7 @@ Various types of load-balancing is supported: A circuit breaker can also be applied to a backend, preventing high loads on failing servers. -## :anchor: Global configuration +## Global configuration ```toml # traefik.toml @@ -103,7 +103,7 @@ A circuit breaker can also be applied to a backend, preventing high loads on fai ``` -## :anchor: File backend +## File backend Like any other reverse proxy, Træfɪk can be configured with a file. You have two choices: @@ -194,7 +194,7 @@ If you want Træfɪk to watch file changes automatically, just add: watch = true ``` -## :anchor: API backend +## API backend Træfik can be configured using a restful api. To enable it: @@ -307,7 +307,7 @@ $ curl -s "http://localhost:8082/api" | jq . * ```/api/frontends/{frontend}```: ```GET``` a frontend -## :anchor: Docker backend +## Docker backend Træfɪk can be configured to use Docker as a backend configuration: @@ -354,7 +354,7 @@ Labels can be used on containers to override default behaviour: * ```traefik.port=80```: register this port. Useful when the container exposes multiples ports. * ```traefik.weight=10```: assign this weight to the container -## :anchor: Marathon backend +## Marathon backend Træfɪk can be configured to use Marathon as a backend configuration: @@ -410,7 +410,7 @@ Labels can be used on containers to override default behaviour: * ```traefik.port=80```: register this port. Useful when the application exposes multiples ports. * ```traefik.weight=10```: assign this weight to the application -## :anchor: Consul backend +## Consul backend Træfɪk can be configured to use Consul as a backend configuration: