The guide in the console
Open Documentation in the console's menu. The guide has a search and links straight to the matching pages of the console. Its chapters:
Getting started
Sign in, add storage, enroll agents and create the first backup job.
Installing the server
Appliance, ISO, install script and packages; certificates, network and updates.
Agents
Enrollment, silent installs, installing from the console, status, upgrades and logs.
Storage targets
SFTP, S3, SMB, Azure, USB, local disks and the hardened repository; recovery keys.
Backup jobs & schedules
All job kinds, schedules, chains, backup windows, retention, copy jobs and replication.
Restoring
Files, folders, whole machines, VMs and databases; restore tests.
Disk images & bare-metal recovery
Windows images, recovery ISO, restore onto different hardware.
Linux system backup & P2V
Full Linux systems, the Linux recovery ISO and restore as a Proxmox VM.
Proxmox VE, VMware ESXi, Hyper-V
Setup, agentless backups, instant recovery, vCenter and restores of virtual machines.
Databases
SQL Server, PostgreSQL and MySQL/MariaDB with log backups and point-in-time restore.
Microsoft 365
App registration, Exchange Online, OneDrive and SharePoint backups and restores.
Ransomware protection
Detection of suspicious backups, Object Lock, hardened repository and recovery after an attack.
Monitoring, reports & notifications
Dashboard, calendar, PDF/CSV reports, email, Slack, Teams and webhooks.
Users, roles & LDAP
Roles, LDAP / Active Directory, SAML and OpenID Connect, two-factor sign-in, four-eyes approval, audit log.
Security & best practices
How the console, agents and backups are protected and how to harden your installation.
REST API and command line
API tokens and endpoints, Prometheus, and the standalone agent CLI.
Troubleshooting & FAQ
Common problems, logs and answers.
Want to read the guide before installing? Try the console locally in a minute with backupzit-server --dev-embedded-db --data-dir ./bzdata --dev-http 127.0.0.1:8080, or import the appliance image.
On GitHub
The README describes the product, installation and the command line:
How it works
Console, agents and storage.
Installation
VM images, ISO, install script and packages.
First steps
Storage, agents and the first job.
Installing agents
Windows MSI, Linux packages, from the console.
Updating
Console, agents and the operating system.
Supported systems
Console, agents, hypervisors, Microsoft 365.
Agent CLI
Back up and restore without a console; repository locations.
Repository format
Encryption, chunking, deduplication and how data is stored.
FAQ
Short answers to common questions.
Questions that the guide does not answer: ask in GitHub Discussions or get commercial support.