Backup

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
• Installation
• Configuration
• Usage
  • Scheduling
• Documentation
• License

Features

Why use our backup addon?

• 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.
• Choose exactly what you want to backup by configuring the backup pipeline.
  • Easy to extend and customize, just create a new pipes!
• Uses laravels storage system and thus supports external storage out of the box.
• Tested, we have over 140 assertions in this addon.

Installation

1. To install this addon, require it using composer.

   composer require itiden/statamic-backup
   

2. Set the content_path config value to the path of your content, start with publishing the config:

   php artisan vendor:publish --tag="backup-config"
   

   default is storage_path('content')

Configuration

You can configure the backup settings in the config/backup.php file, first publish the configuration file using the following command:

php artisan vendor:publish --tag="backup-config"

Then you can configure:

• Backup path
• Backup disk
• Backup filename
• Backup schedule
• Temporary files path
• Max amount of backups to keep
• Backup password
• The Backup pipeline

Read more about the configuration here!

Usage

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.

Or if you prefer to use the command line, you can use the following command:

php artisan statamic:backup:create

Scheduling

Configure the backup schedule in the configuration file, read more about it here.

To use the scheduling you need to run the laravel scheduler. Read more about that here: Running the scheduler.

Documentation

In the docs directory you can read more about the pipeline, scheduling and notification configurations.

License

Backup is open-sourced software licensed under the MIT license.