From a7cbafde11b867c10e6d5d98d170651c196bf396 Mon Sep 17 00:00:00 2001 From: Aki Tuomi Date: Wed, 22 Nov 2023 12:11:18 +0200 Subject: [PATCH] config_variables: Document system: key --- .../config_file/config_variables.rst | 60 ++++++++++++------- 1 file changed, 40 insertions(+), 20 deletions(-) diff --git a/source/configuration_manual/config_file/config_variables.rst b/source/configuration_manual/config_file/config_variables.rst index 6381f03b55..e9e7b0c828 100644 --- a/source/configuration_manual/config_file/config_variables.rst +++ b/source/configuration_manual/config_file/config_variables.rst @@ -19,26 +19,20 @@ Global variables Global variables that work everywhere are: -+------------+-----------------------------------------------------------------------------+ -| Long name | Description | -+============+=============================================================================+ -| %% | '%' character. See :ref:`user_shared_mailboxes` | -| | for further information about %% variables | -+------------+-----------------------------------------------------------------------------+ -| env: | Environment variable | -+------------+-----------------------------------------------------------------------------+ -| uid | Effective UID of the current process NOTE: This is overridden for | -| | :ref:`mail service user variables `. | -+------------+-----------------------------------------------------------------------------+ -| gid | Effective GID of the current process NOTE: This is overridden for | -| | :ref:`mail service user variables `. | -+------------+-----------------------------------------------------------------------------+ -| pid | PID of the current process (e.g. login or imap/pop3 process). | -+------------+-----------------------------------------------------------------------------+ -| hostname | Hostname (without domain). Can be overridden with DOVECOT_HOSTNAME | -| | environment variable. NOTE: This is overridden for | -| | :ref:`mail user variables `. | -+------------+-----------------------------------------------------------------------------+ ++----------------+-----------------------------------------------------------------------------+ +| Long name | Description | ++================+=============================================================================+ +| %% | '%' character. See :ref:`user_shared_mailboxes` | +| | for further information about %% variables | ++----------------+-----------------------------------------------------------------------------+ +| env: | Environment variable | ++----------------+-----------------------------------------------------------------------------+ +| system: | Get a system variable, see :ref:`below ` | +| | for list of supported names. | ++----------------+-----------------------------------------------------------------------------+ +| process: | Get a process variable, see :ref:`below ` | +| | for list of supported names. | ++----------------+-----------------------------------------------------------------------------+ If :ref:`var_expand_crypt_plugin` is loaded, these also work globally: @@ -54,6 +48,32 @@ If :ref:`var_expand_crypt_plugin` is loaded, these also work globally: | | .. dovecotadded:: 2.2.29 | +-------------------------------+-----------------------------+ +.. _variables-system-variables: + +Supported system variables +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +``cpu_count`` + Number of CPUs available. Works only on Linux and FreeBSD-like systems. +``hostname`` + Hostname (without domain). Can be overridden with DOVECOT_HOSTNAME + environment variable. NOTE: This is overridden for + :ref:`mail user variables `. + +.. _variables-process-variables: + +Supported process variables +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +``pid`` + Current process ID. +``uid`` + Effective user ID of the current process NOTE: This is overridden for + :ref:`mail service user variables ` +``gid`` + Effective group ID of the current process NOTE: This is overridden for + :ref:`mail service user variables ` + .. _variables-user: User variables