From 8806ce8923ea53fcd4a5eae94da9963f90371490 Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Fri, 19 May 2023 20:41:19 -0700 Subject: [PATCH] docs: searc providers --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a72a171bb..9a0279a65 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,11 @@ psql postgres -c "create database calckey with encoding = 'UTF8';" In Calckey's directory, fill out the `db` section of `.config/default.yml` with the correct information, where the `db` key is `calckey`. -## 🦔 Set up search +## 🔎 Set up search + +### 🦔 Sonic + +Sonic is better suited for self hosters with smaller deployments. It's easier to use, uses almost no resources, and takes barely any any disk space. Follow sonic's [installation guide](https://github.com/valeriansaliou/sonic#installation) @@ -157,6 +161,17 @@ Follow sonic's [installation guide](https://github.com/valeriansaliou/sonic#inst In Calckey's directory, fill out the `sonic` section of `.config/default.yml` with the correct information. +### Meilisearch + +Meilisearch is better suited for larger deployments. It's faster but uses far more resources and disk space. + +Follow Meilisearch's [quick start guide](https://www.meilisearch.com/docs/learn/getting_started/quick_start) + +In Calckey's directory, fill out the `meilisearch` section of `.config/default.yml` with the correct information. + +### ElasticSearch + +Please don't use ElasticSearch unless you already have an ElasticSearch setup and want to continue using it for Calckey. ElasticSearch is slow, heavy, and offers very few benefits over Sonic/Meilisearch. ## 💅 Customize