Update search docs
MODIFY
cmd/generate-config/main.go
cmd/generate-config/main.go
@@ -85,7 +85,7 @@ func main() {
}
cfg.SyncAPI.Fulltext = config.Fulltext{
Enabled: true,
- IndexPath: config.Path(filepath.Join(*dirPath, "fulltextindex")),
+ IndexPath: config.Path(filepath.Join(*dirPath, "searchindex")),
InMemory: true,
Language: "en",
}

MODIFY
dendrite-sample.monolith.yaml
dendrite-sample.monolith.yaml
@@ -276,13 +276,17 @@ sync_api:
# a reverse proxy server.
# real_ip_header: X-Real-IP
- # Configuration for the fulltext search
+ # Configuration for the full-text search engine.
search:
+ # Whether or not search is enabled.
enabled: false
- # The path where the fulltext index will be created in.
- index_path: "./fulltextindex"
- # The language most likely to be used on the server - used when indexing, to ensure the returned results match the expectations.
- # A full list of possible languages can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
+
+ # The path where the search index will be created in.
+ index_path: "./searchindex"
+
+ # The language most likely to be used on the server - used when indexing, to
+ # ensure the returned results match expectations. A full list of possible languages
+ # can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
language: "en"
# Configuration for the User API.

MODIFY
dendrite-sample.polylith.yaml
dendrite-sample.polylith.yaml
@@ -327,13 +327,17 @@ sync_api:
max_idle_conns: 2
conn_max_lifetime: -1
- # Configuration for the fulltext search
+ # Configuration for the full-text search engine.
search:
+ # Whether or not search is enabled.
enabled: false
- # The path where the fulltext index will be created in.
- index_path: "./fulltextindex"
- # The language most likely to be used on the server - used when indexing, to ensure the returned results match the expectations.
- # A full list of possible languages can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
+
+ # The path where the search index will be created in.
+ index_path: "./searchindex"
+
+ # The language most likely to be used on the server - used when indexing, to
+ # ensure the returned results match expectations. A full list of possible languages
+ # can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
language: "en"
# This option controls which HTTP header to inspect to find the real remote IP

MODIFY
docs/installation/7_configuration.md
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"
```

MODIFY
setup/config/config_syncapi.go
setup/config/config_syncapi.go
@@ -50,7 +50,7 @@ type Fulltext struct {
func (f *Fulltext) Defaults(opts DefaultOpts) {
f.Enabled = false
- f.IndexPath = "./fulltextindex"
+ f.IndexPath = "./searchindex"
f.Language = "en"
}

Update search docs