Welcome to Borgitory’s Documentation!

Borgitory is a comprehensive web-based management interface for BorgBackup repositories with real-time monitoring, automated scheduling, and cloud synchronization capabilities.

Built with modern web technologies, Borgitory provides an intuitive interface for managing your backup infrastructure, whether you’re running a single repository or managing multiple backup destinations across different storage providers.

Key Features

Repository Management: Add, configure, and manage multiple Borg repositories
Real-time Monitoring: Live backup progress with detailed task tracking
Automated Scheduling: Cron-based backup scheduling with integrated cleanup
Archive Browser: Interactive exploration of backup archives with FUSE mounting
Cloud Synchronization: Multi-provider cloud sync using Rclone
Push Notifications: Pushover integration for job completion alerts
Modern UI: Responsive interface built with HTMX, Alpine.js, and Tailwind CSS

Quick Start with Docker

The easiest way to get started with Borgitory is using Docker:

# Pull the latest image
docker pull mlapaglia/borgitory:latest

# Run Borgitory
docker run -d \
  --name borgitory \
  -p 8000:8000 \
  -v /path/to/your/repos:/repos \
  -v borgitory-data:/app/data \
  mlapaglia/borgitory:latest

# Access at http://localhost:8000

For production deployments and advanced configuration, see the Installation Guide guide.

Note

Borgitory requires BorgBackup to be available. The Docker image includes BorgBackup and Rclone pre-installed.

Quick Links

Installation Guide - Docker deployment and alternative installation methods
Features Overview - Comprehensive feature overview
Usage Guide - Step-by-step usage guide
How-To Guides - Task-specific guides and recipes
API Reference - REST API documentation

Getting Help

GitHub Issues - Report bugs or request features
GitHub Discussions - Community support and questions
Troubleshooting Guide - Common issues and solutions

Contents

User Guide

About