Documentation

The shape of the docs.

The docs that are written are linked below; the rest are being written as features ship.

Pages with a link are published; the others are planned. They are organized by what you're trying to do. The CLI reference and the conceptual pages are the two highest-priority bodies of work; the rest is being filled in as features stabilize.

Want a page sooner? Ask for it with our contact form.

Get started

  • Install the agentOn a server at any provider or at home: one command from the panel. No reboot, no kernel module; uninstall in one line.
  • Connect a server: quick startGet the command, run it as root, and the server appears in your panel within seconds.
  • Install the CLIOne line, no root: a signed release from our own servers. Never replaces another program called cf.
  • Authenticate the CLIcf login · approve the code in the panel; the CLI gets its own API key, scoped and revocable like any other.
  • Connect your first servercf connect ssh://user@host · or cf connect computeforge://<server>
  • Quickstart: branch + diff + checkout (being written)A walk-through of the core verbs on a real server.

CLI reference

  • All commandsServers, storage, networking, DNS, connected servers, history and undo, mesh, account: what each group does.
  • cf logChronological history of changes to a tracked server.
  • cf diffCompare two servers, or one server at two points in time.
  • cf blamePer-line attribution for any tracked file.
  • cf branchA running copy of one of our servers, in a minute or two.
  • cf branch at another providerComing soonA running copy at DigitalOcean, Hetzner or AWS, with your API token.
  • cf tag / cf checkoutName a state, restore it: files on any connected server with apply mode on; a whole server on our cloud, on the same IP addresses.
  • cf revertUndo one specific change to one tracked file.
  • cf pushComing soonMigration wizard — move a server between providers.
  • cf snapshotCreate, list and delete snapshots of a server.
  • cf meshManage Forge Mesh membership and ACLs.

API reference

  • REST APIThe HTTP API behind the panel. OpenAPI spec published at https://api.computeforge.com/panel/api/openapi.json.
  • WebhooksSigned deliveries of your organization's events, with retries.
  • Tokens & scopesScoped API keys for scripts and CI, revocable one by one.

Concepts

  • Branch & checkoutComing soonHow branch and restore work on our cloud vs. on third-party providers.
  • Tracked pathsWhat gets recorded (secret files: metadata only, never content) — and how to add custom paths to the change stream.
  • Migration semanticsComing soonHow cf push copies a running server (full copy, delta copies, a short final copy with services stopped), cutover, and the 24-hour rollback window.

Networking

  • Forge MeshWireGuard-based overlay. Cross-provider membership, ACLs, MagicDNS.
  • Forge DNSAuthoritative DNS for your zones, in the panel and the API; any zone downloads as a standard BIND file.
  • DNS failoverForge DNS swaps a record when a Lifeguard probe goes red.
  • Lifeguard probesTCP / HTTP / HTTPS / ping / agent / custom-script. Threshold tuning. Up to 50 per organization; at the limit the panel and API refuse new checks (409 probe_limit), existing ones keep running.
  • Send mail from your serversComing soonPort 25 is closed: sign in on port 587, or let a server's port 25 go through the ComputeForge relay. Scanned, DKIM-signed, rate limited.

Object storage

  • Browser uploads (CORS)Let your web page upload straight to a bucket with a presigned URL; your key never reaches the browser.
  • VersioningGet back overwritten or deleted files, and how older versions are billed.
  • Lifecycle rulesDelete old logs, temporary uploads and older versions on a schedule, by prefix, size or tag.

Operations

  • Export to Borg or ResticBorg / Restic export of a tagged checkpoint, a passphrase only you keep, restore on any Linux box.
  • AI sysadminComing soonHow the diff-reading model works, what it sees, how to trust its output.
  • Activity logChanges made through the panel and the API, exportable as CSV or JSON-Lines.