sneak/vaultik
1
0 Fork 0
Code Issues 13 Pull Requests 5 Actions Packages Projects Releases Wiki Activity

Say which commands need the private key, in README.md and config.example.yml

Browse Source 
The last sentence of "The private key" and the matching comment in
config.example.yml named only the restore machine. snapshot verify --deep
needs the key too. Both now name both commands. The "Everyday use" block
gains a comment saying its next three commands run on a machine that holds
the private key.

Model: fable-5-1
This commit is contained in:
sneak authored and clawbot committed 2026-11-11 07:01:54 +00:00
1 parent 49af986fd1
commit 72ea483312
2 files changed
+5 -4
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+3 -2
View File
@@ -104,6 +104,7 @@ it the backup stops with a permission error on a protected directory.
# Check that a snapshot's blobs are all present, with the listed sizes. # Check that a snapshot's blobs are all present, with the listed sizes.
vaultik snapshot verify <snapshot-id> vaultik snapshot verify <snapshot-id>
# Run the next three commands on a machine that holds the private key.
# Put the private key in the environment. Reading it from the file keeps it # Put the private key in the environment. Reading it from the file keeps it
# out of your shell history. # out of your shell history.
export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)" export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"
@@ -881,8 +882,8 @@ export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"
``` ```
Do not put the private key on a machine you back up. Anyone who breaks into that Do not put the private key on a machine you back up. Anyone who breaks into that
machine could then decrypt its backups. Supply the key only on the machine you machine could then decrypt its backups. Supply the key only on the machine where
restore on. you run `snapshot restore` or `snapshot verify --deep`.
### Exclude patterns ### Exclude patterns
configs/config.example.yml
+2 -2
View File
@@ -17,8 +17,8 @@ age_recipients:
# Age private key for decryption # Age private key for decryption
# Only snapshot restore and snapshot verify --deep need it. The # Only snapshot restore and snapshot verify --deep need it. The
# VAULTIK_AGE_SECRET_KEY environment variable overrides this setting # VAULTIK_AGE_SECRET_KEY environment variable overrides this setting
# Do not set it on a machine you back up: prefer the environment variable, # Do not set it on a machine you back up. Supply the environment variable
# supplied only on the machine you restore on # only on a machine where you run snapshot restore or snapshot verify --deep
# Default: not set # Default: not set
#age_secret_key: YOUR_AGE_PRIVATE_KEY #age_secret_key: YOUR_AGE_PRIVATE_KEY