diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2018-04-28 12:56:27 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2018-04-28 13:31:30 -0700 |
commit | 48744cc821dba0c7c56fbb2aeb8b668cb73a06d9 (patch) | |
tree | 329758461271432234d6bc1678922b5e372292a5 /README.rst | |
parent | 982eb59bf47cccacc872040e1c4e00ef077cb179 (diff) | |
download | git-remote-gcrypt-48744cc821dba0c7c56fbb2aeb8b668cb73a06d9.tar.gz |
rewrite descriptions of rclone backend in README
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 24 |
1 files changed, 15 insertions, 9 deletions
@@ -15,12 +15,15 @@ git-remote-gcrypt is a git remote helper to push and pull from repositories encrypted with GnuPG, using a custom format. This remote helper handles URIs prefixed with `gcrypt::`. -Supported backends are `local`, `rsync://` and `sftp://` (and an experimental -`rclone://` backend), where the repository is stored as a set of files, or -instead any `<giturl>` where gcrypt will store the same representation in a git -repository, bridged over arbitrary git transport. See "Performance" below for +Supported backends are `local`, `rsync://` and `sftp://`, where the +repository is stored as a set of files, or instead any `<giturl>` +where gcrypt will store the same representation in a git repository, +bridged over arbitrary git transport. See "Performance" below for backends comparison. +There is also an experimental `rclone://` backend for early adoptors +only (you have been warned). + The aim is to provide confidential, authenticated git storage and collaboration using typical untrusted file hosts or services. @@ -149,11 +152,14 @@ rsync URIs whereas plain rsync uses either ``user@host:path`` or ``rsync://user@host/path``. -rclone URIs - The URI format for the rclone backend is the same as rclone URI, - ``rclone://<rclone-uri>``, and require to add the corresponding remote - in the rclone configuration. - Please refer to the rclone documentation for more information. +rclone backend + In addition to adding the rclone backend as a remote with URI like + ``gcrypt::rclone://remote:subdir``, you must add the remote to the + rclone configuration too. This is typically done by executing + ``rclone config``. See rclone(1). + + The rclone backend is considered experimental and is for early + adoptors only. You have been warned. Repository format ................. |