From 36c2a6eafbc2619ccfcc5b9f205210eb73362f69 Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Wed, 10 May 2023 17:08:16 -0700 Subject: [PATCH] docs: cleanup apache --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8466ce834..6577e45a2 100644 --- a/README.md +++ b/README.md @@ -80,17 +80,16 @@ If you have access to a server that supports one of the sources below, I recomme - 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 recommend) +- Web Proxy (one of the following) + - 🍀 Nginx (recommended) + - ðŸŠķ Apache ### 😗 Optional dependencies - [FFmpeg](https://ffmpeg.org/) for video transcoding -- Full text search (choost one of the following) - - ðŸĶ” [Sonic](https://crates.io/crates/sonic-server) (highly recommended!) +- Full text search (one of the following) + - ðŸĶ” [Sonic](https://crates.io/crates/sonic-server) (recommended) - [ElasticSearch](https://www.elastic.co/elasticsearch/) -- Management (choose one of the following) - - 🛰ïļ [pm2](https://pm2.io/) - - ðŸģ [Docker](https://docker.com) - - Service manager (systemd, openrc, etc) ### 🏗ïļ Build dependencies @@ -168,18 +167,16 @@ In Calckey's directory, fill out the `sonic` section of `.config/default.yml` wi For migrating from Misskey v13, Misskey v12, and Foundkey, read [this document](https://codeberg.org/calckey/calckey/src/branch/develop/docs/migrate.md). -## Web proxy +## 🌐 Web proxy -Choose between NGINX or Apache (we recommend NGINX) - -### 🍀 NGINX +### 🍀 Nginx (recommended) - Run `sudo cp ./calckey.nginx.conf /etc/nginx/sites-available/ && cd /etc/nginx/sites-available/` - Edit `calckey.nginx.conf` to reflect your instance properly - Run `sudo ln -s ./calckey.nginx.conf ../sites-enabled/calckey.nginx.conf` - Run `sudo nginx -t` to validate that the config is valid, then restart the NGINX service. -### Apache 2 +### ðŸŠķ Apache - Run `sudo cp ./calckey.apache.conf /etc/apache2/sites-available/ && cd /etc/apache2/sites-available/` - Edit `calckey.apache.conf` to reflect your instance properly