BorgBackupServer: A GUI Manager for Multiple Borg Endpoints

Introduction

BorgBackupServer is a powerful, self-hosted web application designed to simplify the complex task of managing BorgBackup across multiple endpoints. Whether you're running Linux, Mac, or Windows machines, this GUI manager provides a centralized platform to oversee backup schedules, perform restores, and handle various other backup-related operations with ease. Its agent-based architecture ensures secure communication, with endpoints polling the server for tasks over HTTPS and backing up over SSH, without requiring inbound connections to the agents. This makes it ideal for environments behind firewalls and NAT. A setup wizard and Docker image options allow for quick and straightforward deployment.

You can explore a live demonstration of its capabilities here: Borg Backup Server Demo

Installation

Getting BorgBackupServer up and running is designed to be simple, whether you prefer a direct server installation or a Docker deployment.

Quick Start on Ubuntu

For a fresh Ubuntu server (22.04, 24.04, and 26.04 LTS are supported), you can use the provided installer script:

curl -sO https://raw.githubusercontent.com/marcpope/borgbackupserver/main/bin/bbs-install
sudo bash bbs-install --hostname backups.example.com

This installer automates the setup of packages, Apache, MySQL, SSL, and cron. Once complete, navigate to the specified URL, and the browser-based setup wizard will guide you through the remaining configuration.

Docker Deployment

Pre-built Docker images are available on Docker Hub for every release, offering a rapid deployment option:

curl -sO https://raw.githubusercontent.com/marcpope/borgbackupserver/main/docker-compose.yml
docker compose up -d

After starting the containers, you can retrieve the admin credentials from the container logs:

docker compose logs bbs

Then, open http://localhost:8080 in your browser to log in. For detailed configuration, storage, reverse proxy, and update documentation, refer to the Docker Installation guide.

Examples

BorgBackupServer offers a rich set of features to handle diverse backup scenarios:

• File-level Restore: Catalog data is efficiently stored in a ClickHouse DB, enabling fast search and file-tree navigation for restores without needing to lock the Borg repository. You can even extract and download files as .tar.gz directly from your browser.
• Database Plugins: Benefit from pre-dump capabilities for MySQL and PostgreSQL, with automatic restoration options either as a copy or a replacement directly into the database.
• S3 Offsite Sync: Enhance your data compliance and disaster recovery strategy by mirroring your Borg repositories to S3-compatible storage providers like AWS, Wasabi, or Backblaze B2.
• Flexible Scheduling and Templates: Define hourly to monthly backup intervals, create multiple plans per client, and utilize pre-configured or customizable directory sets for common server roles.
• Multi-user and Two-factor Authentication: Manage access with custom role-based permissions and secure logins with TOTP-based 2FA, including recovery codes.

Why Use BorgBackupServer?

BorgBackupServer stands out as a comprehensive backup solution due to several key advantages:

• Centralized and Agent-based Management: Effortlessly manage all your BorgBackup operations from a single web interface. The agent-based architecture ensures secure communication, as endpoints initiate connections to the server, eliminating the need for inbound SSH access to client machines.
• Robust Security Features: Data is fully encrypted at rest, and repository passphrases are also encrypted. The append-only SSH security model prevents agents from deleting existing archives, with pruning operations handled server-side for enhanced safety. Two-factor authentication adds an extra layer of login security.
• Ease of Use and Automation: From a browser-based setup wizard to real-time progress bars and automatic self-upgrades for both the server and agents, BorgBackupServer is designed for operational simplicity. It includes flexible scheduling, retention policies, and nightly backup reports to keep you informed.
• Extensive Functionality: Beyond core backups, it offers advanced features like remote storage repos (BorgBase, Hetzner, rsync.net), comprehensive repository management tools (unlock, repair, re-catalog), and integration with over 100 notification services via Apprise alerts. The extensive dashboard provides an at-a-glance overview of backup charts, server stats, and active jobs.

Links

• GitHub Repository: https://github.com/marcpope/borgbackupserver
• Official Demo: https://www.borgbackupserver.com/
• Documentation Wiki: https://github.com/marcpope/borgbackupserver/wiki