puniko/FoundKey
1
0
Fork 0
forked from FoundKeyGang/FoundKey
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add dependency install example for Debian

Browse source
This commit is contained in:
Norm 2022-07-29 02:22:00 -04:00
parent c4415e9af3
commit 7a39c74a78
Signed by untrusted user: norm
GPG key ID: 7123E30E441E80DE
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/INSTALL.md
View file

@ -23,11 +23,23 @@ FoundKey requires the following packages to run:
* **[Node.js](https://nodejs.org/en/)** (16.x)
* **[PostgreSQL](https://www.postgresql.org/)** (12.x / 13.x is preferred)
* **[Redis](https://redis.io/)**
* A C/C++ compiler toolchain like **GCC** or **Clang**.
##### Optional
* [Yarn](https://yarnpkg.com/) - *Optional but recommended for security reasons. If you won't install it, use `npx yarn` instead of `yarn`.*
* [FFmpeg](https://www.ffmpeg.org/)
To install the dependiencies on Debian (or derivatives like Ubuntu) you can use the following commands:
```sh
curl -fsSL https://deb.nodesource.com/setup_16.x | bash -
apt install build-essential nodejs postgresql redis
# Optional dependencies
apt install ffmpeg
corepack enable # for yarn
```
Other OSes will have different package names and package managers to install the dependencies.
*3.* Install FoundKey
----------------------------------------------------------------
1. Connect to the `foundkey` user