haproxy public development tree
Go to file
Willy Tarreau 7f3327390f DOC: split the README into README + INSTALL
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.
2018-12-16 22:30:57 +01:00
contrib CLEANUP: stream: remove SF_TUNNEL, SF_INITIALIZED, SF_CONN_TAR 2018-12-11 18:01:38 +01:00
doc DOC: clarify the agent-check status line syntax 2018-12-16 08:42:56 +01:00
ebtree CLEANUP: fix typos in comments in ebtree 2018-11-18 22:23:15 +01:00
examples [RELEASE] Released version 1.9-dev10 2018-12-08 16:20:55 +01:00
include MINOR: debug: make the ABORT_NOW macro use a volatile int 2018-12-16 08:17:23 +01:00
reg-tests REGTEST: Add a reg test for HTTP cookies. 2018-12-15 16:18:14 +01:00
scripts DOC: split the README into README + INSTALL 2018-12-16 22:30:57 +01:00
src BUG/MAJOR: hpack: fix length check for short names encoding 2018-12-16 09:38:30 +01:00
tests CLEANUP: fix a misspell in tests/filltab25.c 2018-11-18 22:23:15 +01:00
.gitignore DOC: split the README into README + INSTALL 2018-12-16 22:30:57 +01:00
CHANGELOG [RELEASE] Released version 1.9-dev10 2018-12-08 16:20:55 +01:00
CONTRIBUTING
INSTALL DOC: split the README into README + INSTALL 2018-12-16 22:30:57 +01:00
LICENSE
MAINTAINERS
Makefile REGTEST: Reg testing improvements. 2018-12-14 06:50:45 +01:00
README DOC: split the README into README + INSTALL 2018-12-16 22:30:57 +01:00
ROADMAP
SUBVERS
VERDATE [RELEASE] Released version 1.9-dev10 2018-12-08 16:20:55 +01:00
VERSION [RELEASE] Released version 1.9-dev10 2018-12-08 16:20:55 +01:00

README

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)