Skip to content
Snippets Groups Projects
Commit 696d8106 authored by syuilo's avatar syuilo
Browse files

Update docs

parent 336384a1
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -8,31 +8,7 @@ Misskeyサーバーの構築にご関心をお寄せいただきありがとう
----------------------------------------------------------------
Dockerを利用してMisskeyを構築することもできます: [Setup with Docker](./docker.en.md)
その場合、*3番目*以降の手順はスキップできます。
*1.* ドメインの用意
----------------------------------------------------------------
Misskeyはプライマリ ドメインとセカンダリ ドメインを必要とします。
* プライマリ ドメインはMisskeyの主要な部分を提供するために使われます。
* セカンダリ ドメインはXSSといった脆弱性の対策に使われます。
**セカンダリ ドメインがプライマリ ドメインのサブドメインであってはなりません。**
### サブドメイン
Misskeyは以下のサブドメインを使います:
* **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トークンの用意
*1.* reCAPTCHAトークンの用意
----------------------------------------------------------------
MisskeyはreCAPTCHAトークンを必要とします。
https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
......@@ -46,7 +22,7 @@ npm install web-push -g
web-push generate-vapid-keys
```
*3.* 依存関係をインストールする
*2.* 依存関係をインストールする
----------------------------------------------------------------
これらのソフトウェアをインストール・設定してください:
......@@ -59,13 +35,13 @@ web-push generate-vapid-keys
##### オプション
* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
*4.* 設定ファイルを用意する
*3.* 設定ファイルを用意する
----------------------------------------------------------------
Misskeyをインストールしたディレクトリに、`.config`というディレクトリを作成し、
その中に`default.yml`という名前で設定ファイルを作ってください。
設定ファイルの下書きは[ここ](./config.md)にありますので、コピペしてご利用ください。
*5.* Misskeyのインストール
*4.* Misskeyのインストール(とビルド)
----------------------------------------------------------------
1. `git clone -b master git://github.com/syuilo/misskey.git`
......@@ -78,7 +54,7 @@ Misskeyをインストールしたディレクトリに、`.config`というデ
2. `npm install`
3. `npm run build`
*6.* 以上です!
*5.* 以上です!
----------------------------------------------------------------
お疲れ様でした。これでMisskeyを動かす準備は整いました。
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment