misskey/docs/setup.ja.md

Misskey構築の手引き

Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます！ このガイドではMisskeyのインストール・セットアップ方法について解説します。

英語版もあります - English version also available

---

Dockerを利用してMisskeyを構築することもできます: Setup with Docker。 その場合、3番目以降の手順はスキップできます。

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. 依存関係をインストールする

これらのソフトウェアをインストール・設定してください:

依存関係 📦

• Node.js と npm
• MongoDB
• Redis
• GraphicsMagick

オプション

• Elasticsearch - 検索機能を向上させるために用います。

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

デバッグ 🐛

デバッグメッセージを表示するようにする

Misskeyはdebugモジュールを利用しており、ネームスペースはmisskey:*となっています。