Fix three review findings in help text, example config and terms
check / check (push) Successful in 12m37s

The snapshot restore help splits its 40-word permissions sentence in
two. The snapshot-ID case leaves the parenthesis, and the temporary
space requirement gets its own sentence.

configs/config.example.yml gains a commented-out env entry, after
hostname, so its first line, which says the file shows every option,
is true again.

docs/REPOSTRUCTURE.md defines remote key in Terms, before the
marker-file section uses it.

Model: fable-5-1
This commit is contained in:
clawbot committed 2026-11-11 07:55:31 +00:00
1 parent 2bf51d65e3
commit f65fd2870b
3 files changed
+11 -3

No files matched your search

+6
View File
@@ -375,3 +375,9 @@ compression_level: 5
# Hostname to use in backup metadata # Hostname to use in backup metadata
# Default: system hostname # Default: system hostname
#hostname: myserver #hostname: myserver
# Environment variables that vaultik sets in its own process when it loads
# the config. Its keys are variable names
# Default: none
#env:
# NAME: value
+2
View File
@@ -12,6 +12,8 @@ is a storage service set up in rclone. The layout is the same on all three.
- **Snapshot**: one backup of the paths listed under one name in the config. - **Snapshot**: one backup of the paths listed under one name in the config.
- **Snapshot ID**: the name of a snapshot, in the form - **Snapshot ID**: the name of a snapshot, in the form
`<hostname>_<snapshot-name>_<timestamp>`. `<hostname>_<snapshot-name>_<timestamp>`.
- **Remote key**: a hash of the snapshot ID. It names the snapshot's directory
under `metadata/`. See [Remote keys](#remote-keys).
- **Chunk**: a piece of a file's content, named by the SHA-256 hash of that - **Chunk**: a piece of a file's content, named by the SHA-256 hash of that
content. content.
- **Blob**: one object under `blobs/`. It holds many chunks. - **Blob**: one object under `blobs/`. It holds many chunks.
+3 -3
View File
@@ -48,10 +48,10 @@ typing it, so that it does not land in 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)"
Also needs permission to read the backup destination store (and to list Also needs permission to read the backup destination store, and to list
it when given a remote key, or a snapshot ID that is not in the local it when given a remote key, or a snapshot ID that is not in the local
index), and free space in the temporary directory for the decrypted index. It also needs free space in the temporary directory for the
blobs. decrypted blobs.
Examples: Examples:
# Restore entire snapshot # Restore entire snapshot