garethgeorge/backrest
Backrest
Backrest is a web-based management interface for Restic that orchestrates scheduled snapshots, manages offsite repositories, and provides a browser for file restoration. It serves as a scheduled backup orchestrator and remote storage manager to maintain data repositories across various backends.
The system distinguishes itself through a backup lifecycle automation framework that triggers shell scripts and external notifications based on backup events. It includes a snapshot restoration browser that allows for exploring point-in-time snapshots to recover specific directories to local paths.
The project covers broad capability areas including backup workflow automation via pre- and post-run hooks, remote storage integration for cloud backends, and data protection monitoring. It also features system condition validation to check prerequisites like network connectivity and battery levels before initiating tasks.
Access is managed through a security layer providing username and password authentication, with options to disable authentication for reverse proxy configurations.
Features
- Automated Backup Systems - Orchestrates scheduled system snapshots and manages backup plans to ensure consistent data capture.
- Backup Management - Provides a comprehensive web-based management interface for orchestrating Restic snapshots and repositories.
- Snapshot Indexing - Scans backup repositories to identify and list point-in-time snapshots for restoration selection.
- Cron-Driven Backup Schedules - Implements a cron-based timetable for automated backups, snapshot pruning, and system health checks.
- Backup Repositories - Provides a web interface to import existing backup stores and browse available snapshots.
- Backup Storage Backends - Allows defining backup destinations by creating new repositories or linking to existing storage locations.
- File System Restoration - Provides a browser to explore snapshots and restore specific directories or files to local paths.
- Snapshot Indexing - Scans storage backends to map available point-in-time snapshots for selection and granular file restoration.
- Object Storage Integrations - Integrates with remote cloud backends using standardized storage protocols for offsite data protection.
- Cron Scheduling - Uses a time-based trigger system with cron expressions to automate recurring backup and maintenance operations.
- Backup Orchestration Tools - Orchestrates automated backup and maintenance workflows using a cron-based timetable with pre- and post-run hooks.
- Backup Job Scheduling - Allows users to define specific schedules and configurations for regular system snapshots.
- Snapshot Browsers - Ships a browser to explore the file structure of specific snapshots and restore directories to local paths.
- Workflow Automation - Uses custom shell scripts and event hooks to automate prerequisite tasks and cleanup after backups.
- Snapshot Browsers - Includes a file-system explorer for browsing snapshots and recovering specific directories to local paths.
- Event-Driven Execution - Runs custom shell commands tied to specific lifecycle events to automate external tasks.
- Pre/Post Command Hooks - Triggers custom external shell scripts immediately before or after backup processes for prerequisites and cleanup.
- Event Notifications - Dispatches alerts to external services by mapping backup lifecycle events to specific communication channels.
- Credential-Based Access Controls - Implements a security layer requiring username and password authentication to protect the backup management interface.
- Automation Failure Notifications - Sets up system notifications and external alerts to track the success or failure of automated backup tasks.
- Event-Driven Hook Execution - Implements a framework to trigger custom shell scripts and external notifications upon backup success or failure.
- Lifecycle Hooks - Provides the ability to execute custom shell scripts before or after backups for prerequisite or cleanup tasks.
- Pre-Flight System Validators - Verifies internet connectivity, battery levels, and directory existence before initiating backup tasks.
- Pre-Task Condition Guards - Provides a pre-task verification system that checks for internet connectivity and battery levels to prevent backup failures.
- Backup Solutions - Web-based orchestrator for managing remote backups.
