Sharkey/docs/setup.ja.md
2018-04-02 11:34:35 +09:00

2.8 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. Misskeyのインストール

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

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

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

または、npm run configコマンドを利用して、ガイドに従って情報を 入力して設定ファイルを生成することもできます。

5. Misskeyのビルド

  1. npm run build

6. 以上です!

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

起動

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

Misskeyを最新バージョンにアップデートする方法:

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

テスト

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

デバッグ 🐛

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

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