diff --git a/README.md b/README.md index d97e960440..b7ba3cc6fe 100644 --- a/README.md +++ b/README.md @@ -3,49 +3,19 @@ **🌎 Firefish is an open source, decentralized social media platform that's free forever! 🚀** -[![no github badge](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page/) - -[![opencollective badge](https://opencollective.com/firefish/tiers/badge.svg)](https://opencollective.com/Firefish) -[![liberapay badge](https://img.shields.io/liberapay/receives/ThatOneCalculator?logo=liberapay)](https://liberapay.com/ThatOneCalculator) -[![translate-badge](https://hosted.weblate.org/widgets/firefish/-/svg-badge.svg)](https://hosted.weblate.org/engage/firefish/) - -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md) -
-# âœĻ About Firefish - -- Firefish is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web UI, rich chatting, and much more! -- Firefish adds many quality of life changes and bug fixes for users and server admins alike. -- Notable differences: - - Improved UI/UX (especially on mobile) - - Post editing - - Content importing - - Improved notifications - - Improved server security - - Improved accessibility - - Improved threads - - Recommended Servers timeline - - OCR image captioning - - New and improved Groups - - Better intro tutorial - - Compatibility with Mastodon clients/apps - - Backfill user information - - Advanced search - - Many more user and admin settings - - Many bug fixes and performance improvements - - Link verification - - So much more! +Firefish is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web UI, rich chatting, and much more!
-# ðŸĨ‚ Links +# Links ### Want to get involved? Great! @@ -55,58 +25,58 @@ ### Links -- ðŸ’ļ Donations: +- Donations: - OpenCollective: -- 💁 Matrix space: -- ðŸ“Ģ Official account: `@firefish@info.firefish.dev` -- ✍ïļ Weblate: +- Matrix space: +- Official account: `@firefish@info.firefish.dev` +- Weblate: -# 🌠 Getting started +# Getting started This guide will work for both **starting from scratch** and **migrating from Misskey**. -## 🔰 Easy installers + -## ðŸ›ģïļ Containerization +## Containerization -- [ðŸģ How to run Firefish with Docker](https://firefish.dev/firefish/firefish/-/blob/develop/docs/docker.md) -- [🛞 How to run Firefish with Kubernetes/Helm](https://firefish.dev/firefish/firefish/-/blob/develop/docs/kubernetes.md) +- [How to run Firefish with Docker](https://firefish.dev/firefish/firefish/-/blob/develop/docs/docker.md) +- [How to run Firefish with Kubernetes/Helm](https://firefish.dev/firefish/firefish/-/blob/develop/docs/kubernetes.md) -## 🧑‍ðŸ’ŧ Dependencies +## Dependencies -- ðŸĒ At least [NodeJS](https://nodejs.org/en/) v18.16.0 (v20 recommended) -- 🐘 At least [PostgreSQL](https://www.postgresql.org/) v12 (v14 recommended) -- ðŸą At least [Redis](https://redis.io/) v7 +- At least [NodeJS](https://nodejs.org/en/) v18.16.0 (v20/v21 recommended) +- At least [PostgreSQL](https://www.postgresql.org/) v12 (v16 recommended) +- At least [Redis](https://redis.io/) v7 - Web Proxy (one of the following) - - 🍀 Nginx (recommended) - - ðŸĶĶ Caddy (recommended) - - ðŸŠķ Apache + - Nginx (recommended) + - Caddy (recommended) + - Apache -### 😗 Optional dependencies +### Optional dependencies - [FFmpeg](https://ffmpeg.org/) for video transcoding - Full text search (one of the following) - - ðŸĶ” [Sonic](https://crates.io/crates/sonic-server) + - [Sonic](https://crates.io/crates/sonic-server) - [MeiliSearch](https://www.meilisearch.com/) - [ElasticSearch](https://www.elastic.co/elasticsearch/) - Caching server (one of the following) - - ðŸē [DragonflyDB](https://www.dragonflydb.io/) (recommended) - - ðŸ‘ŧ [KeyDB](https://keydb.dev/) - - ðŸą Another [Redis](https://redis.io/) server + - [DragonflyDB](https://www.dragonflydb.io/) (recommended) + - [KeyDB](https://keydb.dev/) + - Another [Redis](https://redis.io/) server -### 🏗ïļ Build dependencies +### Build dependencies -- ðŸĶ€ At least [Rust](https://www.rust-lang.org/) v1.74 -- ðŸĶŽ C/C++ compiler & build tools +- At least [Rust](https://www.rust-lang.org/) v1.74 +- C/C++ compiler & build tools - `build-essential` on Debian/Ubuntu Linux - `base-devel` on Arch Linux -- 🐍 [Python 3](https://www.python.org/) +- [Python 3](https://www.python.org/) -## 👀 Get folder ready +## Get folder ready ```sh git clone https://firefish.dev/firefish/firefish.git @@ -114,16 +84,15 @@ cd firefish/ ``` > **Note** -> By default, you're on the develop branch. Run `git checkout main` or `git checkout beta` to switch to the Main/Beta branches. +> By default, you're on the develop branch. Run `git checkout main` to switch to the Main branch. -## ðŸ“Đ Install dependencies +## Install dependencies ```sh # nvm install 19 && nvm use 19 -corepack enable +sudo corepack enable corepack prepare pnpm@latest --activate -# To build without TensorFlow, append --no-optional -pnpm i # --no-optional +pnpm install --frozen-lockfile ``` ### pm2 @@ -138,7 +107,7 @@ pm2 install pm2-logrotate > **Note** > [`pm2-logrotate`](https://github.com/keymetrics/pm2-logrotate/blob/master/README.md) ensures that log files don't infinitely gather size, as Firefish produces a lot of logs. -## 🐘 Create database +## Create database In PostgreSQL (`psql`), run the following command: @@ -154,13 +123,13 @@ psql postgres -c "create database firefish with encoding = 'UTF8';" In Firefish's directory, fill out the `db` section of `.config/default.yml` with the correct information, where the `db` key is `firefish`. -## 💰 Caching server +## Caching server If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. DragonflyDB is the recommended option due to its unrivaled performance and ease of use. -## 🔎 Set up search +## Set up search -### ðŸĶ” Sonic +### Sonic Sonic is better suited for self hosters with smaller deployments. It uses almost no resources, barely any any disk space, and is relatively fast. @@ -183,7 +152,7 @@ In Firefish's directory, fill out the `meilisearch` section of `.config/default. Please don't use ElasticSearch unless you already have an ElasticSearch setup and want to continue using it for Firefish. ElasticSearch is slow, heavy, and offers very few benefits over Sonic/Meilisearch. -## 💅 Customize +## Customize - To add custom CSS for all users, edit `./custom/assets/instance.css`. - To add static assets (such as images for the splash screen), place them in the `./custom/assets/` directory. They'll then be available on `https://yourserver.tld/static-assets/filename.ext`. @@ -193,26 +162,26 @@ Please don't use ElasticSearch unless you already have an ElasticSearch setup an - To update custom assets without rebuilding, just run `pnpm run gulp`. - To block ChatGPT, CommonCrawl, or other crawlers from indexing your instance, uncomment the respective rules in `./custom/robots.txt`. -## 🧑‍🔎 Configuring a new server +## Configuring a new server - Run `cp .config/example.yml .config/default.yml` - Edit `.config/default.yml`, making sure to fill out required fields. - Also copy and edit `.config/docker_example.env` to `.config/docker.env` if you're using Docker. -## 🚚 Migrating from Misskey/FoundKey to Firefish +## Migrating from Misskey/FoundKey to Firefish For migrating from Misskey v13, Misskey v12, and FoundKey, read [this document](https://firefish.dev/firefish/firefish/-/blob/develop/docs/migrate.md). -## 🌐 Web proxy +## Web proxy -### 🍀 Nginx (recommended) +### Nginx (recommended) - Run `sudo cp ./firefish.nginx.conf /etc/nginx/sites-available/ && cd /etc/nginx/sites-available/` - Edit `firefish.nginx.conf` to reflect your server properly - Run `sudo ln -s ./firefish.nginx.conf ../sites-enabled/firefish.nginx.conf` - Run `sudo nginx -t` to validate that the config is valid, then restart the NGINX service. -### ðŸĶĶ Caddy (recommended) +### Caddy (recommended) - Add the following block to your `Caddyfile`, replacing `example.tld` with your own domain: ```caddy @@ -222,7 +191,7 @@ example.tld { ``` - Reload your caddy configuration -### ðŸŠķ Apache +### Apache > **Warning** > Apache has some known problems with Firefish. Only use it if you have to. @@ -231,9 +200,10 @@ example.tld { - Edit `firefish.apache.conf` to reflect your server properly - Run `sudo a2ensite firefish.apache` to enable the site - Run `sudo service apache2 restart` to reload apache2 configuration -## 🚀 Build and launch! -### ðŸĒ NodeJS + pm2 +## Build and launch! + +### NodeJS + pm2 #### `git pull` and run these steps to update Firefish in the future! @@ -244,7 +214,7 @@ NODE_ENV=production pnpm run build && pnpm run migrate pm2 start "NODE_ENV=production pnpm run start" --name Firefish ``` -## 😉 Tips & Tricks +## Tips & Tricks - When editing the config file, please don't fill out the settings at the bottom. They're designed *only* for managed hosting, not self hosting. Those settings are much better off being set in Firefish's control panel. - Port 3000 (used in the default config) might be already used on your server for something else. To find an open port for Firefish, run `for p in {3000..4000}; do ss -tlnH | tr -s ' ' | cut -d" " -sf4 | grep -q "${p}$" || echo "${p}"; done | head -n 1`. Replace 3000 with the minimum port and 4000 with the maximum port if you need it. diff --git a/docs/development.md b/docs/development.md index 31e6bf9994..2c09a7736f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,4 +1,4 @@ -# 🌎 Firefish Developer Docs +# Firefish Developer Docs ## Nix Dev Environment The Firefish repo comes with a Nix-based shell environment to help make development as easy as possible! diff --git a/docs/docker.md b/docs/docker.md index b1e246e70b..11d2b87272 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,4 +1,4 @@ -# ðŸģ Running a Firefish server with Docker +# Running a Firefish server with Docker ## Pre-built docker container [registry.firefish.dev/firefish/firefish](https://firefish.dev/firefish/firefish/container_registry) diff --git a/docs/migrate.md b/docs/migrate.md index b42b72c263..77c7377f7a 100644 --- a/docs/migrate.md +++ b/docs/migrate.md @@ -1,4 +1,4 @@ -# 🚚 Migrating from Misskey/FoundKey to Firefish +# Migrating from Misskey/FoundKey to Firefish All the guides below assume you're starting in the root of the repo directory. diff --git a/packages/README.md b/packages/README.md index 724f793222..4eb66b9315 100644 --- a/packages/README.md +++ b/packages/README.md @@ -1,4 +1,4 @@ -# ðŸ“Ķ Packages +# Packages This directory contains all of the packages Firefish uses.