Dockerを使ったMisskey構築

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

前提条件

  • dockerおよびdocker-composeがインストールされていること。

リポジトリの取得

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

設定

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

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

default.ymldocker.envをファイル内の説明に従って編集してください。

default.ymlの、Postgresql/Redisのホストはそれぞれdb/redisにしてください。

必要に応じて、docker-compose.ymlを編集します。(ポートを変更したい場合など)

ビルドと初期化

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

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

起動

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

sudo docker-compose up -d

GLHF✨

Misskeyのアップデート方法

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

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