aither/simple-nixos-mailserver
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fts: update docs and defaults

Browse Source
This commit is contained in:
Martin Weinelt
2026-04-19 21:48:55 +02:00
parent f9d1435378
commit 198246f2c2
2 changed files with 50 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
default.nix
+26 -10
View File
@@ -591,18 +591,27 @@ in
memoryLimit = mkOption {
type = types.nullOr types.int;
default = null;
example = 2000;
example = 1024;
description = ''
Memory limit for the indexer process, in MiB.
If null, leaves the default (which is rather low),
and if 0, no limit.
When `null` the [`default_vsz_limit`](https://doc.dovecot.org/main/core/plugins/fts.html#fts_search_read_fallback)
applies while with `0` no limit is applied.
'';
};
autoIndex = mkOption {
type = types.bool;
default = true;
description = "Enable automatic indexing of messages as they are received or modified.";
description = ''
Enable automatic indexing of messages as they are received or modified.
:::{tip}
Can be overridden per mailbox by setting `fts_autoindex` for
{option}`mailserver.mailboxes`. By default the Junk and Trash folders
are already excluded.
:::
'';
};
fallback = mkOption {
@@ -611,6 +620,8 @@ in
description = ''
Whether to fallback to slow non-indexed search, if FTS lookup and
indexing have failed.
See <https://doc.dovecot.org/main/core/plugins/fts.html#fts_search_read_fallback>.
'';
};
@@ -635,10 +646,13 @@ in
type = types.bool;
default = false;
description = ''
If enabled, allows substring searches.
See <https://doc.dovecot.org/main/core/plugins/fts_flatcurve.html#fts_flatcurve_substring_search>.
Whether to allows substring searches. By default only prefix searches are supported.
Enabling this requires significant additional storage space.
:::{warning}
Enabling this significantly increases storage requirements.
:::
See <https://doc.dovecot.org/main/core/plugins/fts_flatcurve.html#fts_flatcurve_substring_search>.
'';
};
@@ -651,7 +665,8 @@ in
"Comments"
];
description = ''
The list of headers to exclude.
The list of headers to exclude while indexing.
See <https://doc.dovecot.org/main/core/plugins/fts.html#fts_header_excludes>.
'';
};
@@ -664,8 +679,9 @@ in
"stopwords"
];
description = ''
The list of language filters to apply.
See <https://doc.dovecot.org/main/core/plugins/fts.html#filter-configuration>.
The list of [language filters] to apply.
[language filters]: https://doc.dovecot.org/main/core/plugins/fts.html#filter-configuration
'';
};
};