Quick start

The fastest path is Docker. One container serves the UI and the API on your machine only.

Prerequisites

• Docker
• Docker Compose v2

Steps

1. Clone and start

git clone https://github.com/goniszewski/grimoire.git
cd grimoire
docker compose up -d

The first run builds the image from the local Dockerfile. That can take several minutes. Later starts reuse the image.

2. Check health

curl http://127.0.0.1:3210/health

Wait until this succeeds before opening the UI.

3. Open the app

Open http://127.0.0.1:3210.

The compose file publishes 127.0.0.1:3210:3210, so the host port is loopback-only. Data lives in the grimoire-data Docker volume.

Optional AI keys can be seeded in docker-compose.yml for first start; day-to-day provider settings live in Settings inside the app.

Next

• Using Grimoire
• Development
• Install without Docker
• Longer Docker notes: docker-deployment.md