From 8e6ad2548ce933ef52113b20f2766d66d16f3e39 Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Wed, 16 Nov 2022 17:42:34 +0100 Subject: [PATCH] DOC: config: fix alphabetical ordering of global section the global section keywords were seriously misordered, and it's visible that some mistakes have induced other ones over time, so it was about time to fix this. Roughly 20% of the keywords were misplaced. This commit only reordered the keywords index and their description, nothing else was changed. It might be backported because it's a real pain to find certain options there. --- doc/configuration.txt | 426 +++++++++++++++++++++--------------------- 1 file changed, 213 insertions(+), 213 deletions(-) diff --git a/doc/configuration.txt b/doc/configuration.txt index 7ce7ae5e0..4883295a7 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -997,40 +997,44 @@ of them have command-line equivalents. The following keywords are supported in the "global" section : * Process management and security + - 51degrees-cache-size + - 51degrees-data-file + - 51degrees-property-name-list + - 51degrees-property-separator - ca-base - chroot - cluster-secret - - crt-base - cpu-map + - crt-base - daemon - default-path - description - deviceatlas-json-file - deviceatlas-log-level - - deviceatlas-separator - deviceatlas-properties-cookie + - deviceatlas-separator - expose-experimental-directives - external-check - fd-hard-limit - gid - grace - group + - h1-accept-payload-with-any-method + - h1-case-adjust + - h1-case-adjust-file + - h2-workaround-bogus-websocket-clients - hard-stop-after - httpclient.resolvers.id - httpclient.resolvers.prefer - httpclient.ssl.ca-file - httpclient.ssl.verify - - h1-accept-payload-with-any-method - - h1-case-adjust - - h1-case-adjust-file - insecure-fork-wanted - insecure-setuid-wanted - issuers-chain-path - - h2-workaround-bogus-websocket-clients - localpeer - log - - log-tag - log-send-hostname + - log-tag - lua-load - lua-load-per-thread - lua-prepend-path @@ -1042,13 +1046,9 @@ The following keywords are supported in the "global" section : - pp2-never-send-local - presetenv - resetenv - - uid - - ulimit-n - - user - set-dumpable - set-var - setenv - - stats - ssl-default-bind-ciphers - ssl-default-bind-ciphersuites - ssl-default-bind-curves @@ -1062,25 +1062,25 @@ The following keywords are supported in the "global" section : - ssl-provider-path - ssl-server-verify - ssl-skip-self-issued-ca + - stats + - strict-limits + - uid + - ulimit-n - unix-bind - unsetenv - - 51degrees-data-file - - 51degrees-property-name-list - - 51degrees-property-separator - - 51degrees-cache-size + - user + - wurfl-cache-size - wurfl-data-file - wurfl-information-list - wurfl-information-list-separator - - wurfl-cache-size - - strict-limits * Performance tuning - busy-polling - max-spread-checks + - maxcompcpuusage + - maxcomprate - maxconn - maxconnrate - - maxcomprate - - maxcompcpuusage - maxpipes - maxsessrate - maxsslconn @@ -1088,16 +1088,16 @@ The following keywords are supported in the "global" section : - maxzlibmem - no-memory-trimming - noepoll - - nokqueue - noevports - - nopoll - - nosplice - nogetaddrinfo + - nokqueue + - nopoll - noreuseport + - nosplice - profiling.tasks - - spread-checks - server-state-base - server-state-file + - spread-checks - ssl-engine - ssl-mode-async - tune.buffers.limit @@ -1115,9 +1115,9 @@ The following keywords are supported in the "global" section : - tune.idletimer - tune.lua.forced-yield - tune.lua.maxmem + - tune.lua.service-timeout - tune.lua.session-timeout - tune.lua.task-timeout - - tune.lua.service-timeout - tune.maxaccept - tune.maxpollevents - tune.maxrewrite @@ -1138,15 +1138,15 @@ The following keywords are supported in the "global" section : - tune.sndbuf.client - tune.sndbuf.server - tune.ssl.cachesize + - tune.ssl.capture-buffer-size + - tune.ssl.capture-cipherlist-size (deprecated) + - tune.ssl.default-dh-param - tune.ssl.force-private-cache - tune.ssl.hard-maxrecord - tune.ssl.keylog - tune.ssl.lifetime - tune.ssl.maxrecord - - tune.ssl.default-dh-param - tune.ssl.ssl-ctx-cache-size - - tune.ssl.capture-buffer-size - - tune.ssl.capture-cipherlist-size (deprecated) - tune.vars.global-max-size - tune.vars.proc-max-size - tune.vars.reqres-max-size @@ -1164,6 +1164,36 @@ The following keywords are supported in the "global" section : 3.1. Process management and security ------------------------------------ +51degrees-data-file + The path of the 51Degrees data file to provide device detection services. The + file should be unzipped and accessible by HAProxy with relevant permissions. + + Please note that this option is only available when HAProxy has been + compiled with USE_51DEGREES. + +51degrees-property-name-list [ ...] + A list of 51Degrees property names to be load from the dataset. A full list + of names is available on the 51Degrees website: + https://51degrees.com/resources/property-dictionary + + Please note that this option is only available when HAProxy has been + compiled with USE_51DEGREES. + +51degrees-property-separator + A char that will be appended to every property value in a response header + containing 51Degrees results. If not set that will be set as ','. + + Please note that this option is only available when HAProxy has been + compiled with USE_51DEGREES. + +51degrees-cache-size + Sets the size of the 51Degrees converter cache to entries. This + is an LRU cache which reminds previous device detections and their results. + By default, this cache is disabled. + + Please note that this option is only available when HAProxy has been + compiled with USE_51DEGREES. + ca-base Assigns a default directory to fetch SSL CA certificates and CRLs from when a relative path is used with "ca-file", "ca-verify-file" or "crl-file" @@ -1178,14 +1208,6 @@ chroot with superuser privileges. It is important to ensure that is both empty and non-writable to anyone. -cluster-secret - Define an ASCII string secret shared between several nodes belonging to the - same cluster. It could be used for different usages. It is at least used to - derive stateless reset tokens for all the QUIC connections instantiated by - this process. This is also the case to derive secrets used to encrypt Retry - tokens. If you do not set this parameter, the stateless reset and Retry QUIC - features will be both silently disabled. - close-spread-time