git-annex/doc/special_remotes/rclone.mdwn
Joey Hess d372553540
rclone special remote
Added rclone special remote, which can be used without needing to install
the git-annex-remote-rclone program. This needs a new version of rclone,
which supports "rclone gitannex".

This is implemented as a variant of an external special remote, that
runs "rclone gitannex" instead of the usual git-annex-remote- command.
Parameterized Remote.External to support that.

Sponsored-by: Luke T. Shumaker on Patreon
2024-04-17 15:20:37 -04:00

37 lines
1.2 KiB
Markdown

[rclone](https://rclone.org/) is a command line program to sync files and
directories to and from a vast variety of cloud provider and protocols. At
the time of writing, this includes the following services:
* Amazon S3 / Dreamhost / Ceph / Minio / Wasabi
* Backblaze B2
* Box
* Dropbox
* FTP
* Google Cloud Storage
* Google Drive
* HTTP
* Hubic
* Jottacloud
* Mega
* Microsoft Azure Blob Storage
* Microsoft OneDrive
* OpenDrive
* Openstack Swift / Rackspace cloud files / Memset Memstore / OVH / Oracle Cloud Storage
* pCloud
* QingStor
* SFTP
* Webdav / Owncloud / Nextcloud
* Yandex Disk
* The local filesystem
That list is regularly expanding.
There are two ways to use rclone as a git-annex special remote.
1. Install [git-annex-remote-rclone](https://github.com/DanielDent/git-annex-remote-rclone).
This will work with any versions of rclone and git-annex.
2. With a recent version of rclone and git-annex, it is not necessary to
install anything else, just use `git-annex initremote type=rclone ...`
For documentation on using rclone that way, see the output of
`rclone gitannex -h` or [here](https://github.com/rclone/rclone/blob/master/cmd/gitannex/gitannex.md).