mirror of
https://github.com/misskey-dev/misskey
synced 2024-08-28 12:41:17 +02:00
2.1 KiB
2.1 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 >= 7.0
Optional
- Elasticsearch - used to provide searching feature instead of MongoDB
3. Install Misskey
git clone -b master git://github.com/syuilo/misskey.git
cd misskey
npm install
4. Prepare configuration
You need to generate config file via npm run config
command.
5. Build Misskey
We need to use node-gyp
to build the crypto
module.
npm install -g node-gyp
node-gyp configure
node-gyp build
npm run build
6. That is it.
Well done! Now, you have an environment that run to Misskey.
Launch
Just sudo npm start
. GLHF!
Way to Update to latest version of your Misskey
git reset --hard && git pull origin master
npm install
npm run build