integrad / laravel-database-backup

dev-main 2026-10-15 16:12 UTC

Requires

• php: ^8.3
• illuminate/contracts: ^11.0||^12.0||^13.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.8
• orchestra/testbench: ^11.0.0||^10.0.0||^9.0.0
• pestphp/pest: ^4.0
• pestphp/pest-plugin-arch: ^4.0
• pestphp/pest-plugin-laravel: ^4.0
• phpstan/extension-installer: ^1.4
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0

PolyForm-Noncommercial-1.0.0

• Integrad

• laravel
• laravel-database-backup
• Integrad

Published on Packagist.org on 2026-10-15 16:12 UTC

README

An independent Laravel package for creating, protecting, storing, and restoring database backups. Storage is configured through the host Laravel application's filesystem disks, including S3-compatible storage such as Cloudflare R2, FTP, and SFTP.

The package is in early development. The current version provides the package foundation and a protected dashboard at /database-backup. It does not create, upload, prune, or restore backups yet.

Requirements

• PHP 8.3 or newer
• Laravel 11, 12, or 13

Local package development

git clone https://github.com/integrad/laravel-database-backup.git
cd laravel-database-backup
composer install
composer test

The package uses Orchestra Testbench as its host Laravel application for development and tests.

Install in a Laravel application

Once a tagged release is available on Packagist:

composer require integrad/laravel-database-backup
php artisan vendor:publish --tag=database-backup-config
php artisan vendor:publish --tag=database-backup-assets

The dashboard defaults to /database-backup. Access is protected by Laravel's auth middleware and the viewDatabaseBackups Gate ability. Define that ability in the host application and allow only trusted operators:

use Illuminate\Support\Facades\Gate;

Gate::define('viewDatabaseBackups', function ($user): bool {
    return $user->is_admin;
});

The route, middleware, and dashboard path can be changed in config/database-backup.php. The panel can be disabled there with dashboard.enabled.

Storage destinations

The package uses the host application's Laravel filesystem disk, selected with database-backup.backup.disk. Configure that disk in the host application's config/filesystems.php; the package does not need storage credentials in its own config. This allows a deployment to use S3-compatible storage (including Cloudflare R2), FTP, or SFTP.

Laravel's FTP and SFTP filesystem adapters are optional dependencies. Install the adapter required by the host application:

composer require league/flysystem-ftp:^3.0
# or
composer require league/flysystem-sftp-v3:^3.0

Then set database-backup.backup.disk to the configured disk name, for example backup-ftp or backup-sftp. Keep credentials in the host application's environment or secret manager and reference them from config/filesystems.php.

The package is still in early development: backup generation and uploads are not implemented yet. These adapters become usable by the backup workflow when that functionality is added.

Development status

• Package skeleton and Composer metadata
• Configurable, protected dashboard
• Database dump drivers: planned
• Streaming compression and authenticated encryption: planned
• S3-compatible, FTP, and SFTP uploads and integrity verification: planned
• Retention and restore workflow: planned
• Scheduled execution and failure notifications: planned

Backups contain sensitive production data. Before using the package for recovery, the implementation must verify completed uploads and exercise a restore into an isolated database.

License

This project is licensed under the PolyForm Noncommercial License 1.0.0. Commercial use requires prior written authorization from Integrad at [e-mail]. Read the full license terms. This is source-available software and is not an OSI-approved open source license.

Required Notice: Copyright Integrad. For commercial licensing, obtain prior written authorization at [e-mail].

The license does not guarantee that a backup is complete or restorable. Read the operational backup and recovery disclaimer, and verify backups with integrity checks and restore drills before relying on them.