2017-05-17 22:56:23 -07:00
|
|
|
Misskey Setup and Installation Guide
|
|
|
|
|
================================================================
|
|
|
|
|
|
2017-11-12 03:25:18 -08:00
|
|
|
We thank you for your interest in setting up your Misskey server!
|
2017-05-17 23:05:48 -07:00
|
|
|
This guide describes how to install and setup Misskey.
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2017-05-18 08:55:06 -07:00
|
|
|
[Japanese version also available - 日本語版もあります](./setup.ja.md)
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2017-05-18 08:52:50 -07:00
|
|
|
----------------------------------------------------------------
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2018-03-26 20:55:58 -07:00
|
|
|
*1.* reCAPTCHA tokens
|
2017-05-17 22:56:23 -07:00
|
|
|
----------------------------------------------------------------
|
|
|
|
|
Misskey requires reCAPTCHA tokens.
|
|
|
|
|
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
|
|
|
|
|
|
2017-11-22 12:43:00 -08:00
|
|
|
*(optional)* Generating VAPID keys
|
|
|
|
|
----------------------------------------------------------------
|
|
|
|
|
If you want to enable ServiceWroker, you need to generate VAPID keys:
|
|
|
|
|
|
|
|
|
|
``` shell
|
|
|
|
|
npm install web-push -g
|
|
|
|
|
web-push generate-vapid-keys
|
|
|
|
|
```
|
|
|
|
|
|
2018-03-26 20:55:58 -07:00
|
|
|
*2.* Install dependencies
|
2017-05-17 22:56:23 -07:00
|
|
|
----------------------------------------------------------------
|
2017-05-18 08:52:50 -07:00
|
|
|
Please install and setup these softwares:
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2017-05-18 08:52:50 -07:00
|
|
|
#### Dependencies :package:
|
|
|
|
|
* *Node.js* and *npm*
|
|
|
|
|
* **[MongoDB](https://www.mongodb.com/)**
|
|
|
|
|
* **[Redis](https://redis.io/)**
|
2018-04-15 03:59:29 -07:00
|
|
|
* **[ImageMagick](http://www.imagemagick.org/script/index.php)** >= 7.0
|
2017-05-18 08:52:50 -07:00
|
|
|
|
|
|
|
|
##### Optional
|
|
|
|
|
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
|
|
|
|
|
|
2018-04-01 19:32:27 -07:00
|
|
|
*3.* Install Misskey
|
|
|
|
|
----------------------------------------------------------------
|
|
|
|
|
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
|
|
|
|
2. `cd misskey`
|
|
|
|
|
3. `npm install`
|
|
|
|
|
|
|
|
|
|
*4.* Prepare configuration
|
2018-03-25 04:19:32 -07:00
|
|
|
----------------------------------------------------------------
|
2018-05-23 03:03:25 -07:00
|
|
|
You need to generate config file via `npm run config` command.
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2018-04-01 19:32:27 -07:00
|
|
|
*5.* Build Misskey
|
|
|
|
|
----------------------------------------------------------------
|
2018-04-15 03:52:16 -07:00
|
|
|
|
2018-06-01 11:52:47 -07:00
|
|
|
Build misskey with the following:
|
|
|
|
|
|
|
|
|
|
`npm run build`
|
|
|
|
|
|
2018-06-01 11:24:30 -07:00
|
|
|
If you're on Debian, you will need to install the `build-essential` package.
|
|
|
|
|
|
2018-06-01 11:52:47 -07:00
|
|
|
If you're still encountering errors about some modules, use node-gyp:
|
2018-06-01 11:24:30 -07:00
|
|
|
|
2018-06-01 11:52:47 -07:00
|
|
|
1. `npm install -g node-gyp`
|
|
|
|
|
2. `node-gyp configure`
|
|
|
|
|
3. `node-gyp build`
|
|
|
|
|
4. `npm run build`
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2018-04-01 19:32:27 -07:00
|
|
|
*6.* That is it.
|
2017-05-17 22:56:23 -07:00
|
|
|
----------------------------------------------------------------
|
2017-05-18 15:49:16 -07:00
|
|
|
Well done! Now, you have an environment that run to Misskey.
|
2017-05-17 22:56:23 -07:00
|
|
|
|
|
|
|
|
### Launch
|
|
|
|
|
Just `sudo npm start`. GLHF!
|
|
|
|
|
|
2018-04-01 19:34:35 -07:00
|
|
|
### Way to Update to latest version of your Misskey
|
2018-04-01 19:32:27 -07:00
|
|
|
1. `git reset --hard && git pull origin master`
|
|
|
|
|
2. `npm install`
|
|
|
|
|
3. `npm run build`
|
