-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
BBS (Borg Backup Server) is a web-based backup management platform built on BorgBackup. It provides a centralized interface for managing backups across all your servers and workstations, with automated scheduling, monitoring, and file-level restoration.
BorgBackup is a deduplicating backup program that efficiently stores data by saving only unique chunks. This means your daily backups consume minimal additional space, making it ideal for frequent backups with long retention periods. BorgBackup also provides compression and encryption out of the box, ensuring your backups are both efficient and secure.
BBS wraps BorgBackup with a user-friendly web interface, automated scheduling, and centralized management, eliminating the need to manually configure and monitor backups on each machine.
- Centralized Management - Manage backups for all your servers and workstations from a single web interface
- Scheduled Backups - Create automated backup plans with flexible scheduling (hourly, daily, weekly, monthly)
- File-Level Restores - Browse backup archives and restore individual files or entire directories
- Database Backups - Built-in support for MySQL, PostgreSQL, and MongoDB dumps with the Database Backup plugin
- Remote SSH Storage - Create repositories on remote SSH hosts like rsync.net, BorgBase, and Hetzner for direct offsite backups
- S3 Offsite Sync - Automatically sync repositories to Amazon S3, Wasabi, or S3-compatible storage for offsite protection
- Multi-User Access - Role-based access control with admin and read-only user accounts
- Two-Factor Authentication - Secure logins with TOTP-based 2FA
- Plugin System - Extensible architecture for custom backup workflows (Docker volumes, application-specific backups, pre/post hooks)
- Real-Time Monitoring - Live job queue, notifications, and detailed backup logs
- Deduplication & Compression - Efficient storage thanks to BorgBackup's deduplication and compression
- Encryption - All backups are encrypted at rest with strong encryption algorithms
New to BBS? Start here:
- System Requirements - Hardware and software requirements
- Installation - Step-by-step installation guide (standard Ubuntu install)
- Docker Installation - Run BBS in a Docker container
- Getting Started - Quick-start guide to creating your first backup
- Dashboard - Overview of the main dashboard
- Managing Clients - Adding and configuring client machines
- Agent Setup - Installing and configuring the BBS agent on client machines
- macOS Agent Setup - Installing the agent on macOS with Full Disk Access
- Repositories - Creating and managing BorgBackup repositories
- Backup Plans - Setting up automated backup schedules
- Restoring Files - How to restore files from backups
- Database Backups - Configuring database backup plugins
- Plugins - Working with the plugin system
- Remote Storage - Backing up to remote SSH hosts (rsync.net, BorgBase, Hetzner)
- S3 Offsite Sync - Setting up S3 offsite synchronization
- Queue and Jobs - Monitoring backup jobs and the queue system
- Notifications - Configuring email and webhook notifications
- Settings - Configuring server settings
- User Management - Managing user accounts and permissions
- Two-Factor Authentication - Setting up 2FA for enhanced security
- Updating BBS - Keeping your BBS installation up to date
- Server Backup and Restore - Backing up and restoring the BBS server itself
- Security - Security architecture and vulnerability reporting
- CLI Reference - Command-line tools and utilities
- Troubleshooting - Common issues and solutions
If you encounter issues or have questions:
- Check the Troubleshooting page for common problems
- Review the relevant documentation section
- Check the GitHub Issues page for known issues
- Open a new issue on GitHub if you've found a bug
This manual covers BBS version 1.x and is continuously updated. Screenshots and examples reflect the current stable release.
📖 User Manual
Getting Started
Using BBS
- Dashboard
- Managing Clients
- Linux Agent Setup
- macOS Agent Setup
- Windows Agent Setup
- Repositories
- Backup Plans
- Restoring Files
- Database Backups
- Plugins
- Remote Storage
- S3 Offsite Sync
Monitoring
Administration
Reference