Docs
rclone
A "Swiss army knife" tool for data transfers
This article provides information about the rclone data transfer tool. In particular:
- what is rclone?
- installing rclone for yourself on JASMIN.
- configuring rclone
- Dos and Don’ts
What is rclone?
rclone is a command-line utility which enables access to lots of different storage systems including object stores and cloud-based storage. It can also move data between directories act as an SFTP client so could be used to access files on JASMIN.
It is very well documented already, so rather than repeat that information here, this article highlights aspects relevant to its use on JASMIN.
Further information will follow in due course as our experience with this tool develops.
Accessing rclone
rclone
is installed on the JASMIN xfer
servers for you, so there should now be
no need to install it for yourself.
which rclone
/usr/bin/rclone
You may also want to consider installing it locally on your own machine
Configuring rclone
Configuring rclone is covered in the rclone documentation. Essentially you need to configure a “remote” representing each storage system you want to interact with. You can then use rclone to manage data between those “remotes”.
Dos and Don’ts
- Please DO NOT use the following features on JASMIN (at least until further notice). Some of these features look useful, but more work is needed to understand if/how they can be used safely on JASMIN without causing problems.
rclone mount
(mounting a remote as a filesystem) - DO NOT USErclone rcd
(remote control daemon) - DO NOT USErclone serve
(serve remote over a protocol) - DO NOT USE
- You should safely be able to use the following, between remotes that you have configured:
rclone copyto
(for single files)rclone copy
(similar torsync
, but does not delete on destination)rclone sync
(similar torsync
, but beware will delete files from destination)rclone lsd
rclone ls
..(other basic commands)
See rclone commands
Help on a particular command is found using
rclone <command> --help
See also using rclone with the JASMIN object store.