Weave Code
Nova Backup Tool Laravel Package
spatie/nova-backup-tool
A Laravel Nova tool that lists, creates, downloads, and deletes backups, powered by spatie/laravel-backup. Requires Nova and the backup package installed and configured.
A Laravel Nova tool that brings backup management directly into your Nova admin panel, powered behind the scenes by spatie/laravel-backup. Once installed alongside the base backup package, it gives you a simple interface for managing your application's backups without touching the terminal.
- List all existing backups across your configured disks
- Create a fresh backup on demand
- Download any backup file straight from Nova
- Delete old backups to free up storage
Requires a Nova app with spatie/laravel-backup installed and configured; register BackupTool in your NovaServiceProvider's tools() method to get started.
Frequently asked questions about Nova Backup Tool
- How do I install spatie/nova-backup-tool in a Laravel Nova app?
- Install spatie/laravel-backup first and confirm that php artisan backup:run creates a backup and php artisan backup:list returns your backup disks. Then run composer require spatie/nova-backup-tool and register new \Spatie\BackupTool\BackupTool() in the tools method of app/Providers/NovaServiceProvider.php. No migrations or schema changes are required.
- Does spatie/nova-backup-tool work without spatie/laravel-backup installed?
- No. This package is a thin Nova UI layer over spatie/laravel-backup and does not implement backup logic itself. It only exposes list, create, download, and delete operations against laravel-backup's disks and status artifacts. If laravel-backup is not already configured and working, this tool is not the entry point.
- Which Laravel and Nova versions does spatie/nova-backup-tool support?
- Version support tracks Nova majors: Nova 4 uses the 5.x line and Nova 5 uses the 6.x line. The 6.x line supports Laravel up to 13 and PHP 8.2+, while older releases cover Laravel 5.8 and Nova 2. Always check the changelog for the exact matrix before upgrading.
- Do I need a queue driver to use the Nova backup tool?
- Yes, you need a non-sync queue driver with reliably supervised workers. Backups are dispatched as queued jobs and the Nova UI polls for status while they run, so a sync driver silently disqualifies the tool. Configure Redis, database, or another real queue before relying on the UI.
- How do I configure polling for backup status in spatie/nova-backup-tool?
- Publish the package config to control polling behavior. Polling is enabled by default with a one-second interval, which can add repeated request volume per open browser tab during long backups. Adjust or disable polling if you have multiple admins watching the tool.
- Is spatie/nova-backup-tool safe to use in production for deleting backups?
- Delete and download are one click away behind Nova authentication, so treat the tool as a privileged admin surface. Authorization is only as granular as Nova's gate and permission model, and there is no documented per-disk or per-user scoping. Confirm that UI deletion aligns with retention, offsite, and immutable-copy requirements.
- How should I test backups before enabling the Nova backup tool?
- Run php artisan backup:run in the terminal and verify a backup appears on your configured disk. Then run php artisan backup:list and confirm it returns the expected backup overview. Only after both commands succeed should you register the Nova tool for your team.
- Does spatie/nova-backup-tool provide backup monitoring or alerting?
- No. This package only provides the Nova list, create, download, and delete interface. Monitoring and alerting come from laravel-backup's separate backup:monitor command, which you should schedule independently. Do not assume the Nova UI will notify you when backups fail.
- What are alternatives to spatie/nova-backup-tool for non-Nova admin panels?
- For Filament, custom dashboards, or plain Blade admin surfaces, this tool is not the right lever because it requires Nova. Instead wire spatie/laravel-backup directly into your own controllers, commands, or panel resources. Keep laravel-backup as the backup foundation and build a minimal UI around its disks and status artifacts.
- How do I upgrade spatie/nova-backup-tool safely without breaking the Nova page?
- Pin the package version and smoke-test the backup page after every upgrade of Laravel, Nova, or laravel-backup. The changelog shows compatibility bumps across all three plus patch fixes such as a missing sizeInBytes function and route middleware changes. Because your upgrade cadence is coupled to three moving targets, treat each upgrade as a small integration test.
Weaver
How can I help you explore Laravel packages today?