blob: eb8f139ffca459b82eb11b3ecb11684752305a1a [file] [log] [blame]
Willy Tarreaub1a34b62010-05-09 22:37:12 +02001 ----------------------
2 HAProxy how-to
3 ----------------------
Willy Tarreau15480d72014-06-19 21:10:58 +02004 version 1.6-dev
Willy Tarreaub1a34b62010-05-09 22:37:12 +02005 willy tarreau
Willy Tarreau61d301f2015-08-30 00:17:17 +02006 2015/08/30
willy tarreau78345332005-12-18 01:33:16 +01007
8
Willy Tarreaub1a34b62010-05-09 22:37:12 +020091) How to build it
10------------------
11
Willy Tarreau15480d72014-06-19 21:10:58 +020012First, please note that this version is a development version, so in general if
13you are not used to build from sources or if you don't have the time to track
14very frequent updates, it is recommended that instead you switch to the stable
15version (1.5) or follow the packaged updates provided by your software vendor
16or Linux distribution. Most of them are taking this task seriously and are
17doing a good job. If for any reason you'd prefer a different version than the
18one packaged for your system, or to get some commercial support, other choices
19are available at :
Willy Tarreau869f3512014-06-19 15:26:32 +020020
21 http://www.haproxy.com/
22
willy tarreau78345332005-12-18 01:33:16 +010023To build haproxy, you will need :
Willy Tarreaub1a34b62010-05-09 22:37:12 +020024 - GNU make. Neither Solaris nor OpenBSD's make work with the GNU Makefile.
Willy Tarreau3543cdb2014-05-10 09:12:46 +020025 If you get many syntax errors when running "make", you may want to retry
26 with "gmake" which is the name commonly used for GNU make on BSD systems.
Willy Tarreau869f3512014-06-19 15:26:32 +020027 - GCC between 2.95 and 4.8. Others may work, but not tested.
willy tarreau78345332005-12-18 01:33:16 +010028 - GNU ld
29
30Also, you might want to build with libpcre support, which will provide a very
Willy Tarreaub1a34b62010-05-09 22:37:12 +020031efficient regex implementation and will also fix some badness on Solaris' one.
willy tarreau78345332005-12-18 01:33:16 +010032
33To build haproxy, you have to choose your target OS amongst the following ones
34and assign it to the TARGET variable :
35
Willy Tarreau83b30c12008-05-25 10:32:50 +020036 - linux22 for Linux 2.2
37 - linux24 for Linux 2.4 and above (default)
38 - linux24e for Linux 2.4 with support for a working epoll (> 0.21)
Willy Tarreau83b30c12008-05-25 10:32:50 +020039 - linux26 for Linux 2.6 and above
Willy Tarreau869f3512014-06-19 15:26:32 +020040 - linux2628 for Linux 2.6.28, 3.x, and above (enables splice and tproxy)
Willy Tarreau83b30c12008-05-25 10:32:50 +020041 - solaris for Solaris 8 or 10 (others untested)
Willy Tarreau869f3512014-06-19 15:26:32 +020042 - freebsd for FreeBSD 5 to 10 (others untested)
Willy Tarreau8624cab2013-04-02 08:17:43 +020043 - osx for Mac OS/X
Daniel Jakots17d228b2015-07-29 08:03:08 +020044 - openbsd for OpenBSD 3.1 and above
Willy Tarreau50abe302014-04-02 20:44:43 +020045 - aix51 for AIX 5.1
Willy Tarreau7dec9652012-06-06 16:15:03 +020046 - aix52 for AIX 5.2
Yitzhak Sapir32087312009-06-14 18:27:54 +020047 - cygwin for Cygwin
Willy Tarreau869f3512014-06-19 15:26:32 +020048 - generic for any other OS or version.
Willy Tarreau83b30c12008-05-25 10:32:50 +020049 - custom to manually adjust every setting
willy tarreau78345332005-12-18 01:33:16 +010050
51You may also choose your CPU to benefit from some optimizations. This is
52particularly important on UltraSparc machines. For this, you can assign
53one of the following choices to the CPU variable :
54
55 - i686 for intel PentiumPro, Pentium 2 and above, AMD Athlon
56 - i586 for intel Pentium, AMD K6, VIA C3.
57 - ultrasparc : Sun UltraSparc I/II/III/IV processor
Willy Tarreau817dad52014-07-10 20:24:25 +020058 - native : use the build machine's specific processor optimizations. Use with
59 extreme care, and never in virtualized environments (known to break).
60 - generic : any other processor or no CPU-specific optimization. (default)
willy tarreau78345332005-12-18 01:33:16 +010061
Willy Tarreau83b30c12008-05-25 10:32:50 +020062Alternatively, you may just set the CPU_CFLAGS value to the optimal GCC options
63for your platform.
64
Willy Tarreauef7341d2009-04-11 19:45:50 +020065You may want to build specific target binaries which do not match your native
66compiler's target. This is particularly true on 64-bit systems when you want
67to build a 32-bit binary. Use the ARCH variable for this purpose. Right now
Willy Tarreaua5899aa2010-11-28 07:41:00 +010068it only knows about a few x86 variants (i386,i486,i586,i686,x86_64), two
69generic ones (32,64) and sets -m32/-m64 as well as -march=<arch> accordingly.
Willy Tarreauef7341d2009-04-11 19:45:50 +020070
willy tarreau78345332005-12-18 01:33:16 +010071If your system supports PCRE (Perl Compatible Regular Expressions), then you
72really should build with libpcre which is between 2 and 10 times faster than
73other libc implementations. Regex are used for header processing (deletion,
74rewriting, allow, deny). The only inconvenient of libpcre is that it is not
75yet widely spread, so if you build for other systems, you might get into
76trouble if they don't have the dynamic library. In this situation, you should
77statically link libpcre into haproxy so that it will not be necessary to
Willy Tarreau83b30c12008-05-25 10:32:50 +020078install it on target systems. Available build options for PCRE are :
willy tarreau78345332005-12-18 01:33:16 +010079
Willy Tarreau83b30c12008-05-25 10:32:50 +020080 - USE_PCRE=1 to use libpcre, in whatever form is available on your system
willy tarreau78345332005-12-18 01:33:16 +010081 (shared or static)
82
Willy Tarreau83b30c12008-05-25 10:32:50 +020083 - USE_STATIC_PCRE=1 to use a static version of libpcre even if the dynamic
84 one is available. This will enhance portability.
85
Willy Tarreau663148c2012-12-12 00:38:22 +010086 - with no option, use your OS libc's standard regex implementation (default).
Willy Tarreau83b30c12008-05-25 10:32:50 +020087 Warning! group references on Solaris seem broken. Use static-pcre whenever
88 possible.
willy tarreau78345332005-12-18 01:33:16 +010089
Willy Tarreau64bc40b2011-03-23 20:00:53 +010090Recent systems can resolve IPv6 host names using getaddrinfo(). This primitive
91is not present in all libcs and does not work in all of them either. Support in
92glibc was broken before 2.3. Some embedded libs may not properly work either,
93thus, support is disabled by default, meaning that some host names which only
94resolve as IPv6 addresses will not resolve and configs might emit an error
95during parsing. If you know that your OS libc has reliable support for
96getaddrinfo(), you can add USE_GETADDRINFO=1 on the make command line to enable
97it. This is the recommended option for most Linux distro packagers since it's
98working fine on all recent mainstream distros. It is automatically enabled on
99Solaris 8 and above, as it's known to work.
100
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200101It is possible to add native support for SSL using the GNU makefile, by passing
102"USE_OPENSSL=1" on the make command line. The libssl and libcrypto will
103automatically be linked with haproxy. Some systems also require libz, so if the
104build fails due to missing symbols such as deflateInit(), then try again with
105"ADDLIB=-lz".
Willy Tarreaud4508812012-09-10 09:07:41 +0200106
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200107To link OpenSSL statically against haproxy, build OpenSSL with the no-shared
108keyword and install it to a local directory, so your system is not affected :
109
110 $ export STATICLIBSSL=/tmp/staticlibssl
111 $ ./config --prefix=$STATICLIBSSL no-shared
112 $ make && make install_sw
113
Lukas Tribus130ddf72013-10-01 00:28:03 +0200114When building haproxy, pass that path via SSL_INC and SSL_LIB to make and
115include additional libs with ADDLIB if needed (in this case for example libdl):
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200116
Lukas Tribus130ddf72013-10-01 00:28:03 +0200117 $ make TARGET=linux26 USE_OPENSSL=1 SSL_INC=$STATICLIBSSL/include SSL_LIB=$STATICLIBSSL/lib ADDLIB=-ldl
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200118
William Lallemand82fe75c2012-10-23 10:25:10 +0200119It is also possible to include native support for ZLIB to benefit from HTTP
120compression. For this, pass "USE_ZLIB=1" on the "make" command line and ensure
Willy Tarreau418b8c02015-03-29 03:32:06 +0200121that zlib is present on the system. Alternatively it is possible to use libslz
122for a faster, memory less, but slightly less efficient compression, by passing
123"USE_SLZ=1".
William Lallemand82fe75c2012-10-23 10:25:10 +0200124
willy tarreau78345332005-12-18 01:33:16 +0100125By default, the DEBUG variable is set to '-g' to enable debug symbols. It is
126not wise to disable it on uncommon systems, because it's often the only way to
127get a complete core when you need one. Otherwise, you can set DEBUG to '-s' to
128strip the binary.
129
130For example, I use this to build for Solaris 8 :
131
Willy Tarreau83b30c12008-05-25 10:32:50 +0200132 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1
willy tarreau78345332005-12-18 01:33:16 +0100133
Willy Tarreau83b30c12008-05-25 10:32:50 +0200134And I build it this way on OpenBSD or FreeBSD :
willy tarreaud38e72d2006-03-19 20:56:52 +0100135
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200136 $ gmake TARGET=freebsd USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
willy tarreaud38e72d2006-03-19 20:56:52 +0100137
Willy Tarreau663148c2012-12-12 00:38:22 +0100138And on a classic Linux with SSL and ZLIB support (eg: Red Hat 5.x) :
139
Willy Tarreau817dad52014-07-10 20:24:25 +0200140 $ make TARGET=linux26 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreau663148c2012-12-12 00:38:22 +0100141
142And on a recent Linux >= 2.6.28 with SSL and ZLIB support :
Willy Tarreaud4508812012-09-10 09:07:41 +0200143
Willy Tarreau817dad52014-07-10 20:24:25 +0200144 $ make TARGET=linux2628 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreaud4508812012-09-10 09:07:41 +0200145
William Lallemand82fe75c2012-10-23 10:25:10 +0200146In order to build a 32-bit binary on an x86_64 Linux system with SSL support
147without support for compression but when OpenSSL requires ZLIB anyway :
Willy Tarreauef7341d2009-04-11 19:45:50 +0200148
Willy Tarreaud4508812012-09-10 09:07:41 +0200149 $ make TARGET=linux26 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
Willy Tarreauef7341d2009-04-11 19:45:50 +0200150
Willy Tarreaub1efede2014-05-09 00:44:48 +0200151The SSL stack supports session cache synchronization between all running
152processes. This involves some atomic operations and synchronization operations
153which come in multiple flavors depending on the system and architecture :
154
155 Atomic operations :
156 - internal assembler versions for x86/x86_64 architectures
157
158 - gcc builtins for other architectures. Some architectures might not
159 be fully supported or might require a more recent version of gcc.
160 If your architecture is not supported, you willy have to either use
161 pthread if supported, or to disable the shared cache.
162
163 - pthread (posix threads). Pthreads are very common but inter-process
164 support is not that common, and some older operating systems did not
165 report an error when enabling multi-process mode, so they used to
166 silently fail, possibly causing crashes. Linux's implementation is
167 fine. OpenBSD doesn't support them and doesn't build. FreeBSD 9 builds
168 and reports an error at runtime, while certain older versions might
169 silently fail. Pthreads are enabled using USE_PTHREAD_PSHARED=1.
170
171 Synchronization operations :
172 - internal spinlock : this mode is OS-independant, light but will not
173 scale well to many processes. However, accesses to the session cache
174 are rare enough that this mode could certainly always be used. This
175 is the default mode.
176
177 - Futexes, which are Linux-specific highly scalable light weight mutexes
178 implemented in user-space with some limited assistance from the kernel.
179 This is the default on Linux 2.6 and above and is enabled by passing
180 USE_FUTEX=1
181
182 - pthread (posix threads). See above.
183
184If none of these mechanisms is supported by your platform, you may need to
185build with USE_PRIVATE_CACHE=1 to totally disable SSL cache sharing. Then
186it is better not to run SSL on multiple processes.
187
willy tarreau78345332005-12-18 01:33:16 +0100188If you need to pass other defines, includes, libraries, etc... then please
189check the Makefile to see which ones will be available in your case, and
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200190use the USE_* variables in the Makefile.
willy tarreau78345332005-12-18 01:33:16 +0100191
Willy Tarreau97ec9692010-01-28 20:52:05 +0100192AIX 5.3 is known to work with the generic target. However, for the binary to
193also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
Willy Tarreau869f3512014-06-19 15:26:32 +0200194otherwise __fd_select() will be used while not being present in the libc, but
195this is easily addressed using the "aix52" target. If you get build errors
196because of strange symbols or section mismatches, simply remove -g from
197DEBUG_CFLAGS.
Willy Tarreau97ec9692010-01-28 20:52:05 +0100198
Willy Tarreau32e65ef2013-04-02 08:14:29 +0200199You can easily define your own target with the GNU Makefile. Unknown targets
200are processed with no default option except USE_POLL=default. So you can very
201well use that property to define your own set of options. USE_POLL can even be
202disabled by setting USE_POLL="". For example :
203
204 $ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
205
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200206
David Carlierb5efa012015-06-01 14:21:47 +02002071.1) DeviceAtlas Device Detection
208---------------------------------
209
210In order to add DeviceAtlas Device Detection support, you would need to download
211the API source code from https://deviceatlas.com/deviceatlas-haproxy-module and
212once extracted :
213
Willy Tarreau82bd42e2015-06-02 14:10:28 +0200214 $ make TARGET=<target> USE_PCRE=1 USE_DEVICEATLAS=1 DEVICEATLAS_SRC=<path to the API root folder>
215
216Optionally DEVICEATLAS_INC and DEVICEATLAS_LIB may be set to override the path
217to the include files and libraries respectively if they're not in the source
218directory.
David Carlierb5efa012015-06-01 14:21:47 +0200219
220These are supported DeviceAtlas directives (see doc/configuration.txt) :
221 - deviceatlas-json-file <path to the DeviceAtlas JSON data file>.
222 - deviceatlas-log-level <number> (0 to 3, level of information returned by
223 the API, 0 by default).
224 - deviceatlas-property-separator <character> (character used to separate the
225 properties produced by the API, | by default).
226
227Sample configuration :
228
229 global
230 deviceatlas-json-file <path to json file>
231
232 ...
233 frontend
234 bind *:8881
235 default_backend servers
David Carlier00d7d612015-09-25 14:06:08 +0100236
237There are two distinct methods available, one which leverages all HTTP headers
238and one which uses only a single HTTP header for the detection. The former
239method is highly recommended and more accurate.
240
241
242All HTTP headers
243
244
245 http-request set-header X-DeviceAtlas-Data %[da-csv-fetch(primaryHardwareType,osName,osVersion,browserName,browserVersion)]
246
247
248Single HTTP header (e.g. User-Agent)
249
250
251 http-request set-header X-DeviceAtlas-Data %[req.fhdr(User-Agent),da-csv-conv(primaryHardwareType,osName,osVersion,browserName,browserVersion)]
252
David Carlierb5efa012015-06-01 14:21:47 +0200253
David Carlier00d7d612015-09-25 14:06:08 +0100254Please find more information about DeviceAtlas and the detection methods at https://deviceatlas.com/resources .
David Carlierb5efa012015-06-01 14:21:47 +0200255
Thomas Holmesf95aaf62015-05-29 15:21:42 +01002561.2) 51Degrees Device Detection
257-------------------------------
258
259You can also include 51Degrees for inbuilt device detection enabling attributes
260such as screen size (physical & pixels), supported input methods, release date,
261hardware vendor and model, browser information, and device price among many
262others. Such information can be used to improve the user experience of a web
263site by tailoring the page content, layout and business processes to the
264precise characteristics of the device. Such customisations improve profit by
265making it easier for customers to get to the information or services they
James Rosewella0c4c692015-09-18 17:21:37 +0100266need. Attributes of the device making a web request can be added to HTTP
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100267headers as configurable parameters.
268
James Rosewella0c4c692015-09-18 17:21:37 +0100269In order to enable 51Degrees download the 51Degrees source code from the
270official github repository :
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100271
James Rosewella0c4c692015-09-18 17:21:37 +0100272 git clone https://github.com/51Degrees/Device-Detection
Willy Tarreauc7203c72015-06-01 11:12:35 +0200273
274then run 'make' with USE_51DEGREES and 51DEGREES_SRC set. Both 51DEGREES_INC
275and 51DEGREES_LIB may additionally be used to force specific different paths
276for .o and .h, but will default to 51DEGREES_SRC. Make sure to replace
277'51D_REPO_PATH' with the path to the 51Degrees repository.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100278
James Rosewella0c4c692015-09-18 17:21:37 +010027951Degrees provide 2 different detection algorithms:
280
Willy Tarreauc7203c72015-06-01 11:12:35 +0200281 1. Pattern - balances main memory usage and CPU.
282 2. Trie - a very high performance detection solution which uses more main
283 memory than Pattern.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100284
285To make with 51Degrees Pattern algorithm use the following command line.
286
Willy Tarreauc7203c72015-06-01 11:12:35 +0200287 $ make TARGET=linux26 USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/pattern
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100288
289To use the 51Degrees Trie algorithm use the following command line.
290
Willy Tarreauc7203c72015-06-01 11:12:35 +0200291 $ make TARGET=linux26 USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/trie
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100292
293A data file containing information about devices, browsers, operating systems
294and their associated signatures is then needed. 51Degrees provide a free
295database with Github repo for this purpose. These free data files are located
296in '51D_REPO_PATH'/data with the extensions .dat for Pattern data and .trie for
297Trie data.
298
299The configuration file needs to set the following parameters:
300
James Rosewella0c4c692015-09-18 17:21:37 +0100301 51degrees-data-file path to the Pattern or Trie data file
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100302 51degrees-property-name-list list of 51Degrees properties to detect
Dragan Dosen93b38d92015-06-29 16:43:25 +0200303 51degrees-property-separator separator to use between values
Dragan Dosenae6d39a2015-06-29 16:43:27 +0200304 51degrees-cache-size LRU-based cache size (disabled by default)
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100305
306The following is an example of the settings for Pattern.
307
James Rosewella0c4c692015-09-18 17:21:37 +0100308 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.dat
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100309 51degrees-property-name-list IsTablet DeviceType IsMobile
Dragan Dosen93b38d92015-06-29 16:43:25 +0200310 51degrees-property-separator ,
Dragan Dosenae6d39a2015-06-29 16:43:27 +0200311 51degrees-cache-size 10000
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100312
313HAProxy needs a way to pass device information to the backend servers. This is
James Rosewella0c4c692015-09-18 17:21:37 +0100314done by using the 51d converter or fetch method, which intercepts the HTTP
315headers and creates some new headers. This is controlled in the frontend
316http-in section.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100317
318The following is an example which adds two new HTTP headers prefixed X-51D-
319
320 frontend http-in
321 bind *:8081
322 default_backend servers
James Rosewella0c4c692015-09-18 17:21:37 +0100323 http-request set-header X-51D-DeviceTypeMobileTablet %[51d.all(DeviceType,IsMobile,IsTablet)]
324 http-request set-header X-51D-Tablet %[51d.all(IsTablet)]
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100325
326Here, two headers are created with 51Degrees data, X-51D-DeviceTypeMobileTablet
327and X-51D-Tablet. Any number of headers can be created this way and can be
James Rosewella0c4c692015-09-18 17:21:37 +0100328named anything. 51d.all( ) invokes the 51degrees fetch. It can be passed up to
329five property names of values to return. Values will be returned in the same
330order, seperated by the 51-degrees-property-separator configured earlier. If a
331property name can't be found the value 'NoData' is returned instead.
332
333In addition to the device properties three additional properties related to the
334validity of the result can be returned when used with the Pattern method. The
335following example shows how Method, Difference and Rank could be included as one
336new HTTP header X-51D-Stats.
337
338 http-request set-header X-51D-Stats %[51d.all(Method,Difference,Rank)]
339
340These values indicate how confident 51Degrees is in the result that that was
341returned. More information is available on the 51Degrees web site at:
342
343 https://51degrees.com/support/documentation/pattern
344
345The above 51d.all fetch method uses all available HTTP headers for detection. A
346modest performance improvement can be obtained by only passing one HTTP header
347to the detection method with the 51d.single converter. The following example
348uses the User-Agent HTTP header only for detection.
349
350 http-request set-header X-51D-DeviceTypeMobileTablet %[req.fhdr(User-Agent),51d.single(DeviceType,IsMobile,IsTablet)]
351
352Any HTTP header could be used inplace of User-Agent by changing the parameter
353provided to req.fhdr.
354
355When compiled to use the Trie detection method the trie format data file needs
356to be provided. Changing the extension of the data file from dat to trie will
357use the correct data.
358
359 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.trie
360
361When used with Trie the Method, Difference and Rank properties are not
362available.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100363
364The free Lite data file contains information about screen size in pixels and
365whether the device is a mobile. A full list of available properties is located
366on the 51Degrees web site at:
367
James Rosewella0c4c692015-09-18 17:21:37 +0100368 https://51degrees.com/resources/property-dictionary
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100369
370Some properties are only available in the paid for Premium and Enterprise
James Rosewella0c4c692015-09-18 17:21:37 +0100371versions of 51Degrees. These data sets not only contain more properties but
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100372are updated weekly and daily and contain signatures for 100,000s of different
373device combinations. For more information see the data options comparison web
374page:
375
376 https://51degrees.com/compare-data-options
377
378
Willy Tarreaub1a34b62010-05-09 22:37:12 +02003792) How to install it
380--------------------
381
382To install haproxy, you can either copy the single resulting binary to the
383place you want, or run :
384
385 $ sudo make install
386
387If you're packaging it for another system, you can specify its root directory
388in the usual DESTDIR variable.
389
390
3913) How to set it up
392-------------------
393
394There is some documentation in the doc/ directory :
395
Willy Tarreaud8e42b62015-08-18 21:51:36 +0200396 - intro.txt : this is an introduction to haproxy, it explains what it is
397 what it is not. Useful for beginners or to re-discover it when planning
398 for an upgrade.
399
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200400 - architecture.txt : this is the architecture manual. It is quite old and
401 does not tell about the nice new features, but it's still a good starting
402 point when you know what you want but don't know how to do it.
403
404 - configuration.txt : this is the configuration manual. It recalls a few
405 essential HTTP basic concepts, and details all the configuration file
406 syntax (keywords, units). It also describes the log and stats format. It
407 is normally always up to date. If you see that something is missing from
Willy Tarreau74774c02014-04-23 00:57:08 +0200408 it, please report it as this is a bug. Please note that this file is
409 huge and that it's generally more convenient to review Cyril Bonté's
410 HTML translation online here :
411
412 http://cbonte.github.io/haproxy-dconv/configuration-1.5.html
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200413
414 - haproxy-en.txt / haproxy-fr.txt : these are the old outdated docs. You
415 should never need them. If you do, then please report what you didn't
416 find in the other ones.
417
418 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
419 the 'LICENSE' file at the top for more information.
420
421 - the rest is mainly for developers.
422
423There are also a number of nice configuration examples in the "examples"
424directory as well as on several sites and articles on the net which are linked
425to from the haproxy web site.
426
427
4284) How to report a bug
429----------------------
430
431It is possible that from time to time you'll find a bug. A bug is a case where
432what you see is not what is documented. Otherwise it can be a misdesign. If you
433find that something is stupidly design, please discuss it on the list (see the
434"how to contribute" section below). If you feel like you're proceeding right
435and haproxy doesn't obey, then first ask yourself if it is possible that nobody
436before you has even encountered this issue. If it's unlikely, the you probably
437have an issue in your setup. Just in case of doubt, please consult the mailing
438list archives :
439
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200440 http://marc.info/?l=haproxy
441
442Otherwise, please try to gather the maximum amount of information to help
443reproduce the issue and send that to the mailing list :
444
445 haproxy@formilux.org
446
447Please include your configuration and logs. You can mask your IP addresses and
448passwords, we don't need them. But it's essential that you post your config if
449you want people to guess what is happening.
450
451Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
452without any reason, then it definitely is a critical bug that must be reported
453and urgently fixed. It has happened a couple of times in the past, essentially
454on development versions running on new architectures. If you think your setup
455is fairly common, then it is possible that the issue is totally unrelated.
456Anyway, if that happens, feel free to contact me directly, as I will give you
457instructions on how to collect a usable core file, and will probably ask for
458other captures that you'll not want to share with the list.
459
460
4615) How to contribute
462--------------------
463
Willy Tarreau11e334d92015-09-20 22:31:42 +0200464Please carefully read the CONTRIBUTING file that comes with the sources. It is
465mandatory.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200466
willy tarreau78345332005-12-18 01:33:16 +0100467-- end