aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNeil Alexander <neilalexander@users.noreply.github.com>2022-09-27 17:10:47 +0100
committerNeil Alexander <neilalexander@users.noreply.github.com>2022-09-27 17:10:47 +0100
commit34993717fd702db50a82858a3ad4b660f0c7feac (patch)
treeae6eb7421dd09040c6521494b90b385867fa17bd /docs
parent87be32ca2671173a4287a938932e543410a32c3a (diff)
Update search docs
Diffstat (limited to 'docs')
-rw-r--r--docs/installation/7_configuration.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/installation/7_configuration.md b/docs/installation/7_configuration.md
index 67cd339c..19958c92 100644
--- a/docs/installation/7_configuration.md
+++ b/docs/installation/7_configuration.md
@@ -138,16 +138,18 @@ room_server:
conn_max_lifetime: -1
```
-## Fulltext search
+## Full-text 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 expectations. A full list of possible languages can be found [here](https://github.com/blevesearch/bleve/tree/master/analysis/lang).
+Dendrite supports experimental full-text 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 expectations. A full list of possible languages can be found [here](https://github.com/blevesearch/bleve/tree/master/analysis/lang).
```yaml
sync_api:
# ...
search:
enabled: false
- index_path: "./fulltextindex"
+ index_path: "./searchindex"
language: "en"
```