Weave Code
Backups Laravel Package
tiknil/backups
A Laravel package for backing up your application's database and files. Configure storage disks, retention, and notifications, then create and restore backups through Artisan commands or the scheduler.
tiknil/backups is a Laravel package for creating and managing backups of your application's database and files. It lets you define backup sources and destinations through a publishable configuration file, then run backups manually or on a schedule, with archives stored on any configured filesystem disk.
- Configurable sources — choose which databases and directories to include.
- Flexible storage — write archives to local, S3, or any Laravel disk.
- Scheduled backups — automate runs through Laravel's task scheduler.
- Retention policies — prune old backups automatically to save space.
- Artisan commands — trigger and inspect backups from the CLI.
Frequently asked questions about Backups
- How do I install tiknil/backups in a Laravel application?
- Install it with Composer using composer require tiknil/backups. Laravel package auto-discovery should register the service provider; check the package README for any config publishing or environment variables. Then configure your backup destinations and schedule the backup:run command. Test the full flow in a non-production environment first.
- Does tiknil/backups support Laravel 10, 11, and 12?
- The package is a Laravel-native utility built for conventional PHP 8.x Laravel applications. The exact Laravel version constraints are defined in its composer.json and release notes, so verify them before adoption. If you are on an older Laravel version, confirm compatibility rather than assuming it.
- How do I schedule automatic backups with tiknil/backups?
- Use Laravel's scheduler to run the package's backup:run artisan command on your chosen cadence. For example, add $schedule->command('backup:run')->daily(); to your console kernel or routes/console.php depending on your Laravel version. Confirm the command name and any destination arguments in the package docs. Then make sure the scheduler is running in production.
- How do I restore a backup using backup:restore?
- Version 0.2.0 introduces the php artisan backup:restore command, which closes the create-store-restore lifecycle. Run it from a CLI environment that has access to your backup storage and database. Before using it in production, check php artisan backup:restore --help and the README for supported options such as selecting a specific backup. Always rehearse the restore against a disposable database first.
- Does backup:restore have a dry-run mode or confirmation prompt?
- The v0.2.0 release notes do not document a dry-run, pretend mode, or interactive confirmation. Treat the command as destructive and irreversible until you verify its behavior in a non-production environment. Check the command help output and package source for safety prompts. Consider wrapping it in your own runbook or confirmation gate.
- Can I restore only the database or only application files?
- The package covers application files and database backups, but the provided release notes do not specify whether backup:restore can target database-only or files-only restores. Check the command options and documentation before relying on partial restore. Test both full and partial scenarios in a disposable environment. If partial restore is unsupported, plan a full restore workflow.
- Are backups created before v0.2.0 restorable with backup:restore?
- There is no documented format or version compatibility guarantee for backups taken before v0.2.0. Before upgrading and relying on restore, validate a round-trip using an older backup. If older backups cannot be restored, document the cutover and keep a separate recovery path for them. Do not assume backward compatibility.
- What permissions and credentials does tiknil/backups need for restore?
- A restore typically needs write access to the configured backup disks and database privileges sufficient to import or recreate schema and data. The package documentation provided does not describe a least-privilege path or key-handling model. Store credentials securely and avoid co-locating encryption keys with backups. Run restore drills with the same credential model you plan to use in production.
- Can tiknil/backups restore managed databases such as Amazon RDS or Cloud SQL?
- The provided material does not state a supported path for managed database services. If the package shells out to mysql or pg_restore, managed services may still work but often restrict the superuser or DDL rights a restore needs. Verify the restore mechanism and required privileges with your provider. Test against a managed non-production instance before committing.
- What are alternatives to tiknil/backups for Laravel backups?
- Spatie's laravel-backup is a widely used Laravel package for database and file backups with multiple filesystems, and Laravel's scheduler can also run native database dumps. The right choice depends on whether you need built-in restore, multi-destination storage, and your database platform. Compare restore safety features, maintenance activity, and Laravel version support before choosing.
Weaver
How can I help you explore Laravel packages today?