RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DOC: Fix "errorfile" description in the configuration manual 

"errorfile" description is outdated. Now, error messages are parsed at startup
and converted to HTX messages. So they must be valid according to the HTTP
standards. In addition, there is now a comment about the reserved buffer space
that should remain available to allow header rewrites.
This commit is contained in:
Christopher Faulet 2020-05-18 17:42:48 +02:00
parent 3b967c1210
commit 7017067d68
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/configuration.txt
View File

@ -3793,17 +3793,15 @@ errorfile <code> <file>
Code 200 is emitted in response to requests matching a "monitor-uri" rule. Code 200 is emitted in response to requests matching a "monitor-uri" rule.
The files are returned verbatim on the TCP socket. This allows any trick such The files are parsed when HAProxy starts and must be valid according to the
as redirections to another URL or site, as well as tricks to clean cookies, HTTP specification. They should not exceed the configured buffer size
force enable or disable caching, etc... The package provides default error (BUFSIZE), which generally is 16 kB, otherwise an internal error will be
files returning the same contents as default errors. returned. It is also wise not to put any reference to local contents
(e.g. images) in order to avoid loops between the client and HAProxy when all
The files should not exceed the configured buffer size (BUFSIZE), which servers are down, causing an error to be returned instead of an
generally is 8 or 16 kB, otherwise they will be truncated. It is also wise image. Finally, The response cannot exceed (tune.bufsize - tune.maxrewrite)
not to put any reference to local contents (e.g. images) in order to avoid so that "http-after-response" rules still have room to operate (see
loops between the client and HAProxy when all servers are down, causing an "tune.maxrewrite").
error to be returned instead of an image. For better HTTP compliance, it is
recommended that all header lines end with CR-LF and not LF alone.
The files are read at the same time as the configuration and kept in memory. The files are read at the same time as the configuration and kept in memory.
For this reason, the errors continue to be returned even when the process is For this reason, the errors continue to be returned even when the process is