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/)**
|
2017-12-09 05:35:26 -08:00
|
|
|
* **[ImageMagick](http://www.imagemagick.org/script/index.php)**
|
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-03-28 19:34:20 -07:00
|
|
|
1. Copy `example.yml` of `.config` directory
|
|
|
|
|
2. Rename it to `default.yml`
|
|
|
|
|
3. Edit it
|
2018-03-25 04:19:32 -07:00
|
|
|
|
2018-04-01 19:32:27 -07:00
|
|
|
---
|
2017-05-17 22:56:23 -07:00
|
|
|
|
2018-04-01 19:32:27 -07:00
|
|
|
Or you can 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
|
|
|
|
|
----------------------------------------------------------------
|
|
|
|
|
1. `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:32:27 -07:00
|
|
|
#### Way to Update to latest version of your Misskey
|
|
|
|
|
1. `git reset --hard && git pull origin master`
|
|
|
|
|
2. `npm install`
|
|
|
|
|
3. `npm run build`
|
|
|
|
|
|
2017-05-17 22:56:23 -07:00
|
|
|
### Testing
|
|
|
|
|
Run `npm test` after building
|
|
|
|
|
|
|
|
|
|
### Debugging :bug:
|
|
|
|
|
#### Show debug messages
|
|
|
|
|
Misskey uses [debug](https://github.com/visionmedia/debug) and the namespace is `misskey:*`.
|
