From d3d9c4830b8327cc137e2b706e0a33960c7738e9 Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Sun, 19 Mar 2023 01:32:17 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20sonic=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b5a80b0d..c430ce63e 100644 --- a/README.md +++ b/README.md @@ -80,8 +80,9 @@ If you have access to a server that supports one of the sources below, I recomme ### 😗 Optional dependencies - [FFmpeg](https://ffmpeg.org/) for video transcoding -- [ElasticSearch](https://www.elastic.co/elasticsearch/) for full-text search - - OpenSearch/Sonic are not supported as of right now +- Full text search (choost one of the following) + - 🦔 [Sonic](https://crates.io/crates/sonic-server) (highly recommended!) + - [ElasticSearch](https://www.elastic.co/elasticsearch/) - Management (choose one of the following) - 🛰️ [pm2](https://pm2.io/) - 🐳 [Docker](https://docker.com) @@ -121,6 +122,17 @@ Assuming you set up PostgreSQL correctly, all you have to run is: 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 + +Follow sonic's [installation guide](https://github.com/valeriansaliou/sonic#installation) + +If you use IPv4: in Sonic's directory, edit the `config.cfg` file to change `inet` to `"0.0.0.0:1491"`. + +In Calckey's directory, fill out the `sonic` section of `.config/default.yml` with the correct information. + + ## 💅 Customize - To add custom CSS for all users, edit `./custom/assets/instance.css`.