From 3b9257cf882dd05e7ba1ad910764fd5ce9edc25b Mon Sep 17 00:00:00 2001 From: sneak Date: Thu, 19 Nov 2026 07:09:33 +0000 Subject: [PATCH] Document where vaultik reads the rclone config (closes #469) The rclone section now says vaultik reads rclone's own config file, which needs no rclone tool once it exists, and that RCLONE_CONFIG names another file. RCLONE_CONFIG joins the environment-variable list, and restoring on another machine says the new host needs that file. Model: opus-5-5 --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6d7601..e3d2ea4 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,11 @@ vaultik config set s3.secret_access_key "..." vaultik snapshot list ``` +For an rclone destination, the storage credentials are in rclone's config file +instead. Copy that file to the new host, or recreate it with `rclone config`, +and set `storage_url` to the original `rclone://remote/path`. See +[storage backends](#storage-backends). + `snapshot list` reads the destination store without the private key. A snapshot that is not in this host's (empty) local index is shown as remote-only: its row is identified by `` rather than by a `hostname_name_timestamp` @@ -281,6 +286,8 @@ work as written. the key is not typed into your shell history. - `VAULTIK_CONFIG`: Path to config file (overridden by `--config`) - `VAULTIK_INDEX_PATH`: Override local SQLite index path +- `RCLONE_CONFIG`: Path to the rclone config file used by an `rclone://` + destination (default `~/.config/rclone/rclone.conf`) - `VAULTIK_CPUPROFILE`: Write a CPU profile to this path for the duration of the run (development/debugging) - `VAULTIK_MEMPROFILE`: Write a heap profile to this path when the run exits @@ -602,7 +609,11 @@ only `vaultik-destination.txt` stops such a backup, and only while the local index holds snapshots. **Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud -providers. Requires rclone to be configured separately (`rclone config`). +providers. `remote` is the name of a remote in rclone's config file, which holds +that remote's credentials. vaultik reads the same file the `rclone` tool reads, +by default `~/.config/rclone/rclone.conf`. Create it with `rclone config`, or +copy it from another machine; vaultik does not need the `rclone` tool once the +file exists. The `RCLONE_CONFIG` environment variable names a different file. An upload cut off part-way leaves nothing under the object's name on S3, which shows an object only once its upload has completed, and on the local filesystem