From 0e82b92a970a71e099cea1ea395113ecd4f9852f Mon Sep 17 00:00:00 2001 From: Jarno Huuskonen Date: Sat, 12 Apr 2014 18:22:19 +0300 Subject: [PATCH] DOC: fix a few config typos. Here's a small patch that fixes a few typos in configuration.txt (and one in haproxy.1). --- doc/configuration.txt | 113 ++++++++++++++++++++++-------------------- doc/haproxy.1 | 2 +- 2 files changed, 60 insertions(+), 55 deletions(-) diff --git a/doc/configuration.txt b/doc/configuration.txt index 5873fc3f4b..fcd58eff60 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -475,6 +475,7 @@ The following keywords are supported in the "global" section : - nokqueue - nopoll - nosplice + - nogetaddrinfo - spread-checks - tune.bufsize - tune.chksize @@ -632,7 +633,7 @@ stats bind-process [ all | odd | even | [-] ] ... ssl-default-bind-ciphers This setting is only available when support for OpenSSL was built in. It sets the default string describing the list of cipher algorithms ("cipher suite") - that are negociated during the SSL/TLS handshake for all "bind" lines which + that are negotiated during the SSL/TLS handshake for all "bind" lines which do not explicitly define theirs. The format of the string is defined in "man 1 ciphers" from OpenSSL man pages, and can be for instance a string such as "AES:ALL:!aNULL:!eNULL:+RC4:@STRENGTH" (without quotes). Please check the @@ -641,7 +642,7 @@ ssl-default-bind-ciphers ssl-default-server-ciphers This setting is only available when support for OpenSSL was built in. It sets the default string describing the list of cipher algorithms that are - negociated during the SSL/TLS handshake with the server, for all "server" + negotiated during the SSL/TLS handshake with the server, for all "server" lines which do not explicitly define theirs. The format of the string is defined in "man 1 ciphers". Please check the "server" keyword for more information. @@ -736,7 +737,7 @@ maxconnrate maxcomprate Sets the maximum per-process input compression rate to kilobytes - pers second. For each session, if the maximum is reached, the compression + per second. For each session, if the maximum is reached, the compression level will be decreased during the session. If the maximum is reached at the beginning of a session, the session will not compress at all. If the maximum is not reached, the compression level will be increased up to @@ -826,6 +827,10 @@ nosplice case of doubt. See also "option splice-auto", "option splice-request" and "option splice-response". +nogetaddrinfo + Disables the use of getaddrinfo(3) for name resolving. It is equivalent to + the command line argument "-dG". Deprecated gethostbyname(3) will be used. + spread-checks <0..50, in percent> Sometimes it is desirable to avoid sending agent and health checks to servers at exact intervals, for instance when many logical servers are @@ -958,7 +963,7 @@ tune.ssl.cachesize Sets the size of the global SSL session cache, in a number of blocks. A block is large enough to contain an encoded session without peer certificate. An encoded session with peer certificate is stored in multiple blocks - depending on the size of the peer certificate. A block use approximatively + depending on the size of the peer certificate. A block uses approximately 200 bytes of memory. The default value may be forced at build time, otherwise defaults to 20000. When the cache is full, the most idle entries are purged and reassigned. Higher values reduce the occurrence of such a purge, hence @@ -969,7 +974,7 @@ tune.ssl.cachesize tune.ssl.lifetime Sets how long a cached SSL session may remain valid. This time is expressed - in seconds and defaults to 300 (5 mn). It is important to understand that it + in seconds and defaults to 300 (5 min). It is important to understand that it does not guarantee that sessions will last that long, because if the cache is full, the longest idle sessions will be purged despite their configured lifetime. The real usefulness of this setting is to prevent sessions from @@ -991,7 +996,7 @@ tune.ssl.maxrecord tune.zlib.memlevel Sets the memLevel parameter in zlib initialization for each session. It - defines how much memory should be allocated for the intenal compression + defines how much memory should be allocated for the internal compression state. A value of 1 uses minimum memory but is slow and reduces compression ratio, a value of 9 uses maximum memory for optimal speed. Can be a value between 1 and 9. The default value is 8. @@ -1038,7 +1043,7 @@ user [password|insecure-password ] evaluated using the crypt(3) function so depending of the system's capabilities, different algorithms are supported. For example modern Glibc based Linux system supports MD5, SHA-256, SHA-512 and of course classic, - DES-based method of crypting passwords. + DES-based method of encrypting passwords. Example: @@ -1541,7 +1546,7 @@ balance url_param [check_post []] adjusted on the fly for slow starts for instance. first The first server with available connection slots receives the - connection. The servers are choosen from the lowest numeric + connection. The servers are chosen from the lowest numeric identifier to the highest (see server parameter "id"), which defaults to the server's position in the farm. Once a server reaches its maxconn value, the next server is used. It does @@ -2650,7 +2655,7 @@ hash-type is the hash function to be used : - sdbm this function was created intially for sdbm (a public-domain + sdbm this function was created initially for sdbm (a public-domain reimplementation of ndbm) database library. It was found to do well in scrambling bits, causing better distribution of the keys and fewer splits. It also happens to be a good general hashing @@ -2873,7 +2878,7 @@ http-request { allow | deny | tarpit | auth [realm ] | redirect | when they're limited on the number of concurrent requests. It can be very efficient against very dumb robots, and will significantly reduce the load on firewalls compared to a "deny" rule. But when facing "correctly" - developped robots, it can make things worse by forcing haproxy and the + developed robots, it can make things worse by forcing haproxy and the front firewall to support insane number of concurrent connections. - "auth" : this stops the evaluation of the rules and immediately responds @@ -3274,7 +3279,7 @@ ignore-persist { if | unless } The "ignore-persist" statement allows one to declare various ACL-based conditions which, when met, will cause a request to ignore persistence. This is sometimes useful to load balance requests for static files, which - oftenly don't require persistence. This can also be used to fully disable + often don't require persistence. This can also be used to fully disable persistence for a specific User-Agent (for example, some web crawler bots). Combined with "appsession", it can also help reduce HAProxy memory usage, as @@ -4121,7 +4126,7 @@ no option http-tunnel "option http-tunnel". Option "http-tunnel" disables any HTTP processing past the first request and - the first respones. This is the mode which was used by default in versions + the first response. This is the mode which was used by default in versions 1.0 to 1.5-dev21. It is the mode with the lowest processing overhead, which is normally not needed anymore unless in very specific cases such as when using an in-house protocol that looks like HTTP but is not compatible, or @@ -4357,7 +4362,7 @@ no option independent-streams data sent to the server. Doing so will typically break large HTTP posts from slow lines, so use it with caution. - Note: older versions used to call this setting "option independant-streams" + Note: older versions used to call this setting "option independent-streams" with a spelling mistake. This spelling is still supported but deprecated. @@ -4917,23 +4922,23 @@ option tcp-check - no "tcp-check" directive : the health check only consists in a connection attempt, which remains the default mode. - - "tcp-check send" or "tcp-check send-binary" only is mentionned : this is + - "tcp-check send" or "tcp-check send-binary" only is mentioned : this is used to send a string along with a connection opening. With some protocols, it helps sending a "QUIT" message for example that prevents the server from logging a connection error for each health check. The check result will still be based on the ability to open the connection only. - - "tcp-check expect" only is mentionned : this is used to test a banner. + - "tcp-check expect" only is mentioned : this is used to test a banner. The connection is opened and haproxy waits for the server to present some contents which must validate some rules. The check result will be based on the matching between the contents and the rules. This is suited for POP, IMAP, SMTP, FTP, SSH, TELNET. - - both "tcp-check send" and "tcp-check expect" are mentionned : this is + - both "tcp-check send" and "tcp-check expect" are mentioned : this is used to test a hello-type protocol. Haproxy sends a message, the server responds and its response is analysed. the check result will be based on - the maching between the response contents and the rules. This is often + the matching between the response contents and the rules. This is often suited for protocols which require a binding or a request/response model. LDAP, MySQL, Redis and SSL are example of such protocols, though they already all have their dedicated checks with a deeper understanding of @@ -4952,7 +4957,7 @@ option tcp-check # look for the redis master server after ensuring it speaks well # redis protocol, then it exits properly. - # (send a command then analyse the response 3 tims) + # (send a command then analyse the response 3 times) option tcp-check tcp-check send PING\r\n tcp-check expect +PONG @@ -5226,7 +5231,7 @@ redirect scheme [code ]