From: Willy Tarreau Date: Thu, 27 Dec 2007 17:26:09 +0000 (+0100) Subject: [DOC] large update to the configuration manual X-Git-Tag: v1.3.15~83 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2769aa050a90aa9a4e59477297ef8dffea2d968d;p=thirdparty%2Fhaproxy.git [DOC] large update to the configuration manual Keywords from "errorloc" to "monitor-uri" inclusive have been added. Some fixes applied too. --- diff --git a/doc/configuration.txt b/doc/configuration.txt index fbaeef8716..903dccc8dd 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -2,9 +2,9 @@ HAProxy Configuration Manual ---------------------- - version 1.3.14 + version 1.3.14.2 willy tarreau - 2007/12/24 + 2007/12/27 This document covers the configuration language as implemented in the version @@ -108,7 +108,7 @@ log
[max level]
can be one of: - - An IPv4 address optionally followed by a colon and an UDP port. If + - An IPv4 address optionally followed by a colon and a UDP port. If no port is specified, 514 is used by default (the standard syslog port). @@ -1064,6 +1064,8 @@ default_backend use_backend static if url_css url_img extension_img default_backend dynamic + See also : "use_backend", "reqsetbe", "reqisetbe" + disabled Disable a proxy, frontend or backend. @@ -1125,11 +1127,116 @@ errorfile See also : "errorloc", "errorloc302", "errorloc303" +errorloc +errorloc302 + Return an HTTP redirection to a URL instead of errors generated by HAProxy + May be used in sections : defaults | frontend | listen | backend + yes | yes | yes | yes + Arguments : + is the HTTP status code. Currently, HAProxy is capable of + generating codes 400, 403, 408, 500, 502, 503, and 504. + + it is the exact contents of the "Location" header. It may contain + either a relative URI to an error page hosted on the same site, + or an absolute URI designating an error page on another site. + Special care should be given to relative URIs to avoid redirect + loops if the URI itself may generate the same error (eg: 500). + + It is important to understand that this keyword is not meant to rewrite + errors returned by the server, but errors detected and returned by HAProxy. + This is why the list of supported errors is limited to a small set. + + Note that both keyword return the HTTP 302 status code, which tells the + client to fetch the designated URL using the same HTTP method. This can be + quite problematic in case of non-GET methods such as POST, because the URL + sent to the client might not be allowed for something other than GET. To + workaround this problem, please use "errorloc303" which send the HTTP 303 + status code, indicating to the client that the URL must be fetched with a GET + request. + + See also : "errorfile", "errorloc303" + + +errorloc303 + Return an HTTP redirection to a URL instead of errors generated by HAProxy + May be used in sections : defaults | frontend | listen | backend + yes | yes | yes | yes + Arguments : + is the HTTP status code. Currently, HAProxy is capable of + generating codes 400, 403, 408, 500, 502, 503, and 504. + + it is the exact contents of the "Location" header. It may contain + either a relative URI to an error page hosted on the same site, + or an absolute URI designating an error page on another site. + Special care should be given to relative URIs to avoid redirect + loops if the URI itself may generate the same error (eg: 500). + + It is important to understand that this keyword is not meant to rewrite + errors returned by the server, but errors detected and returned by HAProxy. + This is why the list of supported errors is limited to a small set. + + Note that both keyword return the HTTP 303 status code, which tells the + client to fetch the designated URL using the same HTTP GET method. This + solves the usual problems associated with "errorloc" and the 302 code. It is + possible that some very old browsers designed before HTTP/1.1 do not support + it, but no such problem have been reported till now. + + See also : "errorfile", "errorloc", "errorloc302" + + +fullconn + Specify at what backend load the servers will reach their maxconn + May be used in sections : defaults | frontend | listen | backend + yes | no | yes | yes + Arguments : + is the number of connections on the backend which will make the + servers use the maximal number of connections. + + When a server has a 'maxconn' parameter specified, it means that its number + of concurrent connections will never go higher. Additionally, if it has a + 'minconn' parameter, it indicates a dynamic limit following the backend's + load. The server will then always accept at least connections, + never more than , and the limit will be on the ramp between both + values when the backend has less than concurrent connections. This + makes it possible to limit the load on the servers during normal loads, but + push it further for important loads without overloading the servers during + exceptionnal loads. + + Example : + # The servers will accept between 100 and 1000 concurrent connections each + # and the maximum of 1000 will be reached when the backend reaches 10000 + # connections. + backend dynamic + fullconn 10000 + server srv1 dyn1:80 minconn 100 maxconn 1000 + server srv2 dyn2:80 minconn 100 maxconn 1000 + + See also : "maxconn", "server" + + +grace