Documentation

Runner Installation

docker run -d \
  --name restoreproof-runner \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v restoreproof-work:/var/lib/restoreproof \
  -e RESTOREPROOF_API_KEY="<your-api-key>" \
  -e RESTOREPROOF_URL="https://grpc.restoreproof.io:443" \
  -e RESTOREPROOF_RUNNER_NAME="my-runner" \
  ghcr.io/kolapsis/restoreproof/runner:latest

kubectl create namespace restoreproof

kubectl create secret generic restoreproof-runner-credentials \
  --namespace restoreproof \
  --from-literal=api-key='<your-api-key>'

helm install restoreproof-runner \
  oci://ghcr.io/kolapsis/restoreproof/charts/restoreproof-runner \
  --namespace restoreproof \
  --set controlPlane.url=https://grpc.restoreproof.io:443 \
  --set runner.name=my-runner \
  --set secrets.apiKeySecretName=restoreproof-runner-credentials

Full documentation

This page is a summary. The complete guide — prerequisites, secrets, restore engine, probes, troubleshooting — lives at docs.restoreproof.io.

Available Probes

Probes are OCI containers that verify your restored data. Each probe runs in isolation and outputs results to /out/result.json.

Probe Output Format

Every probe writes this file to /out/result.json — status, message, metrics, artifacts:

{
  "status": "PASS" | "WARN" | "FAIL",
  "message": "All tables verified successfully",
  "metrics": {
    "tables_verified": 42,
    "rows_sampled": 10000,
    "checksum_valid": true
  },
  "artifacts": [
    "/out/table_checksums.json"
  ]
}

REST API

Base URL: https://api.restoreproof.io/api/v1

Authentication

All API requests require a Bearer token:

curl -X GET https://api.restoreproof.io/api/v1/runners \
  -H "Authorization: Bearer your_jwt_token" \
  -H "Content-Type: application/json"

Runner API Keys

Runners authenticate with organization-scoped API keys:

# API key format
rp_{random_string}

# Example (shown once, at runner creation)
rp_xKj9mNpQrStUvWxYz0aBcDeFgHiJkLmNoPqRsTuVw