blob: cf976057bc87e5250d39d1fb55d457eb88edfa4d [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 Tarreau844028b2015-10-13 18:52:22 +02006 2015/10/13
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
Willy Tarreau869f3512014-06-19 15:26:32 +020050 - generic for any other OS or version.
Willy Tarreau83b30c12008-05-25 10:32:50 +020051 - custom to manually adjust every setting
willy tarreau78345332005-12-18 01:33:16 +010052
53You may also choose your CPU to benefit from some optimizations. This is
54particularly important on UltraSparc machines. For this, you can assign
55one of the following choices to the CPU variable :
56
57 - i686 for intel PentiumPro, Pentium 2 and above, AMD Athlon
58 - i586 for intel Pentium, AMD K6, VIA C3.
59 - ultrasparc : Sun UltraSparc I/II/III/IV processor
Willy Tarreau817dad52014-07-10 20:24:25 +020060 - native : use the build machine's specific processor optimizations. Use with
61 extreme care, and never in virtualized environments (known to break).
62 - generic : any other processor or no CPU-specific optimization. (default)
willy tarreau78345332005-12-18 01:33:16 +010063
Willy Tarreau83b30c12008-05-25 10:32:50 +020064Alternatively, you may just set the CPU_CFLAGS value to the optimal GCC options
65for your platform.
66
Willy Tarreauef7341d2009-04-11 19:45:50 +020067You may want to build specific target binaries which do not match your native
68compiler's target. This is particularly true on 64-bit systems when you want
69to build a 32-bit binary. Use the ARCH variable for this purpose. Right now
Willy Tarreaua5899aa2010-11-28 07:41:00 +010070it only knows about a few x86 variants (i386,i486,i586,i686,x86_64), two
71generic ones (32,64) and sets -m32/-m64 as well as -march=<arch> accordingly.
Willy Tarreauef7341d2009-04-11 19:45:50 +020072
willy tarreau78345332005-12-18 01:33:16 +010073If your system supports PCRE (Perl Compatible Regular Expressions), then you
74really should build with libpcre which is between 2 and 10 times faster than
75other libc implementations. Regex are used for header processing (deletion,
76rewriting, allow, deny). The only inconvenient of libpcre is that it is not
77yet widely spread, so if you build for other systems, you might get into
78trouble if they don't have the dynamic library. In this situation, you should
79statically link libpcre into haproxy so that it will not be necessary to
Willy Tarreau83b30c12008-05-25 10:32:50 +020080install it on target systems. Available build options for PCRE are :
willy tarreau78345332005-12-18 01:33:16 +010081
Willy Tarreau83b30c12008-05-25 10:32:50 +020082 - USE_PCRE=1 to use libpcre, in whatever form is available on your system
willy tarreau78345332005-12-18 01:33:16 +010083 (shared or static)
84
Willy Tarreau83b30c12008-05-25 10:32:50 +020085 - USE_STATIC_PCRE=1 to use a static version of libpcre even if the dynamic
86 one is available. This will enhance portability.
87
Willy Tarreau663148c2012-12-12 00:38:22 +010088 - with no option, use your OS libc's standard regex implementation (default).
Willy Tarreau83b30c12008-05-25 10:32:50 +020089 Warning! group references on Solaris seem broken. Use static-pcre whenever
90 possible.
willy tarreau78345332005-12-18 01:33:16 +010091
Willy Tarreaua8fc8a22015-09-28 22:36:21 +020092If your system doesn't provide PCRE, you are encouraged to download it from
93http://www.pcre.org/ and build it yourself, it's fast and easy.
94
Willy Tarreau64bc40b2011-03-23 20:00:53 +010095Recent systems can resolve IPv6 host names using getaddrinfo(). This primitive
96is not present in all libcs and does not work in all of them either. Support in
97glibc was broken before 2.3. Some embedded libs may not properly work either,
98thus, support is disabled by default, meaning that some host names which only
99resolve as IPv6 addresses will not resolve and configs might emit an error
100during parsing. If you know that your OS libc has reliable support for
101getaddrinfo(), you can add USE_GETADDRINFO=1 on the make command line to enable
102it. This is the recommended option for most Linux distro packagers since it's
103working fine on all recent mainstream distros. It is automatically enabled on
104Solaris 8 and above, as it's known to work.
105
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200106It is possible to add native support for SSL using the GNU makefile, by passing
107"USE_OPENSSL=1" on the make command line. The libssl and libcrypto will
108automatically be linked with haproxy. Some systems also require libz, so if the
109build fails due to missing symbols such as deflateInit(), then try again with
110"ADDLIB=-lz".
Willy Tarreaud4508812012-09-10 09:07:41 +0200111
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200112Your are strongly encouraged to always use an up-to-date version of OpenSSL, as
113found on https://www.openssl.org/ as vulnerabilities are occasionally found and
114you don't want them on your systems. HAProxy is known to build correctly on all
115currently supported branches (0.9.8, 1.0.0, 1.0.1 and 1.0.2 at the time of
116writing). Branch 1.0.2 is recommended for the richest features.
117
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200118To link OpenSSL statically against haproxy, build OpenSSL with the no-shared
119keyword and install it to a local directory, so your system is not affected :
120
121 $ export STATICLIBSSL=/tmp/staticlibssl
122 $ ./config --prefix=$STATICLIBSSL no-shared
123 $ make && make install_sw
124
Lukas Tribus130ddf72013-10-01 00:28:03 +0200125When building haproxy, pass that path via SSL_INC and SSL_LIB to make and
126include additional libs with ADDLIB if needed (in this case for example libdl):
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200127
Lukas Tribus130ddf72013-10-01 00:28:03 +0200128 $ make TARGET=linux26 USE_OPENSSL=1 SSL_INC=$STATICLIBSSL/include SSL_LIB=$STATICLIBSSL/lib ADDLIB=-ldl
Lukas Tribus3fe9f1e2013-05-19 16:28:17 +0200129
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200130It is also possible to include native support for zlib to benefit from HTTP
William Lallemand82fe75c2012-10-23 10:25:10 +0200131compression. For this, pass "USE_ZLIB=1" on the "make" command line and ensure
Willy Tarreau418b8c02015-03-29 03:32:06 +0200132that zlib is present on the system. Alternatively it is possible to use libslz
133for a faster, memory less, but slightly less efficient compression, by passing
134"USE_SLZ=1".
William Lallemand82fe75c2012-10-23 10:25:10 +0200135
Willy Tarreaua8fc8a22015-09-28 22:36:21 +0200136Zlib is commonly found on most systems, otherwise updates can be retrieved from
137http://www.zlib.net/. It is easy and fast to build. Libslz can be downloaded
138from http://1wt.eu/projects/libslz/ and is even easier to build.
139
willy tarreau78345332005-12-18 01:33:16 +0100140By default, the DEBUG variable is set to '-g' to enable debug symbols. It is
141not wise to disable it on uncommon systems, because it's often the only way to
142get a complete core when you need one. Otherwise, you can set DEBUG to '-s' to
143strip the binary.
144
145For example, I use this to build for Solaris 8 :
146
Willy Tarreau83b30c12008-05-25 10:32:50 +0200147 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1
willy tarreau78345332005-12-18 01:33:16 +0100148
Willy Tarreau83b30c12008-05-25 10:32:50 +0200149And I build it this way on OpenBSD or FreeBSD :
willy tarreaud38e72d2006-03-19 20:56:52 +0100150
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200151 $ gmake TARGET=freebsd USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
willy tarreaud38e72d2006-03-19 20:56:52 +0100152
Willy Tarreau663148c2012-12-12 00:38:22 +0100153And on a classic Linux with SSL and ZLIB support (eg: Red Hat 5.x) :
154
Willy Tarreau817dad52014-07-10 20:24:25 +0200155 $ make TARGET=linux26 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreau663148c2012-12-12 00:38:22 +0100156
157And on a recent Linux >= 2.6.28 with SSL and ZLIB support :
Willy Tarreaud4508812012-09-10 09:07:41 +0200158
Willy Tarreau817dad52014-07-10 20:24:25 +0200159 $ make TARGET=linux2628 USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreaud4508812012-09-10 09:07:41 +0200160
William Lallemand82fe75c2012-10-23 10:25:10 +0200161In order to build a 32-bit binary on an x86_64 Linux system with SSL support
162without support for compression but when OpenSSL requires ZLIB anyway :
Willy Tarreauef7341d2009-04-11 19:45:50 +0200163
Willy Tarreaud4508812012-09-10 09:07:41 +0200164 $ make TARGET=linux26 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
Willy Tarreauef7341d2009-04-11 19:45:50 +0200165
Willy Tarreaub1efede2014-05-09 00:44:48 +0200166The SSL stack supports session cache synchronization between all running
167processes. This involves some atomic operations and synchronization operations
168which come in multiple flavors depending on the system and architecture :
169
170 Atomic operations :
171 - internal assembler versions for x86/x86_64 architectures
172
173 - gcc builtins for other architectures. Some architectures might not
174 be fully supported or might require a more recent version of gcc.
175 If your architecture is not supported, you willy have to either use
176 pthread if supported, or to disable the shared cache.
177
178 - pthread (posix threads). Pthreads are very common but inter-process
179 support is not that common, and some older operating systems did not
180 report an error when enabling multi-process mode, so they used to
181 silently fail, possibly causing crashes. Linux's implementation is
182 fine. OpenBSD doesn't support them and doesn't build. FreeBSD 9 builds
183 and reports an error at runtime, while certain older versions might
184 silently fail. Pthreads are enabled using USE_PTHREAD_PSHARED=1.
185
186 Synchronization operations :
187 - internal spinlock : this mode is OS-independant, light but will not
188 scale well to many processes. However, accesses to the session cache
189 are rare enough that this mode could certainly always be used. This
190 is the default mode.
191
192 - Futexes, which are Linux-specific highly scalable light weight mutexes
193 implemented in user-space with some limited assistance from the kernel.
194 This is the default on Linux 2.6 and above and is enabled by passing
195 USE_FUTEX=1
196
197 - pthread (posix threads). See above.
198
199If none of these mechanisms is supported by your platform, you may need to
200build with USE_PRIVATE_CACHE=1 to totally disable SSL cache sharing. Then
201it is better not to run SSL on multiple processes.
202
willy tarreau78345332005-12-18 01:33:16 +0100203If you need to pass other defines, includes, libraries, etc... then please
204check the Makefile to see which ones will be available in your case, and
Willy Tarreau3543cdb2014-05-10 09:12:46 +0200205use the USE_* variables in the Makefile.
willy tarreau78345332005-12-18 01:33:16 +0100206
Willy Tarreau97ec9692010-01-28 20:52:05 +0100207AIX 5.3 is known to work with the generic target. However, for the binary to
208also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
Willy Tarreau869f3512014-06-19 15:26:32 +0200209otherwise __fd_select() will be used while not being present in the libc, but
210this is easily addressed using the "aix52" target. If you get build errors
211because of strange symbols or section mismatches, simply remove -g from
212DEBUG_CFLAGS.
Willy Tarreau97ec9692010-01-28 20:52:05 +0100213
Willy Tarreau32e65ef2013-04-02 08:14:29 +0200214You can easily define your own target with the GNU Makefile. Unknown targets
215are processed with no default option except USE_POLL=default. So you can very
216well use that property to define your own set of options. USE_POLL can even be
217disabled by setting USE_POLL="". For example :
218
219 $ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
220
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200221
David Carlierb5efa012015-06-01 14:21:47 +02002221.1) DeviceAtlas Device Detection
223---------------------------------
224
225In order to add DeviceAtlas Device Detection support, you would need to download
226the API source code from https://deviceatlas.com/deviceatlas-haproxy-module and
227once extracted :
228
Willy Tarreau82bd42e2015-06-02 14:10:28 +0200229 $ make TARGET=<target> USE_PCRE=1 USE_DEVICEATLAS=1 DEVICEATLAS_SRC=<path to the API root folder>
230
231Optionally DEVICEATLAS_INC and DEVICEATLAS_LIB may be set to override the path
232to the include files and libraries respectively if they're not in the source
233directory.
David Carlierb5efa012015-06-01 14:21:47 +0200234
235These are supported DeviceAtlas directives (see doc/configuration.txt) :
236 - deviceatlas-json-file <path to the DeviceAtlas JSON data file>.
237 - deviceatlas-log-level <number> (0 to 3, level of information returned by
238 the API, 0 by default).
239 - deviceatlas-property-separator <character> (character used to separate the
240 properties produced by the API, | by default).
241
242Sample configuration :
243
244 global
245 deviceatlas-json-file <path to json file>
246
247 ...
248 frontend
249 bind *:8881
250 default_backend servers
David Carlier00d7d612015-09-25 14:06:08 +0100251
252There are two distinct methods available, one which leverages all HTTP headers
253and one which uses only a single HTTP header for the detection. The former
254method is highly recommended and more accurate.
255
256
257All HTTP headers
258
259
260 http-request set-header X-DeviceAtlas-Data %[da-csv-fetch(primaryHardwareType,osName,osVersion,browserName,browserVersion)]
261
262
263Single HTTP header (e.g. User-Agent)
264
265
266 http-request set-header X-DeviceAtlas-Data %[req.fhdr(User-Agent),da-csv-conv(primaryHardwareType,osName,osVersion,browserName,browserVersion)]
267
David Carlierb5efa012015-06-01 14:21:47 +0200268
David Carlier00d7d612015-09-25 14:06:08 +0100269Please find more information about DeviceAtlas and the detection methods at https://deviceatlas.com/resources .
David Carlierb5efa012015-06-01 14:21:47 +0200270
Thomas Holmesf95aaf62015-05-29 15:21:42 +01002711.2) 51Degrees Device Detection
272-------------------------------
273
274You can also include 51Degrees for inbuilt device detection enabling attributes
275such as screen size (physical & pixels), supported input methods, release date,
276hardware vendor and model, browser information, and device price among many
277others. Such information can be used to improve the user experience of a web
278site by tailoring the page content, layout and business processes to the
279precise characteristics of the device. Such customisations improve profit by
280making it easier for customers to get to the information or services they
James Rosewella0c4c692015-09-18 17:21:37 +0100281need. Attributes of the device making a web request can be added to HTTP
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100282headers as configurable parameters.
283
James Rosewella0c4c692015-09-18 17:21:37 +0100284In order to enable 51Degrees download the 51Degrees source code from the
285official github repository :
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100286
James Rosewella0c4c692015-09-18 17:21:37 +0100287 git clone https://github.com/51Degrees/Device-Detection
Willy Tarreauc7203c72015-06-01 11:12:35 +0200288
289then run 'make' with USE_51DEGREES and 51DEGREES_SRC set. Both 51DEGREES_INC
290and 51DEGREES_LIB may additionally be used to force specific different paths
291for .o and .h, but will default to 51DEGREES_SRC. Make sure to replace
292'51D_REPO_PATH' with the path to the 51Degrees repository.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100293
James Rosewella0c4c692015-09-18 17:21:37 +010029451Degrees provide 2 different detection algorithms:
295
Willy Tarreauc7203c72015-06-01 11:12:35 +0200296 1. Pattern - balances main memory usage and CPU.
297 2. Trie - a very high performance detection solution which uses more main
298 memory than Pattern.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100299
300To make with 51Degrees Pattern algorithm use the following command line.
301
Willy Tarreauc7203c72015-06-01 11:12:35 +0200302 $ make TARGET=linux26 USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/pattern
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100303
304To use the 51Degrees Trie algorithm use the following command line.
305
Willy Tarreauc7203c72015-06-01 11:12:35 +0200306 $ make TARGET=linux26 USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/trie
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100307
308A data file containing information about devices, browsers, operating systems
309and their associated signatures is then needed. 51Degrees provide a free
310database with Github repo for this purpose. These free data files are located
311in '51D_REPO_PATH'/data with the extensions .dat for Pattern data and .trie for
312Trie data.
313
314The configuration file needs to set the following parameters:
315
James Rosewella0c4c692015-09-18 17:21:37 +0100316 51degrees-data-file path to the Pattern or Trie data file
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100317 51degrees-property-name-list list of 51Degrees properties to detect
Dragan Dosen93b38d92015-06-29 16:43:25 +0200318 51degrees-property-separator separator to use between values
Dragan Dosenae6d39a2015-06-29 16:43:27 +0200319 51degrees-cache-size LRU-based cache size (disabled by default)
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100320
321The following is an example of the settings for Pattern.
322
James Rosewella0c4c692015-09-18 17:21:37 +0100323 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.dat
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100324 51degrees-property-name-list IsTablet DeviceType IsMobile
Dragan Dosen93b38d92015-06-29 16:43:25 +0200325 51degrees-property-separator ,
Dragan Dosenae6d39a2015-06-29 16:43:27 +0200326 51degrees-cache-size 10000
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100327
328HAProxy needs a way to pass device information to the backend servers. This is
James Rosewella0c4c692015-09-18 17:21:37 +0100329done by using the 51d converter or fetch method, which intercepts the HTTP
330headers and creates some new headers. This is controlled in the frontend
331http-in section.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100332
333The following is an example which adds two new HTTP headers prefixed X-51D-
334
335 frontend http-in
336 bind *:8081
337 default_backend servers
James Rosewella0c4c692015-09-18 17:21:37 +0100338 http-request set-header X-51D-DeviceTypeMobileTablet %[51d.all(DeviceType,IsMobile,IsTablet)]
339 http-request set-header X-51D-Tablet %[51d.all(IsTablet)]
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100340
341Here, two headers are created with 51Degrees data, X-51D-DeviceTypeMobileTablet
342and X-51D-Tablet. Any number of headers can be created this way and can be
James Rosewella0c4c692015-09-18 17:21:37 +0100343named anything. 51d.all( ) invokes the 51degrees fetch. It can be passed up to
344five property names of values to return. Values will be returned in the same
345order, seperated by the 51-degrees-property-separator configured earlier. If a
346property name can't be found the value 'NoData' is returned instead.
347
348In addition to the device properties three additional properties related to the
349validity of the result can be returned when used with the Pattern method. The
350following example shows how Method, Difference and Rank could be included as one
351new HTTP header X-51D-Stats.
352
353 http-request set-header X-51D-Stats %[51d.all(Method,Difference,Rank)]
354
355These values indicate how confident 51Degrees is in the result that that was
356returned. More information is available on the 51Degrees web site at:
357
358 https://51degrees.com/support/documentation/pattern
359
360The above 51d.all fetch method uses all available HTTP headers for detection. A
361modest performance improvement can be obtained by only passing one HTTP header
362to the detection method with the 51d.single converter. The following example
363uses the User-Agent HTTP header only for detection.
364
365 http-request set-header X-51D-DeviceTypeMobileTablet %[req.fhdr(User-Agent),51d.single(DeviceType,IsMobile,IsTablet)]
366
367Any HTTP header could be used inplace of User-Agent by changing the parameter
368provided to req.fhdr.
369
370When compiled to use the Trie detection method the trie format data file needs
371to be provided. Changing the extension of the data file from dat to trie will
372use the correct data.
373
374 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.trie
375
376When used with Trie the Method, Difference and Rank properties are not
377available.
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100378
379The free Lite data file contains information about screen size in pixels and
380whether the device is a mobile. A full list of available properties is located
381on the 51Degrees web site at:
382
James Rosewella0c4c692015-09-18 17:21:37 +0100383 https://51degrees.com/resources/property-dictionary
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100384
385Some properties are only available in the paid for Premium and Enterprise
James Rosewella0c4c692015-09-18 17:21:37 +0100386versions of 51Degrees. These data sets not only contain more properties but
Thomas Holmesf95aaf62015-05-29 15:21:42 +0100387are updated weekly and daily and contain signatures for 100,000s of different
388device combinations. For more information see the data options comparison web
389page:
390
391 https://51degrees.com/compare-data-options
392
393
Willy Tarreaub1a34b62010-05-09 22:37:12 +02003942) How to install it
395--------------------
396
397To install haproxy, you can either copy the single resulting binary to the
398place you want, or run :
399
400 $ sudo make install
401
402If you're packaging it for another system, you can specify its root directory
403in the usual DESTDIR variable.
404
405
4063) How to set it up
407-------------------
408
409There is some documentation in the doc/ directory :
410
Willy Tarreaud8e42b62015-08-18 21:51:36 +0200411 - intro.txt : this is an introduction to haproxy, it explains what it is
412 what it is not. Useful for beginners or to re-discover it when planning
413 for an upgrade.
414
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200415 - architecture.txt : this is the architecture manual. It is quite old and
416 does not tell about the nice new features, but it's still a good starting
417 point when you know what you want but don't know how to do it.
418
419 - configuration.txt : this is the configuration manual. It recalls a few
420 essential HTTP basic concepts, and details all the configuration file
421 syntax (keywords, units). It also describes the log and stats format. It
422 is normally always up to date. If you see that something is missing from
Willy Tarreau74774c02014-04-23 00:57:08 +0200423 it, please report it as this is a bug. Please note that this file is
424 huge and that it's generally more convenient to review Cyril Bonté's
425 HTML translation online here :
426
Willy Tarreau844028b2015-10-13 18:52:22 +0200427 http://cbonte.github.io/haproxy-dconv/configuration-1.6.html
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200428
Willy Tarreau373933d2015-10-13 16:32:20 +0200429 - management.txt : it explains how to start haproxy, how to manage it at
430 runtime, how to manage it on multiple nodes, how to proceed with seamless
431 upgrades.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200432
433 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
434 the 'LICENSE' file at the top for more information.
435
436 - the rest is mainly for developers.
437
438There are also a number of nice configuration examples in the "examples"
439directory as well as on several sites and articles on the net which are linked
440to from the haproxy web site.
441
442
4434) How to report a bug
444----------------------
445
446It is possible that from time to time you'll find a bug. A bug is a case where
447what you see is not what is documented. Otherwise it can be a misdesign. If you
448find that something is stupidly design, please discuss it on the list (see the
449"how to contribute" section below). If you feel like you're proceeding right
450and haproxy doesn't obey, then first ask yourself if it is possible that nobody
451before you has even encountered this issue. If it's unlikely, the you probably
452have an issue in your setup. Just in case of doubt, please consult the mailing
453list archives :
454
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200455 http://marc.info/?l=haproxy
456
457Otherwise, please try to gather the maximum amount of information to help
458reproduce the issue and send that to the mailing list :
459
460 haproxy@formilux.org
461
462Please include your configuration and logs. You can mask your IP addresses and
463passwords, we don't need them. But it's essential that you post your config if
464you want people to guess what is happening.
465
466Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
467without any reason, then it definitely is a critical bug that must be reported
468and urgently fixed. It has happened a couple of times in the past, essentially
469on development versions running on new architectures. If you think your setup
470is fairly common, then it is possible that the issue is totally unrelated.
471Anyway, if that happens, feel free to contact me directly, as I will give you
472instructions on how to collect a usable core file, and will probably ask for
473other captures that you'll not want to share with the list.
474
475
4765) How to contribute
477--------------------
478
Willy Tarreau11e334d92015-09-20 22:31:42 +0200479Please carefully read the CONTRIBUTING file that comes with the sources. It is
480mandatory.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200481
willy tarreau78345332005-12-18 01:33:16 +0100482-- end