Misskey構築の手引き

このガイドではMisskeyのインストール・セットアップ方法について解説します。

前提条件

以下のソフトウェアがインストール・設定されていること

環境変数が次のように設定されていること

NODE_ENV=production
1

ユーザーの作成

Misskeyはrootユーザーで実行しない方がよいため、代わりにユーザーを作成します。 Debianの例:

adduser --disabled-password --disabled-login misskey
1

Misskeyのインストール

su - misskey
git clone --recursive -b master https://github.com/misskey-dev/misskey.git
git submodule update --init
cd misskey
git checkout master
yarn install
1
2
3
4
5
6

設定

設定サンプルの.config/example.ymlをコピーし、default.ymlにリネームします。

cp .config/example.yml .config/default.yml
1

default.yml をファイル内の指示に従って編集します。

ビルドと初期化

次のコマンドでMisskeyのビルドとデータベースの初期化を行います。 これにはしばらく時間がかかります。

yarn build
yarn run init
1
2

Debianをお使いであれば、build-essentialパッケージをインストールする必要があります。

エラーが発生する場合

何らかのモジュールでエラーが発生する場合はnode-gypを使ってください:

npx node-gyp configure
npx node-gyp build
yarn build
1
2
3

起動

お疲れ様でした。以下のコマンドでMisskeyを起動できます。

yarn start
1

GLHF✨

systemdを用いた管理

systemdサービスのファイルを作成

/etc/systemd/system/misskey.service

エディタで開き、以下のコードを貼り付けて保存:

[Unit]
Description=Misskey daemon

[Service]
Type=simple
User=misskey
ExecStart=/usr/bin/npm start
WorkingDirectory=/home/misskey/misskey
Environment="NODE_ENV=production"
TimeoutSec=60
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=misskey
Restart=always

[Install]
WantedBy=multi-user.target
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

CentOSで1024以下のポートを使用してMisskeyを使用する場合はExecStart=/usr/bin/sudo /usr/bin/npm startに変更する必要があります。

systemdを再読み込みしmisskeyサービスを有効化

systemctl daemon-reload; systemctl enable misskey
1

misskeyサービスの起動

systemctl start misskey
1

systemctl status misskeyと入力すると、サービスの状態を調べることができます。

Misskeyのアップデート方法

アップデートの際は必ずリリースノートopen in new windowを確認し、変更点や追加で必要になる作業の有無(ほとんどの場合ありません)を予め把握するようにしてください。

masterをpullし直し、インストール、ビルド、データベースのマイグレーションを行います:

git checkout master
git pull
git submodule update --init
yarn install
yarn build
yarn migrate
1
2
3
4
5
6

アップデート内容、およびデータベースの規模によっては時間がかかることがあります。

アップデートが終わり次第、Misskeyプロセスを再起動してください。

ビルドや起動時にエラーが発生した場合は、以下のコマンドをお試しください:

  • yarn cleanまたはyarn cleanall
  • npm rebuild