mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-08-07 07:37:02 +02:00
Code Issues Projects Releases Wiki Activity

DOC: config: indent the list of environment variables

Browse Source 
In the doc our lists are indented but for any reason this one was not,
making it harder to visually delimit. Let's just indent it. No need to
backport this, it's totally cosmetic and would need adaptations since
it was recently touched.
This commit is contained in:
Willy Tarreau 2024-11-20 15:51:35 +01:00
parent 41d906d69b
commit 311dc748b0
1 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/configuration.txt
View File

@ -1007,64 +1007,64 @@ modes:
The variables in question are the following: The variables in question are the following:
* HAPROXY_LOCALPEER: defined at the startup of the process which contains the * HAPROXY_LOCALPEER: defined at the startup of the process which contains the
name of the local peer. (See "-L" in the management guide.) name of the local peer. (See "-L" in the management guide.)
* HAPROXY_CFGFILES: list of the configuration files loaded by HAProxy, * HAPROXY_CFGFILES: list of the configuration files loaded by HAProxy,
separated by semicolons. Can be useful in the case you specified a separated by semicolons. Can be useful in the case you specified a
directory. directory.
* HAPROXY_HTTP_LOG_FMT: contains the value of the default HTTP log format as * HAPROXY_HTTP_LOG_FMT: contains the value of the default HTTP log format as
defined in section 8.2.3 "HTTP log format". It can be used to override the defined in section 8.2.3 "HTTP log format". It can be used to override the
default log format without having to copy the whole original definition. default log format without having to copy the whole original definition.
* HAPROXY_HTTP_CLF_LOG_FMT: contains the value of the default HTTP CLF log * HAPROXY_HTTP_CLF_LOG_FMT: contains the value of the default HTTP CLF log
format as defined in section 8.2.3 "HTTP log format". It can be used to format as defined in section 8.2.3 "HTTP log format". It can be used to
override the default log format without having to copy the whole original override the default log format without having to copy the whole original
definition. definition.
Example: Example:
# Add the rule that gave the final verdict to the log # Add the rule that gave the final verdict to the log
log-format "${HAPROXY_TCP_LOG_FMT} lr=last_rule_file:last_rule_line" log-format "${HAPROXY_TCP_LOG_FMT} lr=last_rule_file:last_rule_line"
* HAPROXY_HTTPS_LOG_FMT: similar to HAPROXY_HTTP_LOG_FMT but for HTTPS log * HAPROXY_HTTPS_LOG_FMT: similar to HAPROXY_HTTP_LOG_FMT but for HTTPS log
format as defined in section 8.2.4 "HTTPS log format". format as defined in section 8.2.4 "HTTPS log format".
* HAPROXY_TCP_LOG_FMT: similar to HAPROXY_HTTP_LOG_FMT but for TCP log format * HAPROXY_TCP_LOG_FMT: similar to HAPROXY_HTTP_LOG_FMT but for TCP log format
as defined in section 8.2.2 "TCP log format". as defined in section 8.2.2 "TCP log format".
* HAPROXY_TCP_CLF_LOG_FMT: similar to HAPROXY_HTTP_CLF_LOG_FMT but for TCP CLF * HAPROXY_TCP_CLF_LOG_FMT: similar to HAPROXY_HTTP_CLF_LOG_FMT but for TCP
log format as defined in section 8.2.2 "TCP log format". CLF log format as defined in section 8.2.2 "TCP log format".
* HAPROXY_MWORKER: In master-worker mode, this variable is set to 1. * HAPROXY_MWORKER: In master-worker mode, this variable is set to 1.
* HAPROXY_CLI: configured listeners addresses of the stats socket of every * HAPROXY_CLI: configured listeners addresses of the stats socket of every
processe, these addresses are separated by semicolons. processe, these addresses are separated by semicolons.
* HAPROXY_MASTER_CLI: In master-worker mode, listeners addresses of the master * HAPROXY_MASTER_CLI: In master-worker mode, listeners addresses of the master
CLI, separated by semicolons. CLI, separated by semicolons.
* HAPROXY_STARTUP_VERSION: contains the version used to start, in master-worker * HAPROXY_STARTUP_VERSION: contains the version used to start, in master-
mode this is the version which was used to start the master, even after worker mode this is the version which was used to start the master, even
updating the binary and reloading. after updating the binary and reloading.
* HAPROXY_BRANCH: contains the HAProxy branch version (such as "2.8"). It does * HAPROXY_BRANCH: contains the HAProxy branch version (such as "2.8"). It
not contain the full version number. It can be useful in case of migration does not contain the full version number. It can be useful in case of
if resources (such as maps or certificates) are in a path containing the migration if resources (such as maps or certificates) are in a path
branch number. containing the branch number.
In addition, some pseudo-variables are internally resolved and may be used as In addition, some pseudo-variables are internally resolved and may be used as
regular variables. Pseudo-variables always start with a dot ('.'), and are the regular variables. Pseudo-variables always start with a dot ('.'), and are the
only ones where the dot is permitted. The current list of pseudo-variables is: only ones where the dot is permitted. The current list of pseudo-variables is:
* .FILE: the name of the configuration file currently being parsed. * .FILE: the name of the configuration file currently being parsed.
* .LINE: the line number of the configuration file currently being parsed, * .LINE: the line number of the configuration file currently being parsed,
starting at one. starting at one.
* .SECTION: the name of the section currently being parsed, or its type if the * .SECTION: the name of the section currently being parsed, or its type if
section doesn't have a name (e.g. "global"), or an empty string before the the section doesn't have a name (e.g. "global"), or an empty string before
first section. the first section.
These variables are resolved at the location where they are parsed. For example These variables are resolved at the location where they are parsed. For example
if a ".LINE" variable is used in a "log-format" directive located in a defaults if a ".LINE" variable is used in a "log-format" directive located in a defaults