User Guide
Everything you need to know about Borg Backup Server. Step-by-step walkthroughs of every feature, with screenshots and videos.
Getting Started
User Profile & Settings
User Profile
Overview of your profile page and all available account settings.
Two-Factor Authentication
Secure your account with TOTP-based two-factor authentication.
Email Reports
Configure daily or weekly backup status email summaries.
Change Password
Update your account password from the profile settings.
Time Zone Settings
Set your preferred time zone for backup scheduling and logs.
Dark / Light Mode
Switch between dark and light themes to match your preference.
Clients & Backups
Managing Clients
View, search, and organize all your backup clients and their status.
Client Detail Page
Explore the tabs: overview, plugins, repos, schedules, and restore.
Adding a Client
Create a new client and get the API key to connect the agent.
Repositories
Create encrypted repos, monitor storage, and run maintenance.
Backup Plans
Schedule backups with directories, exclusions, and retention policies.
Restoring Files
Browse archives and restore files, folders, or databases.
Plugins
Database backups, shell hooks, and S3 offsite sync.