A modern web interface for Borg Backup
Zero-configuration deployment - just run and go.
Note
This project uses Claude Code as a development assistant. I'm a full-stack developer with 10+ years of experience, and I personally review all AI-generated code before merging. Architecture decisions, security practices, and testing are human-driven. Claude Code is acknowledged as a co-author in git commits. All code is open source for community review - your backups deserve scrutiny, and I encourage it.
Monitor all your repositories, backup status, and system metrics at a glance. View repository health, recent activity feed, storage usage, and quick access to common operations. Get a comprehensive overview of your entire backup infrastructure in one place.
Watch your backups execute in real-time with detailed progress tracking. Monitor current file being processed, backup speed (MB/s), data statistics (original, compressed, deduplicated sizes), estimated time remaining, and overall completion percentage.
Create and manage repositories with support for local storage, SSH, and SFTP connections. Configure encryption (repokey, keyfile), compression algorithms (lz4, zstd, zlib, lzma, auto, obfuscate), source directories, exclude patterns, and custom borg flags. Import existing repositories or create new ones with step-by-step wizard.
Get instant alerts for backup events via 100+ notification services powered by Apprise. Configure Email, Slack, Discord, Telegram, Pushover, Microsoft Teams, and many more. Set up per-repository notification preferences with customizable templates for backup start, success, failure, and warnings.
Browse and restore files from any backup archive with 600x faster performance using Redis caching. Navigate through your backup history, preview file contents, and restore individual files or entire directories.
Create and manage automated backup schedules with visual cron builder. Configure multi-repository backups, set up pre/post scripts, enable automatic pruning and compacting, and track execution history with detailed logs.
- Backup Management - Create, schedule, and monitor backups with live progress tracking
- Archive Browser - Browse and restore files from any backup archive with Redis caching (600x faster for large repos)
- Repository Management - Support for local, SSH, and SFTP repositories with multiple compression options
- Scheduling - Visual cron job builder with execution history
- Pre/Post Backup Hooks - Run custom scripts before/after backups (e.g., stop Docker containers, database dumps)
- Notifications - Get alerts via 100+ services (Email, Slack, Discord, Telegram, Pushover, etc.)
- SSH Key Management - Generate, import, and deploy SSH keys for remote repositories
- Real-time Monitoring - Live backup progress, system metrics, and health checks
- Multi-platform - Supports amd64, arm64, and armv7 architectures
Installation is simple with Docker:
# Pull and run
docker run -d \
--name borg-web-ui \
-p 8081:8081 \
-v borg_data:/data \
-v borg_cache:/home/borg/.cache/borg \
-v /home/yourusername:/local:rw \
ainullcode/borg-ui:latestAccess at http://localhost:8081 • Default credentials: admin / admin123
📖 Installation Guide - Complete setup with Docker Compose, Redis, Portainer, Unraid
📚 Full Documentation - Complete guides and tutorials
Quick links:
- Installation Guide - Detailed setup for all platforms
- Configuration Guide - Environment variables and customization
- Usage Guide - Creating your first backup
- Notifications Setup - Email, Slack, Discord alerts
- SSH Keys Guide - Remote backup setup
- Security Guide - Best practices
- Discord: Join our community - Get help, share your setup, suggest features
- Documentation: Full Documentation
- Bug Reports: GitHub Issues
- Discussions: GitHub Discussions
Want to help improve Borg Web UI? See our Contributing Guide and Development Guide to get started.
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.
Built with Borg Backup, FastAPI, React, and Material-UI
Made with ❤️ by Karan Hudia
