summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPrivateGER <privateger@privateger.me>2025-02-19 15:20:48 +0100
committerPrivateGER <privateger@privateger.me>2025-02-19 15:20:48 +0100
commit006e92a7d06e5717b5f13d001128a07145fd213d (patch)
tree62d54b3a6e1377097ce1ae6e5f43f72f8adaf2eb
parentfix wrong column name (diff)
downloadsharkey-006e92a7d06e5717b5f13d001128a07145fd213d.tar.gz
sharkey-006e92a7d06e5717b5f13d001128a07145fd213d.tar.bz2
sharkey-006e92a7d06e5717b5f13d001128a07145fd213d.zip
adjust docs
-rw-r--r--.config/example.yml7
1 files changed, 6 insertions, 1 deletions
diff --git a/.config/example.yml b/.config/example.yml
index 297f794324..fd30d8923b 100644
--- a/.config/example.yml
+++ b/.config/example.yml
@@ -226,10 +226,15 @@ fulltextSearch:
# Use Postgres tsvectors.
# You need to create a generated column and index on the note table to use this, followed by an ANALYZE on the table. Beware, this will take a while to be created and the database will remain locked during this process.
# This also enables advanced search syntax, see documentation of websearch_to_tsquery: https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES
- # Support for non-English languages is currently rather poor and will be improved once post languages become a feature.
+ # Support for multiple languages is currently rather poor and will be improved once post languages become a feature.
+ #
+ # Example to set up tsvectors for an English instance:
# ALTER TABLE note ADD COLUMN tsvector_embedding tsvector GENERATED ALWAYS AS ( to_tsvector('english', COALESCE(text, '') || ' ' || COALESCE(cw, '') || ' ' || COALESCE(name, ''))) STORED;
# CREATE INDEX vector_idx ON note USING GIN (tsvector_embedding);
# ANALYZE note;
+ #
+ # Note: You can opt to use a different dictionary for better results if your main instance language is not English.
+ # To get a list, use "SELECT cfgname FROM pg_ts_config;" and replace 'english' with the desired dictionary name.
# - meilisearch
# Use Meilisearch.
# You need to install Meilisearch and configure.