spatie/laravel-backup
Laravel Backup
This is a Laravel package that creates and manages automated backups of application files and databases. It orchestrates backup, cleanup, and notification steps as a configurable pipeline, compressing selected directories and database dumps into zip archives that can be stored on any Laravel filesystem disk.
The package provides a configurable retention policy engine that prunes old backups based on age, count, or size thresholds, and includes a health-check monitoring system that verifies backup recency and storage capacity. It fires success, failure, and health-check events that route notifications through any configured channel, and exposes Artisan commands for triggering backups, listing archives, and running cleanup operations.
Backups can be stored on multiple filesystems simultaneously for redundancy, and the package supports selecting which directories, files, and database connections to include or exclude. It also provides commands to list all stored backups and display the health status of monitored destinations.
Features
- Laravel Application Backups - Creates and manages automated backups of Laravel application files and databases with configurable retention.
- Scheduled Database Backups - Automates database dumps and stores them alongside application files in a single compressed archive.
- Multi-Destination Backup Storages - Creates compressed archives of application files and database dumps with configurable storage destinations.
- On-Demand Backup Triggers - Triggers a full backup process with a single Artisan command for manual or scheduled execution.
- Combined File and Database Archives - Compresses selected directories and database dumps into a single zip archive for backup.
- Command Line Interfaces - Exposes Artisan commands to trigger backups, list archives, and run cleanup operations.
- Backup Orchestrators - Orchestrates backup, cleanup, and notification steps as a sequential pipeline of configurable actions.
- Backup Job Scheduling - Runs backup jobs on a cron schedule and prunes old archives based on age or count thresholds.
- Retention Policy Cleanups - Removes outdated backup files based on configurable retention policies to free storage space and maintain a manageable archive.
- Policy-Based Retention - Applies age, count, and size thresholds to prune old backups automatically.
- Backup Health Alerters - Checks that backups are recent and have sufficient storage space, with alerts when criteria are not met.
- Cron-Driven Backup Schedules - Triggers full backup processes via CLI commands for manual or cron-based execution.
- Multi-Destination Backup Storage - Stores backup archives on multiple filesystems simultaneously for redundancy and disaster recovery.
- Backup Directory Listing - Displays an overview of every backup archive stored on the configured filesystems.
- Backup Selection Policies - Selects which directories, files, and database connections to include or exclude in a backup archive.
- Laravel Filesystem Disk Abstractions - Stores backup archives on any Laravel filesystem disk, including local, cloud, and custom drivers.
- Backup Lifecycle Notifications - Sends notifications via mail, Slack, or other channels when backup operations succeed or fail.
- Backup Event Notifications - Sends notifications via Mail, Slack, or other channels when a backup succeeds, fails, or requires attention.
- Backup Health Monitors - Verifies backup recency and storage capacity, flagging failures through configurable health checks.
- Databases and ORMs - Backs up the entire application.
