1. Available documentation

  1. The complete HAProxy documentation is contained in the following documents.
  2. Please ensure to consult the relevant documentation to save time and to get the
  3. most accurate response to your needs. Also please refrain from sending questions
  4. to the mailing list whose responses are present in these documents.
  5.  
  6. - intro.txt (this document) : it presents the basics of load balancing,
  7. HAProxy as a product, what it does, what it doesn't do, some known traps to
  8. avoid, some OS-specific limitations, how to get it, how it evolves, how to
  9. ensure you're running with all known fixes, how to update it, complements
  10. and alternatives.
  11.  
  12. - management.txt : it explains how to start haproxy, how to manage it at
  13. runtime, how to manage it on multiple nodes, and how to proceed with
  14. seamless upgrades.
  15.  
  16. - configuration.txt : the reference manual details all configuration keywords
  17. and their options. It is used when a configuration change is needed.
  18.  
  19. - coding-style.txt : this is for developers who want to propose some code to
  20. the project. It explains the style to adopt for the code. It is not very
  21. strict and not all the code base completely respects it, but contributions
  22. which diverge too much from it will be rejected.
  23.  
  24. - proxy-protocol.txt : this is the de-facto specification of the PROXY
  25. protocol which is implemented by HAProxy and a number of third party
  26. products.
  27.  
  28. - README : how to build HAProxy from sources