隠れ家Wiki

Appearance

セットアップ方法

手動でのセットアップ方法 ​

TIP

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

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

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

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

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

bash
sudo -iu misskey
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を起動できます。

bash
NODE_ENV=production pnpm run start

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

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

ini
[Unit]
Description=Misskey daemon

[Service]
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
StandardError=journal
SyslogIdentifier=misskey
Restart=always

[Install]
WantedBy=multi-user.target

6. 検索プロバイダの設定 (任意) ​

Misskey 2025.1.0からは検索プロバイダとしてpgroongaを使用することが出来るようになっており、隠れ家フォークではノート検索に加えてユーザー検索でもpgroongaを使用するように改変されています。
検索プロバイダにpgroongaを指定する場合は、pgroongaを導入した後に以下のようにインデックスを作成してください。

TIP

pgroongaのインストール方法はこちらを参照してください。

INFO

バージョン 2024.11.0-kakurega.1.39.6 以前から使用している場合はインデックスを作成する必要はありません。

sql
CREATE INDEX "IDX_PGROONGA_NOTE_TEXT" ON "note" USING "pgroonga" ("text");
CREATE INDEX "IDX_PGROONGA_USER_NAME" ON "user" USING "pgroonga" ("name" pgroonga_varchar_full_text_search_ops_v2);
CREATE INDEX "IDX_PGROONGA_USER_PROFILE_DESCRIPTION" ON "user_profile" USING "pgroonga" ("description" pgroonga_varchar_full_text_search_ops_v2);

Dockerを用いたセットアップ方法 ​

TIP

基本的な操作はMisskeyHubのドキュメントに記載されている内容と同様ですが、隠れ家フォークを使用する場合は手順「ビルドと初期化」を行う必要はありません。

Note

DockerおよびDocker Composeがインストールされていることを前提としています。
インストールされていない場合はインストールをした上で、以下の手順に従って操作してください

1. リポジトリのクローン ​

bash
git clone -b master-kakurega https://github.com/hideki0403/kakurega.app.git
cd kakurega.app
git checkout master-kakurega

2. configのセットアップ ​

以下のコマンドで設定ファイルをコピーし、configの編集を行います。

bash
cp .config/docker_example.yml .config/default.yml
cp .config/docker_example.env .config/docker.env
cp ./docker-compose_example.yml ./docker-compose.yml

基本的にはdefault.ymlの編集のみで問題ありません。

Important

default.yml内のPostgreSQLの接続に使用するデータベース名、ユーザー名、パスワードを変更した場合はdocker.envも編集してください。

Note

公開するポートを変更する場合はdocker-compose.ymlも編集してください。

3. Dockerコンテナの起動 ​

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

bash
sudo docker compose up -d