Welcome to Borg UI
A modern web interface for Borg Backup with zero-configuration deployment - just run and go.Quick Start
Get up and running in minutes with Docker
Installation Guide
Detailed setup for Docker Compose, Portainer, and Unraid
First Backup
Create your first backup and explore features
Configuration
Customize environment variables and settings
What is Borg UI?
Borg UI provides a powerful, intuitive web interface for managing your Borg Backup infrastructure. Whether you’re backing up a home server or managing enterprise backups, Borg UI simplifies backup creation, monitoring, and restoration with real-time progress tracking and automated scheduling.Key Features
Backup Management
Create, schedule, and monitor backups with live progress tracking showing current file, speed, and completion percentage
Archive Browser
Browse and restore files from any backup archive with Redis caching providing 600x faster performance for large repositories
Repository Management
Support for local, SSH, and SFTP repositories with multiple encryption and compression options (lz4, zstd, zlib, lzma)
Visual Scheduling
Visual cron job builder with execution history and multi-repository backup support
Pre/Post Backup Hooks
Run custom scripts before/after backups (e.g., stop Docker containers, create database dumps)
Smart Notifications
Get alerts via 100+ services powered by Apprise: Email, Slack, Discord, Telegram, Pushover, Microsoft Teams, and more
SSH Key Management
Generate, import, and deploy SSH keys for remote repositories directly from the UI
Real-time Monitoring
Live backup progress, system metrics, health checks, and activity feed at a glance
Features in Action
Live Backup Progress
Watch your backups execute in real-time with detailed progress tracking:- Current file being processed
- Backup speed (MB/s)
- Data statistics (original, compressed, deduplicated sizes)
- Estimated time remaining
- Overall completion percentage
Repository Management
Create and manage repositories with an intuitive wizard:- Local storage, SSH, and SFTP connections
- Encryption options: repokey, keyfile
- Compression algorithms: lz4, zstd, zlib, lzma, auto, obfuscate
- Source directories and exclude patterns
- Custom borg flags
- Import existing repositories or create new ones
Smart Notifications
Get instant alerts for backup events via 100+ notification services:- Configure per-repository notification preferences
- Customizable templates for backup start, success, failure, and warnings
- Popular integrations: Email, Slack, Discord, Telegram, Pushover, Microsoft Teams
Schedule Management
Create and manage automated backup schedules:- Visual cron builder for easy scheduling
- Multi-repository backup support
- Pre/post script execution
- Automatic pruning and compacting
- Detailed execution history and logs
Multi-Platform Support
Borg UI supports multiple architectures:- amd64 - Intel/AMD 64-bit processors
- arm64 - ARM 64-bit processors (Raspberry Pi 4, Apple Silicon)
- armv7 - ARM 32-bit processors (Raspberry Pi 3)
Technology Stack
Built with modern, reliable technologies:- Borg Backup - Deduplicating backup program
- FastAPI - High-performance Python web framework
- React - Modern frontend library
- Material-UI - Beautiful UI components
- Redis - High-performance caching
Default Credentials: When you first access Borg UI at
http://localhost:8081, use:- Username:
admin - Password:
admin123
Getting Started
Quick Start Guide
Get your first backup running in under 5 minutes
Installation Guide
Detailed installation for all platforms
Community & Support
Discord Community
Get help, share your setup, suggest features
GitHub Issues
Report bugs and request features
Docker Hub
Pull the latest images