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 ofyarn
. - Elasticsearch - required to enable the search feature
- FFmpeg
3. Install Misskey
-
Connect to misskey user.
su - misskey
-
Clone the misskey repo from master branch.
git clone -b master git://github.com/syuilo/misskey.git
-
Navigate to misskey directory
cd misskey
-
Checkout to the latest release
git checkout master
-
Install misskey dependencies.
yarn
4. Configure Misskey
-
Copy the
.config/example.yml
and rename it todefault.yml
.cp .config/example.yml .config/default.yml
-
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:
npx node-gyp configure
npx node-gyp build
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
-
Create a systemd service here
/etc/systemd/system/misskey.service
-
Edit it, and paste this and save:
[Unit] Description=Misskey daemon [Service] Type=simple User=misskey ExecStart=/usr/bin/npm start WorkingDirectory=/home/misskey/misskey Environment="NODE_ENV=production" TimeoutSec=60 StandardOutput=syslog StandardError=syslog SyslogIdentifier=misskey Restart=always [Install] WantedBy=multi-user.target
-
Reload systemd and enable the misskey service.
systemctl daemon-reload ; systemctl enable misskey
-
Start the misskey service.
systemctl start misskey
You can check if the service is running with systemctl status misskey
.
How to update your Misskey server to the latest version
git checkout master
git pull
yarn install
NODE_ENV=production yarn build
yarn migrate
- Restart your Misskey process to apply changes
- Enjoy
If you encounter any problems with updating, please try the following:
yarn clean
oryarn cleanall
- Retry update (Don't forget
yarn install
If you have any questions or troubles, feel free to contact us!