blob: 787cc4f277d1fe7c8db760ffd0825cf5c83eef53 [file] [log] [blame]
Willy Tarreaub1a34b62010-05-09 22:37:12 +02001 ----------------------
2 HAProxy how-to
3 ----------------------
Willy Tarreau991b4782015-10-13 21:48:10 +02004 version 1.7
Willy Tarreaub1a34b62010-05-09 22:37:12 +02005 willy tarreau
Willy Tarreau7d1b48f2016-05-10 15:36:58 +02006 2016/05/10
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 Jakots17d228b2015-07-29 08:03:08 +020046 - openbsd for OpenBSD 3.1 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
David Carlierb5efa012015-06-01 14:21:47 +02002231.1) DeviceAtlas Device Detection
224---------------------------------
225
226In order to add DeviceAtlas Device Detection support, you would need to download
227the API source code from https://deviceatlas.com/deviceatlas-haproxy-module and
228once extracted :
229
Willy Tarreau82bd42e2015-06-02 14:10:28 +0200230 $ make TARGET=<target> USE_PCRE=1 USE_DEVICEATLAS=1 DEVICEATLAS_SRC=<path to the API root folder>
231
232Optionally DEVICEATLAS_INC and DEVICEATLAS_LIB may be set to override the path
233to the include files and libraries respectively if they're not in the source
234directory.
David Carlierb5efa012015-06-01 14:21:47 +0200235
236These are supported DeviceAtlas directives (see doc/configuration.txt) :
237 - deviceatlas-json-file <path to the DeviceAtlas JSON data file>.
238 - deviceatlas-log-level <number> (0 to 3, level of information returned by
239 the API, 0 by default).
240 - deviceatlas-property-separator <character> (character used to separate the
241 properties produced by the API, | by default).
242
243Sample configuration :
244
245 global
246 deviceatlas-json-file <path to json file>
247
248 ...
249 frontend
250 bind *:8881
251 default_backend servers
David Carlier00d7d612015-09-25 14:06:08 +0100252
253There are two distinct methods available, one which leverages all HTTP headers
254and one which uses only a single HTTP header for the detection. The former
David Carliera1246932015-10-28 11:08:15 +0000255method is highly recommended and more accurate. There are several possible use
256cases.
David Carlier00d7d612015-09-25 14:06:08 +0100257
David Carliera1246932015-10-28 11:08:15 +0000258# To transmit the DeviceAtlas data downstream to the target application
David Carlier00d7d612015-09-25 14:06:08 +0100259
David Carliera1246932015-10-28 11:08:15 +0000260All HTTP headers via the sample / fetch
David Carlier00d7d612015-09-25 14:06:08 +0100261
David Carlier840b0242016-03-16 10:09:55 +0000262 http-request set-header X-DeviceAtlas-Data %[da-csv-fetch(primaryHardwareType,osName,osVersion,browserName,browserVersion,browserRenderingEngine)]
David Carlier00d7d612015-09-25 14:06:08 +0100263
David Carliera1246932015-10-28 11:08:15 +0000264Single HTTP header (e.g. User-Agent) via the convertor
David Carlier00d7d612015-09-25 14:06:08 +0100265
David Carlier840b0242016-03-16 10:09:55 +0000266 http-request set-header X-DeviceAtlas-Data %[req.fhdr(User-Agent),da-csv-conv(primaryHardwareType,osName,osVersion,browserName,browserVersion,browserRenderingEngine)]
David Carlier00d7d612015-09-25 14:06:08 +0100267
David Carliera1246932015-10-28 11:08:15 +0000268# Mobile content switching with ACL
269
270All HTTP headers
David Carlier00d7d612015-09-25 14:06:08 +0100271
David Carliera1246932015-10-28 11:08:15 +0000272 acl is_mobile da-csv-fetch(mobileDevice) 1
David Carlier00d7d612015-09-25 14:06:08 +0100273
David Carliera1246932015-10-28 11:08:15 +0000274Single HTTP header
David Carlier00d7d612015-09-25 14:06:08 +0100275
David Carliera1246932015-10-28 11:08:15 +0000276 acl device_type_tablet req.fhdr(User-Agent),da-csv-conv(primaryHardwareType) "Tablet"
277
David Carlierb5efa012015-06-01 14:21:47 +0200278
David Carlier00d7d612015-09-25 14:06:08 +0100279Please find more information about DeviceAtlas and the detection methods at https://deviceatlas.com/resources .
David Carlierb5efa012015-06-01 14:21:47 +0200280
David Carliera1246932015-10-28 11:08:15 +0000281
Thomas Holmesf95aaf62015-05-29 15:21:42 +01002821.2) 51Degrees Device Detection
283-------------------------------
284
285You can also include 51Degrees for inbuilt device detection enabling attributes
286such as screen size (physical & pixels), supported input methods, release date,
287hardware vendor and model, browser information, and device price among many
288others. Such information can be used to improve the user experience of a web
289site by tailoring the page content, layout and business processes to the
290precise characteristics of the device. Such customisations improve profit by
291making it easier for customers to get to the information or services they
James Rosewella0c4c692015-09-18 17:21:37 +0100292need. Attributes of the device making a web request can be added to HTTP
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100293headers as configurable parameters.
294
James Rosewella0c4c692015-09-18 17:21:37 +0100295In order to enable 51Degrees download the 51Degrees source code from the
296official github repository :
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100297
James Rosewella0c4c692015-09-18 17:21:37 +0100298 git clone https://github.com/51Degrees/Device-Detection
Willy Tarreauc7203c72015-06-01 11:12:35 +0200299
300then run 'make' with USE_51DEGREES and 51DEGREES_SRC set. Both 51DEGREES_INC
301and 51DEGREES_LIB may additionally be used to force specific different paths
302for .o and .h, but will default to 51DEGREES_SRC. Make sure to replace
303'51D_REPO_PATH' with the path to the 51Degrees repository.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100304
James Rosewella0c4c692015-09-18 17:21:37 +010030551Degrees provide 2 different detection algorithms:
306
Willy Tarreauc7203c72015-06-01 11:12:35 +0200307 1. Pattern - balances main memory usage and CPU.
308 2. Trie - a very high performance detection solution which uses more main
309 memory than Pattern.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100310
311To make with 51Degrees Pattern algorithm use the following command line.
312
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000313 $ make TARGET=<target> USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/pattern
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100314
315To use the 51Degrees Trie algorithm use the following command line.
316
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000317 $ make TARGET=<target> USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/trie
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100318
319A data file containing information about devices, browsers, operating systems
320and their associated signatures is then needed. 51Degrees provide a free
321database with Github repo for this purpose. These free data files are located
322in '51D_REPO_PATH'/data with the extensions .dat for Pattern data and .trie for
323Trie data.
324
325The configuration file needs to set the following parameters:
326
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000327 global
328 51degrees-data-file path to the Pattern or Trie data file
329 51degrees-property-name-list list of 51Degrees properties to detect
330 51degrees-property-separator separator to use between values
331 51degrees-cache-size LRU-based cache size (disabled by default)
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100332
333The following is an example of the settings for Pattern.
334
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000335 global
336 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.dat
337 51degrees-property-name-list IsTablet DeviceType IsMobile
338 51degrees-property-separator ,
339 51degrees-cache-size 10000
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100340
341HAProxy needs a way to pass device information to the backend servers. This is
James Rosewella0c4c692015-09-18 17:21:37 +0100342done by using the 51d converter or fetch method, which intercepts the HTTP
343headers and creates some new headers. This is controlled in the frontend
344http-in section.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100345
346The following is an example which adds two new HTTP headers prefixed X-51D-
347
348 frontend http-in
349 bind *:8081
350 default_backend servers
James Rosewella0c4c692015-09-18 17:21:37 +0100351 http-request set-header X-51D-DeviceTypeMobileTablet %[51d.all(DeviceType,IsMobile,IsTablet)]
352 http-request set-header X-51D-Tablet %[51d.all(IsTablet)]
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100353
354Here, two headers are created with 51Degrees data, X-51D-DeviceTypeMobileTablet
355and X-51D-Tablet. Any number of headers can be created this way and can be
James Rosewella0c4c692015-09-18 17:21:37 +0100356named anything. 51d.all( ) invokes the 51degrees fetch. It can be passed up to
357five property names of values to return. Values will be returned in the same
358order, seperated by the 51-degrees-property-separator configured earlier. If a
359property name can't be found the value 'NoData' is returned instead.
360
361In addition to the device properties three additional properties related to the
362validity of the result can be returned when used with the Pattern method. The
363following example shows how Method, Difference and Rank could be included as one
364new HTTP header X-51D-Stats.
365
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000366 frontend http-in
367 ...
James Rosewella0c4c692015-09-18 17:21:37 +0100368 http-request set-header X-51D-Stats %[51d.all(Method,Difference,Rank)]
369
370These values indicate how confident 51Degrees is in the result that that was
371returned. More information is available on the 51Degrees web site at:
372
373 https://51degrees.com/support/documentation/pattern
374
375The above 51d.all fetch method uses all available HTTP headers for detection. A
376modest performance improvement can be obtained by only passing one HTTP header
377to the detection method with the 51d.single converter. The following example
378uses the User-Agent HTTP header only for detection.
379
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000380 frontend http-in
381 ...
James Rosewella0c4c692015-09-18 17:21:37 +0100382 http-request set-header X-51D-DeviceTypeMobileTablet %[req.fhdr(User-Agent),51d.single(DeviceType,IsMobile,IsTablet)]
383
384Any HTTP header could be used inplace of User-Agent by changing the parameter
385provided to req.fhdr.
386
387When compiled to use the Trie detection method the trie format data file needs
388to be provided. Changing the extension of the data file from dat to trie will
389use the correct data.
390
Ben Shillitoa7bbdd92015-12-03 10:36:20 +0000391 global
James Rosewella0c4c692015-09-18 17:21:37 +0100392 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.trie
393
394When used with Trie the Method, Difference and Rank properties are not
395available.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100396
397The free Lite data file contains information about screen size in pixels and
398whether the device is a mobile. A full list of available properties is located
399on the 51Degrees web site at:
400
James Rosewella0c4c692015-09-18 17:21:37 +0100401 https://51degrees.com/resources/property-dictionary
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100402
403Some properties are only available in the paid for Premium and Enterprise
James Rosewella0c4c692015-09-18 17:21:37 +0100404versions of 51Degrees. These data sets not only contain more properties but
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100405are updated weekly and daily and contain signatures for 100,000s of different
406device combinations. For more information see the data options comparison web
407page:
408
409 https://51degrees.com/compare-data-options
410
411
Willy Tarreaub1a34b62010-05-09 22:37:12 +02004122) How to install it
413--------------------
414
415To install haproxy, you can either copy the single resulting binary to the
416place you want, or run :
417
418 $ sudo make install
419
420If you're packaging it for another system, you can specify its root directory
421in the usual DESTDIR variable.
422
423
4243) How to set it up
425-------------------
426
427There is some documentation in the doc/ directory :
428
Willy Tarreaud8e42b62015-08-18 21:51:36 +0200429 - intro.txt : this is an introduction to haproxy, it explains what it is
430 what it is not. Useful for beginners or to re-discover it when planning
431 for an upgrade.
432
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200433 - architecture.txt : this is the architecture manual. It is quite old and
434 does not tell about the nice new features, but it's still a good starting
435 point when you know what you want but don't know how to do it.
436
437 - configuration.txt : this is the configuration manual. It recalls a few
438 essential HTTP basic concepts, and details all the configuration file
439 syntax (keywords, units). It also describes the log and stats format. It
440 is normally always up to date. If you see that something is missing from
Willy Tarreau74774c02014-04-23 00:57:08 +0200441 it, please report it as this is a bug. Please note that this file is
442 huge and that it's generally more convenient to review Cyril Bonté's
443 HTML translation online here :
444
Willy Tarreau844028b2015-10-13 18:52:22 +0200445 http://cbonte.github.io/haproxy-dconv/configuration-1.6.html
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200446
Willy Tarreau373933d2015-10-13 16:32:20 +0200447 - management.txt : it explains how to start haproxy, how to manage it at
448 runtime, how to manage it on multiple nodes, how to proceed with seamless
449 upgrades.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200450
451 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
452 the 'LICENSE' file at the top for more information.
453
454 - the rest is mainly for developers.
455
456There are also a number of nice configuration examples in the "examples"
457directory as well as on several sites and articles on the net which are linked
458to from the haproxy web site.
459
460
4614) How to report a bug
462----------------------
463
464It is possible that from time to time you'll find a bug. A bug is a case where
465what you see is not what is documented. Otherwise it can be a misdesign. If you
466find that something is stupidly design, please discuss it on the list (see the
467"how to contribute" section below). If you feel like you're proceeding right
468and haproxy doesn't obey, then first ask yourself if it is possible that nobody
469before you has even encountered this issue. If it's unlikely, the you probably
470have an issue in your setup. Just in case of doubt, please consult the mailing
471list archives :
472
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200473 http://marc.info/?l=haproxy
474
475Otherwise, please try to gather the maximum amount of information to help
476reproduce the issue and send that to the mailing list :
477
478 haproxy@formilux.org
479
480Please include your configuration and logs. You can mask your IP addresses and
481passwords, we don't need them. But it's essential that you post your config if
482you want people to guess what is happening.
483
484Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
485without any reason, then it definitely is a critical bug that must be reported
486and urgently fixed. It has happened a couple of times in the past, essentially
487on development versions running on new architectures. If you think your setup
488is fairly common, then it is possible that the issue is totally unrelated.
489Anyway, if that happens, feel free to contact me directly, as I will give you
490instructions on how to collect a usable core file, and will probably ask for
491other captures that you'll not want to share with the list.
492
493
4945) How to contribute
495--------------------
496
Willy Tarreau11e334d92015-09-20 22:31:42 +0200497Please carefully read the CONTRIBUTING file that comes with the sources. It is
498mandatory.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200499
willy tarreau78345332005-12-18 01:33:16 +0100500-- end