forked from mirrors/misskey
2.2 KiB
2.2 KiB
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. reCAPTCHA tokens
Misskey requires reCAPTCHA tokens. Please visit https://www.google.com/recaptcha/intro/ and generate keys.
(optional) Generating VAPID keys
If you want to enable ServiceWroker, you need to generate VAPID keys:
npm install web-push -g
web-push generate-vapid-keys
2. Install dependencies
Please install and setup these softwares:
Dependencies 📦
- Node.js and npm
- MongoDB
- Redis
- ImageMagick
Optional
- Elasticsearch - used to provide searching feature instead of MongoDB
3. Prepare configuration
First, you need to create a .config
directory in the directory that
Misskey installed. And then you need to create a default.yml
file in
the directory. The template of configuration is available here.
4. Install and build Misskey
git clone -b master git://github.com/syuilo/misskey.git
cd misskey
npm install
npm run build
Update
git reset --hard && git pull origin master
npm install
npm run build
5. That is it.
Well done! Now, you have an environment that run to Misskey.
Launch
Just sudo npm start
. GLHF!
Testing
Run npm test
after building
Debugging 🐛
Show debug messages
Misskey uses debug and the namespace is misskey:*
.