misskey/docs/setup.ja.md

81 lines
3.3 KiB
Markdown
Raw Normal View History

2017-05-18 17:52:50 +02:00
Misskey構築の手引き
================================================================
Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます
このガイドではMisskeyのインストール・セットアップ方法について解説します。
[英語版もあります - English version also available](./setup.en.md)
----------------------------------------------------------------
2018-03-27 05:55:58 +02:00
*1.* reCAPTCHAトークンの用意
2017-05-18 17:52:50 +02: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 05:55:58 +02:00
*2.* 依存関係をインストールする
2017-05-18 17:52:50 +02: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 17:52:50 +02:00
##### オプション
* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
2018-04-02 04:32:27 +02:00
*3.* Misskeyのインストール
----------------------------------------------------------------
1. `git clone -b master git://github.com/syuilo/misskey.git`
2. `cd misskey`
3. `npm install`
*4.* 設定ファイルを用意する
2018-03-25 13:19:32 +02:00
----------------------------------------------------------------
2018-03-29 04:34:20 +02:00
1. `.config`ディレクトリ内の`example.yml`をコピー
2. `default.yml`にリネーム
3. 編集する
2018-03-25 13:19:32 +02:00
2018-04-02 04:32:27 +02:00
---
2017-05-18 17:52:50 +02:00
2018-04-02 04:32:27 +02:00
または、`npm run config`コマンドを利用して、ガイドに従って情報を
入力して設定ファイルを生成することもできます。
2017-05-18 17:52:50 +02:00
2018-04-02 04:32:27 +02:00
*5.* Misskeyのビルド
----------------------------------------------------------------
1. `npm run build`
2017-05-18 17:52:50 +02:00
2018-04-02 04:32:27 +02:00
*6.* 以上です!
2017-05-18 17:52:50 +02:00
----------------------------------------------------------------
お疲れ様でした。これでMisskeyを動かす準備は整いました。
### 起動
`sudo npm start`するだけです。GLHF!
2018-04-02 04:34:35 +02:00
### Misskeyを最新バージョンにアップデートする方法:
2018-04-02 04:32:27 +02:00
1. `git reset --hard && git pull origin master`
2. `npm install`
3. `npm run build`
2018-05-07 21:04:18 +02:00
## メモリが足りなくてビルドできない場合
Misskeyの(クライアントの)ビルドには、目安として8GBくらいのメモリを必要とします。
VPSなどでビルドする時は、もしかしたらメモリが足りなくなる可能性があります。
そうなった場合、もしVPSではなくあなたのPCが十分なメモリを搭載しているなら、あなたのPC上でビルドし、生成されたファイルをVPSにFTPでアップロードする方法を採ることができます。
1. あなたのPC上にMisskeyをインストールする
2. 設定ファイルを用意する。設定ファイルは、サーバーに合わせた設定にします。
3. npm run webpack
4. built/client をサーバーにアップロードする
5. サーバー上で、npm run gulp
6. 完了