feat(docs): update sample config and docs about Typesense config
continuous-integration/drone/pr Build is failing Details

This commit is contained in:
kolaente 2023-08-29 11:23:52 +02:00
parent 4f2796ac58
commit c1ccbe8186
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
2 changed files with 55 additions and 0 deletions

View File

@ -91,6 +91,18 @@ database:
# Enable SSL/TLS for mysql connections. Options: false, true, skip-verify, preferred
tls: false
typesense:
# Whether to enable the Typesense integration. If true, all tasks will be synced to the configured Typesense
# instance and all search and filtering will run through Typesense instead of only through the database.
# Typesense allows fast fulltext search including fuzzy matching support. It may return different results than
# what you'd get with a database-only search.
enabled: false
# The url to the Typesense instance you want to use. Can be hosted locally or in Typesense Cloud as long
# as Vikunja is able to reach it.
url: ''
# The Typesense API key you want to use.
apikey: ''
redis:
# Whether to enable redis or not
enabled: false

View File

@ -494,6 +494,49 @@ Full path: `database.tls`
Environment path: `VIKUNJA_DATABASE_TLS`
---
## typesense
### enabled
Whether to enable the Typesense integration. If true, all tasks will be synced to the configured Typesense
instance and all search and filtering will run through Typesense instead of only through the database.
Typesense allows fast fulltext search including fuzzy matching support. It may return different results than
what you'd get with a database-only search.
Default: `false`
Full path: `typesense.enabled`
Environment path: `VIKUNJA_TYPESENSE_ENABLED`
### url
The url to the Typesense instance you want to use. Can be hosted locally or in Typesense Cloud as long
as Vikunja is able to reach it.
Default: `<empty>`
Full path: `typesense.url`
Environment path: `VIKUNJA_TYPESENSE_URL`
### apikey
The Typesense API key you want to use.
Default: `<empty>`
Full path: `typesense.apikey`
Environment path: `VIKUNJA_TYPESENSE_APIKEY`
---
## redis