Shikiryu_Backup/README.md

Shikiryu Backup

Because even small websites need to be backed up

Backup script for limited shared hosting

📚 Table of Contents

• Installation
• Usage
• Support
• Contributing
• License

📦 Installation

First check if you have composer installed

Before installing this, you need to check if you have PHPand Composer installed on your computer.

Then install this script

composer require shikiryu/backup

🚀 Usage

Everything in this library is based on a scenario (or multiple scenarii).

It consists of 2 sections in a JSON file :

• what to backup
• where to backup

You have an example file in app/scenario.

The first section is backup (what to backup) and the second transport

More information about how to use scenario

Tips

Each possible section has docs in their respective folders

Here is an example code

<?php

include_once 'vendor/autoload.php';

try {
    \Shikiryu\Backup\Scenario::launch('backup.json'); // whatever the file name you gave previously
} catch (\Exception $e) {
    echo $e->getMessage();
}

🛠️ Support

Please open an issue for support.

📝 Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

📜 License

Creative Commons Attribution NonCommercial (CC-BY-NC) © Chouchen