From c77c1c20c9b4cdd31a092b6a123bc7569b16e1fe Mon Sep 17 00:00:00 2001 From: sneak Date: Mon, 9 Nov 2026 03:11:05 +0000 Subject: [PATCH] Define rclone's remote where it is first used The documents use "remote key" for something else, so "remote" as rclone's noun is now defined on first use: a remote is a storage service set up in rclone. Changed in `README.md` (the destination bullet), `docs/REPOSTRUCTURE.md` (the opening) and `config.example.yml` (the `storage_url` comment). Model: fable-5-1 --- README.md | 3 ++- config.example.yml | 4 ++-- docs/REPOSTRUCTURE.md | 4 ++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 50e743e..361fab5 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,8 @@ It was written to meet these requirements together: - Small files are packed together into large objects. This keeps the number of S3 requests low. - File contents, names, paths and metadata are encrypted at the destination. -- Three kinds of destination: S3, a local directory and any rclone remote. +- Three kinds of destination: S3, a local directory and any rclone remote. A + remote is a storage service set up in rclone. - Regular files, symlinks and directories are backed up, with their permissions, owners and modification times. - Pure Go, with no C code. It builds for Linux and macOS on `amd64` and `arm64`. diff --git a/config.example.yml b/config.example.yml index b627c9f..dbcbcb3 100644 --- a/config.example.yml +++ b/config.example.yml @@ -278,8 +278,8 @@ exclude: # An s3:// URL also needs s3.access_key_id and s3.secret_access_key below # A file:// path must be absolute, and the directory must already exist: # vaultik never creates it -# An rclone:// URL names a remote of rclone (https://rclone.org/); the remote -# must be defined in rclone's own config (rclone config) +# An rclone:// URL names an rclone remote (https://rclone.org/), a storage +# service set up in rclone's own config (rclone config) storage_url: "rclone://myremote/path/to/backups" # S3-compatible storage configuration diff --git a/docs/REPOSTRUCTURE.md b/docs/REPOSTRUCTURE.md index caf90a1..068fa82 100644 --- a/docs/REPOSTRUCTURE.md +++ b/docs/REPOSTRUCTURE.md @@ -4,8 +4,8 @@ This document describes what `vaultik` stores at the destination. It covers the layout, what the layout protects, and the risks it accepts. The destination is the place the backups are stored. It is an S3 bucket and -prefix, a local directory or a remote of [rclone](https://rclone.org/). The -layout is the same on all three. +prefix, a local directory or an [rclone](https://rclone.org/) remote. A remote +is a storage service set up in rclone. The layout is the same on all three. ## Terms