fediport/pixelfed
2
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update backup config, fixes #3793, #3920, #3931

Browse source
This commit is contained in:
Daniel Supernault 2022-12-12 19:39:11 -07:00
parent e6176494f7
commit b0c4cc304e
No known key found for this signature in database
GPG key ID: 0DEF1C662C9033F7
1 changed files with 106 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

147
config/backup.php
View file

@ -8,7 +8,7 @@ return [
* The name of this application. You can use this name to monitor * The name of this application. You can use this name to monitor
* the backups. * the backups.
*/ */
'name' => config('app.name'), 'name' => env('APP_NAME', 'pixelfed-backup'),
'source' => [ 'source' => [
@ -27,6 +27,7 @@ return [
* Directories used by the backup process will automatically be excluded. * Directories used by the backup process will automatically be excluded.
*/ */
'exclude' => [ 'exclude' => [
base_path('.git'),
base_path('vendor'), base_path('vendor'),
base_path('node_modules'), base_path('node_modules'),
], ],
@ -34,29 +35,60 @@ return [
/* /*
* Determines if symlinks should be followed. * Determines if symlinks should be followed.
*/ */
'followLinks' => false, 'follow_links' => false,
],
'mysql' => [ /*
'dump' => [ * Determines if it should avoid unreadable folders.
'useSingleTransaction' => true, */
'useQuick' => true, 'ignore_unreadable_directories' => false,
],
/*
* This path is used to make directories in resulting zip-file relative
* Set to `null` to include complete absolute path
* Example: base_path()
*/
'relative_path' => null,
], ],
/* /*
* The names of the connections to the databases that should be backed up * The names of the connections to the databases that should be backed up
* MySQL, PostgreSQL, SQLite and Mongo databases are supported. * MySQL, PostgreSQL, SQLite and Mongo databases are supported.
*
* For a complete list of available customization options, see https://github.com/spatie/db-dumper
*/ */
'mysql' => [
'dump' => [
'useSingleTransaction' => true,
'useQuick' => true
],
],
'databases' => [ 'databases' => [
'mysql', 'mysql',
], ],
], ],
/* /*
* The database dump can be gzipped to decrease diskspace usage. * The database dump can be compressed to decrease diskspace usage.
*
* Out of the box Laravel-backup supplies
* Spatie\DbDumper\Compressors\GzipCompressor::class.
*
* You can also create custom compressor. More info on that here:
* https://github.com/spatie/db-dumper#using-compression
*
* If you do not want any compressor at all, set it to null.
*/ */
'gzip_database_dump' => true, 'database_dump_compressor' => Spatie\DbDumper\Compressors\Bzip2Compressor::class,
/*
* The file extension used for the database dump files.
*
* If not specified, the file extension will be .archive for MongoDB and .sql for all other databases
* The file extension should be specified without a leading .
*/
'database_dump_file_extension' => '',
'destination' => [ 'destination' => [
@ -69,27 +101,47 @@ return [
* The disk names on which the backups will be stored. * The disk names on which the backups will be stored.
*/ */
'disks' => [ 'disks' => [
'local' 'local',
], ],
], ],
/*
* The directory where the temporary files will be stored.
*/
'temporary_directory' => storage_path('app/backup-temp'),
/*
* The password to be used for archive encryption.
* Set to `null` to disable encryption.
*/
'password' => env('BACKUP_ARCHIVE_PASSWORD'),
/*
* The encryption algorithm to be used for archive encryption.
* You can set it to `null` or `false` to disable encryption.
*
* When set to 'default', we'll use ZipArchive::EM_AES_256 if it is
* available on your system.
*/
'encryption' => 'default',
], ],
/* /*
* You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'. * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
* For Slack you need to install guzzlehttp/guzzle. * For Slack you need to install laravel/slack-notification-channel.
* *
* You can also use your own notification classes, just make sure the class is named after one of * You can also use your own notification classes, just make sure the class is named after one of
* the `Spatie\Backup\Events` classes. * the `Spatie\Backup\Notifications\Notifications` classes.
*/ */
'notifications' => [ 'notifications' => [
'notifications' => [ 'notifications' => [
\Spatie\Backup\Notifications\Notifications\BackupHasFailed::class => ['mail'], \Spatie\Backup\Notifications\Notifications\BackupHasFailedNotification::class => ['mail'],
\Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFound::class => ['mail'], \Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFoundNotification::class => ['mail'],
\Spatie\Backup\Notifications\Notifications\CleanupHasFailed::class => ['mail'], \Spatie\Backup\Notifications\Notifications\CleanupHasFailedNotification::class => ['mail'],
\Spatie\Backup\Notifications\Notifications\BackupWasSuccessful::class => ['mail'], \Spatie\Backup\Notifications\Notifications\BackupWasSuccessfulNotification::class => ['mail'],
\Spatie\Backup\Notifications\Notifications\HealthyBackupWasFound::class => ['mail'], \Spatie\Backup\Notifications\Notifications\HealthyBackupWasFoundNotification::class => ['mail'],
\Spatie\Backup\Notifications\Notifications\CleanupWasSuccessful::class => ['mail'], \Spatie\Backup\Notifications\Notifications\CleanupWasSuccessfulNotification::class => ['mail'],
], ],
/* /*
@ -99,7 +151,12 @@ return [
'notifiable' => \Spatie\Backup\Notifications\Notifiable::class, 'notifiable' => \Spatie\Backup\Notifications\Notifiable::class,
'mail' => [ 'mail' => [
'to' => '', 'to' => env('BACKUP_EMAIL_ADDRESS', ''),
'from' => [
'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
'name' => env('MAIL_FROM_NAME', 'Example'),
],
], ],
'slack' => [ 'slack' => [
@ -115,6 +172,20 @@ return [
'icon' => null, 'icon' => null,
], ],
'discord' => [
'webhook_url' => '',
/*
* If this is an empty string, the name field on the webhook will be used.
*/
'username' => '',
/*
* If this is an empty string, the avatar on the webhook will be used.
*/
'avatar_url' => '',
],
], ],
/* /*
@ -122,22 +193,15 @@ return [
* If a backup does not meet the specified requirements the * If a backup does not meet the specified requirements the
* UnHealthyBackupWasFound event will be fired. * UnHealthyBackupWasFound event will be fired.
*/ */
'monitorBackups' => [ 'monitor_backups' => [
[ [
'name' => config('app.name'), 'name' => env('APP_NAME', 'pixelfed-backup'),
'disks' => ['local'], 'disks' => ['local'],
'newestBackupsShouldNotBeOlderThanDays' => 1, 'health_checks' => [
'storageUsedMayNotBeHigherThanMegabytes' => 5000, \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1,
\Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000,
],
], ],
/*
[
'name' => 'name of the second app',
'disks' => ['local', 's3'],
'newestBackupsShouldNotBeOlderThanDays' => 1,
'storageUsedMayNotBeHigherThanMegabytes' => 5000,
],
*/
], ],
'cleanup' => [ 'cleanup' => [
@ -152,38 +216,39 @@ return [
*/ */
'strategy' => \Spatie\Backup\Tasks\Cleanup\Strategies\DefaultStrategy::class, 'strategy' => \Spatie\Backup\Tasks\Cleanup\Strategies\DefaultStrategy::class,
'defaultStrategy' => [ 'default_strategy' => [
/* /*
* The number of days for which backups must be kept. * The number of days for which backups must be kept.
*/ */
'keepAllBackupsForDays' => 7, 'keep_all_backups_for_days' => 7,
/* /*
* The number of days for which daily backups must be kept. * The number of days for which daily backups must be kept.
*/ */
'keepDailyBackupsForDays' => 16, 'keep_daily_backups_for_days' => 16,
/* /*
* The number of weeks for which one weekly backup must be kept. * The number of weeks for which one weekly backup must be kept.
*/ */
'keepWeeklyBackupsForWeeks' => 8, 'keep_weekly_backups_for_weeks' => 8,
/* /*
* The number of months for which one monthly backup must be kept. * The number of months for which one monthly backup must be kept.
*/ */
'keepMonthlyBackupsForMonths' => 4, 'keep_monthly_backups_for_months' => 4,
/* /*
* The number of years for which one yearly backup must be kept. * The number of years for which one yearly backup must be kept.
*/ */
'keepYearlyBackupsForYears' => 2, 'keep_yearly_backups_for_years' => 2,
/* /*
* After cleaning up the backups remove the oldest backup until * After cleaning up the backups remove the oldest backup until
* this amount of megabytes has been reached. * this amount of megabytes has been reached.
*/ */
'deleteOldestBackupsWhenUsingMoreMegabytesThan' => 5000, 'delete_oldest_backups_when_using_more_megabytes_than' => 5000,
], ],
], ],
]; ];