From Gentoo Wiki
Jump to:navigation Jump to:search
This article is a stub. Please help out by expanding it - how to get started.

Haproxy (Originally High Availability Proxy) provides an industrial grade proxy to the Gentoo administrator routing traffic between ones frontend (web-facing) and backend (web-servers/web-services/databases). It reports connectivity statistics, performs health checks upon backend services and supports load balancing.

Interestingly, if one has multiple frontend machines HAProxy will redirect clients from one machine to another as they are taken offline ensuring a consistent service (One stands under correction on this point).

It handles both TCP (Level 4 in the OSI model) and the HTTP (Level 7 in the OSI model) routing (Routing further protocols seems possible too e.g. mail).

SSL termination may be done at Haproxy or passed through to be termination at the backend (SNI).


USE flags

USE flags for net-proxy/haproxy A TCP/HTTP reverse proxy for high availability environments

51degrees Device Detection using 51 Degrees
crypt Add support for encryption -- using mcrypt or gpg where applicable
doc Add extra documentation (API, Javadoc, etc). It is recommended to enable per package instead of globally
examples Install examples, usually source code
lua Enable Lua scripting support
net_ns Enable network namespace support (CONFIG_NET_NS)
pcre Add support for Perl Compatible Regular Expressions
pcre-jit Use JIT support for PCRE
prometheus-exporter Also build the prometheus exporter
slz Use dev-libs/libslz compression library
ssl Add support for SSL/TLS connections (Secure Socket Layer / Transport Layer Security)
systemd Enable use of systemd-specific libraries and features like socket activation or session tracking
test Enable dependencies and/or preparations necessary to run tests (usually controlled by FEATURES=test but can be toggled independently)
threads Add threads support for various packages. Usually pthreads
tools Install additional tools (halog, iprange)
wurfl Device Detection using WURFL
zlib Add support for zlib compression


root #emerge --ask net-proxy/haproxy

Additional software

The following software supports, compliments or integrates with Haproxy :

An interactive ncurses client and real-time monitoring, statistics displaying tool for the Haproxy TCP/HTTP load balancer
A load feedback and check agent for Haproxy
A statistics collector which processes various statistics and pushes them to a graphing system (Graphite)

HAProxy serves the usual web-servers (Apache/Lighthttpd/NginX/Traefik) and databases (PostgreSQL/Redis/MySQL/CouchDB) and supports encryption (OpenSSL/LetsEncrypt). It will handle backend connections via unix and web sockets. These packages are used with haproxy and do not interact with it directly, hence are not listed here.


The global section, within Haproxy's configuration file, specifies the services permissions and behaviour upon ones system. This file is read sequentially and one may define One or more default block(s) may be set to define the common behaviour of the subsequent frontend/backend blocks; with later default blocks overriding the earlier ones.

In the example that follow one provide the minimal configuration necessary to enable some feature provided by Haproxy. By combining these examples one should be able to configure Haproxy for their own setup.


The following files and folders are used to configure Haproxy

* /etc/haproxy/haproxy.cfg - The main configuration file
* /etc/haproxy/certs - The SSL certificates folder
* /etc/openssl/private - An alternate, possibly better, location for SSL certificates


The haproxy user and group are configured by emerge during installation.

FILE /etc/haproxy/haproxy.cfg
        user        haproxy
        group       haproxy
        pidfile     /var/run/haproxy.pid


This terminates the secure connection and passes the decrypted traffic on to the backend. This assumes the backend is run on a secured internal network.

Haproxy uses a single certificate for authentication purposes, that is an ordered and combined key, thing and thing. If ones certificates are supplied by letsencrypts' certbot then they may use the following line to generate a combined certiifcate for haproxy. The combined certificates should be stored under either the Haproxy folder, /etc/haproxy/certs, or the OpenSSL one, /etc/openssl/private (The author is not sure which of these paths is the canonical one).


SNI is performed within the TCP layer (Level 4 in the OSI model) allowing frontend connections over HTTPS to be directed to the appropriate backend. Only very old browsers do not support this e.g. I.E. on WinXP.


root #emerge --ask --depclean --verbose net-proxy/haproxy

External resources