setup.en.md

Misskey Setup and Installation Guide

We thank you for your interest in setting up your Misskey server! This guide describes how to install and setup Misskey.

• Japanese version also available - 日本語版もあります
• Simplified Chinese version also available - 简体中文版同样可用

---

1. Create Misskey user

Running misskey as root is not a good idea so we create a user for that. In debian for exemple :

adduser --disabled-password --disabled-login misskey

2. Install dependencies

Please install and setup these softwares:

Dependencies 📦

• Node.js (12.x, 14.x)
• PostgreSQL (>= 10)
• Redis

Optional

• Yarn Optional but recommended for security reason. If you won't install it, use npx yarn instead of yarn.
• Elasticsearch - required to enable the search feature
• FFmpeg

3. Install Misskey

1. Connect to misskey user.

   su - misskey

2. Clone the misskey repo from master branch.

   git clone -b master git://github.com/misskey-dev/misskey.git

3. Navigate to misskey directory

   cd misskey

4. Checkout to the latest release

   git checkout master

5. Install misskey dependencies.

   yarn

4. Configure Misskey

1. Copy the .config/example.yml and rename it to default.yml.

   cp .config/example.yml .config/default.yml

2. Edit default.yml

5. Build Misskey

Build misskey with the following:

NODE_ENV=production yarn build

If you're on Debian, you will need to install the build-essential, python package.

If you're still encountering errors about some modules, use node-gyp:

1. npx node-gyp configure
2. npx node-gyp build
3. NODE_ENV=production yarn build

6. Init DB

yarn run init

7. That is it.

Well done! Now, you have an environment that run to Misskey.

Launch normally

Just NODE_ENV=production npm start. GLHF!

Launch with systemd