Package Data | |
---|---|
Maintainer Username: | pavel-mironchik |
Maintainer Contact: | mironchikpavel@gmail.com (Pavel Mironchik) |
Package Create Date: | 2020-01-04 |
Package Last Update: | 2024-12-09 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-12-19 03:20:48 |
Package Statistics | |
---|---|
Total Downloads: | 54,316 |
Monthly Downloads: | 972 |
Daily Downloads: | 54 |
Total Stars: | 409 |
Total Watchers: | 5 |
Total Forks: | 42 |
Total Open Issues: | 10 |
Laravel Backup Panel provides a dashboard for spatie/laravel-backup package. It lets you:
It resembles the look and functionality of another Spatie package: spatie/nova-backup-tool. This was done on purpose, so users can easily migrate from one to another. Only it doesn't use polling. A "real-time" updates of a backups list isn't such a necessarily thing and an intensive polling can cause unexpected charges if you use services that require to pay per API requests, such as Google Cloud Storage. Also, some users reported about hitting a rate limit of Dropbox API.
Make sure you meet the requirements for installing spatie/laravel-backup.
First you must install spatie/laravel-backup into your Laravel app.
The installation instructions are here.
When successful, 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 may use composer to install Laravel Backup Panel into your project:
$ composer require pavel-mironchik/laravel-backup-panel
After installing, publish it resources using provided Artisan command:
$ php artisan laravel-backup-panel:install
This will place assets into public/laravel_backup_panel
directory, add config file config/laravel_backup_panel.php
, and register service provider app/Providers/LaravelBackupPanelServiceProvider.php
.
When upgrading the package, do not forget to re-publish assets:
$ php artisan vendor:publish --tag=laravel-backup-panel-assets --force
Laravel Backup Panel exposes a dashboard at /backup
. Change it in config/laravel_backup_panel.php
file:
'path' => 'backup',
Sometimes you don't want to run backup jobs on the same queue as user actions and things that is more time critical.
Specify your desired queue name in config/laravel_backup_panel.php
file:
'queue' => 'dedicated_low_priority_queue',
By default, you will only be able to access the dashboard in the local
environment.
To change that, modify authorization gate in the app/Providers/LaravelBackupPanelServiceProvider.php
:
/**
* Register the Laravel Backup Panel gate.
*
* This gate determines who can access Laravel Backup Panel in non-local environments.
*
* @return void
*/
protected function gate()
{
Gate::define('viewLaravelBackupPanel', function ($user) {
return in_array($user->email, [
'admin@your-site.com',
]);
});
}
Open http://your-site/backup
. You'll see a dashboard and controls to use.
$ composer test
Please see CHANGELOG for more information about what has changed recently.
Please see CONTRIBUTING for details.
Make sure you've prepared a dummy Laravel application to test the package in, because assets will be copied there by this line in webpack.mix.js
:
.copy('public/vendor/laravel_backup_panel', '../laravel-backup-panel-test/public/vendor/laravel_backup_panel');
If you discover any security related issues, please email mironchikpavel@gmail.com instead of using the issue tracker.
If you like this package, consider supporting it. You can use this in such ways:
And any other help will be appreciated.
The MIT License (MIT). Please see License File for more information.