Setup with Docker Compose 🐳

The Compose environment builds Misskey with Node.js 22 and starts the app, MongoDB 4.4, and Redis 7 as separate services.

From the repository root, run:

$ docker compose up --build

Open http://localhost:3000 after the app service becomes healthy. MongoDB data is stored in the mongodb-data named volume.

Run the full test suite against the Compose databases with:

$ docker compose run --rm app npm test

To stop the services without deleting the database:

$ docker compose down

To also delete the local MongoDB data, explicitly remove the volume:

$ docker compose down --volumes

The supplied docker/default.yml is intended only for local verification. Use your own .config/default.yml and secrets for a real deployment.