Sharkey/docs/setup.ja.md

70 lines
2.5 KiB
Markdown
Raw Normal View History

2017-05-18 18:52:50 +03:00
Misskey構築の手引き
================================================================
Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます
このガイドではMisskeyのインストール・セットアップ方法について解説します。
[英語版もあります - English version also available](./setup.en.md)
----------------------------------------------------------------
2018-03-27 06:55:58 +03:00
*1.* reCAPTCHAトークンの用意
2017-05-18 18:52:50 +03:00
----------------------------------------------------------------
MisskeyはreCAPTCHAトークンを必要とします。
https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
*(オプション)* VAPIDキーペアの生成
----------------------------------------------------------------
ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:
``` shell
npm install web-push -g
web-push generate-vapid-keys
```
2018-03-27 06:55:58 +03:00
*2.* 依存関係をインストールする
2017-05-18 18:52:50 +03:00
----------------------------------------------------------------
これらのソフトウェアをインストール・設定してください:
#### 依存関係 :package:
* *Node.js* と *npm*
* **[MongoDB](https://www.mongodb.com/)**
* **[Redis](https://redis.io/)**
* **[ImageMagick](http://www.imagemagick.org/script/index.php)**
2017-05-18 18:52:50 +03:00
##### オプション
* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
2018-03-27 06:55:58 +03:00
*3.* 設定ファイルを用意する
2018-03-25 14:19:32 +03:00
----------------------------------------------------------------
2018-03-29 05:34:20 +03:00
1. `.config`ディレクトリ内の`example.yml`をコピー
2. `default.yml`にリネーム
3. 編集する
2018-03-25 14:19:32 +03:00
2018-03-27 06:55:58 +03:00
*4.* Misskeyのインストール(とビルド)
2017-05-18 18:52:50 +03:00
----------------------------------------------------------------
1. `git clone -b master git://github.com/syuilo/misskey.git`
2. `cd misskey`
3. `npm install`
4. `npm run build`
#### アップデートするには:
2018-03-04 02:41:21 +02:00
1. `git reset --hard && git pull origin master`
2017-05-18 18:52:50 +03:00
2. `npm install`
3. `npm run build`
2018-03-27 06:55:58 +03:00
*5.* 以上です!
2017-05-18 18:52:50 +03:00
----------------------------------------------------------------
お疲れ様でした。これでMisskeyを動かす準備は整いました。
### 起動
`sudo npm start`するだけです。GLHF!
### テスト
(ビルドされている状態で)`npm test`
### デバッグ :bug:
#### デバッグメッセージを表示するようにする
Misskeyは[debug](https://github.com/visionmedia/debug)モジュールを利用しており、ネームスペースは`misskey:*`となっています。