RunR documentation
Every page of the RunR documentation, grouped by topic. The repository README gives the overview and the quick start; CHANGELOG.md lists the changes per release.
Getting started#
| Page |
What it covers |
| Architecture |
Control plane, regions, project types, triggers, builds and how the components interact |
| Development setup |
Local stack with Docker Compose or Valet, kind regions, tests and CI checks |
| Single-host install |
Production install with Docker Compose on one machine, including air-gapped hosts |
| Helm values |
Every value of the control-plane chart: helm show values brf-tech/runr (chart from BRF's public Helm repository, see the quick start), validated by the chart's values.schema.json |
| Versioning |
The /api/version endpoint and how Compose, runtime/ci.sh and Helm set the version |
| Upgrading |
helm upgrade of an existing installation, what runs during it, the changes per release (0.4.x → 0.5.0, 0.5.0 → 0.5.1, 0.5.1 → 0.5.2) and the upgrade e2e |
Functions and runtimes#
| Page |
What it covers |
| Runtimes |
Runtime plugins (runtime.yaml), the execution contract, the universal wrapper, the built-in catalog |
| WebAssembly |
Wasm functions on the Spin shim (Rust, Go, JavaScript, Python) and wasm-exec (WASI modules on Spin's WAGI executor) |
| Kata Containers hypervisors |
Cloud Hypervisor, QEMU, Dragonball and Firecracker: requirements, KVM checks, configuration |
Runtime images and ci.sh |
What is in runtime/ and the end-to-end test script on kind |
| Example runtimes |
C, Rust, Bash and Q runtime plugins |
| WebAssembly examples |
One example per Wasm runtime, plus C and Q on wasm-exec |
Deploy#
| Page |
What it covers |
| Git deploy |
The per-project git remote, GitHub App, GitLab and Forgejo / Gitea repositories, preview environments |
| runr CLI |
Install, runr.yaml, deploying, runr dev and the full command reference |
| Terraform provider |
Managing RunR with Terraform or OpenTofu; per-resource reference in terraform-provider-runr/docs |
| GitHub Action |
Deploying from GitHub Actions and pull request previews; action inputs in actions/deploy |
| Uploaded images |
docker save archives, OCI image tars and .wasm modules uploaded into region registries |
Data#
| Page |
What it covers |
| GPU workers and GPU containers |
GPU nodes, GPU support per region, GPU functions and CaaS, quotas and GPU metering |
| Hugging Face models |
Model services (vLLM, TGI, TEI, hf-serve), offline copies, air-gapped regions, model bindings |
| AI agents: MCP |
The RunR MCP server, OAuth 2.1 for MCP clients and hosted MCP servers |
| Sandbox API |
Isolated sandboxes for untrusted code: exec, files, processes, code interpreter, pools, quotas |
| Python Sandbox SDK |
runr-sandbox |
| TypeScript Sandbox SDK |
@runr/sandbox |
| AI examples |
GPU CaaS and Hugging Face model calls from Python, Node.js and Go |
| MCP server examples |
Python and TypeScript starters for hosted MCP servers |
Security and enterprise#
| Page |
What it covers |
| Roles and permissions |
The permission catalog, built-in and custom roles, groups, project access, SSO group mapping, tokens |
| Secrets and audit log |
Encryption at rest, secret environment variables, key rotation, real-time channels, SSO handoff, audit log |
| Supply chain and data residency |
SBOMs, vulnerability scans, signing, policy gate, admission, data residency |
| Security policy |
Supported versions and how to report a vulnerability |
Operations#
| Page |
What it covers |
| Observability |
Metrics, logs, tracing, request replay, uptime checks, status pages and alerting |
| Monitoring and cost |
Metric snapshots, pod sessions, threshold notifications and the cost system |
| Browser shell |
Terminal access to the pods of a deployment |
| WebSocket events |
Every real-time topic: where it is broadcast and where the console handles it |
| White-label |
Branding, self-service signup, onboarding, plans |
| Billing |
What RunR calculates (usage, plans, charges per month), the billing API and signed billing events for your invoicing system |
Project#
RunR v0.5.7 · MIT License
