Skip to content

Commit a860fc8

Browse files
authored
Update README.md, docs and comment in config file (spatie#1154)
* Update README.md and docs * Update comment in config file * One more fix * Update config in docs/sending-notifications/overview to match default config
1 parent 08a76a1 commit a860fc8

File tree

8 files changed

+28
-18
lines changed

8 files changed

+28
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/laravel-backup.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/laravel-backup)
99
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-backup.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-backup)
1010

11-
This Laravel package [creates a backup of your application](https://docs.spatie.be/laravel-backup/v6/taking-backups/overview). The backup is a zip file that contains all files in the directories you specify along with a dump of your database. The backup can be stored on [any of the filesystems you have configured in Laravel 5](http://laravel.com/docs/filesystem).
11+
This Laravel package [creates a backup of your application](https://docs.spatie.be/laravel-backup/v6/taking-backups/overview). The backup is a zip file that contains all files in the directories you specify along with a dump of your database. The backup can be stored on [any of the filesystems you have configured in Laravel](http://laravel.com/docs/filesystem).
1212

1313
Feeling paranoid about backups? No problem! You can backup your application to multiple filesystems at once.
1414

@@ -31,12 +31,12 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
3131

3232
## Installation and usage
3333

34-
This package requires PHP 7.3 and Laravel 5.8 or higher.
34+
This package requires PHP 7.3 and Laravel 6.0 or higher.
3535
You'll find installation instructions and full documentation on https://docs.spatie.be/laravel-backup.
3636

3737
## Using an older version of PHP / Laravel?
3838

39-
If you are on a PHP version below 7.3 or a Laravel version below 5.8 just use an older version of this package.
39+
If you are on a PHP version below 7.3 or a Laravel version below 6.0 just use an older version of this package.
4040

4141
Read the extensive [documentation on version 3](https://docs.spatie.be/laravel-backup/v3), [on version 4](https://docs.spatie.be/laravel-backup/v4) and [on version 5](https://docs.spatie.be/laravel-backup/v5). We won't introduce new features to v5 and below anymore but we will still fix bugs.
4242

config/backup.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113

114114
/*
115115
* You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
116-
* For Slack you need to install guzzlehttp/guzzle and laravel/slack-notification-channel.
116+
* For Slack you need to install laravel/slack-notification-channel.
117117
*
118118
* You can also use your own notification classes, just make sure the class is named after one of
119119
* the `Spatie\Backup\Events` classes.

docs/high-level-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 4
55

66
## Taking backups
77

8-
A backup is a .zip file containing all files in the directories you specify and a dump of your database (MySQL and PostgreSQL are supported). The .zip file can automatically be copied over to [any of the filesystems](https://laravel.com/docs/5.3/filesystem) you have configured.
8+
A backup is a .zip file containing all files in the directories you specify and a dump of your database (MySQL and PostgreSQL are supported). The .zip file can automatically be copied over to [any of the filesystems](https://laravel.com/docs/8.x/filesystem) you have configured.
99

1010
To perform a new backup you just have to run `php artisan backup:run`. In most cases you'll want to schedule this command.
1111

docs/installation-and-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ return [
130130

131131
/*
132132
* You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
133-
* For Slack you need to install guzzlehttp/guzzle.
133+
* For Slack you need to install laravel/slack-notification-channel.
134134
*
135135
* You can also use your own notification classes, just make sure the class is named after one of
136136
* the `Spatie\Backup\Events` classes.

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Introduction
33
weight: 1
44
---
55

6-
This Laravel package creates a backup of your application. The backup is a zipfile that contains all files in the directories you specify along with a dump of your database. The backup can be stored on [any of the filesystems](https://laravel.com/docs/5.7/filesystem) you have configured. The package can also notify you via Mail, Slack or any notification provider when something goes wrong with your backups.
6+
This Laravel package creates a backup of your application. The backup is a zipfile that contains all files in the directories you specify along with a dump of your database. The backup can be stored on [any of the filesystems](https://laravel.com/docs/8.x/filesystem) you have configured. The package can also notify you via Mail, Slack or any notification provider when something goes wrong with your backups.
77

88
Feeling paranoid about backups? Don't be! You can backup your application to multiple filesystems at once.
99

docs/requirements.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Requirements
33
weight: 3
44
---
55

6-
This backup package requires **PHP 7.2**, with the [ZIP module](http://php.net/manual/en/book.zip.php) and **Laravel 5.8 or higher**. It's not compatible with Windows servers.
6+
This backup package requires **PHP 7.3**, with the [ZIP module](http://php.net/manual/en/book.zip.php) and **Laravel 6.0 or higher**. It's not compatible with Windows servers.
77

88
If you are using an older version of Laravel, take a look at one of the previous versions of this package.
99

@@ -15,8 +15,8 @@ Make sure `pg_dump` is installed on your system if you want to backup PostgreSQL
1515

1616
Make sure `mongodump` is installed on your system if you want to backup Mongo databases.
1717

18-
To send notifications to Slack you'll need to install `guzzlehttp/guzzle` v6:
18+
To send notifications to Slack you'll need to install `laravel/slack-notification-channel`:
1919

2020
```bash
21-
composer require guzzlehttp/guzzle
21+
composer require laravel/slack-notification-channel
2222
```

docs/sending-notifications/customizing-the-notifiable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Customizing the notifiable
33
weight: 3
44
---
55

6-
Laravel 5.3's notifications are sent to a notifiable. A notifiable provides configuration values that determine how notifications will be sent.
6+
Laravel's notifications are sent to a notifiable. A notifiable provides configuration values that determine how notifications will be sent.
77

88
By default the package uses this notifiable class: `\Spatie\Backup\Notifications\Notifiable`. This class will read out the config file. All mail notifications will be sent to the mail address specified in the `notifications.mail.to` key of the config file.
99

docs/sending-notifications/overview.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Sending notifications
33
weight: 1
44
---
55

6-
The package leverages Laravel's native notifications to let you know that your backups are ok, or not. Out of the box it can send notifications via mail and Slack (for Slack you'll need to require `guzzlehttp/guzzle` in your project).
6+
The package leverages Laravel's native notifications to let you know that your backups are ok, or not. Out of the box it can send notifications via mail and Slack (for Slack you'll need to require `laravel/slack-notification-channel` in your project).
77

88
## Configuration
99

@@ -14,20 +14,20 @@ This is the portion of the configuration that will determine when and how notifi
1414

1515
/*
1616
* You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
17-
* For Slack you need to install guzzlehttp/guzzle.
17+
* For Slack you need to install laravel/slack-notification-channel.
1818
*
1919
* You can also use your own notification classes, just make sure the class is named after one of
2020
* the `Spatie\Backup\Events` classes.
2121
*/
2222
'notifications' => [
2323

2424
'notifications' => [
25-
\Spatie\Backup\Notifications\Notifications\BackupHasFailed::class => ['mail'],
25+
\Spatie\Backup\Notifications\Notifications\BackupHasFailed::class => ['mail'],
2626
\Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFound::class => ['mail'],
27-
\Spatie\Backup\Notifications\Notifications\CleanupHasFailed::class => ['mail'],
28-
\Spatie\Backup\Notifications\Notifications\BackupWasSuccessful::class => ['mail'],
29-
\Spatie\Backup\Notifications\Notifications\HealthyBackupWasFound::class => ['mail'],
30-
\Spatie\Backup\Notifications\Notifications\CleanupWasSuccessful::class => ['mail'],
27+
\Spatie\Backup\Notifications\Notifications\CleanupHasFailed::class => ['mail'],
28+
\Spatie\Backup\Notifications\Notifications\BackupWasSuccessful::class => ['mail'],
29+
\Spatie\Backup\Notifications\Notifications\HealthyBackupWasFound::class => ['mail'],
30+
\Spatie\Backup\Notifications\Notifications\CleanupWasSuccessful::class => ['mail'],
3131
],
3232

3333
/*
@@ -47,6 +47,16 @@ This is the portion of the configuration that will determine when and how notifi
4747

4848
'slack' => [
4949
'webhook_url' => '',
50+
51+
/*
52+
* If this is set to null the default channel of the webhook will be used.
53+
*/
54+
'channel' => null,
55+
56+
'username' => null,
57+
58+
'icon' => null,
59+
5060
],
5161
],
5262

0 commit comments

Comments
 (0)