tupper/README.md

28 lines
903 B
Markdown
Raw Normal View History

2024-08-07 09:02:41 +00:00
# tupper
Drops of glue between [SSHFS](https://github.com/libfuse/sshfs), [Borg](https://www.borgbackup.org/) and [cron](https://github.com/vixie/cron)
## Features
- Auto-mounts specified SSHFS as required
- Encrypted, deduplicated backups thanks to Borg
- Backup of specified directories to SSHFS
- Daily cron scheduler
2024-08-12 20:17:36 +00:00
- Auto-prune old archives
2024-08-07 09:02:41 +00:00
## Usage
Enter SSH credentials, host and destination directory in `/etc/tupper.conf`, as well as the directories to back up.
2024-08-09 22:01:38 +00:00
After that, run `sudo tupper initialize` once to init the Borg repository.
2024-08-07 09:02:41 +00:00
2024-08-09 22:01:38 +00:00
Then either run `sudo tupper backup` or wait for the daily cron scheduler to kick in.
2024-08-07 09:02:41 +00:00
## Building
2024-08-12 20:17:36 +00:00
`dpkg-deb --build . tupper_0.1.1_all.deb`
2024-08-07 09:02:41 +00:00
2024-08-07 22:44:16 +00:00
## TODO / Known pitfalls
- If `tupper` fails with `timeout waiting for prompt`, you may need to validate and accept the SSH host key: `ssh-keyscan yournas.local | sudo tee --append /root/.ssh/known_hosts`