blob: 562503c396a432faa8a0fb1e9d4aa1aa80289c7c [file] [log] [blame]
Willy Tarreaub1a34b62010-05-09 22:37:12 +02001 ----------------------
2 HAProxy how-to
3 ----------------------
Willy Tarreau0e658fb2016-11-25 16:55:50 +01004 version 1.8
Willy Tarreaub1a34b62010-05-09 22:37:12 +02005 willy tarreau
Willy Tarreaue59fcdd2016-11-25 16:39:17 +01006 2016/11/25
willy tarreau78345332005-12-18 01:33:16 +01007
8
Willy Tarreaub1a34b62010-05-09 22:37:12 +020091) How to build it
10------------------
11
Willy Tarreau991b4782015-10-13 21:48:10 +020012This is a development version, so it is expected to break from time to time,
13to add and remove features without prior notification and it should not be used
14in production. If you are not used to build from sources or if you are not used
15to follow updates then it is recommended that instead you use the packages provided
16by your software vendor or Linux distribution. Most of them are taking this task
Willy Tarreau844028b2015-10-13 18:52:22 +020017seriously and are doing a good job at backporting important fixes. If for any
18reason you'd prefer a different version than the one packaged for your system,
19you want to be certain to have all the fixes or to get some commercial support,
20other choices are available at :
Willy Tarreau869f3512014-06-19 15:26:32 +020021
22 http://www.haproxy.com/
23
willy tarreau78345332005-12-18 01:33:16 +010024To build haproxy, you will need :
Willy Tarreaub1a34b62010-05-09 22:37:12 +020025 - GNU make. Neither Solaris nor OpenBSD's make work with the GNU Makefile.
Willy Tarreau3543cdb2014-05-10 09:12:46 +020026 If you get many syntax errors when running "make", you may want to retry
27 with "gmake" which is the name commonly used for GNU make on BSD systems.
Willy Tarreau869f3512014-06-19 15:26:32 +020028 - GCC between 2.95 and 4.8. Others may work, but not tested.
willy tarreau78345332005-12-18 01:33:16 +010029 - GNU ld
30
31Also, you might want to build with libpcre support, which will provide a very
Willy Tarreaub1a34b62010-05-09 22:37:12 +020032efficient regex implementation and will also fix some badness on Solaris' one.
willy tarreau78345332005-12-18 01:33:16 +010033
34To build haproxy, you have to choose your target OS amongst the following ones
35and assign it to the TARGET variable :
36
Willy Tarreau83b30c12008-05-25 10:32:50 +020037 - linux22 for Linux 2.2
38 - linux24 for Linux 2.4 and above (default)
39 - linux24e for Linux 2.4 with support for a working epoll (> 0.21)
Willy Tarreau83b30c12008-05-25 10:32:50 +020040 - linux26 for Linux 2.6 and above
Willy Tarreau869f3512014-06-19 15:26:32 +020041 - linux2628 for Linux 2.6.28, 3.x, and above (enables splice and tproxy)
Willy Tarreau83b30c12008-05-25 10:32:50 +020042 - solaris for Solaris 8 or 10 (others untested)
Willy Tarreau869f3512014-06-19 15:26:32 +020043 - freebsd for FreeBSD 5 to 10 (others untested)
Willy Tarreau844028b2015-10-13 18:52:22 +020044 - netbsd for NetBSD
Willy Tarreau8624cab2013-04-02 08:17:43 +020045 - osx for Mac OS/X
Daniel Jakots9705ba22016-09-27 19:22:21 +020046 - openbsd for OpenBSD 5.7 and above
Willy Tarreau50abe302014-04-02 20:44:43 +020047 - aix51 for AIX 5.1
Willy Tarreau7dec9652012-06-06 16:15:03 +020048 - aix52 for AIX 5.2
Yitzhak Sapir32087312009-06-14 18:27:54 +020049 - cygwin for Cygwin
Jerome Duval38932c32015-10-19 23:01:16 +000050 - haiku for Haiku
Willy Tarreau869f3512014-06-19 15:26:32 +020051 - generic for any other OS or version.
Willy Tarreau83b30c12008-05-25 10:32:50 +020052 - custom to manually adjust every setting
willy tarreau78345332005-12-18 01:33:16 +010053
54You may also choose your CPU to benefit from some optimizations. This is
55particularly important on UltraSparc machines. For this, you can assign
56one of the following choices to the CPU variable :
57
58 - i686 for intel PentiumPro, Pentium 2 and above, AMD Athlon
59 - i586 for intel Pentium, AMD K6, VIA C3.
60 - ultrasparc : Sun UltraSparc I/II/III/IV processor
Willy Tarreau817dad52014-07-10 20:24:25 +020061 - native : use the build machine's specific processor optimizations. Use with
62 extreme care, and never in virtualized environments (known to break).
63 - generic : any other processor or no CPU-specific optimization. (default)
willy tarreau78345332005-12-18 01:33:16 +010064
Willy Tarreau83b30c12008-05-25 10:32:50 +020065Alternatively, you may just set the CPU_CFLAGS value to the optimal GCC options
66for your platform.
67
Willy Tarreauef7341d2009-04-11 19:45:50 +020068You may want to build specific target binaries which do not match your native
69compiler's target. This is particularly true on 64-bit systems when you want
70to build a 32-bit binary. Use the ARCH variable for this purpose. Right now
Willy Tarreaua5899aa2010-11-28 07:41:00 +010071it only knows about a few x86 variants (i386,i486,i586,i686,x86_64), two
72generic ones (32,64) and sets -m32/-m64 as well as -march=<arch> accordingly.
Willy Tarreauef7341d2009-04-11 19:45:50 +020073
willy tarreau78345332005-12-18 01:33:16 +010074If your system supports PCRE (Perl Compatible Regular Expressions), then you
75really should build with libpcre which is between 2 and 10 times faster than
76other libc implementations. Regex are used for header processing (deletion,
77rewriting, allow, deny). The only inconvenient of libpcre is that it is not
78yet widely spread, so if you build for other systems, you might get into
79trouble if they don't have the dynamic library. In this situation, you should
80statically link libpcre into haproxy so that it will not be necessary to
Willy Tarreau83b30c12008-05-25 10:32:50 +020081install it on target systems. Available build options for PCRE are :
willy tarreau78345332005-12-18 01:33:16 +010082
Willy Tarreau83b30c12008-05-25 10:32:50 +020083 - USE_PCRE=1 to use libpcre, in whatever form is available on your system
willy tarreau78345332005-12-18 01:33:16 +010084 (shared or static)
85
Willy Tarreau83b30c12008-05-25 10:32:50 +020086 - USE_STATIC_PCRE=1 to use a static version of libpcre even if the dynamic
87 one is available. This will enhance portability.
88
Willy Tarreau663148c2012-12-12 00:38:22 +010089 - with no option, use your OS libc's standard regex implementation (default).
Willy Tarreau83b30c12008-05-25 10:32:50 +020090 Warning! group references on Solaris seem broken. Use static-pcre whenever
91 possible.
willy tarreau78345332005-12-18 01:33:16 +010092
Willy Tarreaua8fc8a22015-09-28 22:36:21 +020093If your system doesn't provide PCRE, you are encouraged to download it from
94http://www.pcre.org/ and build it yourself, it's fast and easy.
95
Willy Tarreau64bc40b2011-03-23 20:00:53 +010096Recent systems can resolve IPv6 host names using getaddrinfo(). This primitive
97is not present in all libcs and does not work in all of them either. Support in
98glibc was broken before 2.3. Some embedded libs may not properly work either,
99thus, support is disabled by default, meaning that some host names which only
100resolve as IPv6 addresses will not resolve and configs might emit an error
101during parsing. If you know that your OS libc has reliable support for
102getaddrinfo(), you can add USE_GETADDRINFO=1 on the make command line to enable
103it. This is the recommended option for most Linux distro packagers since it's
104working fine on all recent mainstream distros. It is automatically enabled on
105Solaris 8 and above, as it's known to work.
106
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200107It is possible to add native support for SSL using the GNU makefile, by passing
108"USE_OPENSSL=1" on the make command line. The libssl and libcrypto will
109automatically be linked with haproxy. Some systems also require libz, so if the
110build fails due to missing symbols such as deflateInit(), then try again with
111"ADDLIB=-lz".
Willy Tarreaud4508812012-09-10 09:07:41 +0200112
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200113Your are strongly encouraged to always use an up-to-date version of OpenSSL, as
114found on https://www.openssl.org/ as vulnerabilities are occasionally found and
115you don't want them on your systems. HAProxy is known to build correctly on all
116currently supported branches (0.9.8, 1.0.0, 1.0.1 and 1.0.2 at the time of
117writing). Branch 1.0.2 is recommended for the richest features.
118
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200119To link OpenSSL statically against haproxy, build OpenSSL with the no-shared
120keyword and install it to a local directory, so your system is not affected :
121
122 $ export STATICLIBSSL=/tmp/staticlibssl
123 $ ./config --prefix=$STATICLIBSSL no-shared
124 $ make && make install_sw
125
Lukas Tribus130ddf72013-10-01 00:28:03 +0200126When building haproxy, pass that path via SSL_INC and SSL_LIB to make and
127include additional libs with ADDLIB if needed (in this case for example libdl):
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200128
Lukas Tribus130ddf72013-10-01 00:28:03 +0200129 $ make TARGET=linux26 USE_OPENSSL=1 SSL_INC=$STATICLIBSSL/include SSL_LIB=$STATICLIBSSL/lib ADDLIB=-ldl
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200130
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200131It is also possible to include native support for zlib to benefit from HTTP
William Lallemand82fe75c2012-10-23 10:25:10 +0200132compression. For this, pass "USE_ZLIB=1" on the "make" command line and ensure
Willy Tarreau418b8c02015-03-29 03:32:06 +0200133that zlib is present on the system. Alternatively it is possible to use libslz
134for a faster, memory less, but slightly less efficient compression, by passing
135"USE_SLZ=1".
William Lallemand82fe75c2012-10-23 10:25:10 +0200136
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200137Zlib is commonly found on most systems, otherwise updates can be retrieved from
138http://www.zlib.net/. It is easy and fast to build. Libslz can be downloaded
139from http://1wt.eu/projects/libslz/ and is even easier to build.
140
willy tarreau78345332005-12-18 01:33:16 +0100141By default, the DEBUG variable is set to '-g' to enable debug symbols. It is
142not wise to disable it on uncommon systems, because it's often the only way to
143get a complete core when you need one. Otherwise, you can set DEBUG to '-s' to
144strip the binary.
145
146For example, I use this to build for Solaris 8 :
147
Willy Tarreau83b30c12008-05-25 10:32:50 +0200148 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1
willy tarreau78345332005-12-18 01:33:16 +0100149
Willy Tarreau83b30c12008-05-25 10:32:50 +0200150And I build it this way on OpenBSD or FreeBSD :
willy tarreaud38e72d2006-03-19 20:56:52 +0100151
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200152 $ gmake TARGET=freebsd USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
willy tarreaud38e72d2006-03-19 20:56:52 +0100153
Willy Tarreau663148c2012-12-12 00:38:22 +0100154And on a classic Linux with SSL and ZLIB support (eg: Red Hat 5.x) :
155
Willy Tarreau817dad52014-07-10 20:24:25 +0200156 $ make TARGET=linux26 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreau663148c2012-12-12 00:38:22 +0100157
158And on a recent Linux >= 2.6.28 with SSL and ZLIB support :
Willy Tarreaud4508812012-09-10 09:07:41 +0200159
Willy Tarreau817dad52014-07-10 20:24:25 +0200160 $ make TARGET=linux2628 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreaud4508812012-09-10 09:07:41 +0200161
William Lallemand82fe75c2012-10-23 10:25:10 +0200162In order to build a 32-bit binary on an x86_64 Linux system with SSL support
163without support for compression but when OpenSSL requires ZLIB anyway :
Willy Tarreauef7341d2009-04-11 19:45:50 +0200164
Willy Tarreaud4508812012-09-10 09:07:41 +0200165 $ make TARGET=linux26 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
Willy Tarreauef7341d2009-04-11 19:45:50 +0200166
Willy Tarreaub1efede2014-05-09 00:44:48 +0200167The SSL stack supports session cache synchronization between all running
168processes. This involves some atomic operations and synchronization operations
169which come in multiple flavors depending on the system and architecture :
170
171 Atomic operations :
172 - internal assembler versions for x86/x86_64 architectures
173
174 - gcc builtins for other architectures. Some architectures might not
175 be fully supported or might require a more recent version of gcc.
176 If your architecture is not supported, you willy have to either use
177 pthread if supported, or to disable the shared cache.
178
179 - pthread (posix threads). Pthreads are very common but inter-process
180 support is not that common, and some older operating systems did not
181 report an error when enabling multi-process mode, so they used to
182 silently fail, possibly causing crashes. Linux's implementation is
183 fine. OpenBSD doesn't support them and doesn't build. FreeBSD 9 builds
184 and reports an error at runtime, while certain older versions might
185 silently fail. Pthreads are enabled using USE_PTHREAD_PSHARED=1.
186
187 Synchronization operations :
188 - internal spinlock : this mode is OS-independant, light but will not
189 scale well to many processes. However, accesses to the session cache
190 are rare enough that this mode could certainly always be used. This
191 is the default mode.
192
193 - Futexes, which are Linux-specific highly scalable light weight mutexes
194 implemented in user-space with some limited assistance from the kernel.
195 This is the default on Linux 2.6 and above and is enabled by passing
196 USE_FUTEX=1
197
198 - pthread (posix threads). See above.
199
200If none of these mechanisms is supported by your platform, you may need to
201build with USE_PRIVATE_CACHE=1 to totally disable SSL cache sharing. Then
202it is better not to run SSL on multiple processes.
203
willy tarreau78345332005-12-18 01:33:16 +0100204If you need to pass other defines, includes, libraries, etc... then please
205check the Makefile to see which ones will be available in your case, and
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200206use the USE_* variables in the Makefile.
willy tarreau78345332005-12-18 01:33:16 +0100207
Willy Tarreau97ec9692010-01-28 20:52:05 +0100208AIX 5.3 is known to work with the generic target. However, for the binary to
209also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
Willy Tarreau869f3512014-06-19 15:26:32 +0200210otherwise __fd_select() will be used while not being present in the libc, but
211this is easily addressed using the "aix52" target. If you get build errors
212because of strange symbols or section mismatches, simply remove -g from
213DEBUG_CFLAGS.
Willy Tarreau97ec9692010-01-28 20:52:05 +0100214
Willy Tarreau32e65ef2013-04-02 08:14:29 +0200215You can easily define your own target with the GNU Makefile. Unknown targets
216are processed with no default option except USE_POLL=default. So you can very
217well use that property to define your own set of options. USE_POLL can even be
218disabled by setting USE_POLL="". For example :
219
220 $ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
221
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200222
Willy Tarreau29b25312016-11-08 14:57:29 +01002231.1) Device Detection
224---------------------
David Carlierb5efa012015-06-01 14:21:47 +0200225
Willy Tarreau29b25312016-11-08 14:57:29 +0100226HAProxy supports several device detection modules relying on third party
227products. Some of them may provide free code, others free libs, others free
228evaluation licenses. Please read about their respective details in the
229following files :
David Carlierb5efa012015-06-01 14:21:47 +0200230
Willy Tarreau29b25312016-11-08 14:57:29 +0100231 doc/DeviceAtlas-device-detection.txt for DeviceAtlas
232 doc/51Degrees-device-detection.txt for 51Degrees
233 doc/WURFL-device-detection.txt for Scientiamobile WURFL
scientiamobiled0027ed2016-11-04 10:55:08 +0100234
scientiamobiled0027ed2016-11-04 10:55:08 +0100235
Willy Tarreaub1a34b62010-05-09 22:37:12 +02002362) How to install it
237--------------------
238
239To install haproxy, you can either copy the single resulting binary to the
240place you want, or run :
241
242 $ sudo make install
243
244If you're packaging it for another system, you can specify its root directory
245in the usual DESTDIR variable.
246
247
2483) How to set it up
249-------------------
250
251There is some documentation in the doc/ directory :
252
Willy Tarreaud8e42b62015-08-18 21:51:36 +0200253 - intro.txt : this is an introduction to haproxy, it explains what it is
254 what it is not. Useful for beginners or to re-discover it when planning
255 for an upgrade.
256
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200257 - architecture.txt : this is the architecture manual. It is quite old and
258 does not tell about the nice new features, but it's still a good starting
259 point when you know what you want but don't know how to do it.
260
261 - configuration.txt : this is the configuration manual. It recalls a few
262 essential HTTP basic concepts, and details all the configuration file
263 syntax (keywords, units). It also describes the log and stats format. It
264 is normally always up to date. If you see that something is missing from
Willy Tarreau74774c02014-04-23 00:57:08 +0200265 it, please report it as this is a bug. Please note that this file is
266 huge and that it's generally more convenient to review Cyril Bonté's
267 HTML translation online here :
268
Willy Tarreau844028b2015-10-13 18:52:22 +0200269 http://cbonte.github.io/haproxy-dconv/configuration-1.6.html
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200270
Willy Tarreau373933d2015-10-13 16:32:20 +0200271 - management.txt : it explains how to start haproxy, how to manage it at
272 runtime, how to manage it on multiple nodes, how to proceed with seamless
273 upgrades.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200274
275 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
276 the 'LICENSE' file at the top for more information.
277
278 - the rest is mainly for developers.
279
280There are also a number of nice configuration examples in the "examples"
281directory as well as on several sites and articles on the net which are linked
282to from the haproxy web site.
283
284
2854) How to report a bug
286----------------------
287
288It is possible that from time to time you'll find a bug. A bug is a case where
289what you see is not what is documented. Otherwise it can be a misdesign. If you
290find that something is stupidly design, please discuss it on the list (see the
291"how to contribute" section below). If you feel like you're proceeding right
292and haproxy doesn't obey, then first ask yourself if it is possible that nobody
293before you has even encountered this issue. If it's unlikely, the you probably
294have an issue in your setup. Just in case of doubt, please consult the mailing
295list archives :
296
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200297 http://marc.info/?l=haproxy
298
299Otherwise, please try to gather the maximum amount of information to help
300reproduce the issue and send that to the mailing list :
301
302 haproxy@formilux.org
303
304Please include your configuration and logs. You can mask your IP addresses and
305passwords, we don't need them. But it's essential that you post your config if
306you want people to guess what is happening.
307
308Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
309without any reason, then it definitely is a critical bug that must be reported
310and urgently fixed. It has happened a couple of times in the past, essentially
311on development versions running on new architectures. If you think your setup
312is fairly common, then it is possible that the issue is totally unrelated.
313Anyway, if that happens, feel free to contact me directly, as I will give you
314instructions on how to collect a usable core file, and will probably ask for
315other captures that you'll not want to share with the list.
316
317
3185) How to contribute
319--------------------
320
Willy Tarreau11e334d92015-09-20 22:31:42 +0200321Please carefully read the CONTRIBUTING file that comes with the sources. It is
322mandatory.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200323
willy tarreau78345332005-12-18 01:33:16 +0100324-- end