aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTill <2353100+S7evinK@users.noreply.github.com>2022-09-07 18:15:54 +0200
committerGitHub <noreply@github.com>2022-09-07 18:15:54 +0200
commitd5876abbe9f5484768f603ec91a567b8650e6e73 (patch)
treee8288bac7557a840ed636391ce5afbc7059dc993 /docs
parent31f4ae8997af7e939f505107341b86b2abd3fd9a (diff)
Fulltext implementation incl. config (#2480)
This adds the main component of the fulltext search. This PR doesn't do anything yet, besides creating an empty fulltextindex folder if enabled. Indexing events is done in a separate PR.
Diffstat (limited to 'docs')
-rw-r--r--docs/installation/7_configuration.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/installation/7_configuration.md b/docs/installation/7_configuration.md
index b1c74741..8fbe71c4 100644
--- a/docs/installation/7_configuration.md
+++ b/docs/installation/7_configuration.md
@@ -138,6 +138,19 @@ room_server:
conn_max_lifetime: -1
```
+## Fulltext search
+
+Dendrite supports experimental fulltext indexing using [Bleve](https://github.com/blevesearch/bleve), it is configured in the `sync_api` section as follows. Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing, to ensure the returned results match the expections. A full list of possible languages can be found [here](https://github.com/blevesearch/bleve/tree/master/analysis/lang).
+
+```yaml
+sync_api:
+ # ...
+ fulltext:
+ enabled: false
+ index_path: "./fulltextindex"
+ language: "en"
+```
+
## Other sections
There are other options which may be useful so review them all. In particular, if you are