obox plugin¶
obox-plugin
¶
obox_use_object_ids
¶
Deprecated since version v2.3.0.
Default:
no
Values: Boolean
Access objects directly via their IDs instead of by paths, if possible. This can bypass index lookups with Scality CDMI and fs-dictmap/Cassandra. This setting was removed from v2.3 and made the default. (Although there is obox_dont_use_object_ids to disable it if really needed.)
obox_track_copy_flags
¶
Default:
no
Values: Boolean
Enable only if dictmap/Cassandra & lazy_expunge plugin are used: Try to avoid Cassandra SELECTs when expunging mails.
obox_refresh_index_once_after
¶
Default:
0
Values: Unsigned integer
This forces the next mailbox open after the specified UNIX timestamp to refresh locally cached indexes to see if other backends have modified the user’s indexes simultaneously.
obox_max_parallel_writes
¶
Default: mail_prefetch_count
Values: Unsigned integer
Maximum number of email write HTTP operations to do in parallel.
obox_max_parallel_copies
¶
Default: mail_prefetch_count
Values: Unsigned integer
Maximum number of email HTTP copy/link operations to do in parallel.
If the storage driver supports bulk-copy/link operation, this controls how many individual copy operations can be packed into a single bulk-copy/link HTTP request.
obox_max_parallel_deletes
¶
Default: mail_prefetch_count
Values: Unsigned integer
Maximum number of email HTTP delete operations to do in parallel.
If the storage driver supports bulk-delete operation, this controls how many individual delete operations can be packed into a single bulk-delete HTTP request.
obox_rescan_mails_once_after
¶
Default:
0
Values: Unsigned integer
This forces the next mailbox open after the specified UNIX timestamp to rescan the mails to make sure there aren’t any unindexed mails.
obox_fs
¶
Default: <empty>
Values: String
This setting handles the basic Object Storage configuration, typically via the plugin block of 90-plugin.conf.
obox_index_fs
¶
Default: Same as obox_fs
Values: String
This setting handles the object storage configuration for index bundles.
Warning
obox_index_fs is currently not compatible with fs-posix driver.
metacache_close_delay
¶
Default:
2secs
Values: Time
If user was accessed this recently, assume the user’s indexes are up-to-date. If not, list index bundles in object storage (or Cassandra) to see if they have changed. This typically matters only when user is being moved to another backend and soon back again, or if the user is simultaneously being accessed by multiple backends. Default is 2 seconds.
Must be less than director_user_expire (Default: 15min).
metacache_max_space
¶
Default: <empty>
Values: Size
How much disk space metacache can use before old data is cleaned up.
Generally, this should be set at ~90% of the available disk space.
metacache_max_grace
¶
Default: 1G
Values: Size
How much disk space on top of metacache_max_space can be used before Dovecot stops allowing more users to login.
metacache_upload_interval
¶
Default:
5min
Values: Time
How often to upload important index changes to object storage? This mainly means that if a backend crashes during this time, message flag changes within this time may be lost. A longer time can however reduce the number of index bundle uploads.
fs_auth_cache_dict
¶
Default: <empty>
Values: String
Dictionary URI where fs-auth process keeps authentication cache. This allows sharing the cache between multiple servers.
fs_auth_request_max_retries
¶
Default: 1
Values: Unsigned integer
If fs-auth fails to perform authentication lookup, retry the HTTP request this many times.
fs_auth_request_timeout
¶
Default: 10s
Values: Millisecond Time
Absolute HTTP request timeout for authentication lookups.
metacache_roots
¶
Default: <parsed from mail_home and mail_chroot settings>
Values: String
List of metacache root directories, separated with :
.
Usually this is automatically parsed directly from mail_home setting.
Accessing a metacache directory outside these roots will result in a warning: “Index directory is outside metacache_roots”.
It’s possible to disable this check entirely by setting the value to :
.
This setting is required for metacache_rescan_interval.
metacache_rescan_interval
¶
Default: 1 day
Values: Time
How often to run a background metacache rescan, which makes sure that the disk space usage tracked by metacache process matches what really exists on filesystem. The desync may happen for example because the metacache process (or the whole backend) crashes. The rescanning helps with two issues:
If metacache filesystem uses more disk space than metacache process thinks, it may run out of disk space.
If metacache filesystem uses less disk space than metacache process thinks, metacache runs non-optimally since it’s not filling it out as much as it could.
Setting this to 0 disables the rescan.
It’s also possible to do this manually by running the doveadm metacache rescan
command.