Documentation

EPAR documentation

Use these guides after the short README quick start. Docker Sandboxes is the primary provider for Linux, macOS, and Windows hosts when its capability checks pass; open a compatibility guide only when an existing configuration needs that provider.

Start and configure

• Usage: start, initialize, verify, inspect, clean up, labels, and dry runs.
• GitHub App setup: create the App EPAR uses for short-lived registration tokens.
• Runner group security: restrict which repositories can route work to your runners.
• Configuration: edit local configuration and provider defaults.

Choose a provider

• Docker Sandboxes: the primary provider with dedicated microVM runners and guided template provisioning on Linux, macOS, and Windows hosts.

Four provider identities remain accepted at runtime, while three are onboarding-capable. The first-run wizard shows only Docker Sandboxes initially; choose C. Show compatibility providers to reveal Docker Container and WSL2 for existing compatibility deployments. Tart is retired and has no onboarding path; its guide remains for existing configurations and exact runtime/cleanup compatibility.

Operate and maintain

• Operations: supervision, capacity, cleanup, recovery, and maintenance.
• Troubleshooting: symptom-first diagnostics.
• Logging, Storage, and Generated files and recovery: retention, capacity, directory ownership, safe deletion, exact reset, and cleanup boundaries.
• Image customization: build layers and custom install scripts.
• Docker Sandboxes templates: build, verify, import, size, and retain exact templates.
• Cross-architecture containers: image platforms, emulation, labels, and verification.
• Docker registry mirrors: an optional pull-time optimization.
• Windows startup, macOS startup, and no-Go startup: host-specific launch help.

Safety and support

• Security: Docker Sandboxes isolation, compatibility-provider caveats, secrets, and private vulnerability reporting.
• Support: information to collect before opening an issue.

Contribute

Read Contributing, then use the developer documentation for architecture, extension contracts, provider work, and the live core-runner canary.