2017-05-18 05:56:23 +00:00
|
|
|
Misskey Setup and Installation Guide
|
|
|
|
|
================================================================
|
|
|
|
|
|
2017-05-18 06:54:43 +00:00
|
|
|
We thank you for your interest in setup your Misskey server!
|
2017-05-18 06:05:48 +00:00
|
|
|
This guide describes how to install and setup Misskey.
|
2017-05-18 05:56:23 +00:00
|
|
|
|
2017-05-18 15:55:06 +00:00
|
|
|
[Japanese version also available - 日本語版もあります](./setup.ja.md)
|
2017-05-18 05:56:23 +00:00
|
|
|
|
2017-05-18 15:52:50 +00:00
|
|
|
----------------------------------------------------------------
|
2017-05-18 05:56:23 +00:00
|
|
|
|
2017-05-25 00:08:16 +00:00
|
|
|
If you can use Docker, please see [Setup with Docker](./docker.en.md).
|
2017-05-18 05:56:23 +00:00
|
|
|
|
2017-05-18 15:52:50 +00:00
|
|
|
*1.* Domains
|
2017-05-18 05:56:23 +00:00
|
|
|
----------------------------------------------------------------
|
|
|
|
|
Misskey requires two domains called the primary domain and the secondary domain.
|
|
|
|
|
|
|
|
|
|
* The primary domain is used to provide main service of Misskey.
|
|
|
|
|
* The secondary domain is used to avoid vulnerabilities such as XSS.
|
|
|
|
|
|
|
|
|
|
**Ensure that the secondary domain is not a subdomain of the primary domain.**
|
|
|
|
|
|
|
|
|
|
### Subdomains
|
|
|
|
|
Note that Misskey uses following subdomains:
|
|
|
|
|
|
|
|
|
|
* **api**.*{primary domain}*
|
|
|
|
|
* **auth**.*{primary domain}*
|
|
|
|
|
* **about**.*{primary domain}*
|
2017-08-11 14:57:16 +00:00
|
|
|
* **status**.*{primary domain}*
|
2017-05-18 05:56:23 +00:00
|
|
|
* **dev**.*{primary domain}*
|
|
|
|
|
* **file**.*{secondary domain}*
|
|
|
|
|
|
2017-05-18 15:52:50 +00:00
|
|
|
*2.* reCAPTCHA tokens
|
2017-05-18 05:56:23 +00:00
|
|
|
----------------------------------------------------------------
|
|
|
|
|
Misskey requires reCAPTCHA tokens.
|
|
|
|
|
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
|
|
|
|
|
|
2017-05-18 15:52:50 +00:00
|
|
|
*3.* Install dependencies
|
2017-05-18 05:56:23 +00:00
|
|
|
----------------------------------------------------------------
|
2017-05-18 15:52:50 +00:00
|
|
|
Please install and setup these softwares:
|
2017-05-18 05:56:23 +00:00
|
|
|
|
2017-05-18 15:52:50 +00:00
|
|
|
#### Dependencies :package:
|
|
|
|
|
* *Node.js* and *npm*
|
|
|
|
|
* **[MongoDB](https://www.mongodb.com/)**
|
|
|
|
|
* **[Redis](https://redis.io/)**
|
|
|
|
|
* **[GraphicsMagick](http://www.graphicsmagick.org/)**
|
|
|
|
|
|
|
|
|
|
##### Optional
|
|
|
|
|
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
|
|
|
|
|
|
|
|
|
|
*4.* Install Misskey
|
|
|
|
|
----------------------------------------------------------------
|
2017-05-18 05:56:23 +00:00
|
|
|
There is **two ways** to install Misskey:
|
|
|
|
|
|
2017-05-18 05:58:15 +00:00
|
|
|
### WAY 1) Using built code (recommended)
|
2017-05-18 05:56:23 +00:00
|
|
|
We have official release of Misskey.
|
|
|
|
|
The built code is automatically pushed to https://github.com/syuilo/misskey/tree/release after the CI test succeeds.
|
|
|
|
|
|
|
|
|
|
1. `git clone -b release git://github.com/syuilo/misskey.git`
|
|
|
|
|
2. `cd misskey`
|
|
|
|
|
3. `npm install`
|
|
|
|
|
|
|
|
|
|
#### Update
|
|
|
|
|
1. `git fetch`
|
|
|
|
|
2. `git reset --hard origin/release`
|
|
|
|
|
3. `npm install`
|
|
|
|
|
|
2017-05-18 05:58:15 +00:00
|
|
|
### WAY 2) Using source code
|
2017-05-18 05:56:23 +00:00
|
|
|
If you want to build Misskey manually, you can do it via the
|
|
|
|
|
`build` command after download the source code of Misskey and install dependencies:
|
|
|
|
|
|
|
|
|
|
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
|
|
|
|
2. `cd misskey`
|
|
|
|
|
3. `npm install`
|
|
|
|
|
4. `npm run build`
|
|
|
|
|
|
|
|
|
|
#### Update
|
|
|
|
|
1. `git pull origin master`
|
|
|
|
|
2. `npm install`
|
|
|
|
|
3. `npm run build`
|
|
|
|
|
|
2017-05-18 06:01:33 +00:00
|
|
|
*5.* That is it.
|
2017-05-18 05:56:23 +00:00
|
|
|
----------------------------------------------------------------
|
2017-05-18 22:49:16 +00:00
|
|
|
Well done! Now, you have an environment that run to Misskey.
|
2017-05-18 05:56:23 +00:00
|
|
|
|
|
|
|
|
### Launch
|
|
|
|
|
Just `sudo npm start`. GLHF!
|
|
|
|
|
|
|
|
|
|
### Testing
|
|
|
|
|
Run `npm test` after building
|
|
|
|
|
|
|
|
|
|
### Debugging :bug:
|
|
|
|
|
#### Show debug messages
|
|
|
|
|
Misskey uses [debug](https://github.com/visionmedia/debug) and the namespace is `misskey:*`.
|
