Categorygithub.com/kevinrandolph/traefik
modulepackage
0.0.0-20160303024905-179ca9e88d5f
Repository: https://github.com/kevinrandolph/traefik.git
Documentation: pkg.go.dev

# README

Træfɪk

Build Status License Join the chat at https://traefik.herokuapp.com Twitter

Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends (Docker :whale:, 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 Image Layers
  • SSL backends support
  • SSL frontend support
  • Clean AngularJS Web UI
  • Websocket support
  • HTTP/2 support

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

Web UI

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

Web UI Providers Web UI Health

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 -c traefik.toml
  • Use the tiny Docker image:
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml containous/traefik
  • From sources:
git clone https://github.com/containous/traefik

Documentation

You can find the complete documentation here.

Contributing

Please refer to this section.

Træfɪk here and there

These projects use Træfɪk internally. If your company uses Træfɪk, we would be glad to get your feedback :) Contact us on Join the chat at https://traefik.herokuapp.com

  • Project Mantl from Cisco

Web UI Providers

Mantl is a modern platform for rapidly deploying globally distributed services. A container orchestrator, docker, a network stack, something to pool your logs, something to monitor health, a sprinkle of service discovery and some automation.

  • Project Apollo from Cap Gemini

Web UI Providers

Apollo is an open source project to aid with building and deploying IAAS and PAAS services. It is particularly geared towards managing containerized applications across multiple hosts, and big data type workloads. Apollo leverages other open source components to provide basic mechanisms for deployment, maintenance, and scaling of infrastructure and applications.

Partners

Zenika

Zenika is one of the leading providers of professional Open Source services and agile methodologies in Europe. We provide consulting, development, training and support for the world’s leading Open Source software products.

Asteris

Founded in 2014, Asteris creates next-generation infrastructure software for the modern datacenter. Asteris writes software that makes it easy for companies to implement continuous delivery and realtime data pipelines. We support the HashiCorp stack, along with Kubernetes, Apache Mesos, Spark and Kafka. We're core committers on mantl.io, consul-cli and mesos-consul. .

# Packages

No description provided by the author
No description provided by the author

# Functions

LoadConfiguration returns a GlobalConfiguration.
NewGlobalConfiguration returns a GlobalConfiguration with default values.
NewServer returns an initialized Server.

# Variables

BuildDate holds the build date of traefik.
Version holds the current version of traefik.

# Structs

Certificate holds a SSL cert/key pair.
EntryPoint holds an entry point configuration of the reverse proxy (ip, port, TLS...).
GlobalConfiguration holds global configuration (with providers, etc.).
OxyLogger implements oxy Logger interface with logrus.
Redirect configures a redirection of an entry point to another, or to an URL.
Server is the reverse-proxy/load-balancer engine.
TLS configures TLS for an entry point.
WebProvider is a provider.Provider implementation that provides the UI.

# Type aliases

Certificates defines traefik certificates type.
DefaultEntryPoints holds default entry points.
EntryPoints holds entry points configuration of the reverse proxy (ip, port, TLS...).