Browse Source

📝 Add a proper README file with section and links

Fix #1
master
Clement Desmidt 4 months ago
parent
commit
c18d517afb
3 changed files with 101 additions and 1 deletions
  1. +70
    -1
      README.md
  2. +10
    -0
      app/scenario/scenarii.json
  3. +21
    -0
      docs/configuration/transport/dropbox.md

+ 70
- 1
README.md View File

@@ -1 +1,70 @@
Backup script for limited shared hosting
# Shikiryu Backup ![language](https://img.shields.io/badge/language-php-blue.svg) ![issues](https://img.shields.io/github/issues-raw/Chouchen/Shikiryu_backup)

> Because even small websites need to be backed up

Backup script for limited shared hosting

## :books: Table of Contents

- [Installation](#package-installation)
- [Usage](#rocket-usage)
- [Support](#hammer_and_wrench-support)
- [Contributing](#memo-contributing)
- [License](#scroll-license)

## :package: Installation

### First check if you have composer installed

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

### Then install this script

```sh
composer require shikiryu/backup
```

## :rocket: 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](docs/using-scenario.md)


### Tips

Each possible section has docs in [their respective folders](docs/configuration)

Here is an example code

```php
<?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();
}
```

## :hammer_and_wrench: Support

Please [open an issue](https://github.com/Chouchen/Shikiryu_Backup/issues/new) for support.

## :memo: Contributing

Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/Chouchen/Shikiryu_Backupleonard-henriquez/readme-boilerplateleonard-henriquez/readme-boilerplate/compare/).

## :scroll: License

[Creative Commons Attribution NonCommercial (CC-BY-NC)](https://tldrlegal.com/license/creative-commons-attribution-noncommercial-(cc-nc)) © [Chouchen](https://github.com/Chouchen/)

+ 10
- 0
app/scenario/scenarii.json View File

@@ -24,6 +24,13 @@
"subject" : "[Example.net] backup of the day",
"message" : "Hi,\n\nYou can find your backup in this mail.\n\nRegards,\nMyself."
},
"Sftp": {
"host" : "sftp.domain.com",
"port" : "22",
"login" : "login",
"password" : "password",
"folder" : "/folder"
},
"Ftp": {
"host" : "ftp.domain.com",
"login" : "login",
@@ -32,6 +39,9 @@
},
"Folder": {

},
"Dropbox": {
"token": "123456789123456789"
}
}
}

+ 21
- 0
docs/configuration/transport/dropbox.md View File

@@ -0,0 +1,21 @@
# Dropbox transport configuration

## JSON
```
"Dropbox": {
"token": "your-token-here",
},
```
## General

To generate your access token, you need to go to your [`App Console`](https://www.dropbox.com/developers/apps).

Then,
1. Create a new app
2. Select DropboxAPI, "App folder" and give it a unique name.
3. Click on the button next to "Generate access token"
## Options
token (mandatory) = access token



Loading…
Cancel
Save