Document snapshot files and fix the six findings of the last review
check / check (push) Successful in 17m0s
check / check (push) Successful in 17m0s
Rebased onto next, which added `snapshot files` and refuses an exclude pattern that does not compile. The README, docs/REPOSTRUCTURE.md, the example config and the help text now name `snapshot files` wherever they list the commands that need the private key, read or list the destination, run without the lock or write a decrypted database. The config load conditions name exclude patterns, and docs/ARCHITECTURE.md lists internal/exclude. The six findings of #399 (comment) use the wording that review gives. Model: opus-5-5
This commit is contained in:
1 parent
3e53dd4014
commit
7b0f0e1362
7 files changed
+145
-48
No files matched your search
@@ -38,7 +38,7 @@ func NewRootCommand() *cobra.Command {
|
||||
Long: `vaultik is an incremental backup tool that encrypts data to age public
|
||||
keys and uploads it to an S3-compatible object store, a local directory or
|
||||
an rclone remote. The backed-up machine needs no private key: only
|
||||
'snapshot restore' and 'snapshot verify --deep' need one.`,
|
||||
'snapshot files', 'snapshot restore' and 'snapshot verify --deep' need one.`,
|
||||
SilenceUsage: true,
|
||||
// Bare 'vaultik' (no subcommand): print help. The banner is
|
||||
// printed once at process startup by Entry, before cobra
|
||||
|
||||
@@ -74,8 +74,8 @@ If no names are provided, all configured snapshots are created.
|
||||
Needs at least one public key in age_recipients, and permission to write
|
||||
objects at the backup destination store. It does not need the age private
|
||||
key. With --prune it also needs permission to list, read and delete objects
|
||||
there. An rclone remote that can move objects also needs permission to
|
||||
read and delete.
|
||||
there. On an rclone remote, a backup can also need permission to read and
|
||||
delete. Which ones depends on the storage service.
|
||||
|
||||
The config is read from the path given by --config or VAULTIK_CONFIG;
|
||||
otherwise from the platform config directory (~/.config/vaultik/config.yml
|
||||
@@ -209,8 +209,13 @@ by the remote key that 'snapshot list' prints for a remote-only snapshot
|
||||
(an unambiguous leading part is enough).
|
||||
|
||||
The file list is only in the snapshot's encrypted database, so this
|
||||
downloads and decrypts it, and requires the age private key in the
|
||||
VAULTIK_AGE_SECRET_KEY environment variable, as 'snapshot restore' does.`,
|
||||
downloads and decrypts it. It requires the age private key, in the
|
||||
VAULTIK_AGE_SECRET_KEY environment variable or as age_secret_key in the
|
||||
config file; the environment variable wins.
|
||||
|
||||
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
|
||||
index.`,
|
||||
Args: cobra.RangeArgs(1, filesMaxArgs),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
path := ""
|
||||
|
||||
Reference in new issue
Block a user