From ba1903eb8431d0e261f62e26fb0ce00d0b36c236 Mon Sep 17 00:00:00 2001 From: Timo Sirainen Date: Thu, 12 Sep 2024 13:29:09 +0300 Subject: [PATCH] global: Change "backend" to "driver" --- data/settings.js | 30 ++++----- data/updates.js | 2 +- docs/core/config/auth/databases/ldap.md | 2 +- docs/core/config/dict.md | 16 ++--- docs/core/config/fs.md | 10 +-- docs/core/config/imap.md | 2 +- docs/core/config/mail_cache.md | 2 +- docs/core/config/mailbox/formats/imapc.md | 2 +- docs/core/config/mailbox/formats/maildir.md | 4 +- docs/core/config/shared_mailboxes.md | 2 +- docs/core/man/doveadm-fts.1.md | 2 +- docs/core/man/doveadm-index.1.md | 2 +- docs/core/man/include/doveadm-fs.inc | 4 +- docs/core/plugins/acl.md | 8 +-- docs/core/plugins/fs_compress.md | 6 +- docs/core/plugins/fts.md | 10 +-- docs/core/plugins/push_notification.md | 2 +- docs/core/plugins/quota.md | 62 +++++++++---------- docs/core/plugins/quota_clone.md | 2 +- docs/core/plugins/sieve.md | 6 +- docs/developers/design/dict_protocol.md | 4 +- docs/developers/design/mail.md | 2 +- docs/developers/design/mail_storage.md | 2 +- docs/howto/sasl/postfix.md | 2 +- docs/howto/virtual/postfix.md | 2 +- docs/installation/installation.md | 10 +-- .../upgrade/include/2.3-to-2.4.inc | 2 +- 27 files changed, 100 insertions(+), 100 deletions(-) diff --git a/data/settings.js b/data/settings.js index 672ebcb85..3c072711e 100644 --- a/data/settings.js +++ b/data/settings.js @@ -1557,7 +1557,7 @@ Has two settings: The ACL driver to use. This setting is **REQUIRED** - if empty, the acl plugin is disabled. -Currently, there is a single backend available: \`vfile\`. This backend +Currently, there is a single driver available: \`vfile\`. This driver supports two ways of defining the ACL configuration: - *global*: ACL rules are applied to all users. @@ -1959,7 +1959,7 @@ fts_header_includes { plugin: 'fts', values: setting_types.UINT, text: ` -When the full text search backend detects that the index isn't up-to-date, +When the full text search driver detects that the index isn't up-to-date, the indexer is told to index the messages and is given this much time to do so. If this time limit is reached, an error is returned, indicating that the search timed out during waiting for the indexing to complete: @@ -2925,7 +2925,7 @@ quota_clone { advanced: true, text: ` Unset quota information before updating. This is needed with some dict -backends that do not support upserting, such as SQL with older SQLite.` +drivers that do not support upserting, such as SQL with older SQLite.` }, /* quota plugin */ @@ -2953,9 +2953,9 @@ quota "User quota" { plugin: 'quota', values: setting_types.STRING, default: 'count', - seealso: [ '[[link,quota_backends]]' ], + seealso: [ '[[link,quota_drivers]]' ], text: ` -Quota driver to use. See [[link,quota_backends]].` +Quota driver to use. See [[link,quota_drivers]].` }, quota_enforce: { @@ -2992,7 +2992,7 @@ There are also other messages, which are currently hard coded: text: ` If yes, use filesystem quota's inode limit as the message count limit. This can be useful with Maildir or sdbox. Used only with -[[link,quota_backend_fs]].` +[[link,quota_driver_fs]].` }, quota_fs_mount_path: { @@ -3002,7 +3002,7 @@ This can be useful with Maildir or sdbox. Used only with text: ` If specified, enable FS quota for the specified mount path. Only mailboxes existing in this mount path have the quota enabled. Empty value looks up the -mountpoint automatically. Used only with [[link,quota_backend_fs]].` +mountpoint automatically. Used only with [[link,quota_driver_fs]].` }, quota_fs_type: { @@ -3015,7 +3015,7 @@ mountpoint automatically. Used only with [[link,quota_backend_fs]].` Using \`any\` attempts to use the user quota first, with a fallback to group quota. Using \`user\` or \`group\` only attempts to use the user or the group quota, with a fallback to unlimited quota limit. Used only with -[[link,quota_backedn_fs]].` +[[link,quota_driver_fs]].` }, quota_hidden: { @@ -3063,7 +3063,7 @@ no tracking of the quota, and not making it visible to IMAP GETQUOTA commands.` default: 'INBOX', text: ` If non-empty, use \`GETQUOTAROOT \` to get the imapc quota root. -Used only with [[link,quota_backend_imapc]].` +Used only with [[link,quota_driver_imapc]].` }, quota_imapc_root_name: { @@ -3078,7 +3078,7 @@ to get the imapc quota. Some servers may have an empty quota root name. This is why if this setting and [[setting,quota_imapc_mailbox_name]] both have empty values, this setting is -used. Used only with [[link,quota_backend_imapc]].` +used. Used only with [[link,quota_driver_imapc]].` }, quota_mail_size: { @@ -4691,7 +4691,7 @@ Name of the dict to access in the dict server. This refers to the text: ` Points to the dict server's UNIX socket. The path is relative to the the [[setting,base_dir]] setting. This should be changed to \`dict-async\` if the -dict backend supports asynchronous lookups (e.g. ldap, pgsql, cassandra, NOT +dict driver supports asynchronous lookups (e.g. ldap, pgsql, cassandra, NOT mysql). The \`dict-async\` service allows more than one client, so this configuration prevents creating unnecessarily many dict processes.` }, @@ -8881,7 +8881,7 @@ drivers.` tags: [ 'passdb' ], values: setting_types.STRING, text: ` -Arguments for the passdb backend. The format of this value depends on the +Arguments for the passdb driver. The format of this value depends on the passdb driver. Each one uses different args.` }, @@ -9952,7 +9952,7 @@ See: https://wiki.openssl.org/index.php/TLS1.3#Ciphersuites` text: ` The directory where trusted SSL CA certificates can be found. For example \`/etc/ssl/certs\`. These certificates are used only for outgoing SSL -connections (e.g. with the imapc backend). +connections (e.g. with the imapc driver). For extra security you might want to point to a directory containing certificates only for the CAs that are actually needed for the server @@ -9967,7 +9967,7 @@ File containing the trusted SSL CA certificates. For example \`/etc/ssl/certs/ca-bundle.crt\`. These certificates are used only for outgoing SSL connections (e.g. with -the [[link,imapc]] backend). +the [[link,imapc]] driver). Note that this setting isn't recommended to be used with large CA bundles, because all the certificates are read into memory. This leads to excessive @@ -10538,7 +10538,7 @@ drivers.` tags: [ 'userdb' ], values: setting_types.STRING, text: ` -Arguments for the userdb backend. The format of this value depends on the userdb driver. Each one uses different args.` +Arguments for the userdb driver. The format of this value depends on the userdb driver. Each one uses different args.` }, userdb_fields: { diff --git a/data/updates.js b/data/updates.js index 7f250ab02..6119dba99 100644 --- a/data/updates.js +++ b/data/updates.js @@ -55,7 +55,7 @@ export const updates = { process_title_imap_process: '2.4.0', process_title_initializing: '2.4.0', process_title_mail_processes: '2.4.0', - quota_maildir_backend_removed: '2.4.0', + quota_maildir_driver_removed: '2.4.0', service_auth_listener_type: '2.4.0', service_dict_expire: '2.4.0', service_listener_type: '2.4.0', diff --git a/docs/core/config/auth/databases/ldap.md b/docs/core/config/auth/databases/ldap.md index a1ec3c9da..b838ce950 100644 --- a/docs/core/config/auth/databases/ldap.md +++ b/docs/core/config/auth/databases/ldap.md @@ -326,7 +326,7 @@ When connecting to AD, you may need to use port 3268. Then again, not all LDAP fields are available in port 3268. Use whatever works. See: https://technet.microsoft.com/en-us/library/cc978012.aspx. -### LDAP Backend Configuration +### LDAP Driver Configuration ::: code-group ```[dovecot.conf] diff --git a/docs/core/config/dict.md b/docs/core/config/dict.md index 59293e761..72ce519b3 100644 --- a/docs/core/config/dict.md +++ b/docs/core/config/dict.md @@ -25,7 +25,7 @@ used by, for example, [[plugin,last-login]] and [[setting,imap_metadata]]. The dictionaries can be accessed either directly by the mail processes or they can be accessed via [proxy processes](#dictionary-proxy-process). -Currently supported backends are: +Currently supported drivers are: | Name | Description | | ---- | ----------- | @@ -43,7 +43,7 @@ been accessed once. The connection is reused for other SQL lookups as long as their SQL settings are exactly the same. Opened SQL connections are currently never closed. -## Backends +## Drivers ### Flat Files @@ -55,7 +55,7 @@ databases, but good for small ones such as a single user's quota. ### Filesystem (lib-fs-wrapper) This is a wrapper for lib-fs, which most importantly has the `posix` -backend. Use the [[setting,fs]] setting to configure the filesystem. +driver. Use the [[setting,fs]] setting to configure the filesystem. For example: ``` @@ -73,7 +73,7 @@ This create a separate file under `/var/lib/dovecot/dict` for each key. LDAP support is very similar to [`sql`](#sql) support, but there is no write support. -Note that the LDAP backend must be used via [`proxy`](#proxy). +Note that the LDAP driver must be used via [`proxy`](#proxy). See [[link,auth_ldap]]. @@ -132,14 +132,14 @@ map { The proxy driver performs dictionary accessing via the [[link,dict_proxy]]. (The dict processes exist only if dict proxying is used.) This is especially -useful with backends where their initialization is relatively expensive, such +useful with drivers where their initialization is relatively expensive, such as SQL. The dict processes will perform connection pooling. ### Redis -The Redis backend is recommended to be used via [`proxy`](#proxy) to support +The Redis driver is recommended to be used via [`proxy`](#proxy) to support [connection pooling](#connection-pooling). ::: warning @@ -151,7 +151,7 @@ Currently using Redis without proxying may cause crashes. ### SQL ::: warning -Note that the SQL backend must be used with [`proxy`](#proxy). +Note that the SQL driver must be used with [`proxy`](#proxy). ::: @@ -275,7 +275,7 @@ dict_map shared/$mailbox_guid/$key { Dict server is used for providing dictionary access via server processes instead of doing it directly from whichever process wants to access -the dictionary. This is useful for some backends with relatively high +the dictionary. This is useful for some drivers with relatively high connection cost (e.g. [`sql`](#sql)), but not necessarily for others (e.g., [`redis`](#redis). diff --git a/docs/core/config/fs.md b/docs/core/config/fs.md index f92a1aad5..04febbd73 100644 --- a/docs/core/config/fs.md +++ b/docs/core/config/fs.md @@ -21,7 +21,7 @@ can be made to look similar to filesystems. It is similar to [[link,dict]] but generally where [[link,dict]] is generally used for small data `fs` is used for larger data. -Currently supported FS backends are: +Currently supported FS drivers are: | Name | Description | | --- | --- | @@ -29,7 +29,7 @@ Currently supported FS backends are: | [[link,fs_dict,dict]] | Dictionary (`lib-dict` wrapper). | -Wrapper backends used on top of other backends: +Wrapper drivers used on top of other drivers: | Name | Description | | --- | --- | @@ -54,8 +54,8 @@ support file metadata, in case you have a need for that use ## Dictionary Filesystem -This is a wrapper for `lib-dict` for using [[link,dict]] backends as `fs` -backends. +This is a wrapper for `lib-dict` for using [[link,dict]] drivers as `fs` +drivers. ### Settings @@ -63,5 +63,5 @@ backends. ## Metawrap Filesystem -This is a wrapper for other `fs` backends that don't support metadata. The +This is a wrapper for other `fs` drivers that don't support metadata. The metadata is implemented by placing them into the beginning of the file content. diff --git a/docs/core/config/imap.md b/docs/core/config/imap.md index 83f4533ec..951097d54 100644 --- a/docs/core/config/imap.md +++ b/docs/core/config/imap.md @@ -33,7 +33,7 @@ compression level for the available mechanism. ### SEARCH=FUZZY IMAP provides SEARCH as part of the core protocol, so it is useful to activate -a Full Text Search indexing backend to handle these searches. +a Full Text Search indexing driver to handle these searches. See [[plugin,fts]]. diff --git a/docs/core/config/mail_cache.md b/docs/core/config/mail_cache.md index edae5bc36..5b5e4a61b 100644 --- a/docs/core/config/mail_cache.md +++ b/docs/core/config/mail_cache.md @@ -76,7 +76,7 @@ IMAP ENVELOPE is used by many clients, which includes: | `date.sent` | The Date: header parsed to timestamp | | `date.received` | Mail delivery date (IMAP INTERNALDATE) | | `date.save` | Mail save/copy date (mdbox stores this always in dovecot.index) -| `size.physical` | Physical message size (line feeds exactly as they are stored in the stored mail). Note that the size is of the mail as plaintext, i.e. after decryption/compression. This is typically used by [[link,quota_backend_fs]] or [[link,quota_backend_maildir]] quota. | +| `size.physical` | Physical message size (line feeds exactly as they are stored in the stored mail). Note that the size is of the mail as plaintext, i.e. after decryption/compression. This is typically used by [[link,quota_driver_fs]] or [[link,quota_driver_maildir]] quota. | | `imap.bodystructure` | IMAP BODYSTRUCTURE response, which describes what the message's MIME structure looks like. | | `imap.body` | IMAP BODY response. This is the short version of imap.bodystructure, not the message body itself. If imap.bodystructure is cached, this field isn't cached because it can be generated from the imap.bodystructure. | | `imap.envelope` | IMAP ENVELOPE response, which contains the From, To, Cc, Bcc, Sender, Reply-To, Date, Subject, Message-ID and In-Reply-To headers in parsed forms. This is typically in the [[setting,mail_never_cache_fields]] because the raw headers are more useful in the cache and the ENVELOPE can be generated from them. | diff --git a/docs/core/config/mailbox/formats/imapc.md b/docs/core/config/mailbox/formats/imapc.md index bb488bcc3..ec78227ed 100644 --- a/docs/core/config/mailbox/formats/imapc.md +++ b/docs/core/config/mailbox/formats/imapc.md @@ -39,7 +39,7 @@ imapc_user = user@example.com ## Quota -Using the `imapc` quota backend allows asking for the quota from remote +Using the `imapc` quota driver allows asking for the quota from remote IMAP server. By default it uses `GETQUOTAROOT INBOX` to retrieve the quota. There are two parameters that can be used to control how the quota is looked diff --git a/docs/core/config/mailbox/formats/maildir.md b/docs/core/config/mailbox/formats/maildir.md index 5f6b49f38..48c72cfd6 100644 --- a/docs/core/config/mailbox/formats/maildir.md +++ b/docs/core/config/mailbox/formats/maildir.md @@ -131,7 +131,7 @@ Dovecot supports reading a few fields from the ``: * `,S=`: `` contains the file size. Getting the size from the filename avoids doing a system `stat()` call, which may improve the - performance. This is especially useful with [[link,quota_backend_maildir]]. + performance. This is especially useful with [[link,quota_driver_maildir]]. * `,W=`: `` contains the file's RFC822.SIZE, i.e., the file size with linefeeds being CR+LF characters. If the message was stored with CR+LF linefeeds, `` and `` are the same. Setting this may @@ -341,7 +341,7 @@ cache and download the messages all over again. If you do this for all the users, you could cause huge disk I/O bursts to your server. Dovecot cannot currently handle not being able to write the control files, so -it will cause problems with [[link,quota_backend_fs]]. To +it will cause problems with [[link,quota_driver_fs]]. To avoid problems with this, you should place control files into a partition where quota isn't checked. You can specify this with the [[setting,mail_control_path]] setting: diff --git a/docs/core/config/shared_mailboxes.md b/docs/core/config/shared_mailboxes.md index f0a0b1d79..a6509c165 100644 --- a/docs/core/config/shared_mailboxes.md +++ b/docs/core/config/shared_mailboxes.md @@ -323,7 +323,7 @@ below) to get the dictionary updated for themselves. See [[setting,acl_sharing_map]] for plugin setting information. -You could use any dictionary backend, including SQL or Cassandra, but a +You could use any dictionary driver, including SQL or Cassandra, but a simple flat file should work pretty well too: ```[dovecot.conf] diff --git a/docs/core/man/doveadm-fts.1.md b/docs/core/man/doveadm-fts.1.md index e1b58af6e..fa0b09bfc 100644 --- a/docs/core/man/doveadm-fts.1.md +++ b/docs/core/man/doveadm-fts.1.md @@ -61,7 +61,7 @@ Scan what mails exist in the full text search index and compare those to what actually exist in mailboxes. This removes mails from the index that have already been expunged and makes sure that the next **doveadm index** will index all the missing mails (if any). Note that currently -most FTS backends do not implement this properly, but instead they +most FTS drivers do not implement this properly, but instead they delete all the FTS indexes. This may change in the future versions. ### fts check fast diff --git a/docs/core/man/doveadm-index.1.md b/docs/core/man/doveadm-index.1.md index d11b819b9..3e9df3834 100644 --- a/docs/core/man/doveadm-index.1.md +++ b/docs/core/man/doveadm-index.1.md @@ -75,7 +75,7 @@ fts_autoindex = yes **-q** : Queues the indexing to be run by indexer process. Without -q the indexing is done directly by the [[man,doveadm]] process. Some - backends can't handle multiple processes updating the indexes + drivers can't handle multiple processes updating the indexes simultaneously, so -q should usually be used on production. diff --git a/docs/core/man/include/doveadm-fs.inc b/docs/core/man/include/doveadm-fs.inc index 0e67d47ba..83119118a 100644 --- a/docs/core/man/include/doveadm-fs.inc +++ b/docs/core/man/include/doveadm-fs.inc @@ -10,9 +10,9 @@ ## DESCRIPTION The **doveadm fs** *commands* are used to abstractly interact with the -storage backend defined in the Dovecot configuration. It allows access +storage driver defined in the Dovecot configuration. It allows access to the mailbox structure without needing to know details of how the -storage backend is designed. +storage driver is designed. *config-filter-name* : Filter name to use when looking up the fs settings. For example diff --git a/docs/core/plugins/acl.md b/docs/core/plugins/acl.md index c7f72cebf..628b25d65 100644 --- a/docs/core/plugins/acl.md +++ b/docs/core/plugins/acl.md @@ -26,7 +26,7 @@ Dovecot supports both administrator-configured ACL files and the IMAP ACL extension (see [[plugin,imap-acl]], which allows users to change ACLs themselves. -The ACL code was written to allow multiple ACL backends, but currently Dovecot +The ACL code was written to allow multiple ACL drivers, but currently Dovecot supports only virtual ACL files. Note that using ACLs doesn't grant mail processes any extra filesystem @@ -119,9 +119,9 @@ Master users have their own ACLs. They're not the mailbox owners, so by default they have no permissions to any of the mailboxes. See [[link,acl_master_users]] for more information. -## ACL vfile Backend +## ACL vfile Driver -`vfile` backend supports per-mailbox ACLs and global ACLs. +`vfile` driver supports per-mailbox ACLs and global ACLs. Per-mailbox ACLs are stored in `dovecot-acl` named file, which exists in: @@ -266,7 +266,7 @@ by administrator, so users shouldn't be able to override them. ### Global ACL File -Global ACL file path is specified as a parameter to vfile backend in +Global ACL file path is specified as a parameter to vfile driver in [[setting,acl]], `/etc/dovecot/dovecot-acl` in the above example. The file contains otherwise the same data as regular per-mailbox `dovecot-acl` diff --git a/docs/core/plugins/fs_compress.md b/docs/core/plugins/fs_compress.md index 104a67ed4..0a3fc4489 100644 --- a/docs/core/plugins/fs_compress.md +++ b/docs/core/plugins/fs_compress.md @@ -11,10 +11,10 @@ dovecotlinks: `fs-compress` plugin is used to wrap other data streams in a compression layer. -It can be used by any of the settings using the [[link,fs,FS backends]]. +It can be used by any of the settings using the [[link,fs,FS drivers]]. -The exact location where to set it in the FS backend hierarchy depends on what -other FS backends are being used. +The exact location where to set it in the FS driver hierarchy depends on what +other FS drivers are being used. The important rules are: diff --git a/docs/core/plugins/fts.md b/docs/core/plugins/fts.md index c76224cee..f8762c9a3 100644 --- a/docs/core/plugins/fts.md +++ b/docs/core/plugins/fts.md @@ -45,7 +45,7 @@ Dovecot maintains these FTS indexing engines: ## Searching In Dovecot -When a FTS indexing backend is not present, searches use a slow sequential +When a FTS indexing driver is not present, searches use a slow sequential search through all message data. This is both computationally and time expensive. It is desirable to pre-index data so that searches can be executed against this index. @@ -81,16 +81,16 @@ whether or not the indexes will ever be used by the user. ## Dovecot FTS Architecture Dovecot splits the full text search functionality into two parts: -a common tokenization library (lib-language) and backend indexing engine +a common tokenization library (lib-language) and driver indexing engine responsible for storing the tokens produced by the common library persistently. -Some of the FTS backends do their own internal tokenization, although it's +Some of the FTS drivers do their own internal tokenization, although it's possible to configure them to use the lib-language tokenization as well. See [Tokenization](#tokenization) for more details about configuring the tokenization. -All backends are implemented as plugins that extend the base fts plugin's +All drivers are implemented as plugins that extend the base fts plugin's functionality. ## Settings @@ -143,7 +143,7 @@ doveadm fts rescan -u user@domain doveadm index -u user@domain -q '*' ``` -Note that currently most FTS backends don't implement the rescan. +Note that currently most FTS drivers don't implement the rescan. Instead, they simply delete all the FTS indexes. This may change in the future versions. diff --git a/docs/core/plugins/push_notification.md b/docs/core/plugins/push_notification.md index 37e91af01..115ab1baa 100644 --- a/docs/core/plugins/push_notification.md +++ b/docs/core/plugins/push_notification.md @@ -117,7 +117,7 @@ push_notification dlog { ### OX (Open-Xchange) driver [`ox`] -The OX backend supports sending notifications on MessageNew events (i.e. mail +The OX driver supports sending notifications on MessageNew events (i.e. mail deliveries, not IMAP APPENDs). This driver was designed for use with diff --git a/docs/core/plugins/quota.md b/docs/core/plugins/quota.md index adc6f734a..42d58d627 100644 --- a/docs/core/plugins/quota.md +++ b/docs/core/plugins/quota.md @@ -8,21 +8,21 @@ dovecotlinks: quota_limits: hash: quota-limits text: Quota Limits - quota_backends: - hash: quota-backends - text: Quota Backends - quota_backend_count: - hash: backend-count - text: "Quota Backend: Count" - quota_backend_fs: - hash: backend-fs - text: "Quota Backend: Filesystem" - quota_backend_imapc: - hash: backend-imapc - text: "Quota Backend: Imapc" - quota_backend_maildir: - hash: backend-maildir - text: "Quota Backend: Maildir" + quota_drivers: + hash: quota-drivers + text: Quota Drivers + quota_driver_count: + hash: driver-count + text: "Quota Driver: Count" + quota_driver_fs: + hash: driver-fs + text: "Quota Driver: Filesystem" + quota_driver_imapc: + hash: driver-imapc + text: "Quota Driver: Imapc" + quota_driver_maildir: + hash: driver-maildir + text: "Quota Driver: Maildir" quota_mailbox_count: hash: maximum-mailbox-count text: "Quota: Maximum Mailbox Count" @@ -52,7 +52,7 @@ Three plugins are associated with quota: | Name | Description | | ---- | ----------- | | [[plugin,imap-quota]] | Enables IMAP commands for requesting and administering current quota. | -| quota (this plugin) | Implements the actual quota handling and includes all quota backends. | +| quota (this plugin) | Implements the actual quota handling and includes all quota drivers. | | [[plugin,quota-clone]] | Copy the current quota usage to a dict. | ## Settings @@ -281,21 +281,21 @@ plugin { quota_exceeded_message = Quota exceeded, please go to http://www.example.com/over_quota_help for instructions on how to fix this. } ``` -## Quota Backends +## Quota Drivers -Quota backend specifies the method how Dovecot keeps track of the current quota +Quota driver specifies the method how Dovecot keeps track of the current quota usage. They don't specify users' quota limits - that's done by [returning extra fields from userdb](#per-user-quota). -We recommend using [`count`](#backend-count) for any new installations. +We recommend using [`count`](#driver-count) for any new installations. If you need usage data to an external database, consider using [[plugin,quota-clone]] for exporting the information. (It's very slow to query every user's quota from the index files directly.) -### Backend: Count +### Driver: Count -The `count` quota backend tracks the quota internally within Dovecot's index +The `count` quota driver tracks the quota internally within Dovecot's index files. ::: info @@ -308,7 +308,7 @@ wanted to be known, the mailboxes' quotas are summed up together. To get the best performance, make sure [[setting,mailbox_list_index,yes]]. ::: warning -If you're switching from some other quota backend to `count`, make +If you're switching from some other quota driver to `count`, make sure that all the mails have their virtual sizes already indexed. Otherwise there may be a significant performance hit when Dovecot starts opening all the mails to get their sizes. You can help to avoid this by accessing the @@ -318,7 +318,7 @@ mailbox vsizes for all the users before doing the configuration change: #### Configuration -`count` backend doesn't have any additional parameters. +`count` driver doesn't have any additional parameters. ```[dovecot.conf] mailbox_list_index = yes @@ -338,9 +338,9 @@ quota "User quota" { } ``` -### Backend: fs +### Driver: fs -The `fs` (filesystem) quota backend supports both local filesystems and +The `fs` (filesystem) quota driver supports both local filesystems and rquota (NFS). #### Configuration @@ -350,7 +350,7 @@ rquota (NFS). #### Systemd If you are using systemd, please make sure you **turn off** -`PrivateDevices=yes`, otherwise the backend won't work properly. The best +`PrivateDevices=yes`, otherwise the driver won't work properly. The best way to do this is to use `systemctl edit dovecot` command or add file `/etc/systemd/system/dovecot.service.d/override.conf` with: @@ -459,7 +459,7 @@ quota Others { } ``` -### Backend: imapc +### Driver: imapc See [[link,imapc_quota]]. @@ -467,14 +467,14 @@ See [[link,imapc_quota]]. -### Backend: maildir +### Driver: maildir ::: warning Note that **Maildir++ quota works only with Maildir format**. However, even -with Maildir format the recommendation is to use [`count`](#backend-count). +with Maildir format the recommendation is to use [`count`](#driver-count). ::: -The `maildir` quota backend implements Maildir++ quota in Dovecot. Dovecot +The `maildir` quota driver implements Maildir++ quota in Dovecot. Dovecot implements the [Maildir++ specification](https://www.courier-mta.org/imap/README.maildirquota.html) so Dovecot remains compatible with [Courier](https://www.courier-mta.org/), @@ -491,7 +491,7 @@ format: S,C ``` -[[removed,quota_maildir_backend_removed]] Maildir++ quota limit must now be +[[removed,quota_maildir_driver_removed]] Maildir++ quota limit must now be specified in Dovecot configuration. It will no longer be read from the `maildirsize` file. The limits are still written to the file header, but they are ignored by Dovecot. diff --git a/docs/core/plugins/quota_clone.md b/docs/core/plugins/quota_clone.md index e54a6c649..d4bbd3876 100644 --- a/docs/core/plugins/quota_clone.md +++ b/docs/core/plugins/quota_clone.md @@ -19,7 +19,7 @@ Additionally, it is expensive to directly scan quota information from each individual user account, so quota-clone allows access to quota information that is less resource intensive. -In these example use-cases, you can use [[link,quota_backend_count]] as the +In these example use-cases, you can use [[link,quota_driver_count]] as the authoritative quota database and make a copy of the quota usage to Redis. From Redis you could then once in a while gather everybody's current quota usage and send it to yet another place (e.g. for statistics handling). diff --git a/docs/core/plugins/sieve.md b/docs/core/plugins/sieve.md index 0cd8d657d..186c61289 100644 --- a/docs/core/plugins/sieve.md +++ b/docs/core/plugins/sieve.md @@ -237,7 +237,7 @@ of the user running the Sieve interpreter is used. ##### Examples -###### Flat File Backend +###### Flat File Driver To retrieve the Sieve script named "keep" from the dict file /etc/dovecot/sieve.dict: @@ -274,9 +274,9 @@ require ["enotify", "variables"]; if header :matches "From" "*" { set "from" "${ ``` ::: -###### Using a SQL backend +###### Using a SQL Driver -For greater flexibility, it's possible to use a SQL backend for your +For greater flexibility, it's possible to use a SQL driver for your dict scripts. First, set up a configuration file (such as diff --git a/docs/developers/design/dict_protocol.md b/docs/developers/design/dict_protocol.md index fe7a65845..186bafa86 100644 --- a/docs/developers/design/dict_protocol.md +++ b/docs/developers/design/dict_protocol.md @@ -173,7 +173,7 @@ Possible responses include: | ------------- | ----------------- | ----------- | | `OK` | `O` | Commit was done successfully and all transaction operations completed. | | `NOTFOUND` | `N` | Transaction ID specified in the commit was not found. | -| `WRITE_UNCERTAIN` | `W` | The transaction may or may not have succeeded (e.g. a write timeout occurred or the connection to dict backend was closed by the backend server). A tab-escaped error string is appended to the response line. | +| `WRITE_UNCERTAIN` | `W` | The transaction may or may not have succeeded (e.g. a write timeout occurred or the connection to dict driver was closed by the backend server). A tab-escaped error string is appended to the response line. | | `FAIL` | `F` | Iteration failed due to an error. A tab-escaped error string is appended to the response line. | ## `ROLLBACK` Command @@ -216,7 +216,7 @@ C: ATABTAB Set the unix timestamp for the given transaction. Note that this will set the timestamp for the entire transaction. This must be set before any changes are done and can't be changed afterwards. Currently only dict-sql with Cassandra -backend does anything with this. +driver does anything with this. ``` C: TTABTAB diff --git a/docs/developers/design/mail.md b/docs/developers/design/mail.md index d1469ffa5..3d2048c28 100644 --- a/docs/developers/design/mail.md +++ b/docs/developers/design/mail.md @@ -98,7 +98,7 @@ Only functions returning int can fail, others don't. was. - `mail_get_special()` can return various special fields. If a - special isn't implemented by some backend, the call returns success + special isn't implemented by some driver, the call returns success and sets the value to empty string. - `mail_get_stream()` returns an input stream that can be used to diff --git a/docs/developers/design/mail_storage.md b/docs/developers/design/mail_storage.md index 2a78ba880..f087fe0d1 100644 --- a/docs/developers/design/mail_storage.md +++ b/docs/developers/design/mail_storage.md @@ -35,7 +35,7 @@ seconds" or "NO Mailbox is locked, will abort in n seconds". ## Required Methods -Methods that mail storage backends need to implement are: +Methods that mail storage drivers need to implement are: ### `get_setting_parser_info()` diff --git a/docs/howto/sasl/postfix.md b/docs/howto/sasl/postfix.md index 092ba14c7..4059fc943 100644 --- a/docs/howto/sasl/postfix.md +++ b/docs/howto/sasl/postfix.md @@ -56,7 +56,7 @@ smtpd_relay_restrictions = permit_mynetworks, permit_sasl_authenticated, reject_ ## Using SASL with Postfix Submission Port -When Dovecot is used as the authentication backend for Postfix, it is good +When Dovecot is used as the authentication driver for Postfix, it is good practice to use a dedicated submission port for the MUAs (TCP 587). Not only can you specify individual parameters in `master.cf` overriding diff --git a/docs/howto/virtual/postfix.md b/docs/howto/virtual/postfix.md index 81f62227f..23c3a9c58 100644 --- a/docs/howto/virtual/postfix.md +++ b/docs/howto/virtual/postfix.md @@ -268,7 +268,7 @@ local1.err -/var/log/dovecot.err In this configuration Postfix will only accept SASL requests on its submission port (`TCP:587`) and will not accept them on Port 25. -As Dovecot is used as authentication backend in this example, this will not +As Dovecot is used as authentication driver in this example, this will not break inbound mail flow in case the authentication mechanism is down e.g. due to upgrading to a new build. diff --git a/docs/installation/installation.md b/docs/installation/installation.md index f9f99a751..6f5ace945 100644 --- a/docs/installation/installation.md +++ b/docs/installation/installation.md @@ -230,7 +230,7 @@ Build with zStandard compression support (default if detected) #### SQL Driver Options SQL drivers are typically used for authentication, and they may be -used as a lib-dict backend too, which can be used by plugins for +used as a lib-dict driver too, which can be used by plugins for different purposes. ##### `--with-cassandra` @@ -252,9 +252,9 @@ or similar package) Build with SQLite3 driver support (requires `sqlite-devel`, `libsqlite3-dev` or similar package) -#### Authentication Backend Options +#### Authentication Driver Options -The basic backends are built if the system is detected to support them: +The basic drivers are built if the system is detected to support them: ##### `--with-pam` @@ -264,9 +264,9 @@ Build with [[link,auth_pam]] support Build with [[link,auth_bsd]] support -#### Authentication Backend Options (Extra Libraries Needed) +#### Authentication Driver Options (Extra Libraries Needed) -Some backends require extra libraries and are not necessarily wanted, so +Some drivers require extra libraries and are not necessarily wanted, so they are built only if specifically enabled: ##### `--with-sql(=plugin)` diff --git a/docs/installation/upgrade/include/2.3-to-2.4.inc b/docs/installation/upgrade/include/2.3-to-2.4.inc index 1d810e50e..d5b284702 100644 --- a/docs/installation/upgrade/include/2.3-to-2.4.inc +++ b/docs/installation/upgrade/include/2.3-to-2.4.inc @@ -84,7 +84,7 @@ prefixing them with `\`. | Feature | Notes | | ------- | ----- | -| Dict quota; Dirsize quota | These backends are removed. You should use [[link,quota_backend_count]] instead along with [[plugin,quota-clone]].
Note that switching to quota count can cause all user's indexes to update, so reserve time for this. | +| Dict quota; Dirsize quota | These drivers are removed. You should use [[link,quota_driver_count]] instead along with [[plugin,quota-clone]].
Note that switching to quota count can cause all user's indexes to update, so reserve time for this. | | XZ Compression | You need to perform migration using different plugin. With maildir, you can try uncompressing all your mail and compressing them with another algorithm while Dovecot is not running. | | `auth_worker_max_count` | Use [[link,service_configuration,service-specific process limit]]. | | Weak password schemes | Weak password schemes are disabled by default, you need to use [[setting,auth_allow_weak_schemes]] to enable them. |