Sharkey/docs/setup.en.md

74 lines
2.2 KiB
Markdown
Raw Normal View History

2017-05-18 07:56:23 +02:00
Misskey Setup and Installation Guide
================================================================
2017-11-12 12:25:18 +01:00
We thank you for your interest in setting up your Misskey server!
2017-05-18 08:05:48 +02:00
This guide describes how to install and setup Misskey.
2017-05-18 07:56:23 +02:00
2017-05-18 17:55:06 +02:00
[Japanese version also available - 日本語版もあります](./setup.ja.md)
2017-05-18 07:56:23 +02:00
2017-05-18 17:52:50 +02:00
----------------------------------------------------------------
2017-05-18 07:56:23 +02:00
2018-03-27 05:55:58 +02:00
*1.* reCAPTCHA tokens
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
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:
``` shell
npm install web-push -g
web-push generate-vapid-keys
```
2018-03-27 05:55:58 +02:00
*2.* Install dependencies
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
2017-05-18 17:52:50 +02:00
Please install and setup these softwares:
2017-05-18 07:56:23 +02:00
2017-05-18 17:52:50 +02:00
#### Dependencies :package:
* *Node.js* and *npm*
* **[MongoDB](https://www.mongodb.com/)**
* **[Redis](https://redis.io/)**
* **[ImageMagick](http://www.imagemagick.org/script/index.php)** >= 7.0
2017-05-18 17:52:50 +02:00
##### Optional
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
2018-04-02 04:32:27 +02: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 13:19:32 +02:00
----------------------------------------------------------------
2018-03-29 04:34:20 +02:00
1. Copy `example.yml` of `.config` directory
2. Rename it to `default.yml`
3. Edit it
2018-03-25 13:19:32 +02:00
2018-04-02 04:32:27 +02:00
---
2017-05-18 07:56:23 +02:00
2018-04-02 04:32:27 +02:00
Or you can generate config file via `npm run config` command.
2017-05-18 07:56:23 +02:00
2018-04-02 04:32:27 +02:00
*5.* Build Misskey
----------------------------------------------------------------
We need to use `node-gyp` to build the `crypto` module.
1. `npm install -g node-gyp`
2018-04-15 12:55:15 +02:00
2. `node-gyp configure`
3. `node-gyp build`
2018-04-15 12:52:54 +02:00
4. `npm run build`
2017-05-18 07:56:23 +02:00
2018-04-02 04:32:27 +02:00
*6.* That is it.
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
2017-05-19 00:49:16 +02:00
Well done! Now, you have an environment that run to Misskey.
2017-05-18 07:56:23 +02:00
### Launch
Just `sudo npm start`. GLHF!
2018-04-02 04:34:35 +02:00
### Way to Update to latest version of your Misskey
2018-04-02 04:32:27 +02:00
1. `git reset --hard && git pull origin master`
2. `npm install`
3. `npm run build`