-
Notifications
You must be signed in to change notification settings - Fork 619
Features
The following list provides a list of features supported by fabio.
Check out fabio.properties for a full list of config options.
fabio has support for dynamic certificate stores which allow you to store certificates in a central place and update them at runtime without restarting fabio. You can store certificates in files, directories, on HTTP servers in Consul or in Vault.
See Certificate Stores for more detail.
To run fabio within Docker use the official Docker image and mount your own config file to /etc/fabio/fabio.properties
docker run -d -p 9999:9999 -p 9998:9998 -v $PWD/fabio/fabio.properties:/etc/fabio/fabio.properties magiconair/fabio
If you want to run the Docker image with one or more SSL certificates then
you can store your configuration and certificates in /etc/fabio
and mount
the entire directory, e.g.
$ cat ~/fabio/fabio.properties
proxy.addr=:443;/etc/fabio/ssl/mycert.pem;/etc/fabio/ssl/mykey.pem
docker run -d -p 443:443 -p 9998:9998 -v $PWD/fabio:/etc/fabio magiconair/fabio
The official Docker image contains the root CA certificates from a recent and updated Ubuntu 12.04.5 LTS installation.
fabio watches services in consul and reloads its configuration on every change without interrupting existing connections.
fabio supports a graceful shutdown timeout during which new requests will receive a 503 Service Unavailable
response while the active requests can complete. See the proxy.shutdownwait
option in the fabio.properties file.
fabio collects metrics per route and service instance as well as running totals to avoid computing large amounts of metrics. The metrics can be send to a Graphite server or stdout. See the metrics.*
options in the fabio.properties file.
Other metrics backends can be added as long as they are supported by the github.com/rcrowley/go-metrics library.
In addition, to injecting the Forwarded
and X-Real-Ip
headers the X-Forwarded-For
, X-Forwarded-Port
and X-Forwarded-Proto
headers are added to HTTP(S) and Websocket requests. Custom headers for the ip address and protocol can be configured with the proxy.header.clientip
, proxy.header.tls
and proxy.header.tls.value
options.
fabio transparently supports the HA Proxy PROXY protocol version 1 which is used by HA Proxy, Amazon ELB and others to transmit the remote address and port of the client without using headers.
fabio allows to control the amount of traffic a set of service instances will
receive. You can use this feature to direct a fixed percentage of traffic to a
newer version of an existing service for testing ("Canary testing"). See
Manual Overrides for a complete description of the route weight
command.
The following command will allocate 5% of traffic to www.kjca.dev/auth/
to
all instances of service-b
which match tags version-15
and dc-fra
. This
is independent of the number of actual instances running. The remaining 95%
of the traffic will be distributed evenly across the remaining instances
publishing the same prefix.
route weight service-b www.kjca.dev/auth/ weight 0.05 tags "version-15,dc-fra"
To send a request from the command line via the fabio using curl
you should send it as follows:
curl -v -H 'Host: foo.com' 'http://localhost:9999/path'
The -x
or --proxy
options will most likely not work as you expect as they
send the full URL instead of just the request URI which usually does not match
any route but the default one - if configured.
To trace how a request is routed you can add a Trace
header with an non-
empty value which is truncated at 16 characters to keep the log output short.
$ curl -v -H 'Trace: abc' -H 'Host: foo.com' 'http://localhost:9999/bar/baz'
2015/09/28 21:56:26 [TRACE] abc Tracing foo.com/bar/baz
2015/09/28 21:56:26 [TRACE] abc No match foo.com/bang
2015/09/28 21:56:26 [TRACE] abc Match foo.com/
2015/09/28 22:01:34 [TRACE] abc Routing to http://1.2.3.4:8080/
fabio transparently supports Websocket connections by detecting the Upgrade: websocket
header in the incoming HTTP(S) request. See Websockets for more details.
fabio supports a Web UI to examine the current routing table and manage the manual overrides. By default it listens on http://localhost:9998/
which can be changed with the ui.addr
option. The ui.title
and ui.color
options allow customization of the title and the color of the header bar.
- Home
- Quickstart
- Installation
- Verifying Releases
- Configuration
- Binding to low ports
- Deployment
-
Features
- Access Logging ⭐️
- Certificate Stores
- Compression
- Circonus Support
- DataDog Support
- Docker Support
- Dynamic Reloading
- Graceful Shutdown
- Graphite Support
- HTTP Header
- HTTPS Upstream
- Metrics Support
- Path Stripping
- PROXY Protocol
- Request Debugging
- Request Tracing
- SSE Support
- StatsD Support
- TCP Proxy ⭐️
- TCP+SNI Support
- Traffic Shaping
- Vault Integration
- Websockets
- Web UI
- Performance
- Service Configuration
- Routing
- Debugging
- Contributing
- Why fabio?