Quick start

What you need

• Docker with Compose 2.24 or later.
• About 5 GB of free disk in the Docker VM and 4 GB of RAM for Docker (8 GB is comfortable).

The first build takes about 5 minutes.

Start it

git clone https://github.com/ratel-ai/ratel.git
cd ratel
docker compose up -d --build --wait

Open http://localhost:3000. No configuration is needed.

Port 3000 or 5432 taken? Copy .env.example to .env, set RATEL_PORT and RATEL_DB_PORT, and set BASE_URL to the address you open.

Send a first trace

1. Open Settings > API keys and create a key. It is shown once.
2. Export it: export RATEL_API_KEY=<your-key>.
3. Copy the curl snippet from the same page and run it. A 202 means Ratel stored the span.

Next, point your agent at it: Send data.

Explore with demo data

A fresh install seeds a sample project, Site Copilot, the first time the console opens with no project. It holds 30 days of agent activity, marked as sample data.

To replace it with a fresh copy, or restore it after a delete:

docker compose --profile demo run --rm demo

If it does not start

• Read docker compose logs db web worker.
• A full Docker disk shows only in the db log: No space left on device.
• On a small machine the worker can report unhealthy for a few minutes after a restart, while it catches up on queued jobs.