Skip to content

Commit

Permalink
global: Change "backend" to "driver"
Browse files Browse the repository at this point in the history
  • Loading branch information
sirainen authored and cmouse committed Sep 16, 2024
1 parent 4d3af23 commit bc54648
Show file tree
Hide file tree
Showing 27 changed files with 100 additions and 100 deletions.
30 changes: 15 additions & 15 deletions data/settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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 */
Expand Down Expand Up @@ -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: {
Expand Down Expand Up @@ -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: {
Expand All @@ -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: {
Expand All @@ -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: {
Expand Down Expand Up @@ -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 <mailbox>\` to get the imapc quota root.
Used only with [[link,quota_backend_imapc]].`
Used only with [[link,quota_driver_imapc]].`
},

quota_imapc_root_name: {
Expand All @@ -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: {
Expand Down Expand Up @@ -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.`
},
Expand Down Expand Up @@ -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.`
},

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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: {
Expand Down
2 changes: 1 addition & 1 deletion data/updates.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs/core/config/auth/databases/ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
16 changes: 8 additions & 8 deletions docs/core/config/dict.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ---- | ----------- |
Expand All @@ -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

Expand All @@ -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:

```
Expand All @@ -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]].

Expand Down Expand Up @@ -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.

<SettingsComponent tag="dict-proxy" level="3" />

### 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
Expand All @@ -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).
:::

<SettingsComponent tag="dict-sql" level="3" />
Expand Down Expand Up @@ -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).

Expand Down
10 changes: 5 additions & 5 deletions docs/core/config/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ 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 |
| --- | --- |
| [[link,fs_posix,posix]] | POSIX filesystem. |
| [[link,fs_dict,dict]] | Dictionary (`lib-dict` wrapper). |
<!-- @include: @docs/storage/providers/includes/fs.inc -->

Wrapper backends used on top of other backends:
Wrapper drivers used on top of other drivers:

| Name | Description |
| --- | --- |
Expand All @@ -54,14 +54,14 @@ 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

<SettingsComponent tag="fs-dict" />

## 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.
2 changes: 1 addition & 1 deletion docs/core/config/imap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]].

Expand Down
2 changes: 1 addition & 1 deletion docs/core/config/mail_cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
2 changes: 1 addition & 1 deletion docs/core/config/mailbox/formats/imapc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/core/config/mailbox/formats/maildir.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Dovecot supports reading a few fields from the `<base filename>`:

* `,S=<size>`: `<size>` 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=<vsize>`: `<vsize>` 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, `<size>` and `<vsize>` are the same. Setting this may
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/core/config/shared_mailboxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/core/man/doveadm-fts.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/core/man/doveadm-index.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- @include: option-S-socket.inc -->
Expand Down
4 changes: 2 additions & 2 deletions docs/core/man/include/doveadm-fs.inc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/core/plugins/acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions docs/core/plugins/fs_compress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading

0 comments on commit bc54648

Please sign in to comment.