Documentation

Official product and operations reference

The docs stay focused on the actual Beagle product path: Proxmox control plane, Sunshine in the target VM, and Moonlight on the Beagle OS endpoint.

7 documentation page(s) visible
01

Getting Started

Five-step quick start from fresh host setup to first endpoint boot, plus the most common operational issues.

Open page
AR

Architecture

Two-layer model, VM-centric provisioning, single-protocol decision, and the control plane REST API.

Open page
PX

Proxmox Setup

Full script reference, variables, installed components, Create Beagle VM workflow, update path, and clean removal.

Open page
OS

Endpoint OS

What the thin-client OS is, what it is not, how it boots, and how identity and egress settings fit into the runtime.

Open page
USB

USB Passthrough

Hardened reverse-SSH USB flow from endpoint to host to VM, including attach and detach operations.

Open page
SEC

Security

Security model, per-VM keys, scoped tokens, fingerprint awareness, and egress routing for sensitive targets.

Open page
5.0

Release Notes

The 5.0 highlights, project trajectory, and the link to the full GitHub changelog.

Open page