Reword ten sentences after rereading the last commit's prose
check / check (push) Successful in 10m56s
check / check (push) Successful in 10m56s
The last commit was not written on the model that #397 requires. Every sentence it added or changed was read again under that issue's rules and checked against the code, as #399 (comment) asks. - The local index lists files too, so the README and the help text no longer say the file list is stored only in the snapshot's database. - The root help lists the three commands that need the private key. - The quoted-path, mode and rclone upload sentences now put the subject and verb early. - `docs/REPOSTRUCTURE.md` names the path that `snapshot files` writes. - The example config says what runs when the `snapshots` requirement is not met. - "take that object for complete" becomes "treat that object as complete". Model: fable-5-2
This commit is contained in:
1 parent
7b0f0e1362
commit
a3dfe94c8b
5 files changed
+25
-20
No files matched your search
@@ -483,7 +483,7 @@ It needs:
|
|||||||
- Permission to read at the destination, and to list it when you give a remote
|
- Permission to read at the destination, and to list it when you give a remote
|
||||||
key, or a snapshot ID that is not in the local index.
|
key, or a snapshot ID that is not in the local index.
|
||||||
|
|
||||||
The file list is stored only in the snapshot's encrypted database. The command
|
The command reads the file list from the snapshot's encrypted database. It
|
||||||
downloads and decrypts that database. It writes the decrypted database to a
|
downloads and decrypts that database. It writes the decrypted database to a
|
||||||
temporary directory and removes it afterwards. See
|
temporary directory and removes it afterwards. See
|
||||||
[Temporary files](#temporary-files).
|
[Temporary files](#temporary-files).
|
||||||
@@ -499,12 +499,12 @@ The table is sorted by path. It has these columns:
|
|||||||
- `MODIFIED`: the modification time, in UTC.
|
- `MODIFIED`: the modification time, in UTC.
|
||||||
- `PATH`: the original absolute path.
|
- `PATH`: the original absolute path.
|
||||||
|
|
||||||
In the table, a path that holds a newline or another non-printable character is
|
A path can contain a newline or another non-printable character. The table shows
|
||||||
shown in double quotes, with that character escaped, as in `"a\nb"`.
|
such a path in double quotes, with that character escaped, as in `"a\nb"`.
|
||||||
|
|
||||||
The mode looks like the one `ls -l` shows, as in `-rw-r--r--` or `drwxr-xr-x`.
|
The mode looks like the one `ls -l` shows, as in `-rw-r--r--` or `drwxr-xr-x`.
|
||||||
The letters before the nine permission characters show the type and any special
|
The letters before the nine permission characters show the type. They also show
|
||||||
bit. These letters differ from `ls -l`:
|
the setuid, setgid and sticky bits. These letters differ from `ls -l`:
|
||||||
|
|
||||||
- `L`: a symlink, which `ls -l` shows as `l`.
|
- `L`: a symlink, which `ls -l` shows as `l`.
|
||||||
- `u`: setuid, which `ls -l` shows as `s` in place of the owner's `x`.
|
- `u`: setuid, which `ls -l` shows as `s` in place of the owner's `x`.
|
||||||
@@ -1096,7 +1096,7 @@ The URL takes no parameters and no credentials.
|
|||||||
### Interrupted uploads
|
### Interrupted uploads
|
||||||
|
|
||||||
An upload that is cut off must not leave a partial object under the final name.
|
An upload that is cut off must not leave a partial object under the final name.
|
||||||
A later backup would take that object for complete.
|
A later backup would treat that object as complete.
|
||||||
|
|
||||||
- S3 shows an object only once its upload has finished.
|
- S3 shows an object only once its upload has finished.
|
||||||
- The local directory destination writes a temporary file and then renames it.
|
- The local directory destination writes a temporary file and then renames it.
|
||||||
@@ -1127,9 +1127,9 @@ Commands need these permissions at the destination:
|
|||||||
- `prune` and `snapshot create --prune` list, read and delete.
|
- `prune` and `snapshot create --prune` list, read and delete.
|
||||||
|
|
||||||
On an rclone remote, a backup can also need permission to read and delete. Which
|
On an rclone remote, a backup can also need permission to read and delete. Which
|
||||||
ones depends on the storage service. An upload to a remote that can move objects
|
ones depends on the storage service. On a remote that can move objects, an
|
||||||
looks up the object it replaces and deletes it. It stops when the look-up is
|
upload looks up the object it replaces and deletes that object. The upload stops
|
||||||
refused.
|
when the look-up is refused.
|
||||||
|
|
||||||
These commands list only when you give a remote key, or a snapshot ID that is
|
These commands list only when you give a remote key, or a snapshot ID that is
|
||||||
not in the local index:
|
not in the local index:
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ age_recipients:
|
|||||||
# Named snapshots - each snapshot can contain multiple paths
|
# Named snapshots - each snapshot can contain multiple paths
|
||||||
# Each snapshot gets its own ID and can have snapshot-specific excludes
|
# Each snapshot gets its own ID and can have snapshot-specific excludes
|
||||||
# Required: at least one snapshot, and every snapshot needs at least one path.
|
# Required: at least one snapshot, and every snapshot needs at least one path.
|
||||||
# Only the config commands, version and completion run without a snapshot
|
# Otherwise only the config commands, version and completion run
|
||||||
snapshots:
|
snapshots:
|
||||||
testing:
|
testing:
|
||||||
paths:
|
paths:
|
||||||
|
|||||||
@@ -312,7 +312,8 @@ These commands write unencrypted data to the temporary directory:
|
|||||||
is no limit on their total size.
|
is no limit on their total size.
|
||||||
- `snapshot restore` writes the decrypted database to
|
- `snapshot restore` writes the decrypted database to
|
||||||
`vaultik-restore-*/snapshot.db`.
|
`vaultik-restore-*/snapshot.db`.
|
||||||
- `snapshot files` writes the decrypted database to the same place.
|
- `snapshot files` writes the decrypted database to
|
||||||
|
`vaultik-restore-*/snapshot.db` as well.
|
||||||
- `snapshot verify --deep` writes the decrypted database to
|
- `snapshot verify --deep` writes the decrypted database to
|
||||||
`vaultik-verify-*/snapshot.db`.
|
`vaultik-verify-*/snapshot.db`.
|
||||||
- `snapshot create` writes a copy of the local index to
|
- `snapshot create` writes a copy of the local index to
|
||||||
@@ -342,9 +343,9 @@ it needs no other permission. Other commands need more:
|
|||||||
- `prune` lists, reads and deletes.
|
- `prune` lists, reads and deletes.
|
||||||
|
|
||||||
On an rclone remote, a backup can also need permission to read and delete. Which
|
On an rclone remote, a backup can also need permission to read and delete. Which
|
||||||
ones depends on the storage service. An upload to a remote that can move objects
|
ones depends on the storage service. On a remote that can move objects, an
|
||||||
looks up the object it replaces and deletes it. It stops when the look-up is
|
upload looks up the object it replaces and deletes that object. The upload stops
|
||||||
refused.
|
when the look-up is refused.
|
||||||
|
|
||||||
These commands list only when they are given a remote key, or a snapshot ID that
|
These commands list only when they are given a remote key, or a snapshot ID that
|
||||||
is not in the local index:
|
is not in the local index:
|
||||||
|
|||||||
@@ -37,8 +37,12 @@ func NewRootCommand() *cobra.Command {
|
|||||||
Short: "Secure incremental backup tool with asymmetric encryption",
|
Short: "Secure incremental backup tool with asymmetric encryption",
|
||||||
Long: `vaultik is an incremental backup tool that encrypts data to age public
|
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
|
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
|
an rclone remote. The backed-up machine needs no private key. Only these
|
||||||
'snapshot files', 'snapshot restore' and 'snapshot verify --deep' need one.`,
|
commands need one:
|
||||||
|
|
||||||
|
snapshot files
|
||||||
|
snapshot restore
|
||||||
|
snapshot verify --deep`,
|
||||||
SilenceUsage: true,
|
SilenceUsage: true,
|
||||||
// Bare 'vaultik' (no subcommand): print help. The banner is
|
// Bare 'vaultik' (no subcommand): print help. The banner is
|
||||||
// printed once at process startup by Entry, before cobra
|
// printed once at process startup by Entry, before cobra
|
||||||
|
|||||||
@@ -208,10 +208,10 @@ The snapshot may be named by its ID or, on a host with no local index,
|
|||||||
by the remote key that 'snapshot list' prints for a remote-only snapshot
|
by the remote key that 'snapshot list' prints for a remote-only snapshot
|
||||||
(an unambiguous leading part is enough).
|
(an unambiguous leading part is enough).
|
||||||
|
|
||||||
The file list is only in the snapshot's encrypted database, so this
|
The command reads the file list from the snapshot's encrypted database.
|
||||||
downloads and decrypts it. It requires the age private key, in the
|
It downloads and decrypts that database. It requires the age private
|
||||||
VAULTIK_AGE_SECRET_KEY environment variable or as age_secret_key in the
|
key, in the VAULTIK_AGE_SECRET_KEY environment variable or as
|
||||||
config file; the environment variable wins.
|
age_secret_key in the config file; the environment variable wins.
|
||||||
|
|
||||||
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
|
||||||
|
|||||||
Reference in new issue
Block a user