config_variables: Document system: key

dovecot · Nov 22, 2023 · a7cbafd · a7cbafd
1 parent 0440e1d
commit a7cbafd
Showing 1 changed file with 40 additions and 20 deletions.
diff --git 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:<name> | Environment variable <name>                                                 |
-+------------+-----------------------------------------------------------------------------+
-| uid        | Effective UID of the current process NOTE: This is overridden for           |
-|            | :ref:`mail service user variables <variables-mail_service_user>`.           |
-+------------+-----------------------------------------------------------------------------+
-| gid        | Effective GID of the current process NOTE: This is overridden for           |
-|            | :ref:`mail service user variables <variables-mail_service_user>`.           |
-+------------+-----------------------------------------------------------------------------+
-| 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 <variables-mail_user>`.                           |
-+------------+-----------------------------------------------------------------------------+
++----------------+-----------------------------------------------------------------------------+
+| Long name      |  Description                                                                |
++================+=============================================================================+
+| %%             | '%' character. See :ref:`user_shared_mailboxes`                             |
+|                | for further information about %% variables                                  |
++----------------+-----------------------------------------------------------------------------+
+| env:<name>     | Environment variable <name>                                                 |
++----------------+-----------------------------------------------------------------------------+
+| system:<name>  | Get a system variable, see :ref:`below <variables-system-variables>`        |
+|                | for list of supported names.                                                |
++----------------+-----------------------------------------------------------------------------+
+| process:<name> | Get a process variable, see :ref:`below <variables-process-variables>`      |
+|                | 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-mail_user>`.
+
+.. _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 <variables-mail_service_user>`
+``gid``
+  Effective group ID of the current process NOTE: This is overridden for
+  :ref:`mail service user variables <variables-mail_service_user>`
+
 .. _variables-user:
 
 User variables