Skip to content

Docs Get started

Fwoop documentation

Everything you need to connect servers, deploy services, schedule jobs and keep it all backed up and monitored.

Fwoop is a control plane for servers you run yourself. You install a small agent on each machine, and from then on you deploy, schedule, back up and monitor everything from one workspace, in the dashboard, the CLI or a fwoop.yaml file in your repository.

Early access. Fwoop is onboarding teams in small batches. These docs describe the product as it ships to early-access workspaces, and details may change before general availability. If something here doesn’t match what you see, tell us.

How it fits together

  • The agent runs on each server as a systemd service. It connects out to the control plane over TLS, so no inbound ports are needed.
  • The control plane stores your configuration: services, jobs, backup plans, alert rules and encrypted secrets. It sends instructions to agents and collects results.
  • Your data stays with you. Containers, logs and databases stay on your servers, and backups go to your own bucket.

Start here

  1. Quickstart: connect a server and deploy something in about five minutes.
  2. Install the agent: requirements, install options, updates and removal.
  3. Core concepts: workspaces, projects, servers, labels and targets.

Get started

  • Quickstart: Connect your first server, deploy a service and schedule a job in about five minutes.
  • Install the agent: Requirements, install options, labels, updates and removal for the Fwoop agent.
  • Core concepts: Workspaces, projects, servers, labels, targets and releases, and how they relate.

Guides

  • Deploy services: Deploy Docker Compose applications with rolling updates, health checks and one-command rollbacks.
  • Cron jobs: Schedule commands across your servers with retries, timeouts, overlap control, history and alerts.
  • Monitoring and alerts: Server and container metrics, uptime checks, alert rules and notification channels.
  • Backups: Encrypted snapshots of volumes, databases and folders to your own S3-compatible bucket.
  • Secrets: Versioned, encrypted environment variables per environment, delivered only where they're needed.
  • Teams and access: Members, roles, single sign-on, SCIM, two-factor authentication and the audit log.

Reference

  • fwoop.yaml reference: Describe services, jobs, backups, checks and alerts in a file you keep next to your code.
  • CLI reference: Every fwoop command, for your laptop and for CI.
  • API reference: Automate Fwoop over REST, and get notified with signed webhooks.