maride/tupper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
maride 2024-08-10 00:01:38 +02:00
parent f3a49945aa
commit 36798f9cf4
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -12,8 +12,9 @@ Drops of glue between [SSHFS](https://github.com/libfuse/sshfs), [Borg](https://
## Usage ## Usage
Enter SSH credentials, host and destination directory in `/etc/tupper.conf`, as well as the directories to back up. Enter SSH credentials, host and destination directory in `/etc/tupper.conf`, as well as the directories to back up.
After that, run `sudo tupper initialize` once to init the Borg repository.
Then either run `sudo tupper` or wait for the daily cron scheduler to kick in. Then either run `sudo tupper backup` or wait for the daily cron scheduler to kick in.
## Building ## Building
@ -21,7 +22,5 @@ Then either run `sudo tupper` or wait for the daily cron scheduler to kick in.
## TODO / Known pitfalls ## TODO / Known pitfalls
- The Borg backup destination (thus, the contents of the SSHFS directory) must be `borg init`ed; tupper won't do that (and probably shouldn't anyway)
- 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` - 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`