Document where vaultik reads the rclone config (closes #469)
check / check (push) Waiting to run

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
This commit is contained in:
sneak committed 2026-11-19 08:39:28 +00:00
1 parent 9fedcbeb0a
commit bf614c58ac
1 file changed
+16 -5
+16 -5
View File
@@ -127,6 +127,11 @@ vaultik config set s3.secret_access_key "..."
vaultik snapshot list 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 `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 that is not in this host's (empty) local index is shown as remote-only: its row
is identified by `<remote only:...>` rather than by a `hostname_name_timestamp` is identified by `<remote only:...>` rather than by a `hostname_name_timestamp`
@@ -281,6 +286,8 @@ work as written.
the key is not typed into your shell history. the key is not typed into your shell history.
- `VAULTIK_CONFIG`: Path to config file (overridden by `--config`) - `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
- `VAULTIK_INDEX_PATH`: Override local SQLite index path - `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 - `VAULTIK_CPUPROFILE`: Write a CPU profile to this path for the duration of the
run (development/debugging) run (development/debugging)
- `VAULTIK_MEMPROFILE`: Write a heap profile to this path when the run exits - `VAULTIK_MEMPROFILE`: Write a heap profile to this path when the run exits
@@ -602,11 +609,15 @@ only `vaultik-destination.txt` stops such a backup, and only while the local
index holds snapshots. index holds snapshots.
**Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud **Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud
providers. Requires rclone to be configured separately (`rclone config`). The providers. `remote` is the name of a remote in rclone's config file, which holds
path after the remote name is relative: rclone resolves it on the remote, for that remote's credentials. vaultik reads the same file the `rclone` tool reads,
example against the login directory on sftp. A second slash makes it absolute, by default `~/.config/rclone/rclone.conf`. Create it with `rclone config`, or
as in `rclone://remote//srv/backup`. A remote of type `local` needs an absolute copy it from another machine; vaultik does not need the `rclone` tool once the
path; a relative one is refused. file exists. The `RCLONE_CONFIG` environment variable names a different file.
The path after the remote name is relative: rclone resolves it on the remote,
for example against the login directory on sftp. A second slash makes it
absolute, as in `rclone://remote//srv/backup`. A remote of type `local` needs an
absolute path; a relative one is refused.
An upload cut off part-way leaves nothing under the object's name on S3, which 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 shows an object only once its upload has completed, and on the local filesystem