Requirements
Server
- Ubuntu 22.04 or later, or Debian 12 or later. The installer refuses any other operating system.
- A 64-bit (x86-64) server, physical or virtual. The installer checks CPU, memory and disk space before it changes anything.
- A domain name pointing at the server, for example
backups.your-msp.com. Agents, the portals and the API all use this one address. - Ports 80 and 443 reachable from your clients' networks, so agents can connect from wherever they run.
The server runs the API, the web portals, PostgreSQL and Redis. Backup data does not pass through it during a backup: agents write straight to storage. The server reads from storage only when someone restores files in the browser.
Storage
You need at least one place to keep backups:
| Target | Notes |
|---|---|
| S3-compatible bucket | AWS S3, Wasabi, Backblaze B2, MinIO and other S3 services. Needed for Object Lock immutability, replication and restores in the browser. |
| SMB share | A Windows or NAS file share. Agents mount it and write to it. |
| NFS export | A Linux or NAS export. Agents mount it and write to it. |
For immutable backups, create the S3 bucket with Object Lock turned on. Most providers only allow Object Lock when the bucket is created. See Immutability and ransomware.
Devices
| Platform | What you get |
|---|---|
| Windows (64-bit) | Setup program, background service, desktop app, CLI, disk-image backups |
| macOS (Intel, 64-bit) | Background service (launchd) and CLI |
| Linux (64-bit) | .deb package, background service (systemd), CLI, disk-image backups |
| Proxmox VE | The Linux agent on the Proxmox host backs up its VMs and containers |
Database sources need the vendor's dump tool on the device that runs them: mysqldump, pg_dump or sqlcmd. See Databases and Proxmox sources.
Optional
- An SMTP server, for invitations and password-reset emails. Without one, the set-password link is written to the server log instead, and you pass it on yourself.
- A Square account, if you want to bill tenants by card. See Billing tenants.
- An OpenID Connect identity provider, for single sign-on. See Security.