misskey/docs/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 - 日本語版もあります

---

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 >= 10.0.0
• MongoDB >= 3.6

Optional

• Redis
  • Redis is optional, but we strongly recommended to install it
• Elasticsearch - required to enable the search feature
• FFmpeg

3. Setup MongoDB

As root:

1. mongo Go to the mongo shell
2. use misskey Use the misskey database
3. db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } ) Create the misskey user.
4. exit You're done!

4. Install Misskey

1. Connect to misskey user.

   su - misskey

2. Clone the misskey repo from master branch.

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

3. Navigate to misskey directory

   cd misskey

4. Checkout to the latest release

   git tag | grep '^10\.' | sort -V --reverse | \
   while read tag_name; do \
   if ! curl -s "https://api.github.com/repos/syuilo/misskey/releases/tags/$tag_name" \
   | grep -qE '"(draft|prerelease)": true'; \
   then git checkout $tag_name; break; fi ; done
   

5. Install misskey dependencies.

   npm install

5. 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

6. Build Misskey

Build misskey with the following:

NODE_ENV=production npm run 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. npm install -g node-gyp
2. node-gyp configure
3. node-gyp build
4. NODE_ENV=production npm run build

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

1. Create a systemd service here

   /etc/systemd/system/misskey.service

2. 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
   

3. Reload systemd and enable the misskey service.

   systemctl daemon-reload ; systemctl enable misskey

4. 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

1. git fetch

2. 　

   git tag | grep '^10\.' | sort -V --reverse | \
   while read tag_name; do \
   if ! curl -s "https://api.github.com/repos/syuilo/misskey/releases/tags/$tag_name" \
   | grep -qE '"(draft|prerelease)": true'; \
   then git checkout $tag_name; break; fi ; done
   

3. npm install

4. NODE_ENV=production npm run build

5. Check ChangeLog for migration information

6. Restart your Misskey process to apply changes

7. Enjoy

---

If you have any questions or troubles, feel free to contact us!