Sharkey/docs/setup.ja.md
2018-03-29 14:48:47 +09:00

2.5 KiB
Raw Blame History

Misskey構築の手引き

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

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


1. reCAPTCHAトークンの用意

MisskeyはreCAPTCHAトークンを必要とします。 https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。

(オプション) VAPIDキーペアの生成

ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:

npm install web-push -g
web-push generate-vapid-keys

2. 依存関係をインストールする

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

依存関係 📦

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

3. 設定ファイルを用意する

  1. .configディレクトリ内のexample.ymlをコピー
  2. default.ymlにリネーム
  3. 編集する

4. Misskeyのインストール(とビルド)

  1. git clone -b master git://github.com/syuilo/misskey.git
  2. cd misskey
  3. npm install
  4. npm run build

アップデートするには:

  1. git reset --hard && git pull origin master
  2. npm install
  3. npm run build

5. 以上です!

お疲れ様でした。これでMisskeyを動かす準備は整いました。

起動

sudo npm startするだけです。GLHF!

テスト

(ビルドされている状態で)npm test

デバッグ 🐛

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

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