summaryrefslogtreecommitdiff
path: root/docs/setup.ja.md
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-05-19 00:52:50 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-05-19 00:52:50 +0900
commit6e57ef281da36c3a3dc5049e57f58e32003ada0e (patch)
tree4384df411757720165f8a7c6388ab853f6cfeaf6 /docs/setup.ja.md
parentUpdate setup.md (diff)
downloadsharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.tar.gz
sharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.tar.bz2
sharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.zip
やった
Diffstat (limited to 'docs/setup.ja.md')
-rw-r--r--docs/setup.ja.md93
1 files changed, 93 insertions, 0 deletions
diff --git a/docs/setup.ja.md b/docs/setup.ja.md
new file mode 100644
index 0000000000..e260ae0fcb
--- /dev/null
+++ b/docs/setup.ja.md
@@ -0,0 +1,93 @@
+Misskey構築の手引き
+================================================================
+
+Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます!
+このガイドではMisskeyのインストール・セットアップ方法について解説します。
+
+[英語版もあります - English version also available](./setup.en.md)
+
+----------------------------------------------------------------
+
+Dockerを利用してMisskeyを構築することもできます: [Setup with Docker](./docker.en.md)。
+その場合、3および4番目の手順はスキップできます。
+
+*1.* ドメインの用意
+----------------------------------------------------------------
+Misskeyはプライマリ ドメインとセカンダリ ドメインを必要とします。
+
+* プライマリ ドメインはMisskeyの主要な部分を提供するために使われます。
+* セカンダリ ドメインはXSSといった脆弱性の対策に使われます。
+
+**セカンダリ ドメインがプライマリ ドメインのサブドメインであってはなりません。**
+
+### サブドメイン
+Misskeyは以下のサブドメインを使います:
+
+* **api**.*{primary domain}*
+* **auth**.*{primary domain}*
+* **about**.*{primary domain}*
+* **dev**.*{primary domain}*
+* **file**.*{secondary domain}*
+
+*2.* reCAPTCHAトークンの用意
+----------------------------------------------------------------
+MisskeyはreCAPTCHAトークンを必要とします。
+https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
+
+*3.* 依存関係をインストールする
+----------------------------------------------------------------
+これらのソフトウェアをインストール・設定してください:
+
+#### 依存関係 :package:
+* *Node.js* と *npm*
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[GraphicsMagick](http://www.graphicsmagick.org/)**
+
+##### オプション
+* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
+
+*4.* Misskeyのインストール
+----------------------------------------------------------------
+Misskeyをインストールするには**2つの方法**があります:
+
+### 方法 1) ビルドされたコードを利用する (推奨)
+Misskeyには公式のリリースがあります。
+ビルドされたコードはCIテストに合格した後、自動で https://github.com/syuilo/misskey/tree/release にpushされています。
+
+1. `git clone -b release git://github.com/syuilo/misskey.git`
+2. `cd misskey`
+3. `npm install`
+
+#### アップデートするには:
+1. `git fetch`
+2. `git reset --hard origin/release`
+3. `npm install`
+
+### 方法 2) ソースコードを利用する
+Misskeyを手動でビルドしたい場合は、Misskeyのソースコードと依存関係をインストールした後、
+`build`コマンドを用いることができます:
+
+1. `git clone -b master git://github.com/syuilo/misskey.git`
+2. `cd misskey`
+3. `npm install`
+4. `npm run build`
+
+#### アップデートするには:
+1. `git pull origin master`
+2. `npm install`
+3. `npm run build`
+
+*5.* 以上です!
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 起動
+`sudo npm start`するだけです。GLHF!
+
+### テスト
+(ビルドされている状態で)`npm test`
+
+### デバッグ :bug:
+#### デバッグメッセージを表示するようにする
+Misskeyは[debug](https://github.com/visionmedia/debug)モジュールを利用しており、ネームスペースは`misskey:*`となっています。