thesaturn/c14-backup-tool

This package is abandoned and no longer maintained. No replacement package was suggested.

Backup tool for cheap C14 storage provided by online.net. Support encryption, diff backups and backup rotation. Description about storage https://www.online.net/en/c14

1.1.1 2018-04-08 14:10 UTC

Requires

• fabiang/xmpp: *
• thesaturn/xmpplogger: 1.0.*

MIT

• TheSaturn

README

Backup tool for cheap C14 storage provided by online.net. Support encryption, diff backups and backup rotation. Description and prices here: https://www.online.net/en/c14.

Описание на русском

Inspired by BackInTime

Features

• Multi profile configuration
• Exclude folders and files
• Client-side encryption
• Backup rotations

Requirements

PHP >= 5.6

rsync

encfs (+encfstools)

sshfs

ssh

ssh-keygen

Optional dependence

cron

composer

fabiang/xmpp

Installation

Without xmpp logs and composer

git clone https://github.com/TheSaturn/C14BackupTool.git
cd C14BackupTool
cp config.example.php config.php

If you want get logs by xmpp:

composer create-project thesaturn/c14-backup-tool
cp config.example.php config.php

Terminology

C14 — Storage type

Safe — Name of archives group in C14

Archive — Contains your files

Configuring

All possible options described in config.example.php. Below some tips

• config.php must return array with profiles return [...]
• Every profile has its name

return [
    'default' => [...],
    'books2' => [...],
    'books3' => [...],
    'books4' => [...],
];

• All paths must be absolute to avoid possible errors

Usage

Command line usage: php /path/to/main.php profileName

1. Register to online.net
2. Add your debit/credit card
3. Generate ssh keys (if you don't have them) ssh-keygen
4. Edit config.php as you like
5. Test your configuration
6. Add backup tool to cron
7. Time to time look through archives in safe lists to check size of archives

Notices

• Diff backups created only in one archive. So you can always delete any archive without corrupting others
• Storage API is a quite slow and not stable. That is why code try several times to do operations and have sleep() function to wait, while operations will be applied.
• Archive creates for 7 days, but tool make backups only for 6 days since archive created.
• Encfs config file also copied to archive. So you don't need to save it somewhere else.
• If all rotation options is to false, all backups will be saved.
• If encryption enabled, exclude working with only absolute paths, regex is not available

Not implemented yet

• Better config validation
• Dependencies checking
• Tests

Algorithm

1. Send a message about backup starting "Backup started for safe"
2. Find a safe with safe name (set up in config)
3. Find an archive in the safe to store backups
4. Create necessary folders
5. Mount encfs (encrypted view of the root FS)
6. Encrypt included and excluded file names (for rsync)
7. Mount the archive (sshfs)
8. Clean up backup_temp folder (if last backup was unsuccessful)
9. Copy hard links from the last backup folder
10. Send the message "YAY! The real backuping is starting!"
11. rsync
12. rename backup_temp to C14ABT/$date
13. Write date of successful backup to description of the archive
14. Send "Backup success."
15. Unmount sshfs and encfs