From 95ce4151e4a75b095873de1aee8e0a04a57e1ce8 Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Sun, 27 Nov 2022 12:04:08 -0800 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20optional=20deps?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d371cc8d4..9bf408347 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,16 @@ This guide will work for both **starting from scratch** and **migrating from Mis - Install with [nvm](https://github.com/nvm-sh/nvm) - 🐘 At least [PostgreSQL](https://www.postgresql.org/) v12 - 🍱 At least [Redis](https://redis.io/) v6 (v7 recommended) -- 📗 (Optional) [FFmpeg](https://ffmpeg.org/) -- 🛰️ (Optional, for non-Docker) [pm2](https://pm2.io/) + +### 😗 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 +- 🥡 Management (choose one of the following) + - 🛰️ [pm2](https://pm2.io/) + - 🐳 [Docker](https://docker.com) + - 📐 Service manager (systemd, openrc, etc) ### 🏗️ Build dependencies @@ -117,7 +125,7 @@ cp -r ../misskey/files . # if you don't use object storage ## 🚀 Build and launch! -### 🐢 NodeJS +### 🐢 NodeJS + pm2 #### `git pull` and run these steps to update Calckey in the future!