Sharkey/docs/setup.ja.md

131 lines
5.1 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-07-15 02:43:16 +02:00
*1.* Misskeyユーザーの作成
2017-05-18 17:52:50 +02:00
----------------------------------------------------------------
2018-09-10 11:32:51 +02:00
Misskeyはrootユーザーで実行しない方がよいため、代わりにユーザーを作成します。
2018-07-15 02:43:16 +02:00
Debianの例:
2018-07-15 02:43:16 +02:00
```
adduser --disabled-password --disabled-login misskey
```
2018-03-27 05:55:58 +02:00
*2.* 依存関係をインストールする
2017-05-18 17:52:50 +02:00
----------------------------------------------------------------
これらのソフトウェアをインストール・設定してください:
#### 依存関係 :package:
2018-11-05 02:48:40 +01:00
* **[Node.js](https://nodejs.org/en/)** (10.0.0以上)
2018-07-15 07:20:30 +02:00
* **[MongoDB](https://www.mongodb.com/)** (3.6以上)
2017-05-18 17:52:50 +02:00
##### オプション
2018-10-11 08:50:27 +02:00
* [Redis](https://redis.io/)
2018-10-11 11:18:15 +02:00
* Redisはオプションですが、インストールすることを強く推奨します。
* インストールしなくていいのは、あなたのインスタンスが自分専用のときだけとお考えください。
2018-10-11 11:20:27 +02:00
* 具体的には、Redisをインストールしないと、次の事が出来なくなります:
2018-10-11 11:18:15 +02:00
* Misskeyプロセスを複数起動しての負荷分散
* レートリミット
* Twitter連携
* [Elasticsearch](https://www.elastic.co/)
2018-10-11 11:20:27 +02:00
* 検索機能を有効にするためにはインストールが必要です。
2017-05-18 17:52:50 +02:00
2018-07-23 13:48:55 +02:00
*3.* MongoDBの設定
2018-04-02 04:32:27 +02:00
----------------------------------------------------------------
2018-07-15 02:43:16 +02:00
ルートで:
1. `mongo` mongoシェルを起動
2. `use misskey` misskeyデータベースを使用
3. `db.users.save( {dummy:"dummy"} )` ダミーデータを書き込みDBを初期化
4. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` misskeyユーザーを作成
5. `exit` mongoシェルを終了
*4.* Misskeyのインストール
----------------------------------------------------------------
1. `su - misskey` misskeyユーザーを使用
2. `git clone -b master git://github.com/syuilo/misskey.git` masterブランチからMisskeyレポジトリをクローン
3. `cd misskey` misskeyディレクトリに移動
4. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` [最新のリリース](https://github.com/syuilo/misskey/releases/latest)を確認
5. `npm install` Misskeyの依存パッケージをインストール
*(オプション)* VAPIDキーペアの生成
----------------------------------------------------------------
ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:
``` shell
npm install web-push -g
web-push generate-vapid-keys
```
2018-04-02 04:32:27 +02:00
2018-07-18 17:04:09 +02:00
*5.* 設定ファイルを作成する
2018-03-25 13:19:32 +02:00
----------------------------------------------------------------
2018-07-15 02:43:16 +02:00
1. `cp .config/example.yml .config/default.yml` `.config/example.yml`をコピーし名前を`default.yml`にする。
2. `default.yml` を編集する。
2017-05-18 17:52:50 +02:00
2018-07-18 17:04:09 +02:00
*6.* Misskeyのビルド
2018-04-02 04:32:27 +02:00
----------------------------------------------------------------
2018-07-15 02:43:16 +02:00
次のコマンドでMisskeyをビルドしてください:
`npm run build`
Debianをお使いであれば、`build-essential`パッケージをインストールする必要があります。
何らかのモジュールでエラーが発生する場合はnode-gypを使ってください:
2018-05-23 12:00:23 +02:00
1. `npm install -g node-gyp`
2. `node-gyp configure`
3. `node-gyp build`
4. `npm run build`
2017-05-18 17:52:50 +02:00
2018-07-18 17:04:09 +02:00
*7.* 以上です!
2017-05-18 17:52:50 +02:00
----------------------------------------------------------------
お疲れ様でした。これでMisskeyを動かす準備は整いました。
2018-07-15 02:43:16 +02:00
### 通常起動
`npm start`するだけです。GLHF!
### systemdを用いた起動
1. systemdサービスのファイルを作成: `/etc/systemd/system/misskey.service`
2. エディタで開き、以下のコードを貼り付けて保存:
```
[Unit]
Description=Misskey daemon
[Service]
Type=simple
User=misskey
ExecStart=/usr/bin/npm start
WorkingDirectory=/home/misskey/misskey
TimeoutSec=60
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=misskey
Restart=always
[Install]
WantedBy=multi-user.target
```
CentOSで1024以下のポートを使用してMisskeyを使用する場合は`ExecStart=/usr/bin/sudo /usr/bin/npm start`に変更する必要があります。
2018-07-15 02:43:16 +02:00
3. `systemctl daemon-reload ; systemctl enable misskey` systemdを再読み込みしmisskeyサービスを有効化
4. `systemctl start misskey` misskeyサービスの起動
`systemctl status misskey`と入力すると、サービスの状態を調べることができます。
2017-05-18 17:52:50 +02:00
2018-04-02 04:34:35 +02:00
### Misskeyを最新バージョンにアップデートする方法:
2018-07-15 02:43:16 +02:00
1. `git fetch`
2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
3. `npm install`
4. `npm run build`
2018-09-01 11:42:46 +02:00
5. [ChangeLog](../CHANGELOG.md)でマイグレーション情報を確認する
2018-05-07 21:04:18 +02:00
2018-07-24 21:15:22 +02:00
----------------------------------------------------------------
なにかお困りのことがありましたらお気軽にご連絡ください。