diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-03-27 12:55:58 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-03-27 12:55:58 +0900 |
| commit | 696d810677a04e2b8df7b0e151e074973baa173a (patch) | |
| tree | cf44f9200f140e762edaa528e302d3cab193a1d3 /docs/setup.en.md | |
| parent | Bye bye secondary domain (diff) | |
| download | sharkey-696d810677a04e2b8df7b0e151e074973baa173a.tar.gz sharkey-696d810677a04e2b8df7b0e151e074973baa173a.tar.bz2 sharkey-696d810677a04e2b8df7b0e151e074973baa173a.zip | |
Update docs
Diffstat (limited to 'docs/setup.en.md')
| -rw-r--r-- | docs/setup.en.md | 33 |
1 files changed, 5 insertions, 28 deletions
diff --git a/docs/setup.en.md b/docs/setup.en.md index e7de83689a..08cd16857d 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -8,30 +8,7 @@ This guide describes how to install and setup Misskey. ---------------------------------------------------------------- -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 the 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}* -* **docs**.*{primary domain}* -* **ch**.*{primary domain}* -* **stats**.*{primary domain}* -* **status**.*{primary domain}* -* **dev**.*{primary domain}* -* **file**.*{secondary domain}* - -*2.* reCAPTCHA tokens +*1.* reCAPTCHA tokens ---------------------------------------------------------------- Misskey requires reCAPTCHA tokens. Please visit https://www.google.com/recaptcha/intro/ and generate keys. @@ -45,7 +22,7 @@ npm install web-push -g web-push generate-vapid-keys ``` -*3.* Install dependencies +*2.* Install dependencies ---------------------------------------------------------------- Please install and setup these softwares: @@ -58,13 +35,13 @@ Please install and setup these softwares: ##### Optional * [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB -*4.* Prepare configuration +*3.* Prepare configuration ---------------------------------------------------------------- First, you need to create a `.config` directory in the directory that Misskey installed. And then you need to create a `default.yml` file in the directory. The template of configuration is available [here](./config.md). -*5.* Install Misskey +*4.* Install and build Misskey ---------------------------------------------------------------- 1. `git clone -b master git://github.com/syuilo/misskey.git` @@ -77,7 +54,7 @@ the directory. The template of configuration is available [here](./config.md). 2. `npm install` 3. `npm run build` -*6.* That is it. +*5.* That is it. ---------------------------------------------------------------- Well done! Now, you have an environment that run to Misskey. |