blob: 8086d154855c41f7554cb2131d4c1e6df5e60bc6 [file] [log] [blame]
Willy Tarreau7f332732018-12-16 22:27:15 +01001Installation instructions for HAProxy
2=====================================
3
4This is a development version, so it is expected to break from time to time,
5to add and remove features without prior notification and it should not be used
6in production. If you are not used to build from sources or if you are not used
7to follow updates then it is recommended that instead you use the packages
8provided by your software vendor or Linux distribution. Most of them are taking
9this task seriously and are doing a good job at backporting important fixes. If
10for any reason you'd prefer to use a different version than the one packaged
11for your system, you want to be certain to have all the fixes or to get some
12commercial support, other choices are available at http://www.haproxy.com/.
13
14
15Areas covered in this document
16==============================
17
181) Quick build & install
192) Basic principles
203) Build environment
214) Dependencies
225) Advanced build options
236) How to install HAProxy
24
25
261) Quick build & install
27========================
28
29If you've already built HAProxy and are just looking for a quick reminder, here
30are a few build examples :
31
32 - recent Linux system with all options, make and install :
33 $ make clean
34 $ make -j 4 TARGET=linux2628 USE_NS=1 USE_TFO=1 \
35 USE_OPENSSL=1 USE_ZLIB=1 USE_LUA=1 USE_PCRE=1 USE_SYSTEMD=1
36 $ sudo make install
37
38 - FreeBSD and OpenBSD, build with all options :
39 $ gmake -j 4 TARGET=freebsd USE_OPENSSL=1 USE_ZLIB=1 USE_LUA=1 USE_PCRE=1
40
41 - embedded Linux, build using a cross-compiler :
42 $ make -j 4 TARGET=linux2628 USE_NS=1 USE_OPENSSL=1 USE_SLZ=1 USE_PCRE=1 \
43 CC=/opt/cross/gcc730-arm/bin/gcc
44
45 - Build with static PCRE on Solaris / UltraSPARC :
46 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1
47
48For more advanced build options or if a command above reports an error, please
49read the following sections.
50
51
522) Basic principles
53===================
54
55HAProxy uses a single GNU Makefile which supports options on the command line,
56so that there is no need to hack a "configure" file to work on your system. The
57makefile totally supports parallel build using "make -j <jobs>" where <jobs>
58matches the number of usable processors, which on some platforms is returned by
59the "nproc" utility. The explanations below may occasionally refer to some
60options, usually in the form "name=value", which have to be passed to the
61command line. This means that the option has to be passed after the "make"
62command. For example :
63
64 $ make -j $(nproc) TARGET=generic USE_GZIP=1
65
66One required option is TARGET, it must be set to a target platform name, which
67provides a number of presets. The list of known platforms is displayed when no
68target is specified. It is not strictly required to use the exact target, you
69can use a relatively similar one and adjust specific variables by hand.
70
71Most configuration variables are in fact booleans. Some options are detected and
72enabled by default if available on the target platform. This is the case for all
73those named "USE_<feature>". These booleans are enabled by "USE_<feature>=1"
74and are disabled by "USE_<feature>=" (with no value). The last occurrence on the
75command line overrides any previous one. Example :
76
77 $ make TARGET=generic USE_THREAD=
78
79In case of error or missing TARGET, a help screen is displayed. It is also
80possible to display a list of all known options using "make help".
81
82
833) Build environment
84====================
85
86HAProxy requires a working GCC or Clang toolchain and GNU make :
87
88 - GNU make >= 3.80. Note that neither Solaris nor OpenBSD's make work with
89 the GNU Makefile. If you get many syntax errors when running "make", you
90 may want to retry with "gmake" which is the name commonly used for GNU make
91 on BSD systems.
92
93 - GCC >= 3.4 (up to 8.1 tested). Older versions can be made to work with a
94 few minor adaptations if really needed. Newer versions may sometimes break
95 due to compiler regressions or behaviour changes. The version shipped with
96 your operating system is very likely to work with no trouble. Clang >= 3.0
97 is also known to work as an alternative solution. Recent versions may emit
98 a bit more warnings that are worth reporting.
99
100 - GNU ld (binutils package), with no particular version. Other linkers might
101 work but were not tested.
102
103On debian or Ubuntu systems and their derivatives, you may get all these tools
104at once by issuing the two following commands :
105
106 $ sudo apt-get update
107 $ sudo apt-get install build-essential
108
109On Fedora, CentOS, RHEL and derivatives, you may get the equivalent packages
110with the following command :
111
112 $ sudo yum groupinstall "Development Tools"
113
114Please refer to your operating system's documentation for other systems.
115
116It is also possible to build HAProxy for another system or platform using a
117cross-compiler but in this case you probably already have installed these
118tools.
119
120Building HAProxy may require between 10 and 40 MB of free space in the
121directory where the sources have been extracted, depending on the debugging
122options involved.
123
124
1254) Dependencies
126===============
127
128HAProxy in its basic form does not depend on anything beyond a working libc.
129However a number of options are enabled by default, or are highly recommended,
130and these options will typically involve some external components or libraries,
131depending on the targetted platform.
132
133Optional dependencies may be split into several categories :
134
135 - memory allocation
136 - regular expressions
137 - multi-threading
138 - password encryption
139 - cryptography
140 - compression
141 - lua
142 - device detection
143 - miscellaneous
144
145
1464.1) Memory allocation
147----------------------
148By default, HAProxy uses the standard malloc() call provided by the libc. It
149may be built to use dlmalloc instead. In this case, "USE_DLMALLOC=1" needs to
150be appended to the build options, and "DLMALLOC_SRC" needs to point to the
151absolute path to "dlmalloc.c". Doing this is not safe when using threads.
152HAProxy may also be built to use jemalloc, which is fast and thread-safe.
153In order to use it, please add "-ljemalloc" to the ADDLIB variable. You may
154possibly also need to append "-lpthread" and/or "-ldl" depending on the
155operating system.
156
157
1584.2) Regular expressions
159------------------------
160HAProxy may make use regular expressions (regex) to match certain patterns. The
161regex engine is provided by default in the libc. On some operating systems, it
162might happen that the original regex library provided by the libc is too slow,
163too limited or even bogus. For example, on older Solaris versions up to 8, the
164default regex used not to properly extract group references, without reporting
165compilation errors. Also, some early versions of the GNU libc used to include a
166regex engine which could be slow or even crash on certain patterns.
167
168If you plan on importing a particularly heavy configuration involving a lot of
169regex, you may benefit from using some alternative regex implementations sur as
170PCRE. HAProxy natively supports PCRE and PCRE2, both in standard and JIT
171flavors (Just In Time). The following options are available depending on the
172library version provided on your system :
173
174 - "USE_PCRE=1" : enable PCRE version 1, dynamic linking
175 - "USE_STATIC_PCRE=1" : enable PCRE version 1, static linking
176 - "USE_PCRE_JIT=1" : enable PCRE version 1 in JIT mode
177 - "USE_PCRE2=1" : enable PCRE version 2, dynamic linking
178 - "USE_STATIC_PCRE2=1" : enable PCRE version 2, static linking
179 - "USE_PCRE2_JIT=1" : enable PCRE version 2 in JIT mode
180
181Both of these libraries may be downloaded from https://www.pcre.org/.
182
183By default, the include and library paths are figured from the "pcre-config"
184and "pcre2-config" utilities. If these ones are not installed or inaccurate
185(for example when cross-compiling), it is possible to force the path to include
186files using "PCRE_INC" and "PCRE2_INC" respectively, and the path to library
187files using "PCRE_LIB" and "PCRE2_LIB" respectively. For example :
188
189 $ make TARGET=generic \
190 USE_PCRE2_JIT=1 PCRE2_INC=/opt/cross/include PCRE2_LIB=/opt/cross/lib
191
192
1934.3) Multi-threading
194--------------------
195On some systems for which positive feedback was reported, multi-threading will
196be enabled by default. When multi-threading is used, the libpthread library
197(POSIX threading) will be used. If the target system doesn't contain such a
198library, it is possible to forcefully disable multi-threading by adding
199"USE_THREAD=" on the command line.
200
201
2024.4) Password encryption
203------------------------
204Many systems provide password encryption functions used for authentication. On
205some systems these functions are part of the libc. On others, they're part of a
206separate library called "libcrypt". The default targets are pre-configured
207based on which system needs the library. It is possible to forcefully disable
208the linkage against libcrypt by adding "USE_LIBCRYPT=" on the command line, or
209to forcefully enable it using "USE_LIBCRYPT=1".
210
211
2124.5) Cryptography
213-----------------
214For SSL/TLS, it is necessary to use a cryptography library. HAProxy currently
215supports the OpenSSL library, and is known to build ant work with branches
2160.9.8, 1.0.0, 1.0.1, 1.0.2, 1.1.0 and 1.1.1. OpenSSL follows a long-term
217support cycle similar to HAProxy's, and each of the branches above receives its
218own fixes, without forcing you to upgrade to another branch. There is no excuse
219for staying vulnerable by not applying a fix available for your version. There
220is always a small risk of regression when jumping from one branch to another
221one, especially when it's very new, so it's preferable to observe for a while
222if you use a different version than your system's defaults.
223
224Two OpenSSL derivatives called LibreSSL and BoringSSL are reported to work as
225well. While there are some efforts from the community to ensure they work well,
226OpenSSL remains the primary target and this means that in case of conflicting
227choices, OpenSSL support will be favored over other options.
228
229In order to enable SSL/TLS support, simply pass "USE_OPENSSL=1" on the command
230line and the default library present on your system will be used :
231
232 $ make TARGET=generic USE_OPENSSL=1
233
234If you want to use a different version from the one provided by your system
235(which is not recommended due to the risk of missing security fixes), it is
236possible to indicate the path to the SSL include files using SSL_INC, and the
237SSL library files using SSL_LIB. Example :
238
239 $ make TARGET=generic \
240 USE_OPENSSL=1 SSL_INC=/opt/ssl-1.1.1/include SSL_LIB=/opt/ssl-1.1.1/lib
241
242In order to link OpenSSL statically against HAProxy, first download OpenSSL
243from https://www.openssl.org/ then build it with the "no-shared" keyword and
244install it to a local directory, so your system is not affected :
245
246 $ export STATICLIBSSL=/tmp/staticlibssl
247 $ ./config --prefix=$STATICLIBSSL no-shared
248 $ make && make install_sw
249
250Then when building haproxy, pass that path via SSL_INC and SSL_LIB :
251
252 $ make TARGET=generic \
253 USE_OPENSSL=1 SSL_INC=$STATICLIBSSL/include SSL_LIB=$STATICLIBSSL/lib
254
255When building with OpenSSL on some systems, you may also need to enable support
256for the "libz" library, which is visible if the linker complains about function
257"deflateInit()" not being found. In this case, simply append "ADDLIB=-lz" to
258the command line.
259
260It is worth mentioning that asynchronous cryptography engines are supported on
261OpenSSL 1.1.0 and above. Such engines are used to access hardware cryptography
262acceleration that might be present on your system.
263
264
2654.6) Compression
266----------------
267HAProxy can compress HTTP responses before delivering them to clients, in order
268to save network bandwidth. Two compression options are available. The first one
269involves the widely known zlib library, which is very likely installed on your
270system. In order to use zlib, simply pass "USE_ZLIB=1" to the command line. If
271the library is not installed in your default system's path, it is possible to
272specify the path to the include files using ZLIB_INC, and the path to the
273library files using ZLIB_LIB :
274
275 $ make TARGET=generic \
276 USE_ZLIB=1 ZLIB_INC=/opt/zlib-1.2.11/include ZLIB_LIB=/opt/zlib-1.2.11/lib
277
278However, zlib maintains an in-memory context for each compressed stream, which
279is not always welcome when dealing with large sites. An alternative solution is
280to use libslz instead, which doesn't consume memory, which is much faster, but
281compresses slightly less efficiently. For this, please use "USE_SLZ=1", and
282optionally make "SLZ_INC" and "SLZ_LIB" point to the library's include and
283library paths, respectively.
284
285Zlib is commonly found on most systems, otherwise updates can be retrieved from
286http://www.zlib.net/. It is easy and fast to build, and new versions sometimes
287provide better performance so it might be worth using an up-to-date one. Libslz
288can be downloaded http://libslz.org/ and is even easier to build.
289
290
2914.7) Lua
292--------
293Lua is an embedded programming langage supported by HAProxy to provide more
294advanced scripting capabilities. Only versions 5.3 and above are supported.
295In order to enable Lua support, please specify "USE_LUA=1" on the command line.
296Some systems provide this library under various names to avoid conflicts with
297previous versions. By default, HAProxy looks for "lua5.3", "lua53", "lua". If
298your system uses a different naming, you may need to set the library name in
299the "LUA_LIB_NAME" variable.
300
301If Lua is not provided on your system, it can be very simply built locally. It
302can be downloaded from https://www.lua.org/, extracted and built, for example :
303
304 $ cd /opt/lua-5.3.5
305 $ make linux
306
307The path to the include files and library files may be set using "LUA_INC" and
308"LUA_LIB" respectively. For example :
309
310 $ make TARGET=generic \
311 USE_LUA=1 LUA_INC=/opt/lua-5.3.5/src LUA_LIB=/opt/lua-5.3.5/src
312
313
3144.8) Device detection
315---------------------
316HAProxy supports several device detection modules relying on third party
317products. Some of them may provide free code, others free libs, others free
318evaluation licenses. Please read about their respective details in the
319following files :
320
321 doc/DeviceAtlas-device-detection.txt for DeviceAtlas
322 doc/51Degrees-device-detection.txt for 51Degrees
323 doc/WURFL-device-detection.txt for Scientiamobile WURFL
324
325
3264.9) Miscellaneous
327------------------
328Some systems have specificities. Usually these specificities are known and/or
329detected and properly set for you. If you need to adjust the behaviour, here
330are the extra libraries that may be referenced at build time :
331
332 - USE_RT=1 build with librt, which is sometimes needed on some systems
333 when using threads. It is set by default on Linux platforms,
334 and may be disabled using "USE_RT=" if your system doesn't
335 have one.
336
337 - USE_DL=1 build with libdl, which is usually needed for Lua and OpenSSL
338 on Linux. It is automatically detected and may be disabled
339 using "USE_DL=", though it should never harm.
340
341 - USE_SYSTEMD=1 enables support for the sdnotify features of systemd,
342 allowing better integration with systemd on Linux systems
343 which come with it. It is never enabled by default so there
344 is no need to disable it.
345
346
3475) How to build HAProxy
348=======================
349
350This section assumes that you have already read section 2 (basic principles)
351and section 3 (build environment). It often refers to section 4 (dependencies).
352
353To build haproxy, you have to choose your target OS amongst the following ones
354and assign it to the TARGET variable :
355
356 - linux22 for Linux 2.2
357 - linux24 for Linux 2.4 and above (default)
358 - linux24e for Linux 2.4 with support for a working epoll (> 0.21)
359 - linux26 for Linux 2.6 and above
360 - linux2628 for Linux 2.6.28, 3.x, and above (enables splice and tproxy)
361 - solaris for Solaris 8 or 10 (others untested)
362 - freebsd for FreeBSD 5 to 12 (others untested)
363 - netbsd for NetBSD
364 - osx for Mac OS/X
365 - openbsd for OpenBSD 5.7 and above
366 - aix51 for AIX 5.1
367 - aix52 for AIX 5.2
368 - cygwin for Cygwin
369 - haiku for Haiku
370 - generic for any other OS or version.
371 - custom to manually adjust every setting
372
373You may also choose your CPU to benefit from some optimizations. This is
374particularly important on UltraSparc machines. For this, you can assign
375one of the following choices to the CPU variable :
376
377 - i686 for intel PentiumPro, Pentium 2 and above, AMD Athlon (32 bits)
378 - i586 for intel Pentium, AMD K6, VIA C3.
379 - ultrasparc : Sun UltraSparc I/II/III/IV processor
380 - native : use the build machine's specific processor optimizations. Use with
381 extreme care, and never in virtualized environments (known to break).
382 - generic : any other processor or no CPU-specific optimization. (default)
383
384Alternatively, you may just set the CPU_CFLAGS value to the optimal GCC options
385for your platform. A second variable named SMALL_OPTS also supports passing a
386number of defines and compiler options usually for small systems. For better
387clarity it's recommended to pass the options which result in a smaller binary
388(like memory limits or -Os) into this variable.
389
390If you are building for a different system than the one you're building on,
391this is called "cross-compiling". HAProxy supports cross-compilation pretty
392well and tries to ease it by letting you adjust paths to all libraries (please
393read section 4 on dependencies for more details). When cross-compiling, you
394just need to pass the path to your compiler in the "CC" variable, and the path
395to the linker in the "LD" variable. Most of the time, setting the CC variable
396is enough since LD points to it by default.
397
398By default the build process runs in quiet mode and hide the details of the
399commands that are executed. This allows to more easily catch build warnings
400and see what is happening. However it is not convenient at all to observe what
401flags are passed to the compiler nor what compiler is involved. Simply append
402"V=1" to the "make" command line to switch to verbose mode and display the
403details again. It is recommended to use this option when cross-compiling to
404verify that the paths are correct and that /usr/include is never invovled.
405
406You may want to build specific target binaries which do not match your native
407compiler's target. This is particularly true on 64-bit systems when you want
408to build a 32-bit binary. Use the ARCH variable for this purpose. Right now
409it only knows about a few x86 variants (i386,i486,i586,i686,x86_64), two
410generic ones (32,64) and sets -m32/-m64 as well as -march=<arch> accordingly.
411This variable is only used to set ARCH_FLAGS to preset values, so if you know
412the arch-specific flags that your system needs, you may prefer to set
413ARCH_FLAGS instead. Note that these flags are passed both to the compiler and
414to the linker. For example, in order to build a 32-bit binary on an x86_64
415Linux system with SSL support without support for compression but when OpenSSL
416requires ZLIB anyway :
417
418 $ make TARGET=linux2628 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
419
420Recent systems can resolve IPv6 host names using getaddrinfo(). This primitive
421is not present in all libcs and does not work in all of them either. Support in
422glibc was broken before 2.3. Some embedded libs may not properly work either,
423thus, support is disabled by default, meaning that some host names which only
424resolve as IPv6 addresses will not resolve and configs might emit an error
425during parsing. If you know that your OS libc has reliable support for
426getaddrinfo(), you can add USE_GETADDRINFO=1 on the make command line to enable
427it. This is the recommended option for most Linux distro packagers since it's
428working fine on all recent mainstream distros. It is automatically enabled on
429Solaris 8 and above, as it's known to work.
430
431If your system supports PCRE (Perl Compatible Regular Expressions), then you
432really should build with libpcre which is between 2 and 10 times faster than
433other libc implementations. Regex are used for header processing (deletion,
434rewriting, allow, deny). Please see section 4 about dependencies to figure
435how to build with PCRE support.
436
437It is possible to add native support for SSL, by passing "USE_OPENSSL=1" on the
438make command line. The libssl and libcrypto will automatically be linked with
439HAProxy. Some systems also require libz, so if the build fails due to missing
440symbols such as deflateInit(), then try again with "ADDLIB=-lz". Please check
441section 4 about dependencies for more information on how to build with OpenSSL.
442
443HAProxy can compress HTTP responses to save bandwidth. Please see section 4
444about dependencies to see the available libraries and associated options.
445
446By default, the DEBUG variable is set to '-g' to enable debug symbols. It is
447not wise to disable it on uncommon systems, because it's often the only way to
448get a usable core when you need one. Otherwise, you can set DEBUG to '-s' to
449strip the binary.
450
451If the ERR variable is set to any non-empty value, then -Werror will be added
452to the compiler so that any build warning will trigger an error. This is the
453recommended way to build when developing, and it is expected that contributed
454patches were tested with ERR=1.
455
456The SSL stack supports session cache synchronization between all running
457processes. This involves some atomic operations and synchronization operations
458which come in multiple flavors depending on the system and architecture :
459
460 Atomic operations :
461 - internal assembler versions for x86/x86_64 architectures
462
463 - gcc builtins for other architectures. Some architectures might not
464 be fully supported or might require a more recent version of gcc.
465 If your architecture is not supported, you willy have to either use
466 pthread if supported, or to disable the shared cache.
467
468 - pthread (posix threads). Pthreads are very common but inter-process
469 support is not that common, and some older operating systems did not
470 report an error when enabling multi-process mode, so they used to
471 silently fail, possibly causing crashes. Linux's implementation is
472 fine. OpenBSD doesn't support them and doesn't build. FreeBSD 9 builds
473 and reports an error at runtime, while certain older versions might
474 silently fail. Pthreads are enabled using USE_PTHREAD_PSHARED=1.
475
476 Synchronization operations :
477 - internal spinlock : this mode is OS-independent, light but will not
478 scale well to many processes. However, accesses to the session cache
479 are rare enough that this mode could certainly always be used. This
480 is the default mode.
481
482 - Futexes, which are Linux-specific highly scalable light weight mutexes
483 implemented in user-space with some limited assistance from the kernel.
484 This is the default on Linux 2.6 and above and is enabled by passing
485 USE_FUTEX=1
486
487 - pthread (posix threads). See above.
488
489If none of these mechanisms is supported by your platform, you may need to
490build with USE_PRIVATE_CACHE=1 to totally disable SSL cache sharing. Then it
491is better not to run SSL on multiple processes. Note that you don't need these
492features if you only intend to use multi-threading and never multi-process.
493
494If you need to pass other defines, includes, libraries, etc... then please
495check the Makefile to see which ones will be available in your case, and
496use/override the USE_* variables from the Makefile.
497
498AIX 5.3 is known to work with the generic target. However, for the binary to
499also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
500otherwise __fd_select() will be used while not being present in the libc, but
501this is easily addressed using the "aix52" target. If you get build errors
502because of strange symbols or section mismatches, simply remove -g from
503DEBUG_CFLAGS.
504
505You can easily define your own target with the GNU Makefile. Unknown targets
506are processed with no default option except USE_POLL=default. So you can very
507well use that property to define your own set of options. USE_POLL can even be
508disabled by setting USE_POLL="". For example :
509
510 $ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
511
512If you need to pass some defines to the preprocessor or compiler, you may pass
513them all in the DEFINE variable. Example:
514
515 $ make TARGET=generic DEFINE="-DDEBUG_DONT_SHARE_POOLS -DDEBUG_MEMORY_POOLS"
516
517The ADDINC variable may be used to add some extra include paths; this is
518sometimes needed when cross-compiling. Similarly the ADDLIB variable may be
519used to specifify extra paths to library files. Example :
520
521 $ make TARGET=generic ADDINC=-I/opt/cross/include ADDLIB=-L/opt/cross/lib64
522
523
5246) How to install HAProxy
525=========================
526
527To install haproxy, you can either copy the single resulting binary to the
528place you want, or run :
529
530 $ sudo make install
531
532If you're packaging it for another system, you can specify its root directory
533in the usual DESTDIR variable.
534
535-- end