haproxy public development tree
Go to file
Willy Tarreau 1efe68978e DOC: add a few words about USE_* and the addons directory
Nowhere it was really explained what USE_* was used for. Let's
take this opportunity to introduce addons/ which will also rely
on these.
2021-04-02 17:48:42 +02:00
.github CONTRIB: move prometheus-exporter to addons/promex 2021-04-02 17:48:42 +02:00
addons/promex CONTRIB: move prometheus-exporter to addons/promex 2021-04-02 17:48:42 +02:00
admin BUILD: makefile: build halog with the correct flags 2021-04-02 17:48:42 +02:00
contrib CONTRIB: move prometheus-exporter to addons/promex 2021-04-02 17:48:42 +02:00
dev BUILD: makefile: integrate the hpack tools 2021-04-02 17:48:42 +02:00
doc MINOR: global: define diagnostic mode of execution 2021-04-01 18:03:37 +02:00
examples CLEANUP: assorted typo fixes in the code and comments 2020-06-26 11:27:28 +02:00
include MINOR: diag: create cfgdiag module 2021-04-01 18:03:37 +02:00
reg-tests REGTESTS: ssl: mark set_ssl_cert_bundle.vtc as broken 2021-04-02 17:13:55 +02:00
scripts BUILD: Makefile: move REGTESTST_TYPE default setting 2021-02-05 11:41:16 +01:00
src CONTRIB: move some dev-specific tools to dev/ 2021-04-02 17:48:42 +02:00
tests TESTS: move tests/*.cfg to tests/config 2021-04-02 10:59:29 +02:00
.cirrus.yml CI: cirrus: update FreeBSD image to 12.2 2021-02-12 16:04:52 +01:00
.gitattributes MINOR: Configure the `cpp` userdiff driver for *.[ch] in .gitattributes 2021-02-22 18:17:57 +01:00
.gitignore CONTRIB: move halog to admin/ 2021-04-02 17:48:42 +02:00
.travis.yml CI: travis-ci: drop coverity scan builds 2020-12-22 19:39:23 +01:00
BRANCHES DOC: fix some spelling issues over multiple files 2021-01-08 14:53:47 +01:00
CHANGELOG [RELEASE] Released version 2.4-dev14 2021-03-27 09:42:09 +01:00
CONTRIBUTING DOC: fix some spelling issues over multiple files 2021-01-08 14:53:47 +01:00
INSTALL DOC: add a few words about USE_* and the addons directory 2021-04-02 17:48:42 +02:00
LICENSE
MAINTAINERS CONTRIB: move prometheus-exporter to addons/promex 2021-04-02 17:48:42 +02:00
Makefile CONTRIB: move prometheus-exporter to addons/promex 2021-04-02 17:48:42 +02:00
README
ROADMAP
SUBVERS
VERDATE [RELEASE] Released version 2.4-dev14 2021-03-27 09:42:09 +01:00
VERSION [RELEASE] Released version 2.4-dev14 2021-03-27 09:42:09 +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
  - 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)