From 9becdc55b502086ca98bd3b10fd2b5e65159c4b5 Mon Sep 17 00:00:00 2001 From: Timo Sirainen Date: Mon, 25 Mar 2024 12:07:52 +0200 Subject: [PATCH] global: Replace fts_dovecot named filter with "fts dovecot" list filter where possible --- source/configuration_manual/fts/dovecot.rst | 6 ++--- source/configuration_manual/fts/flatcurve.rst | 26 ++++++++++--------- source/configuration_manual/fts/solr.rst | 5 ++-- .../mail_location/obox/amazon_s3.rst | 4 +-- .../mail_location/obox/dictmap.rst | 2 +- .../mail_location/obox/s3.rst | 2 +- .../mail_location/obox/scality_cdmi.rst | 2 +- .../plugins/fs-compress-plugin.rst | 2 +- .../upgrading/from-2.3-to-3.0.rst | 2 +- source/man/doveadm-fs.1.rst.in | 2 +- source/settings/plugin/fts-dovecot-plugin.rst | 8 +++--- source/settings/plugin/fts-plugin.rst | 20 +++++++++++--- 12 files changed, 49 insertions(+), 32 deletions(-) diff --git a/source/configuration_manual/fts/dovecot.rst b/source/configuration_manual/fts/dovecot.rst index 06293f633..535db858d 100644 --- a/source/configuration_manual/fts/dovecot.rst +++ b/source/configuration_manual/fts/dovecot.rst @@ -232,14 +232,12 @@ Example configuration using OBOX:: fts_dovecot = yes } - fts_driver = dovecot - # Fall back to built in search. #fts_enforced = no # Local filesystem example: # Use local filesystem storing FTS indexes - fts_dovecot { + fts dovecot { fs posix { prefix = %h/fts/ } @@ -249,7 +247,7 @@ Example configuration using OBOX:: # Keep URL the same as obox plus the mail_path setting, # Then append e.g. /fts/ # Example: http:///%2Mu/%2.3Mu/%u/fts/ - fts_dovecot { + fts dovecot { fs fts-cache { } fs fscache { diff --git a/source/configuration_manual/fts/flatcurve.rst b/source/configuration_manual/fts/flatcurve.rst index 52846b94e..74c2447a9 100644 --- a/source/configuration_manual/fts/flatcurve.rst +++ b/source/configuration_manual/fts/flatcurve.rst @@ -30,7 +30,8 @@ Enabling flatcurve is designed to be as easy as adding these lines: fts_flatcurve = yes } - fts_driver = flatcurve + fts flatcurve { + } Optional parameters ------------------- @@ -109,17 +110,18 @@ FTS-Flatcurve Plugin Settings Example fts_flatcurve = yes } - fts_driver = flatcurve - # All of these are optional, and indicate the default values. - # They are listed here for documentation purposes; most people should - # not need to define/override in their config. - fts_flatcurve_commit_limit = 500 - fts_flatcurve_max_term_size = 30 - fts_flatcurve_min_term_size = 2 - fts_flatcurve_optimize_limit = 10 - fts_flatcurve_rotate_count = 5000 - fts_flatcurve_rotate_time = 5000 - fts_flatcurve_substring_search = no + fts flatcurve { + # All of these are optional, and indicate the default values. + # They are listed here for documentation purposes; most people should + # not need to define/override in their config. + commit_limit = 500 + max_term_size = 30 + min_term_size = 2 + optimize_limit = 10 + rotate_count = 5000 + rotate_time = 5000 + substring_search = no + } Data Storage ------------ diff --git a/source/configuration_manual/fts/solr.rst b/source/configuration_manual/fts/solr.rst index d41edba9e..3e1eac294 100644 --- a/source/configuration_manual/fts/solr.rst +++ b/source/configuration_manual/fts/solr.rst @@ -115,8 +115,9 @@ Example Configuration fts_solr = yes } - fts_driver = solr - fts_solr_url = https://solr.example.org:8983/solr/dovecot/ + fts solr { + url = https://solr.example.org:8983/solr/dovecot/ + } Important notes: diff --git a/source/configuration_manual/mail_location/obox/amazon_s3.rst b/source/configuration_manual/mail_location/obox/amazon_s3.rst index 9866bb9b9..8ba42c7b1 100644 --- a/source/configuration_manual/mail_location/obox/amazon_s3.rst +++ b/source/configuration_manual/mail_location/obox/amazon_s3.rst @@ -209,7 +209,7 @@ With IAM: fs aws-s3 { } } - fts_dovecot { + fts dovecot { fs fts-cache { } fs fscache { @@ -234,6 +234,6 @@ Without IAM add the ACCESSKEY and SECRET to the URL: .. code-block:: none fs_s3_url = https://ACCESSKEY:SECRET@bucket-name.s3.region.amazonaws.com/ - fts_dovecot { + fts dovecot { fs_s3_url = https://ACCESSKEY:SECRET@bucket-name.s3.region.amazonaws.com/%8Mu/%u/fts/ } diff --git a/source/configuration_manual/mail_location/obox/dictmap.rst b/source/configuration_manual/mail_location/obox/dictmap.rst index 197b993a6..d7e746b05 100644 --- a/source/configuration_manual/mail_location/obox/dictmap.rst +++ b/source/configuration_manual/mail_location/obox/dictmap.rst @@ -66,7 +66,7 @@ Cassandra/sproxyd Example Configuration fs sproxyd { } } - fts_dovecot { + fts dovecot { fs fts-cache { } fs fscache { diff --git a/source/configuration_manual/mail_location/obox/s3.rst b/source/configuration_manual/mail_location/obox/s3.rst index 318541e4c..3ba40d2f1 100644 --- a/source/configuration_manual/mail_location/obox/s3.rst +++ b/source/configuration_manual/mail_location/obox/s3.rst @@ -156,7 +156,7 @@ AWS S3 specific example configurations. fs s3 { } } - fts_dovecot { + fts dovecot { fs fts-cache { } fs fscache { diff --git a/source/configuration_manual/mail_location/obox/scality_cdmi.rst b/source/configuration_manual/mail_location/obox/scality_cdmi.rst index 43fecb879..287adb322 100644 --- a/source/configuration_manual/mail_location/obox/scality_cdmi.rst +++ b/source/configuration_manual/mail_location/obox/scality_cdmi.rst @@ -130,7 +130,7 @@ Example configuration fs scality { } } - fts_dovecot { + fts dovecot { fs fts-cache { } fs fscache { diff --git a/source/configuration_manual/plugins/fs-compress-plugin.rst b/source/configuration_manual/plugins/fs-compress-plugin.rst index 1f8ccb51c..74f27015c 100644 --- a/source/configuration_manual/plugins/fs-compress-plugin.rst +++ b/source/configuration_manual/plugins/fs-compress-plugin.rst @@ -53,7 +53,7 @@ Example Configuration bucket = mails } } - fts_dovecot { + fts dovecot { fs fscache { size = 512M path = /var/cache/fts/%4Nu diff --git a/source/installation_guide/upgrading/from-2.3-to-3.0.rst b/source/installation_guide/upgrading/from-2.3-to-3.0.rst index 28e5756f0..aa27a4f21 100644 --- a/source/installation_guide/upgrading/from-2.3-to-3.0.rst +++ b/source/installation_guide/upgrading/from-2.3-to-3.0.rst @@ -172,7 +172,7 @@ Removed features and their replacements | ``service_count`` | Renamed to :dovecot_core:ref:`service_restart_request_count`. | | | The default value is set to ``unlimited``. Value ``0`` is now a configuration error. | +------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| ``fts`` | Replaced by :dovecot_plugin:ref:`fts_driver`. | +| ``fts`` | Replaced by :dovecot_plugin:ref:`fts` named filter. | +------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :dovecot_plugin:ref:`fts_autoindex_exclude`. | Changed to boolean property of ``mailbox``. | +------------------------------------------------------------+------------------------------------------------------------------------------------------+ diff --git a/source/man/doveadm-fs.1.rst.in b/source/man/doveadm-fs.1.rst.in index 483dffd21..d61710b58 100644 --- a/source/man/doveadm-fs.1.rst.in +++ b/source/man/doveadm-fs.1.rst.in @@ -32,7 +32,7 @@ Otherwise the commands behave identically. *config-filter-name* Filter name to use when looking up the fs settings. For example - *mail_attachment*, *obox*, *metacache*, *fts_dovecot*. It's also + *mail_attachment*, *obox*, *metacache*, *fts/dovecot*. It's also possible to use an empty filter name and specify the fs settings using the **-o** parameters. diff --git a/source/settings/plugin/fts-dovecot-plugin.rst b/source/settings/plugin/fts-dovecot-plugin.rst index 4c0a120bf..bea08ef4d 100644 --- a/source/settings/plugin/fts-dovecot-plugin.rst +++ b/source/settings/plugin/fts-dovecot-plugin.rst @@ -62,6 +62,10 @@ Settings It must be somewhat synchronized with :dovecot_plugin:ref:`obox` and :ref:`mail_location_settings`. + This setting isn't actually necessary to use. It's simpler to just add the + settings inside ``fts dovecot`` filter, which is used to enable the + Dovecot Pro FTS driver. + It is strongly recommended to use :ref:`fscache` to speed up :ref:`obox ` and Dovecot FTS Engine operation. @@ -77,9 +81,7 @@ Settings fts_dovecot = yes } - fts_driver = dovecot - - fts_dovecot { + fts dovecot { fs posix { prefix = /var/fts/%u } diff --git a/source/settings/plugin/fts-plugin.rst b/source/settings/plugin/fts-plugin.rst index 60e66e803..40a86b2eb 100644 --- a/source/settings/plugin/fts-plugin.rst +++ b/source/settings/plugin/fts-plugin.rst @@ -11,6 +11,21 @@ fts plugin Settings ^^^^^^^^ +.. dovecot_plugin:setting:: fts + :plugin: fts + :values: @named_list_filter + + Configures the used fts driver to perform FTS indexing. If not specified, + FTS is disabled. The filter name refers to the + :dovecot_plugin:ref:`fts_driver` setting. + + Example:: + + fts solr { + [...] + } + + .. dovecot_plugin:setting:: fts_autoindex :default: no :plugin: fts @@ -105,9 +120,8 @@ Settings :plugin: fts :values: dovecot, solr, flatcurve - (previously named ``fts``) - Name of the backend implementation used to perform fts indexing. - If not specified, fts is disabled. + Configures the used fts driver to perform FTS indexing. + The :dovecot_plugin:ref:`fts` filter name refers to this setting. .. dovecot_plugin:setting:: fts_enforced