You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-43Lines changed: 8 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,12 @@
2
2
3
3
Backup is an extensible and powerful backup tool for statamic sites, it enables you to create, manage and schedule backups of your site with ease in the control panel.
- Choose exactly what you want to backup by configuring the backup [pipeline](docs/pipeline.md).
23
22
- Easy to extend and customize, [just create a new pipes](docs/pipeline.md#creating-a-new-backup-pipe)!
24
23
- Uses laravels [storage system](https://laravel.com/docs/11.x/filesystem) and thus supports external storage out of the box.
25
-
- Tested, we have over 140 assertions in this addon.
24
+
- Tested, the addon have over 85% test coverage.
26
25
27
26
## Installation
28
27
28
+
Read the more detailed guide in the documentation, [here](https://itiden.github.io/statamic-backup/getting-started.html).
29
+
30
+
Otherwise, here is a "quickstart guide":
31
+
29
32
1. To install this addon, require it using composer.
30
33
31
34
```bash
@@ -36,48 +39,10 @@ Why use our backup addon?
36
39
```bash
37
40
php artisan vendor:publish --tag="backup-config"
38
41
```
39
-
default is `storage_path('content')`
40
-
41
-
## Configuration
42
-
43
-
You can configure the backup settings in the `config/backup.php` file, first publish the configuration file using the following command:
44
-
45
-
```bash
46
-
php artisan vendor:publish --tag="backup-config"
47
-
```
48
-
49
-
Then you can configure:
50
-
51
-
- Backup path
52
-
- Backup disk
53
-
- Backup filename
54
-
- Backup schedule
55
-
- Temporary files path
56
-
- Max amount of backups to keep
57
-
- Backup password
58
-
- The Backup pipeline
59
-
60
-
Read more about the configuration [here](docs/configuration.md)!
61
-
62
-
## Usage
63
-
64
-
To create a backup, navigate to the Backup section in the control panel and click the "Create Backup" button. There you can also see a list of all your backups and download or restore them if needed.
65
-
66
-
Or if you prefer to use the command line, you can use the following command:
67
-
68
-
```bash
69
-
php artisan statamic:backup:create
70
-
```
71
-
72
-
### Scheduling
73
-
74
-
Configure the backup schedule in the configuration file, read more about it [here](docs/scheduling.md).
75
-
76
-
To use the scheduling you need to run the laravel scheduler. Read more about that here: [Running the scheduler](https://laravel.com/docs/10.x/scheduling#running-the-scheduler).
77
42
78
43
## Documentation
79
44
80
-
In the docs directory you can read more about the pipeline, scheduling and notification configurations.
45
+
Read more about configuration, installation, usage and more advanced topics in our [documentation](https://itiden.github.io/statamic-backup/)!
0 commit comments