Merge pull request #27 from itiden/chore/improve-readme

NeoIsRecursive · web-flow · commit 9ecdf456d880 · 2024-08-20T17:35:12.000+02:00
Chore/improve readme
diff --git a/README.md b/README.md
@@ -1,93 +1,84 @@
 # Backup
 
-Welcome to the Backup Addon! This addon supercharges your Statamic experience by providing powerful backup management capabilities. Say goodbye to data loss worries and hello to peace of mind!
+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.
 
 ## Table of Contents
 
 - [Features](#features)
 - [Installation](#installation)
 - [Configuration](#configuration)
 - [Usage](#usage)
-- [Contributing](#contributing)
+  - [Scheduling](#scheduling)
+- [Documentation](#documentation)
 - [License](#license)
 
 ## Features
 
-- 📂 **Customizable Storage**: Choose where your backups are stored, whether it's on your local disk or a different storage provider.
-- 🔄 **Backup Rotation**: Automatically manage your backups by setting a maximum number to keep. Old backups are deleted to make room for new ones.
-- 🔒 **Password Protection**: Keep your backups secure with an optional password. No unauthorized access allowed!
-- ⏰ **Scheduled Backups**: Set it and forget it! Schedule backups to run automatically at your preferred frequency.
+Why use our backup addon?
 
-## Installation
-
-To install this addon, follow these simple steps:
+- Control panel page where you can manage backups
+- Chunked uploads - upload huge backups from other servers without the need to change your `php.ini`.
+- Permissions - choose exactly which users can manage your backups with [permissions](https://statamic.dev/users#permissions).
+- Choose exactly what you want to backup by configuring the backup [pipeline](docs/pipeline.md).
+  - Easy to extend and customize, [just create a new pipes](docs/pipeline.md#creating-a-new-backup-pipe)!
+- Uses laravels [storage system](https://laravel.com/docs/11.x/filesystem) and thus supports external storage out of the box.
+- Tested, we have over 140 assertions in this addon.
 
-1. **Composer Installation**:
+## Installation
 
-   Run the following composer command in your Statamic project:
+1. To install this addon, require it using composer.
 
    ```bash
    composer require itiden/statamic-backup
    ```
 
-2. **Configuration**:
-
-   Publish the configuration file:
-
-   ```sh
+2. Set the `content_path` config value to the path of your content, start with publishing the config:
+   ```bash
    php artisan vendor:publish --tag="backup-config"
    ```
+   default is `storage_path('content')`
 
-   Next, configure the addon by editing the `config/backup.php` file. Customize settings such as content path, backup destination, and more.
-
-   Read the full configuration documentation [here](docs/configuration.md)!
-
-3. **Usage**:
-
-   You're all set! Start using the addon to handle your backups effortlessly.
-
-## Commands
-
-Backup your site:
-
-```sh
-php artisan statamic:backup
-```
+## Configuration
 
-Restore your site from an absolute path
+You can configure the backup settings in the `config/backup.php` file, first publish the configuration file using the following command:
 
-```sh
-php artisan statamic:backup:restore {path}
+```bash
+php artisan vendor:publish --tag="backup-config"
 ```
 
-Clear the temp file directory
-
-```sh
-php artisan statamic:backup:clear
-```
+Then you can configure:
 
-## Configuration
+- Backup path
+- Backup disk
+- Backup filename
+- Backup schedule
+- Temporary files path
+- Max amount of backups to keep
+- Backup password
+- The Backup pipeline
 
-Read the configuration [docs](docs/configuration.md)!
+Read more about the configuration [here](docs/configuration.md)!
 
-## Notifications/Events
+## Usage
 
-You can send notifications when a backup is created. Read the notifications [docs](docs/notifications.md)!
+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.
 
-## Usage
+Or if you prefer to use the command line, you can use the following command:
 
-Using the Statamic Backup Addon is a breeze:
+```bash
+php artisan statamic:backup:create
+```
 
-1. Configure your backup settings in `config/backup.php` to match your needs [[docs]](docs/configuration.md).
+### Scheduling
 
-2. Run the backup command manually or let scheduled backups take care of it automatically.
+Configure the backup schedule in the configuration file, read more about it [here](docs/scheduling.md).
 
-3. Enjoy the peace of mind knowing your data is backed up, secure, and accessible when you need it.
+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).
 
-## Contributing
+## Documentation
 
-We welcome contributions from the Statamic community! Whether it's bug fixes, new features, or improvements, please feel free to contribute.
+In the docs directory you can read more about the pipeline, scheduling and notification configurations.
 
 ## License
 
-This addon is open-source and available under the [MIT License](LICENSE).
+Backup is open-sourced software licensed under the [MIT license](LICENSE.md).
diff --git a/config/backup.php b/config/backup.php
@@ -40,7 +40,7 @@
      *
      * set to null to disable automatic backups
      * frequency can be any of the laravel schedule frequencies
-     * time should be what the frequency expects
+     * time should be parameters the frequency expects
      *
      * see https://laravel.com/docs/10.x/scheduling#schedule-frequency-options
      */
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -10,42 +10,72 @@ php artisan vendor:publish --tag="backup-config"
 
 ## Configuration Options
 
-Now, let's dive into the exciting world of configuration. Here's an overview of each option:
-
-- **`content_path`**:
-
-  - _Description_: Specifies the path to your content directory, used by the default content backup driver.
-  - _Default_: `storage_path('content')`
-
-- **`destination`**:
-
-  - _Description_: Defines the backup destination disk and path.
-  - _Default_: statamic-backups on the local disk.
-
-- **`temp_path`**:
-
-  - _Description_: Specifies the path to the temporary directory used for backup operations.
-  - _Defualt_: `storage_path('framework/statamic-backup')`
-
-- **`max_backups`**:
-
-  - _Description_: Determines the maximum number of backups to keep. When this limit is exceeded, the oldest backup will be automatically deleted.
-  - _Default_: 10
-
-- **`password`**:
-
-  - _Description_: Sets a backup password. If set to null, password protection is disabled.
-  - _Default_: `env('BACKUP_PASSWORD')`
-
-- **`schedule`**:
-
-  - _Description_: Configure the backup schedule options. Specify the frequency and time for automatic backups.
-  - _Configuration_: Check out our scheduling docs [here](scheduling.md).
-  - _Default_: Daily at midnight
-
-- **`pipeline`**:
-  - _Description_: Specifies the backup pipeline. These "pipes" determine what parts of your site will be backed up.
-  - _Configuration_: Check out our backup pipes docs [here](pipes.md).
-  - _Default_: Content, Assets, and Users.
+This is the default contents of the configuration:
+
+```php
+return [
+    /**
+     * The path to the content directory
+     *
+     * This is used by the default content backup driver
+     */
+    'content_path' => storage_path('content'),
+
+    /**
+     * The backup destination options
+     */
+    'destination' => [
+        'disk' => 'local',
+        'path' => 'statamic-backups',
+    ],
+
+    /**
+     * The path to the temp directory
+     */
+    'temp_path' => storage_path('framework/statamic-backup'),
+
+    /**
+     * The maximum number of backups to keep
+     *
+     * when exceeded the oldest backup will be deleted
+     */
+    'max_backups' => 10,
+
+    /**
+     * The backup password
+     *
+     * set to null to disable password protection
+     */
+    'password' => env('BACKUP_PASSWORD', null),
+
+    /**
+     * The backup schedule options
+     *
+     * set to null to disable automatic backups
+     * frequency can be any of the laravel schedule frequencies
+     * time should be parameters the frequency expects
+     *
+     * see https://laravel.com/docs/10.x/scheduling#schedule-frequency-options
+     */
+    'schedule' => [
+        'frequency' => 'daily',
+        // 'time' => '03:00',
+    ],
+
+    /**
+     * The backup steps to use
+     *
+     * These are the steps/pipes that will be used to backup your site
+     * You can add your own here
+     *
+     * All pipes are expected to be instances of Itiden\Backup\Abtracts\BackupPipe
+     */
+    'pipeline' => [
+        Itiden\Backup\Pipes\Content::class,
+        Itiden\Backup\Pipes\Assets::class,
+        Itiden\Backup\Pipes\Users::class,
+    ],
+];
+```
 
 There you have it! With these options, you can fine-tune your backup setup to suit your needs and keep your data safe and sound. Happy configuring! 😄🚀

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`*`
`41`	`41`	`* set to null to disable automatic backups`
`42`	`42`	`* frequency can be any of the laravel schedule frequencies`
`43`		`- * time should be what the frequency expects`
	`43`	`+ * time should be parameters the frequency expects`
`44`	`44`	`*`
`45`	`45`	`* see https://laravel.com/docs/10.x/scheduling#schedule-frequency-options`
`46`	`46`	`*/`