Docker Composeを使ったMisskey構築

このガイドはDocker Composeを使ったMisskeyセットアップ方法を説明します。

一度使用を始めたインスタンスのドメイン・ホスト名は、決して変更しないでください!

前提条件

  • DockerおよびDocker Composeがインストールされていること。

リポジトリの取得

git clone -b master https://github.com/misskey-dev/misskey.git
cd misskey
git checkout master

設定

下記コマンドで、各種設定ファイルのサンプルをコピーします。

cp .config/docker_example.yml .config/default.yml
cp .config/docker_example.env .config/docker.env
cp ./docker-compose.yml.example ./docker-compose.yml

default.ymldocker.envをファイル内の説明に従って編集してください。
また、必要に応じて、docker-compose.ymlを編集します。(ポートを変更したい場合など)

ビルドと初期化

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

sudo docker compose build
sudo docker compose run --rm web pnpm run init

起動

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

sudo docker compose up -d

GLHF✨

Misskeyのアップデート方法

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

git stash
git checkout master
git pull
git submodule update --init
git stash pop
sudo docker compose build
sudo docker compose stop && sudo docker compose up -d

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

cliコマンドを実行する方法

sudo docker compose run --rm web node packages/backend/built/tools/foo bar