manual.md

手動でのMisskey(隠れ家フォーク)のセットアップ方法

Tip

基本的な操作はMisskeyHubのドキュメントに記載されている内容と同様です。

1. 前提ソフトウェアのインストールとユーザーの作成

ドキュメントに記載されている手順に従って、Misskeyの動作に必要なソフトウェアのインストールおよびユーザーの作成を行います。

• 前提ソフトウェア
• ユーザーの作成

Important

ドキュメントに記載されている前提ソフトウェアに加え、pgroongaのインストールが必須になります
インストール方法はこちらを参照してください。

マイグレーション時の注意点

マイグレーションを行うユーザー (.config/default.yml のdbに記載されているユーザー) がスーパーユーザー権限を持っていないとコケる可能性があります。
マイグレーション時に QueryFailedError: permission denied to create extension "pgroonga" が表示された場合は、一時的にスーパーユーザー権限を付与してマイグレーションを行ってください。

pgroongaを使用しない場合

手順「2. リポジトリのクローンとインストール」の後に以下のコマンドを実行し、関連するコミットおよびコードを取り除いてください

git revert 923c9de5c5cb1ba2e3e9c924f5227aaa61bd7f00
git revert 4b63224f3a53a5e38f9a901e40c7a4fadbbd42a8

2. リポジトリのクローンとインストール

以下のコマンドでリポジトリをクローンし、依存関係のインストールを行います。

git clone --recursive https://github.com/hideki0403/kakurega.app.git
cd kakurega.app
git checkout master-kakurega
git submodule update --init
NODE_ENV=production pnpm install --frozen-lockfile

3. 設定およびビルドと初期化

ドキュメントに記載されている手順に従い、設定・ビルド・初期化を行います。

• 設定
• ビルドと初期化

4. 起動

以下のコマンドでMisskeyを起動できます。

NODE_ENV=production pnpm run start

5. サービスの設定 (任意)

ドキュメントに記載されている「systemdを用いた管理」に従って操作を行うことでサービスとして運用することが出来ますが、サービスファイルの作成時に以下の箇所を修正する必要があります。

--- a.service   2024-03-11 16:21:27.559208177 +0900
+++ b.service   2024-03-11 16:21:39.335118743 +0900
@@ -5,7 +5,7 @@
 Type=simple
 User=misskey
 ExecStart=/usr/bin/npm start
-WorkingDirectory=/home/misskey/misskey
+WorkingDirectory=/home/misskey/kakurega.app
 Environment="NODE_ENV=production"
 TimeoutSec=60
 StandardOutput=journal