Skip to content

Commit

Permalink
adjusting readme for encryption options
Browse files Browse the repository at this point in the history
  • Loading branch information
garikello3d committed Mar 14, 2024
1 parent 16279e3 commit d70c48a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Finally, additional assurance is maintained since the integrity of resulting fil

#### Example to backup data coming from stdin into files

`tar cf - /my/disk | ./bigarchiver backup --buf-size 256 --auth "My Full Name" --auth-every 32 --pass mysecret --compress-level 6 --split-size 1024 --out-template /path/to/files%%%%%%`
`tar cf - /my/disk | ./bigarchiver backup --buf-size 256 --alg aes128-gcm --auth "My Full Name" --auth-every 32 --pass mysecret --compress-level 6 --split-size 1024 --out-template /path/to/files%%%%%%`

#### Example to restore data from files to stdout:

Expand All @@ -22,13 +22,14 @@ Finally, additional assurance is maintained since the integrity of resulting fil

#### Example brenchmark different settings and see the performance

`dd if=/dev/urandom bs=1M | ./bigarchiver bench --out-dir /tmp/test --duration 60 --compress-levels 1,3,5,7,9 --buf-sizes 4,32 --compress-threads-nums 1,2,4`
`dd if=/dev/urandom bs=1M | ./bigarchiver bench --out-dir /tmp/test --duration 60 --compress-levels 1,3,5,7,9 --buf-sizes 4,32 --compress-threads-nums 1,2,4 --algs none,aes128-gcm`

## Command line option reference

| Option                                                   | Meaning |
|----------------------------------------------------------|---------|
| `backup, restore, check, bench` | select mode of operation (only one at a time) |
| `--alg <alg>` | Encryption & authentication algorithm; possible values: none, aes128-gcm, chacha20-poly1305 |
| `--auth-every <size_mb>` | Embed authentication data to each portion of data of indicated size, in MB |
| `--auth <string>` | Public authentication data to embed |
| `--buf-size <size_mb>` | Buffer size for reading disk files or stdin, in MB |
Expand Down

0 comments on commit d70c48a

Please sign in to comment.