dovecot · cmouse · Jan 30, 2024 · Jan 16, 2024 · Jan 16, 2024 · Jan 16, 2024
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
diff --git a/source/admin_manual/debugging/debugging_rawlog.rst b/source/admin_manual/debugging/debugging_rawlog.rst
@@ -94,7 +94,7 @@ If your userdb can't return a home directory directly, with v2.1+ you can add:
 
 .. code-block:: none
 
-   userdb {
+   userdb db1 {
       # ...
       default_fields = home=/home/%u
       # or temporarily even e.g. default_fields = home=/tmp/temp-home

diff --git a/source/admin_manual/known_issues/large_cache.rst b/source/admin_manual/known_issues/large_cache.rst
@@ -47,7 +47,7 @@ and:
 
 These usually happen because the dovecot.index.cache file is so large
 that it can't fit into the memory. The solution is usually to either the
-imap service's vsz_limit or default_vsz_limit to somewhat higher than the
+imap service's :dovecot_core:ref:`service_vsz_limit` to somewhat higher than the
 maximum cache file size (1 GB by default). For example to 1500M.
 
 An alternative solution to this is to reduce the maximum cache file size to

diff --git a/source/admin_manual/login_processes.rst b/source/admin_manual/login_processes.rst
@@ -34,7 +34,6 @@ You can enable high-security mode with:
  service imap-login {
    service_count = 1
    #process_min_avail = 0
-   #process_limit = $default_process_limit
    #vsz_limit = 64M
  }
  service pop3-login {
@@ -78,7 +77,6 @@ You can enable high-performance mode with:
 
   service imap-login {
     service_count = 0
-    #client_limit = $default_client_limit
     process_min_avail = 4 # number of CPU cores
     vsz_limit = 1G
   }
@@ -95,7 +93,7 @@ passwords, read their mails, etc.
 * ``process_min_avail`` should be set to be at least the number of CPU cores in
   the system, so that all of them will be used.
 * Otherwise new processes are created only once an existing one's connection
-  count reaches client_limit
+  count reaches :dovecot_core:ref:`service_client_limit`
 * Default ``client_limit * process_limit = 1000*100 = 100k`` connections
 * ``vsz_limit`` should be increased to avoid out of memory errors, especially
   if you're using SSL/TLS.

diff --git a/source/admin_manual/migrating_mailboxes.rst b/source/admin_manual/migrating_mailboxes.rst
@@ -236,7 +236,9 @@ If you need to retain POP3 support on your new system, you should use :ref:`plug
   }
 
   protocol doveadm {
-    mail_plugins = $mail_plugins pop3_migration
+    mail_plugins {
+      pop3_migration = yes
+    }
   }
 
   plugin {

diff --git a/source/admin_manual/submission_server.rst b/source/admin_manual/submission_server.rst
@@ -75,7 +75,7 @@ Configuration
 Submission Service
 ^^^^^^^^^^^^^^^^^^
 
-Just add ``submission`` to the ``protocols=`` setting and configure the relay
+Just add ``submission`` to the :dovecot_core:ref:`protocols` setting and configure the relay
 MTA server. The submission service is a login service, just like IMAP, POP3 and :ref:`pigeonhole_managesieve_server`, so clients
 are required to authenticate. The same :ref:`authentication configuration
 <authentication-authentication>` shall also apply to submission,

diff --git a/source/configuration_manual/acl.rst b/source/configuration_manual/acl.rst
@@ -46,11 +46,15 @@ Sample Configuration:
 .. code-block:: none
 
   # Enable internal ACL support
-  mail_plugins = acl
+  mail_plugins {
+    acl = yes
+  }
 
   # Enable the IMAP ACL commands
   protocol imap {
-    mail_plugins = $mail_plugins imap_acl
+    mail_plugins {
+      imap_acl = yes
+    }
   }
 
   plugin {

diff --git a/source/configuration_manual/apparmor.rst b/source/configuration_manual/apparmor.rst
@@ -26,7 +26,9 @@ Sample Configuration
 
 .. code-block:: none
 
-  mail_plugins = $mail_plugins apparmor
+  mail_plugins {
+    apparmor = yes
+  }
 
   plugin {
     apparmor_hat = hat_name

diff --git a/source/configuration_manual/authentication/allow_nets.rst b/source/configuration_manual/authentication/allow_nets.rst
@@ -35,7 +35,7 @@ Postfix to verify the email account:
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     driver = static
     args = password=test allow_nets=local,127.0.0.1/32
   }

diff --git a/...e/configuration_manual/authentication/authentication_via_remote_imap_server.rst b/...e/configuration_manual/authentication/authentication_via_remote_imap_server.rst
@@ -28,7 +28,7 @@ Authenticates users against remote IMAP server in IP address 192.168.1.123:
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     driver = imap
     args = host=192.168.1.123
   }
diff --git a/source/configuration_manual/authentication/caching.rst b/source/configuration_manual/authentication/caching.rst
@@ -82,7 +82,7 @@ use:
 
 ::
 
-   passdb {
+   passdb db1 {
      driver = pam
      args = cache_key=%s%u *
    }

diff --git a/source/configuration_manual/authentication/dict.rst b/source/configuration_manual/authentication/dict.rst
@@ -19,11 +19,11 @@ Auth configuration
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     driver = dict
     args = /etc/dovecot/dovecot-dict-auth.conf
   }
-  userdb {
+  userdb db1 {
     driver = dict
     args = /etc/dovecot/dovecot-dict-auth.conf
   }
@@ -221,12 +221,12 @@ Auth configuration
     auth = cdb:/etc/dovecot/auth.cdb
   }
 
-  passdb {
+  passdb db1 {
     driver = dict
     args = /etc/dovecot/dovecot-cdb.conf
   }
 
-  userdb {
+  userdb db1 {
     driver = dict
     args = /etc/dovecot/dovecot-cdb.conf
   }
@@ -275,15 +275,15 @@ Auth configuration
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     driver = dict
     args = /etc/dovecot/dovecot-dict-auth.conf
   }
-  userdb {
+  userdb db1 {
     # optional
     driver = prefetch
   }
-  userdb {
+  userdb db2 {
     driver = dict
     args = /etc/dovecot/dovecot-dict-auth.conf
   }

diff --git a/source/configuration_manual/authentication/domain_lost.rst b/source/configuration_manual/authentication/domain_lost.rst
@@ -74,27 +74,27 @@ user lookup.
 ::
 
    ## Your virtual passdb
-   passdb {
+   passdb db1 {
       driver = ldap
       args = /path/to/ldap/config
    }
 
-   passdb {
+   passdb db2 {
       driver = static
       args = user=%Ld noauthenticate
       skip = authenticated
    }
 
-   passdb {
+   passdb db3 {
       driver = pam
       skip = authenticated
    }
 
-   userdb {
+   userdb db1 {
       driver = ldap
       args = /path/to/ldap/config
    }
 
-   userdb {
+   userdb db2 {
       driver = passwd
    }
diff --git a/source/configuration_manual/authentication/gssapi.rst b/source/configuration_manual/authentication/gssapi.rst
@@ -57,8 +57,11 @@ Configuring Dovecot
 
 Once you have a keytab, configure GSSAPI on Dovecot.
 
-::
-  auth_mechanisms = $auth_mechanisms gssapi
+.. code-block:: none
+
+  auth_mechanisms {
+    gssapi = yes
+  }
   auth_gssapi_hostname = hostname-from-spn # or "$ALL"
   auth_krb5_keytab = /etc/dovecot/keytab
 

diff --git a/source/configuration_manual/authentication/kerberos.rst b/source/configuration_manual/authentication/kerberos.rst
@@ -87,7 +87,7 @@ If you only want to use Kerberos ticket-based authentication:
    auth_mechanisms = gssapi
    auth_krb5_keytab = /etc/dovecot/dovecot.keytab
 
-   userdb {
+   userdb db1 {
      driver = static
      args = uid=vmail gid=vmail home=/var/vmail/%u
    }
@@ -104,10 +104,10 @@ ticket-based authentication, you will need something like:
    auth_gssapi_hostname = "$ALL"
    auth_mechanisms = gssapi
    auth_krb5_keytab = /etc/dovecot/dovecot.keytab
-   passdb {
+   passdb db1 {
      driver = pam
    }
-   userdb {
+   userdb db1 {
      driver = passwd
    }
 
@@ -131,7 +131,7 @@ Then enable PAM passdb:
 
 ::
 
-   passdb {
+   passdb db1 {
      driver = pam
    }
 

diff --git a/source/configuration_manual/authentication/ldap.rst b/source/configuration_manual/authentication/ldap.rst
@@ -84,7 +84,7 @@ LDAP Backend Configuration
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     args = /etc/dovecot/dovecot-ldap.conf.ext
     driver = ldap
   }
@@ -256,12 +256,12 @@ dovecot.conf:
 
 .. code-block:: none
 
-   userdb {
+   userdb db1 {
      driver = ldap
      args = /etc/dovecot/dovecot-users-ldap.conf.ext
      result_success = continue-ok
    }
-   userdb {
+   userdb db2 {
      driver = ldap
      args = /etc/dovecot/dovecot-class-ldap.conf.ext
      skip = notfound

diff --git a/source/configuration_manual/authentication/ldap_authentication.rst b/source/configuration_manual/authentication/ldap_authentication.rst
@@ -8,14 +8,14 @@ See :ref:`LDAP <authentication-ldap>` for more details.
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     args = /etc/dovecot/dovecot-ldap.conf.ext
     driver = ldap
   }
-  userdb {
+  userdb db1 {
     driver = prefetch
   }
-  userdb {
+  userdb db2 {
     args = /etc/dovecot/dovecot-ldap.conf.ext
     driver = ldap
   }

diff --git a/source/configuration_manual/authentication/ldap_bind.rst b/source/configuration_manual/authentication/ldap_bind.rst
@@ -76,11 +76,11 @@ symlink to the first one. For example:
 
 ::
 
-   passdb {
+   passdb db1 {
      driver = ldap
      args = /etc/dovecot/dovecot-ldap.conf.ext
    }
-   userdb {
+   userdb db1 {
      driver = ldap
      args = /etc/dovecot/dovecot-ldap-userdb.conf.ext
    }

diff --git a/source/configuration_manual/authentication/ldap_userdb.rst b/source/configuration_manual/authentication/ldap_userdb.rst
@@ -135,12 +135,12 @@ dovecot.conf:
 
 ::
 
-   userdb {
+   userdb db1 {
      driver = ldap
      args = /etc/dovecot/dovecot-users-ldap.conf.ext
      result_success = continue-ok
    }
-   userdb {
+   userdb db2 {
      driver = ldap
      args = /etc/dovecot/dovecot-class-ldap.conf.ext
      skip = notfound

diff --git a/source/configuration_manual/authentication/lua_based_authentication.rst b/source/configuration_manual/authentication/lua_based_authentication.rst
@@ -59,7 +59,7 @@ Example
 
 .. code:: none
 
-  passdb {
+  passdb db1 {
     driver = lua
     args = file=/etc/dovecot/auth.lua password={PLAIN}test
   }
@@ -184,7 +184,7 @@ To configure passdb in dovecot, use
 
 .. code-block:: none
 
-  passdb {
+  passdb db1 {
     driver = lua
     args = file=/path/to/lua blocking=yes # default is yes
   }
@@ -218,7 +218,7 @@ To configure userdb in dovecot, use
 
 .. code-block:: none
 
-  userdb {
+  userdb db1 {
     driver = lua
     args = file=/path/to/lua blocking=yes # default is yes
   }