Skip to content

Getting Started

Squirrel Backend is the Python service behind the Squirrel snapshot/restore tooling for EPICS control systems. This section walks you from a fresh clone to a running stack.

Pick the page that matches what you need:

  • Installation — full setup guide. Docker Compose (recommended) and local development workflows, troubleshooting, and a Docker command reference.
  • Configuration — SQUIRREL_* environment variables and the docker/.env Docker Compose configuration.
  • API Keys — bootstrap your first key, manage keys via REST or scripts.

Once the stack is up: