Docker Setup

Pull and run. No auth required.

Pull and run

Ferricula is distributed as a Docker image. Mount a volume so memory persists across container restarts.

docker run -p 8765:8765 -v ferricula-data:/data deepbluedynamics/ferricula

The HTTP API is available at http://localhost:8765. The dashboard is served at GET /.

Environment variables

All config is optional. Defaults work out of the box for local development.

docker run -p 8765:8765 \
  -v ferricula-data:/data \
  -e FERRICULA_DECAY_DELTA=0.005 \
  -e FERRICULA_HEAT_CEILING=12.0 \
  deepbluedynamics/ferricula

Verify it's running

curl http://localhost:8765/status

Response:

{
  "total_memories": 0,
  "active": 0,
  "ghosts": 0,
  "keystones": 0,
  "edges": 0,
  "clock": 0
}

Persistence

Ferricula writes a WAL (write-ahead log) and periodic snapshots to /data. On startup, it replays the WAL to restore state. As long as the Docker volume is mounted, memory survives restarts.

To force a checkpoint (flush all pending writes to disk):

curl -X POST http://localhost:8765/checkpoint