aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.rst
diff options
context:
space:
mode:
authorBeren Minor <beren.minor+git@gmail.com>2018-04-14 19:51:21 +0200
committerSean Whitton <spwhitton@spwhitton.name>2018-04-28 12:46:43 -0700
commit8540e765baf5a6f3b01e69dcbeead9f6a5478094 (patch)
tree9f4570b6d97fa7730dd8e1b5197495ed835e9756 /README.rst
parent8b3d003fada9b61e059e5b1401aebd9ffd866e4d (diff)
downloadgit-remote-gcrypt-8540e765baf5a6f3b01e69dcbeead9f6a5478094.tar.gz
Add support for several cloud storage remotes using rclone
rclone is an open-source command-line too to get and put files to several cloud storage services that aren't supported by rsync. git-remote-gcrypt can now push encrypted repositories to any configured rclone remote using gcrypt::rclone://<rclone-repo>:<folder> URLs. Signed-off-by: Beren Minor <beren.minor+git@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 8bcc429..21cefc4 100644
--- a/README.rst
+++ b/README.rst
@@ -15,10 +15,10 @@ 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://`, 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://` (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
backends comparison.
The aim is to provide confidential, authenticated git storage and
@@ -119,9 +119,9 @@ Collaboration
keys of all collaborators and correct participant config.
Dependencies
- ``rsync`` and ``curl`` for remotes ``rsync:`` and ``sftp:``
- respectively. The main executable requires a POSIX-compliant shell
- that supports ``local``.
+ ``rsync``, ``curl`` and ``rclone`` for remotes ``rsync:``, ``sftp:`` and
+ ``rclone:`` respectively. The main executable requires a POSIX-compliant
+ shell that supports ``local``.
GNU Privacy Guard
Both GPG 1.4 and 2 are supported. You need a personal GPG key. GPG
@@ -149,6 +149,12 @@ 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.
+
Repository format
.................