misskey/docs/setup.en.md

93 lines
2.9 KiB
Markdown
Raw Normal View History

2017-05-18 05:56:23 +00:00
Misskey Setup and Installation Guide
================================================================
2017-11-12 11:25:18 +00:00
We thank you for your interest in setting up 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.
2018-03-15 06:16:54 +00:00
* The primary-domain is used to provide the main service of Misskey.
* The secondary-domain is used to avoid vulnerabilities such as XSS.
2017-05-18 05:56:23 +00:00
**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}*
2017-12-16 16:41:22 +00:00
* **docs**.*{primary domain}*
2017-10-31 18:17:14 +00:00
* **ch**.*{primary domain}*
2017-08-12 06:17:03 +00:00
* **stats**.*{primary domain}*
* **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.
*(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
```
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/)**
* **[ImageMagick](http://www.imagemagick.org/script/index.php)**
2017-05-18 15:52:50 +00:00
##### 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
1. `git clone -b master git://github.com/syuilo/misskey.git`
2. `cd misskey`
3. `npm install`
4. `npm run build`
#### Update
2018-03-04 00:41:30 +00:00
1. `git reset --hard && git pull origin master`
2017-05-18 05:56:23 +00:00
2. `npm install`
3. `npm run build`
2018-03-18 06:52:09 +00:00
*5.* Prepare configuration
----------------------------------------------------------------
First, you need to create a `.config` directory in the directory that
Misskey installed. Then you need to create a `default.yml` file in
the directory. The template of configuration is available [here](./config.md).
*6.* 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:*`.