From 6464aa6e109cb0ec450547ee9b86c260d35ff05a Mon Sep 17 00:00:00 2001 From: metamuffin Date: Fri, 14 Jun 2024 04:50:33 +0200 Subject: doc --- readme.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 7053403..296548c 100644 --- a/readme.md +++ b/readme.md @@ -6,8 +6,8 @@ files automatically. Problem: Offsite backups could be as easy as a network filesystem - the problem is however that these usually implement deleting files aswell. In the case where a user's machine is comprimised by an attacker, these files could just be -deleted in the same way they were created, defeating the advantages of an -**offsite** backup. +deleted in the same way they were created, defeating some of the advantages of +an offsite backup. Solution: Implement a network "filesystem" that only supports non-destructive operations. Only implementing upload means that backups will accumulate on the @@ -62,7 +62,7 @@ encrypt it! 3. Start uploading a backup: `backuptool config.toml upload /path/to/backup` 4. List currently stored backups: `backuptool config.toml list` 5. Restore a remote backup by serial: - `backuptool config.toml download 2 /path/to/restore` + `backuptool config.toml download /path/to/restore` 6. See further usage `backuptool --help` ## Protocol @@ -79,3 +79,7 @@ disconnects you.First send a line with the shared secret, then send commands. - `download`: Client sends `download,` on a line. If accepted the server replies `ready,` on a line and then continues sending exactly this many bytes before concluding with `done` on a line. + +## Todo + +- implement upload / download max rate -- cgit v1.2.3-70-g09d2