diff --git a/config.yml.sample b/config.yml.sample index 159780fc8..fa1820bdf 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -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 diff --git a/docs/content/doc/setup/config.md b/docs/content/doc/setup/config.md index a1d5f227f..8cc0d147c 100644 --- a/docs/content/doc/setup/config.md +++ b/docs/content/doc/setup/config.md @@ -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: `` + +Full path: `typesense.url` + +Environment path: `VIKUNJA_TYPESENSE_URL` + + +### apikey + +The Typesense API key you want to use. + +Default: `` + +Full path: `typesense.apikey` + +Environment path: `VIKUNJA_TYPESENSE_APIKEY` + + --- ## redis