From 0af3ba27088d460d1b8764468a94d5e9ef10b741 Mon Sep 17 00:00:00 2001 From: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Date: Tue, 18 Jun 2024 15:25:44 +1200 Subject: [PATCH] Apply suggestions from code review --- docs/content/examples/tutorials/dovecot-solr.md | 9 +++++++-- docs/mkdocs.yml | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/content/examples/tutorials/dovecot-solr.md b/docs/content/examples/tutorials/dovecot-solr.md index c291bb6e..b482cd32 100644 --- a/docs/content/examples/tutorials/dovecot-solr.md +++ b/docs/content/examples/tutorials/dovecot-solr.md @@ -2,12 +2,16 @@ Dovecot supports several FTS backends for providing fast and efficient full text searching of e-mails directly from the IMAP server. -As the size of your mail storage grows, the benefits of FTS is especially notable: +As the size of your mail storage grows, the benefits of FTS are especially notable: - Without FTS, Dovecot would perform a search query by checking each individual email stored for a match, and then repeat this process again from scratch for the exact same query in future. - Some mail clients (_like Thunderbird_) may provide their own indexing and search features when all mail to search is stored locally, otherwise Dovecot needs to handle the search query (_for example webmail and mobile clients, like Gmail_). - FTS indexes each mail into a database for querying instead, where it can skip the cost of inspecting irrelevant emails for a query. +!!! warning "This is a community contributed guide" + + It extends [our official docs for Dovecot FTS][docs::dovecot::full-text-search] with a focus on Apache Solr. DMS does not officially support this integration. + ## Setup Solr for DMS An FTS backend supported by Dovecot is [Apache Solr][github-solr], a fast and efficient multi-purpose search indexer. @@ -136,7 +140,8 @@ docker compose exec mailserver doveadm fts rescan -A Usually within 15 minutes or so, you should be able to search your mail using the Dovecot FTS feature! :tada: -[docs::user-patches]: ../config/advanced/override-defaults/user-patches.md +[docs::user-patches]: ../../config/advanced/override-defaults/user-patches.md +[docs::dovecot::full-text-search]: ../../config/advanced/full-text-search.md [gh-dms::feature-request::dovecot-solr-package]: https://github.com/docker-mailserver/docker-mailserver/issues/4052 [dockerhub-solr]: https://hub.docker.com/_/solr diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ffb3bea8..b04631d2 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -174,7 +174,7 @@ nav: - 'Crowdsec': examples/tutorials/crowdsec.md - 'Building your own Docker image': examples/tutorials/docker-build.md - 'Blog Posts': examples/tutorials/blog-posts.md - - 'Full text search using Apache SOLR': examples/tutorials/dovecot-solr.md + - 'Dovecot FTS with Apache Solr': examples/tutorials/dovecot-solr.md - 'Use Cases': - 'Forward-Only Mail-Server with LDAP': examples/use-cases/forward-only-mailserver-with-ldap-authentication.md - 'Customize IMAP Folders': examples/use-cases/imap-folders.md