PhpDev.App
spatie/nova-backup-tool

spatie/nova-backup-tool

Stars: 357

Forks: 55

Pull Requests: 71

Issues: 0

Watchers: 13

Last Updated: 2023-08-25 08:43:29

#laravel #nova #tool #backups

A Laravel Nova tool to backup your app

License: MIT License

Languages: JavaScript, Vue, PHP

https://freek.dev/1125-introducing-our-laravel-nova-packages

A Laravel Nova tool to backup your application

Latest Version on Packagist Total Downloads

This Nova tool lets you:

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

Behind the scenes spatie/laravel-backup is used.

screenshot of the backup tool

You can see the tool in action in this video on YouTube.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

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. We publish all received postcards on our virtual postcard wall.

Requirements

Make sure you meet the requirements for installing spatie/laravel-backup.

Installation

First you must install spatie/laravel-backup into your Laravel app. The installation instructions are here. 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 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()
{
    return [
        // ...
        new \Spatie\BackupTool\BackupTool(),
    ];
}

Finally you should setup a queue. This tool doesn't care what kind of queue as long as you don't use the sync driver.

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:

<?php

return [
    /*
     * Enable or disable backup tool polling.
     */
    'polling' => true,

    /*
     * Interval seconds between polling requests.
     */
    'polling_interval' => 1,
];

Usage

Click on the "Backups" menu item in your Nova app to see the backup tool.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

License

The MIT License (MIT). Please see License File for more information.

OPEN ISSUES

See all

RELEASES

See all