HAProxy Documentation
  • Starter Guide
  • Configuration Manual
  • Management Guide
  • HAProxy Home Page
  • Summary
  • Keywords
1. Quick reminder about HTTP
1.1.
The HTTP transaction model
1.2.
HTTP request
1.2.1.
The request line
1.2.2.
The request headers
1.3.
HTTP response
1.3.1.
The response line
1.3.2.
The response headers

2.
Configuring HAProxy
2.1.
Configuration file format
2.2.
Quoting and escaping
2.3.
Environment variables
2.4.
Conditional blocks
2.5.
Time format
2.6.
Size format
2.7.
Examples

3.
Global parameters
3.1.
Process management and security
3.2.
Performance tuning
3.3.
Debugging
3.4.
Userlists
3.5.
Peers
3.6.
Mailers
3.7.
Programs
3.8.
HTTP-errors
3.9.
Rings
3.10.
Log forwarding
3.11.
HTTPClient tuning

4.
Proxies
4.1.
Proxy keywords matrix
4.2.
Alphabetically sorted keywords reference

5.
Bind and server options
5.1.
Bind options
5.2.
Server and default-server options
5.3.
Server DNS resolution
5.3.1.
Global overview
5.3.2.
The resolvers section

6.
Cache
6.1.
Limitation
6.2.
Setup
6.2.1.
Cache section
6.2.2.
Proxy section

7.
Using ACLs and fetching samples
7.1.
ACL basics
7.1.1.
Matching booleans
7.1.2.
Matching integers
7.1.3.
Matching strings
7.1.4.
Matching regular expressions (regexes)
7.1.5.
Matching arbitrary data blocks
7.1.6.
Matching IPv4 and IPv6 addresses
7.2.
Using ACLs to form conditions
7.3.
Fetching samples
7.3.1.
Converters
7.3.2.
Fetching samples from internal states
7.3.3.
Fetching samples at Layer 4
7.3.4.
Fetching samples at Layer 5
7.3.5.
Fetching samples from buffer contents (Layer 6)
7.3.6.
Fetching HTTP samples (Layer 7)
7.3.7.
Fetching samples for developers
7.4.
Pre-defined ACLs

8.
Logging
8.1.
Log levels
8.2.
Log formats
8.2.1.
Default log format
8.2.2.
TCP log format
8.2.3.
HTTP log format
8.2.4.
HTTPS log format
8.2.5.
Error log format
8.2.6.
Custom log format
8.3.
Advanced logging options
8.3.1.
Disabling logging of external tests
8.3.2.
Logging before waiting for the session to terminate
8.3.3.
Raising log level upon errors
8.3.4.
Disabling logging of successful connections
8.4.
Timing events
8.5.
Session state at disconnection
8.6.
Non-printable characters
8.7.
Capturing HTTP cookies
8.8.
Capturing HTTP headers
8.9.
Examples of logs

9.
Supported filters
9.1.
Trace
9.2.
HTTP compression
9.3.
Stream Processing Offload Engine (SPOE)
9.4.
Cache
9.5.
fcgi-app
9.6.
OpenTracing
9.7.
Bandwidth limitation

10.
FastCGI applications
10.1.
Setup
10.1.1.
Fcgi-app section
10.1.2.
Proxy section
10.1.3.
Example
10.2.
Default parameters
10.3.
Limitations

11.
Address formats
11.1.
Address family prefixes
11.2.
Socket type prefixes
11.3.
Protocol prefixes

5

51d.all 51d.single 51degrees-allow-unmatched 51degrees-cache-size 51degrees-data-file 51degrees-difference 51degrees-drift 51degrees-property-name-list 51degrees-property-separator 51degrees-use-performance-graph 51degrees-use-predictive-graph

A

accept-netscaler-cip accept-proxy accepted_payload_size acl (Fcgi-app section) acl (Alphabetically sorted keywords reference) add add_item addr aes_gcm_dec agent-addr agent-check agent-inter agent-port agent-send allow-0rtt (Bind options) allow-0rtt (Server and default-server options) alpn (Bind options) alpn (Server and default-server options) always_false always_true and anonkey avg_queue

B

b64dec backing-file backlog (Log forwarding) backlog (Alphabetically sorted keywords reference) backlog (Bind options) backup balance balance url_param base base32 base32+src base64 baseq bc_dst bc_dst_port bc_err bc_err_str bc_glitches bc_http_major bc_rtt bc_rttvar bc_src bc_src_port be2dec be2hex be_conn be_conn_free be_id be_name be_server_timeout be_sess_rate be_tunnel_timeout bin bind (Log forwarding) bind (Peers) bind (Alphabetically sorted keywords reference) bool (Converters) bool (Fetching samples from internal states) busy-polling bytes

C

ca-base ca-file (Bind options) ca-file (Server and default-server options) ca-ignore-err ca-sign-file ca-sign-pass ca-verify-file cache capture capture cookie capture request capture request header capture response capture response header capture-req capture-res capture.req.hdr capture.req.method capture.req.uri capture.req.ver capture.res.hdr capture.res.ver check check-alpn check-proto check-send-proxy check-sni check-ssl check-via-socks4 chroot ciphers (Bind options) ciphers (Server and default-server options) ciphersuites (Bind options) ciphersuites (Server and default-server options) client-sigalgs clitcpka-cnt clitcpka-idle clitcpka-intvl close-spread-time cluster-secret command compression compression algo compression algo-req compression algo-res compression direction compression offload compression type concat connslots cook cook_cnt cook_val cookie (Alphabetically sorted keywords reference) cookie (Server and default-server options) cookie (Fetching HTTP samples (Layer 7)) cpl cpu-map cpu_calls cpu_ns_avg cpu_ns_tot crc32 crc32c crl-file (Bind options) crl-file (Server and default-server options) crt (Bind options) crt (Server and default-server options) crt-base crt-ignore-err crt-list cur_server_timeout cur_tunnel_timeout curves cut_crlf

D

da-csv-conv daemon date date_us debug declare declare capture default-bind default-path default-server (Peers) default-server (Alphabetically sorted keywords reference) default_backend defer-accept description (Process management and security) description (Rings) description (Alphabetically sorted keywords reference) deviceatlas-json-file deviceatlas-log-level deviceatlas-properties-cookie deviceatlas-separator dgram-bind digest disabled (Peers) disabled (Alphabetically sorted keywords reference) disabled (Server and default-server options) dispatch distcc_body distcc_param div djb2 docroot downinter dst dst_conn dst_is_local dst_port dynamic-cookie-key

E

ecdhe email-alert email-alert from email-alert level email-alert mailers email-alert myhostname email-alert to enabled (Peers) enabled (Alphabetically sorted keywords reference) enabled (Server and default-server options) env error-limit error-log-format errorfile (HTTP-errors) errorfile (Alphabetically sorted keywords reference) errorfiles errorloc errorloc302 errorloc303 even expose-experimental-directives expose-fd expose-fd listeners external-check external-check command external-check path

F

fall fastinter fc_dst fc_dst_is_local fc_dst_port fc_err fc_err_str fc_fackets fc_glitches fc_http_major fc_lost fc_pp_authority fc_pp_unique_id fc_rcvd_proxy fc_reordering fc_retrans fc_rtt fc_rttvar fc_sacked fc_src fc_src_is_local fc_src_port fc_unacked fcgi-app fd-hard-limit fe_client_timeout fe_conn fe_defbe fe_id fe_name fe_req_rate fe_sess_rate field filter (Alphabetically sorted keywords reference) filter (Trace) filter (HTTP compression) filter (Stream Processing Offload Engine (SPOE)) filter (Cache) filter (fcgi-app) filter (OpenTracing) filter (Bandwidth limitation) filter bwlim-in filter bwlim-out filter cache filter compression filter fcgi-app filter opentracing filter spoe filter trace fix_is_valid fix_tag_value force-persist force-sslv3 force-tlsv10 force-tlsv11 force-tlsv12 force-tlsv13 format fullconn

G

generate-certificates gid (Process management and security) gid (Bind options) grace group (Process management and security) group (Userlists) group (Programs) group (Bind options)

H

h1-accept-payload-with-any-method h1-case-adjust h1-case-adjust-file h2-workaround-bogus-websocket-clients hard-stop-after harden.reject-privileged-ports.quic harden.reject-privileged-ports.tcp hash-balance-factor hash-type hdr hdr_cnt hdr_ip hdr_val hex hex2i hmac hold host_only hostname htonl