Merge pull request #1196 from mmatur/update-traefik-docs

Update Træfik documentation
This commit is contained in:
yosifkit 2018-04-17 13:16:10 -07:00 committed by GitHub
commit 5684a122be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions

View File

@ -1,6 +1,10 @@
%%LOGO%%
[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.
[Træfɪk](https://github.com/containous/traefik) 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.
# Example usage
@ -8,10 +12,9 @@ Grab a [sample configuration file](https://raw.githubusercontent.com/containous/
```toml
################################################################
# Web configuration backend
# API and dashboard configuration
################################################################
[web]
address = ":8080"
[api]
################################################################
# Docker configuration backend
################################################################
@ -58,8 +61,10 @@ 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.
![Web UI Providers](https://traefik.io/web.frontend.png)
![Web UI Providers](https://github.com/containous/traefik/blob/master/docs/img/web.frontend.png)
# Documentation
You can find the complete documentation [here](https://docs.traefik.io).
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).