rbackup/README.rst
2019-03-17 09:37:40 -07:00

58 lines
1.5 KiB
ReStructuredText

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
rbackup - An rsync-based backup tool
====================================
A tool that automates the use of rsync and extra features for package manager backups.
Features
--------
* Snapshot-based backup management
* Backups of deleted and modified files
* Creation of installed package lists and backup of package manager databases
Advanced Features
^^^^^^^^^^^^^^^^^
* rbackup depends on the filesystem that stores the repository to provide features such as checksumming, advanced deduplication, and data integrity verification
Target Directories
------------------
* /boot
* /etc
* /home
* /root
* /var
* /var/lib
* /var/log
* Extras
* Installed packages
* Package manager databases
Backup Directory Hierarchy
--------------------------
* basedir
| - data *directory containing all snapshots*
| | - snapshot1 *first snapshot*
| | - boot
| | - home
| | - etc
| | - snapshot2
| | - boot
| | - home
| | - etc
| - prev *link to previous snapshot*
* Assuming snapshot2 was the previous backup and snapshot1 was the backup before that:
* prev would link to snapshot2
* Unchanged files files from snapshot1 backed up to snapshot2 are hardlinked to snapshot1
Implementation Notes
--------------------
* os.path is used for path handling
* Use --link-dest=
* Use --suffix=, --backup, and --backup-dir=
To-do
-----
* Use --suffix=, --backup, and --backup-dir=