haproxy public development tree
Go to file
Ilya Shipitsin 5a6347fe3f CI: codespell: whitelist "te" and "nd" words
te is widely used abbrevation for "transfer encoding"
nd is variable name "name description"

we need to teach codespell those are legitimate
2020-12-21 11:54:06 +01:00
.github CI: codespell: whitelist "te" and "nd" words 2020-12-21 11:54:06 +01:00
contrib CLEANUP: assorted typo fixes in the code and comments 2020-12-21 11:24:48 +01:00
doc DOC: assorted typo fixes in the documentation 2020-12-21 11:24:56 +01:00
examples CLEANUP: assorted typo fixes in the code and comments 2020-06-26 11:27:28 +02:00
include CLEANUP: assorted typo fixes in the code and comments 2020-12-21 11:24:48 +01:00
reg-tests CLEANUP: assorted typo fixes in the code and comments 2020-12-21 11:24:48 +01:00
scripts REGTESTS: make use of HAPROXY_ARGS and pass -dM by default 2020-12-16 21:43:50 +01:00
src CLEANUP: assorted typo fixes in the code and comments 2020-12-21 11:24:48 +01:00
tests MEDIUM: config: remove the deprecated and dangerous global "debug" directive 2020-10-09 19:18:45 +02:00
.cirrus.yml CI: cirrus: drop CentOS 6 builds 2020-12-16 09:21:51 +01:00
.gitattributes MINOR: Commit .gitattributes 2020-09-05 16:21:59 +02:00
.gitignore CLEANUP: Update .gitignore 2020-09-12 13:11:24 +02:00
.travis.yml CI: travis-ci: remove builds migrated to GH actions 2020-11-21 05:40:27 +01:00
BRANCHES
CHANGELOG [RELEASE] Released version 2.4-dev3 2020-12-11 17:22:51 +01:00
CONTRIBUTING DOC: Use gender neutral language 2020-07-26 22:35:43 +02:00
INSTALL DOC: mention in INSTALL that it's development again 2020-11-05 17:19:13 +01:00
LICENSE
MAINTAINERS DOC: email change of the DeviceAtlas maintainer 2020-12-10 11:00:18 +01:00
Makefile CONTRIB: opentracing: add the OpenTracing filter 2020-12-16 15:49:53 +01:00
README
ROADMAP
SUBVERS
VERDATE [RELEASE] Released version 2.4-dev3 2020-12-11 17:22:51 +01:00
VERSION [RELEASE] Released version 2.4-dev3 2020-12-11 17:22:51 +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)