Quickstart

This quickstart uses the top-level docker-compose.yml from https://github.com/ferosai/feros.

1) Clone and prepare env

git clone https://github.com/ferosai/feros.git
cd feros
cp .env.example .env

2) Start services

# Fast path: pull prebuilt multi-arch images (recommended for most users)
docker compose up -d

Compose starts:

• db (Postgres 18)
• studio-api (http://localhost:8000)
• voice-server (http://localhost:8300)
• studio-web (http://localhost:3000)

If you are actively changing Rust/Python core code (voice/server, voice/engine, or PyO3 bindings used by studio/api), use source builds instead:

docker compose -f docker-compose.yml -f docker-compose.source.yml up -d --build

3) Verify health

curl http://localhost:8000/api/health
curl http://localhost:8300/health

Expected studio-api response includes:

{
  "status": "healthy",
  "service": "studio-api",
  "version": "0.1.0"
}

4) Open the dashboard

Open http://localhost:3000.

5) Shared secret requirement

AUTH__SECRET_KEY must match between studio-api and voice-server.

6) Stop services

docker compose down