| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 1 | The HAProxy documentation has been split into a number of different files for |
| 2 | ease of use. |
| willy tarreau | 7834533 | 2005-12-18 01:33:16 +0100 | [diff] [blame] | 3 | |
| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 4 | Please refer to the following files depending on what you're looking for : |
| willy tarreau | 7834533 | 2005-12-18 01:33:16 +0100 | [diff] [blame] | 5 | |
| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 6 | - INSTALL for instructions on how to build and install HAProxy |
| Willy Tarreau | ba4ad17 | 2019-06-15 21:53:40 +0200 | [diff] [blame] | 7 | - BRANCHES to understand the project's life cycle and what version to use |
| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 8 | - LICENSE for the project's license |
| 9 | - CONTRIBUTING for the process to follow to submit contributions |
| Willy Tarreau | b1a34b6 | 2010-05-09 22:37:12 +0200 | [diff] [blame] | 10 | |
| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 11 | The more detailed documentation is located into the doc/ directory : |
| Willy Tarreau | b1a34b6 | 2010-05-09 22:37:12 +0200 | [diff] [blame] | 12 | |
| Willy Tarreau | 7f33273 | 2018-12-16 22:27:15 +0100 | [diff] [blame] | 13 | - doc/intro.txt for a quick introduction on HAProxy |
| 14 | - doc/configuration.txt for the configuration's reference manual |
| 15 | - doc/lua.txt for the Lua's reference manual |
| 16 | - doc/SPOE.txt for how to use the SPOE engine |
| 17 | - doc/network-namespaces.txt for how to use network namespaces under Linux |
| 18 | - doc/management.txt for the management guide |
| 19 | - doc/regression-testing.txt for how to use the regression testing suite |
| 20 | - doc/peers.txt for the peers protocol reference |
| 21 | - doc/coding-style.txt for how to adopt HAProxy's coding style |
| 22 | - doc/internals for developer-specific documentation (not all up to date) |