fabio: A Go repository from leprechau

Notes

If you are confused about the commit order for the v1.5.11 release please check the Release Notes for an explanation.
The 1.5.11 tag was wrongly pointing to commit 0297494e9a00f87d3e387b8c6ff0408c2f5db6a0 instead of commit 446fbba59da42ed73df67c3d738b9945dbf0790a. I have updated the v1.5.11 tag to point to the correct version and created v1.5.11-wrong tag to point to the old (wrong) version.

fabio is a fast, modern, zero-conf load balancing HTTP(S) and TCP router for deploying applications managed by consul.

Register your services in consul, provide a health check and fabio will start routing traffic to them. No configuration required. Deployment, upgrading and refactoring has never been easier.

fabio is developed and maintained by The Fabio Authors.

It powers some of the largest websites in The Netherlands (marktplaats.nl), Australia (gumtree.com.au) and Italy (www.kijiji.it). It delivers 23.000 req/sec every day since Sep 2015 without problems.

It integrates with Consul, Vault, Amazon ELB, Amazon API Gateway and more.

It supports (Full feature list)

TLS termination with dynamic certificate stores
Raw TCP proxy
TCP+SNI proxy for full end-to-end TLS without decryption
HTTPS upstream support
Websockets and SSE
Dynamic reloading without restart
Traffic shaping for "blue/green" deployments,
Circonus, Graphite and StatsD/DataDog metrics
WebUI

Watch Kelsey Hightower demo Consul, Nomad, Vault and fabio at HashiConf EU 2016.

The full documentation is on fabiolb.net

Getting started

Install from source, binary, Docker or Homebrew.

# go 1.9 or higher is required
go get github.com/fabiolb/fabio                     (>= go1.9)

brew install fabio                                  (OSX/macOS stable)
brew install --devel fabio                          (OSX/macOS devel)

docker pull fabiolb/fabio                           (Docker)

https://github.com/fabiolb/fabio/releases           (pre-built binaries)

Register your service in consul.

Make sure that each instance registers with a unique ServiceID and a service name without spaces.
Register a health check in consul as described here.

By default fabio only watches services which have a passing health check, unless overridden with registry.consul.service.status.
Register one urlprefix- tag per host/path prefix it serves, e.g.:

# HTTP/S examples
urlprefix-/css                                     # path route
urlprefix-i.com/static                             # host specific path route
urlprefix-mysite.com/                              # host specific catch all route
urlprefix-/foo/bar strip=/foo                      # path stripping (forward '/bar' to upstream)
urlprefix-/foo/bar proto=https                     # HTTPS upstream
urlprefix-/foo/bar proto=https tlsskipverify=true  # HTTPS upstream and self-signed cert

# TCP examples
urlprefix-:3306 proto=tcp                          # route external port 3306

Make sure the prefix for HTTP routes contains at least one slash (/).

See the full list of options in the Documentation.

Start fabio without a config file (assuming a running consul agent on localhost:8500) Watch the log output how fabio picks up the route to your service. Try starting/stopping your service to see how the routing table changes instantly.
Send all your HTTP traffic to fabio on port 9999. For TCP proxying see TCP proxy.
Done

Author and Founder

Frank Schroeder @magiconair

Maintainers

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

See LICENSE for details.