mirror of
http://git.haproxy.org/git/haproxy.git/
synced 2024-12-11 22:15:14 +00:00
7f3327390f
The README was barely usable after all the additions having accumulated over the years. This patch introduces a new INSTALL file explaining how to build and install haproxy with various levels of details. The README is now mostly an index to the list of useful documentations.
22 lines
1017 B
Plaintext
22 lines
1017 B
Plaintext
The HAProxy documentation has been split into a number of different files for
|
|
ease of use.
|
|
|
|
Please refer to the following files depending on what you're looking for :
|
|
|
|
- INSTALL for instructions on how to build and install HAProxy
|
|
- 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)
|