Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronligt/snapsync
Backup solution with snapshots using hard links
https://github.com/ronligt/snapsync
backup-script hardlinks rsync-backup-script snapshot-backup
Last synced: about 1 month ago
JSON representation
Backup solution with snapshots using hard links
- Host: GitHub
- URL: https://github.com/ronligt/snapsync
- Owner: ronligt
- License: gpl-3.0
- Created: 2023-02-23T12:31:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T13:26:19.000Z (over 1 year ago)
- Last Synced: 2024-10-13T16:31:38.921Z (2 months ago)
- Topics: backup-script, hardlinks, rsync-backup-script, snapshot-backup
- Language: Shell
- Homepage:
- Size: 1.6 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# snapsync
The **snapsync** system is a backup system that creates hourly snapshots (backups) of a given directory using hard links to files in snapshots created earlier to save storage. New or modified files are included in the snapshot and removed files are deleted from the snapshot.
A cleanup script is included to preserve snapshots via a retention scheme. By default this scheme only keeps the following snapshots:
1. the oldest one
1. the first backup in a month
1. the first backup on every Sunday [`SNAPSYNC_DOW`] of the last 4 [`SNAPSYNC_MAXWEEK`] weeks
1. Every first backup of the last 7 [`SNAPSYNC_MAXDAY`] days
1. Every backup in the last 24 [`SNAPSYNC_MAXHOUR`] hours
Using the environment variables given inside the square brackets in the rules above you can modify this scheme.
All files in the snapshots are added to a local `locate` database enabling users to find their files ([Locate](#locate)).
## Usage
1. create a `snapsync` directory for all snapshots, e.g. `/snapsync`
1. create a specific directory inside `snapsync` for each snapsynced directory, e.g. `/snapsync/home`
1. add the following lines to the crontab jobs of the `root` for each directory (in this example `/home`):
```bash
15 * * * * snapsync.sh /home /snapsync/home >> /snapsync/home/snapsync.log
45 * * * * cleanup.sh /snapsync/home >> /snapsync/home/snapsync.log
```
For the exact usage of the script run the scripts [`snapsync.sh`](snapsync.sh) and [`cleanup.sh`](cleanup.sh) with arguments to get more information.
Runtime errors are added to `error.log` inside the snapsync directory.
A sample `logrotate` script ([`logrotate_snapsync`](logrotate_snapsync)) is included which can be saved in `/etc/logrotate.d/snapsync`.
## Locate
After each modification to the snapsync system the `locate` database (`mlocate.db`) is updated. This allows users to find their files and/or directory using the following command:
```bash
locate --database=/snapsync/home/mlocate.db -b
```
## Dependencies
* standard Linux or macOS environment. This system has not been tested with Windows.
* `bash`
* `rsync`
* `updatedb` (part of `locate`)
## Separating source and backup
This system allows for easy separation of the source hardware and snapsync (backup) hardware. As the system will always copy new or modified files via `rsync` these copies can also be stored on attached external devices like usb-disks or network storages. Note that the [`snapsync.sh`](snapsync.sh) script must be run on the source system and the [`cleanup.sh`](cleanup.sh) script can be run on the snapsync system.
## License and Copyright
```raw
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
```
Please read the [`LICENSE`](LICENSE) file for more information.