Merge branch 'docs/add_dependencies' into 'develop'

docs: add minimum dependencies See merge request firefish/firefish!10703
docs: add minimum dependencies
2024-04-19 03:39:51 +00:00 · 2024-03-19 22:51:05 +08:00
2 changed files with 32 additions and 0 deletions
--- a/dev/docs/local-installation.md
+++ b/dev/docs/local-installation.md
@ -42,6 +42,8 @@ cargo --version

 ### PostgreSQL and PGroonga

+Firefish requires PostgreSQL v12 or later. While you can choose any versions between v12 and the latest version (v16.2 as of writing), we recommend that you install v12.x so as not to use new features inadvertently and introduce incompatibility issues.
+
 PostgreSQL install instructions can be found at [this page](https://www.postgresql.org/download/).

 ```sh
--- a/docs/install.md
+++ b/docs/install.md
@ -4,6 +4,8 @@ This document shows an example procedure for installing Firefish on Debian 12. N

 If you want to use the pre-built container image, please refer to [`install-container.md`](./install-container.md).

+If you do not prepare your environment as document, be sure to meet the minimum dependencies given at the bottom of the page.
+
 Make sure that you can use the `sudo` command before proceeding.

 ## 1. Install dependencies
@ -316,3 +318,31 @@ cd ~/firefish
  - Run `psql -d firefish` (or whatever the database name is)
  - Run `UPDATE "user" SET "isAdmin" = true WHERE id='999999';` (replace `999999` with the copied ID)
  - Restart your Firefish server
+
+## Dependencies
+
+**We only recommend that you use components that are still within the upstream support cycle for better performance and security, and it is recommended that new sites meet the recommended dependency version requirements.**
+
+- At least [NodeJS](https://nodejs.org/en/) v18.17.0 (v20/v21 recommended)
+- At least [PostgreSQL](https://www.postgresql.org/) v12 (v16 recommended) with [PGroonga](https://pgroonga.github.io/) extension
+- At least [Redis](https://redis.io/) v7
+- Web Proxy (one of the following)
+  - Caddy (recommended for new users)
+  - Nginx (recommended)
+  - Apache
+
+### Optional dependencies
+
+- [FFmpeg](https://ffmpeg.org/) for video transcoding
+- Caching server (one of the following)
+  - [DragonflyDB](https://www.dragonflydb.io/) (recommended)
+  - [KeyDB](https://keydb.dev/)
+  - Another [Redis](https://redis.io/) server
+
+### Build dependencies
+
+- 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/)
Author	SHA1	Message	Date
laozhoubuluo	8d0128e879	Merge branch 'docs/add_dependencies' into 'develop' docs: add minimum dependencies See merge request firefish/firefish!10703	2024-04-19 03:39:51 +00:00
老周部落	de4da3c1fd	docs: add minimum dependencies	2024-03-19 22:51:05 +08:00