Repository files navigation

HAProxy is a free, very fast and reliable reverse-proxy offering high availability, load balancing, and proxying for TCPand HTTP-based applications.

TheINSTALL file describes how to build HAProxy.Alist of packages is also available on the wiki.

Thediscourse and themailing-listare available for questions or configuration assistance. You can also use theslack orIRC channel. Please don't use the issue tracker for these.

Theissue tracker is only for bug reports or feature requests.

The HAProxy documentation has been split into a number of different files forease of use. It is available in text format as well as HTML. The wiki is also meant to replace the old architectureguide.

• HTML documentation
• HTML HAProxy LUA API Documentation
• Wiki

Please refer to the following files depending on what you're looking for:

• INSTALL for instructions on how to build and install HAProxy
• BRANCHES to understand the project's life cycle and what version to use
• LICENSE for the project's license
• CONTRIBUTING for the process to follow to submit contributions

The more detailed documentation is located into the doc/ directory:

• doc/intro.txt for a quick introduction on HAProxy
• doc/configuration.txt for the configuration's reference manual
• doc/lua.txt for the Lua's reference manual
• doc/SPOE.txt for how to use the SPOE engine
• doc/network-namespaces.txt for how to use network namespaces under Linux
• doc/management.txt for the management guide
• doc/regression-testing.txt for how to use the regression testing suite
• doc/peers.txt for the peers protocol reference
• doc/coding-style.txt for how to adopt HAProxy's coding style
• doc/internals for developer-specific documentation (not all up to date)

HAProxy is licensed underGPL 2 or any later version, the headers underLGPL 2.1. See theLICENSE file for a more detailed explanation.