やった

docs/setup.en.md

@@ -0,0 +1,92 @@
+Misskey Setup and Installation Guide
+================================================================
+
+We thank you for your interest in setup your Misskey server!
+This guide describes how to install and setup Misskey.
+
+[Japanse version also available - 日本語版もあります](./setup.ja.md)
+
+----------------------------------------------------------------
+
+If you can use Docker, Please see [Setup with Docker](./docker.en.md).
+
+*1.* Domains
+----------------------------------------------------------------
+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}*
+* **dev**.*{primary domain}*
+* **file**.*{secondary domain}*
+
+*2.* reCAPTCHA tokens
+----------------------------------------------------------------
+Misskey requires reCAPTCHA tokens.
+Please visit https://www.google.com/recaptcha/intro/ and generate keys.
+
+*3.* Install dependencies
+----------------------------------------------------------------
+Please install and setup these softwares:
+
+#### 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
+----------------------------------------------------------------
+There is **two ways** to install Misskey:
+
+### WAY 1) Using built code (recommended)
+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`
+
+### WAY 2) Using source code
+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`
+
+*5.* That is it.
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 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:*`.