PHPackages                             spatie/nova-backup-tool - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. spatie/nova-backup-tool

ActiveLibrary[Utility & Helpers](/categories/utility)

spatie/nova-backup-tool
=======================

A Laravel Nova tool to backup your application.

6.0.3(2mo ago)361560.7k—7.5%651MITPHPPHP ^8.2CI failing

Since Aug 22Pushed 2mo ago10 watchersCompare

[ Source](https://github.com/spatie/nova-backup-tool)[ Packagist](https://packagist.org/packages/spatie/nova-backup-tool)[ Docs](https://github.com/spatie/nova-backup-tool)[ Fund](https://spatie.be/open-source/support-us)[ RSS](/packages/spatie-nova-backup-tool/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (57)Used By (1)

A Laravel Nova tool to backup your application
==============================================

[](#a-laravel-nova-tool-to-backup-your-application)

[![Latest Version on Packagist](https://camo.githubusercontent.com/c85cf2cfcce7eb1a993eb570859851775800b346fc567407686a5116dc96ad6f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7370617469652f6e6f76612d6261636b75702d746f6f6c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/nova-backup-tool)[![Total Downloads](https://camo.githubusercontent.com/a1d14e85cab47d22b435899a2d0dcc12b5cca07785e6fc8174cd7c99af142c90/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f6e6f76612d6261636b75702d746f6f6c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/nova-backup-tool)

This [Nova](https://nova.laravel.com) tool lets you:

- list all backups
- create a new backup
- download a backup
- delete a backup

Behind the scenes [spatie/laravel-backup](https://docs.spatie.be/laravel-backup) is used.

[![screenshot of the backup tool](https://camo.githubusercontent.com/f5e1f8a4f11c61a4fe84eb54e457d90dc252b211624c9a268e30e77316840416/68747470733a2f2f7370617469652e6769746875622e696f2f6e6f76612d6261636b75702d746f6f6c2f73637265656e73686f742e706e67)](https://camo.githubusercontent.com/f5e1f8a4f11c61a4fe84eb54e457d90dc252b211624c9a268e30e77316840416/68747470733a2f2f7370617469652e6769746875622e696f2f6e6f76612d6261636b75702d746f6f6c2f73637265656e73686f742e706e67)

You can see the tool in action in [this video on YouTube](https://www.youtube.com/watch?v=9wSi2ByavX8).

Support us
----------

[](#support-us)

[![](https://camo.githubusercontent.com/495d3b9ae37bd3a16a6e91a19c98dd491a93a1dfc8b0525d5264b1bff20ff5f1/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6e6f76612d6261636b75702d746f6f6c2e6a70673f743d31)](https://spatie.be/github-ad-click/nova-backup-tool)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).

Requirements
------------

[](#requirements)

Make sure you meet [the requirements for installing spatie/laravel-backup](https://docs.spatie.be/laravel-backup/v6/requirements).

Installation
------------

[](#installation)

First you must install [spatie/laravel-backup](https://docs.spatie.be/laravel-backup) into your Laravel app. The installation instructions are [here](https://docs.spatie.be/laravel-backup/v6/installation-and-setup). When successfull running `php artisan backup:run` on the terminal should create a backup and `php artisan backup:list` should return a list with an overview of all backup disks.

You can install the nova tool in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:

```
composer require spatie/nova-backup-tool
```

Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.

```
// in app/Providers/NovaServiceProvider.php

// ...

public function tools(): array
{
    return [
        // ...
        new \Spatie\BackupTool\BackupTool(),
    ];
}
```

Finally you should setup [a queue](https://laravel.com/docs/master/queues). This tool doesn't care what kind of queue as long as you don't use the `sync` driver.

Configuration
-------------

[](#configuration)

You can optionally publish the config file with:

```
php artisan vendor:publish --provider="Spatie\BackupTool\BackupToolServiceProvider" --tag="config"
```

This is the contents of the published config file:

```