Nick Craig-WoodVersion v1.55.06e2e2d95 years agoHistory
49319 lines · 1.3 MB · Text
RawDownload
.\"t.\" Automatically generated by Pandoc 2.5.\".TH "rclone" "1" "Mar 31, 2021" "User Manual" "".hy.SH Rclone syncs your files to cloud storage.PP.IP \[bu] 2About rclone.IP \[bu] 2What can rclone do for you?.IP \[bu] 2What features does rclone have?.IP \[bu] 2What providers does rclone support?.IP \[bu] 2Download (https://rclone.org/downloads/).IP \[bu] 2Install (https://rclone.org/install/).IP \[bu] 2Donate. (https://rclone.org/donate/).SS About rclone.PPRclone is a command line program to manage files on cloud storage.It is a feature rich alternative to cloud vendors\[aq] web storageinterfaces.Over 40 cloud storage products support rclone including S3 objectstores, business & consumer file storage services, as well as standardtransfer protocols..PPRclone has powerful cloud equivalents to the unix commands rsync, cp,mv, mount, ls, ncdu, tree, rm, and cat.Rclone\[aq]s familiar syntax includes shell pipeline support, and\f[C]\-\-dry\-run\f[R] protection.It is used at the command line, in scripts or via its API (/rc)..PPUsers call rclone \f[I]\[dq]The Swiss army knife of cloudstorage\[dq]\f[R], and \f[I]\[dq]Technology indistinguishable frommagic\[dq]\f[R]..PPRclone really looks after your data.It preserves timestamps and verifies checksums at all times.Transfers over limited bandwidth; intermittent connections, or subjectto quota can be restarted, from the last good file transferred.You can check (https://rclone.org/commands/rclone_check/) the integrityof your files.Where possible, rclone employs server\-side transfers to minimise localbandwidth use and transfers from one provider to another without usinglocal disk..PPVirtual backends wrap local and cloud file systems to applyencryption (https://rclone.org/crypt/),caching (https://rclone.org/cache/),compression (https://rclone.org/compress/)chunking (https://rclone.org/chunker/) andjoining (https://rclone.org/union/)..PPRclone mounts (https://rclone.org/commands/rclone_mount/) any local,cloud or virtual filesystem as a disk on Windows, macOS, linux andFreeBSD, and also serves these overSFTP (https://rclone.org/commands/rclone_serve_sftp/),HTTP (https://rclone.org/commands/rclone_serve_http/),WebDAV (https://rclone.org/commands/rclone_serve_webdav/),FTP (https://rclone.org/commands/rclone_serve_ftp/) andDLNA (https://rclone.org/commands/rclone_serve_dlna/)..PPRclone is mature, open source software originally inspired by rsync andwritten in Go (https://golang.org).The friendly support community are familiar with varied use cases.Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos.include rclone.For the latest version downloading fromrclone.org (https://rclone.org/downloads/) is recommended..PPRclone is widely used on Linux, Windows and Mac.Third party developers create innovative backup, restore, GUI andbusiness process solutions using the rclone command line or API..PPRclone does the heavy lifting of communicating with cloud storage..SS What can rclone do for you?.PPRclone helps you:.IP \[bu] 2Backup (and encrypt) files to cloud storage.IP \[bu] 2Restore (and decrypt) files from cloud storage.IP \[bu] 2Mirror cloud data to other cloud services or locally.IP \[bu] 2Migrate data to cloud, or between cloud storage vendors.IP \[bu] 2Mount multiple, encrypted, cached or diverse cloud storage as a disk.IP \[bu] 2Analyse and account for data held on cloud storage usinglsf (https://rclone.org/commands/rclone_lsf/),ljson (https://rclone.org/commands/rclone_lsjson/),size (https://rclone.org/commands/rclone_size/),ncdu (https://rclone.org/commands/rclone_ncdu/).IP \[bu] 2Union (https://rclone.org/union/) file systems together to presentmultiple local and/or cloud file systems as one.SS Features.IP \[bu] 2Transfers.RS 2.IP \[bu] 2MD5, SHA1 hashes are checked at all times for file integrity.IP \[bu] 2Timestamps are preserved on files.IP \[bu] 2Operations can be restarted at any time.IP \[bu] 2Can be to and from network, e.g.two different cloud providers.IP \[bu] 2Can use multi\-threaded downloads to local disk.RE.IP \[bu] 2Copy (https://rclone.org/commands/rclone_copy/) new or changed files tocloud storage.IP \[bu] 2Sync (https://rclone.org/commands/rclone_sync/) (one way) to make adirectory identical.IP \[bu] 2Move (https://rclone.org/commands/rclone_move/) files to cloud storagedeleting the local after verification.IP \[bu] 2Check (https://rclone.org/commands/rclone_check/) hashes and formissing/extra files.IP \[bu] 2Mount (https://rclone.org/commands/rclone_mount/) your cloud storage asa network disk.IP \[bu] 2Serve (https://rclone.org/commands/rclone_serve/) local or remote filesoverHTTP (https://rclone.org/commands/rclone_serve_http/)/WebDav (https://rclone.org/commands/rclone_serve_webdav/)/FTP (https://rclone.org/commands/rclone_serve_ftp/)/SFTP (https://rclone.org/commands/rclone_serve_sftp/)/dlna (https://rclone.org/commands/rclone_serve_dlna/).IP \[bu] 2Experimental Web based GUI (https://rclone.org/gui/).SS Supported providers.PP(There are many others, built on standard protocols such as WebDAV orS3, that work out of the box.).IP \[bu] 21Fichier.IP \[bu] 2Alibaba Cloud (Aliyun) Object Storage System (OSS).IP \[bu] 2Amazon Drive.IP \[bu] 2Amazon S3.IP \[bu] 2Backblaze B2.IP \[bu] 2Box.IP \[bu] 2Ceph.IP \[bu] 2Citrix ShareFile.IP \[bu] 2C14.IP \[bu] 2DigitalOcean Spaces.IP \[bu] 2Dreamhost.IP \[bu] 2Dropbox.IP \[bu] 2Enterprise File Fabric.IP \[bu] 2FTP.IP \[bu] 2Google Cloud Storage.IP \[bu] 2Google Drive.IP \[bu] 2Google Photos.IP \[bu] 2HDFS.IP \[bu] 2HTTP.IP \[bu] 2Hubic.IP \[bu] 2Jottacloud.IP \[bu] 2IBM COS S3.IP \[bu] 2Koofr.IP \[bu] 2Mail.ru Cloud.IP \[bu] 2Memset Memstore.IP \[bu] 2Mega.IP \[bu] 2Memory.IP \[bu] 2Microsoft Azure Blob Storage.IP \[bu] 2Microsoft OneDrive.IP \[bu] 2Minio.IP \[bu] 2Nextcloud.IP \[bu] 2OVH.IP \[bu] 2OpenDrive.IP \[bu] 2OpenStack Swift.IP \[bu] 2Oracle Cloud Storage.IP \[bu] 2ownCloud.IP \[bu] 2pCloud.IP \[bu] 2premiumize.me.IP \[bu] 2put.io.IP \[bu] 2QingStor.IP \[bu] 2Rackspace Cloud Files.IP \[bu] 2rsync.net.IP \[bu] 2Scaleway.IP \[bu] 2Seafile.IP \[bu] 2SFTP.IP \[bu] 2StackPath.IP \[bu] 2SugarSync.IP \[bu] 2Tardigrade.IP \[bu] 2Tencent Cloud Object Storage (COS).IP \[bu] 2Wasabi.IP \[bu] 2WebDAV.IP \[bu] 2Yandex Disk.IP \[bu] 2Zoho WorkDrive.IP \[bu] 2The local filesystem.PPLinks.IP \[bu] 2Home page (https://rclone.org/).IP \[bu] 2GitHub project page for source and bugtracker (https://github.com/rclone/rclone).IP \[bu] 2Rclone Forum (https://forum.rclone.org).IP \[bu] 2Downloads (https://rclone.org/downloads/).SH Install.PPRclone is a Go program and comes as a single binary file..SS Quickstart.IP \[bu] 2Download (https://rclone.org/downloads/) the relevant binary..IP \[bu] 2Extract the \f[C]rclone\f[R] or \f[C]rclone.exe\f[R] binary from thearchive.IP \[bu] 2Run \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..PPSee below for some expanded Linux / macOS instructions..PPSee the Usage section (https://rclone.org/docs/#usage) of the docs forhow to use rclone, or run \f[C]rclone \-h\f[R]..PPAlready installed rclone can be easily updated to the latest versionusing the rcloneselfupdate (https://rclone.org/commands/rclone_selfupdate/) command..SS Script installation.PPTo install rclone on Linux/macOS/BSD systems, run:.IP.nf\f[C]curl https://rclone.org/install.sh | sudo bash\f[R].fi.PPFor beta installation, run:.IP.nf\f[C]curl https://rclone.org/install.sh | sudo bash \-s beta\f[R].fi.PPNote that this script checks the version of rclone installed first andwon\[aq]t re\-download if not needed..SS Linux installation from precompiled binary.PPFetch and unpack.IP.nf\f[C]curl \-O https://downloads.rclone.org/rclone\-current\-linux\-amd64.zipunzip rclone\-current\-linux\-amd64.zipcd rclone\-*\-linux\-amd64\f[R].fi.PPCopy binary file.IP.nf\f[C]sudo cp rclone /usr/bin/sudo chown root:root /usr/bin/rclonesudo chmod 755 /usr/bin/rclone\f[R].fi.PPInstall manpage.IP.nf\f[C]sudo mkdir \-p /usr/local/share/man/man1sudo cp rclone.1 /usr/local/share/man/man1/sudo mandb \f[R].fi.PPRun \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..IP.nf\f[C]rclone config\f[R].fi.SS macOS installation with brew.IP.nf\f[C]brew install rclone\f[R].fi.SS macOS installation from precompiled binary, using curl.PPTo avoid problems with macOS gatekeeper enforcing the binary to besigned and notarized it is enough to download with \f[C]curl\f[R]..PPDownload the latest version of rclone..IP.nf\f[C]cd && curl \-O https://downloads.rclone.org/rclone\-current\-osx\-amd64.zip\f[R].fi.PPUnzip the download and cd to the extracted folder..IP.nf\f[C]unzip \-a rclone\-current\-osx\-amd64.zip && cd rclone\-*\-osx\-amd64\f[R].fi.PPMove rclone to your $PATH.You will be prompted for your password..IP.nf\f[C]sudo mkdir \-p /usr/local/binsudo mv rclone /usr/local/bin/\f[R].fi.PP(the \f[C]mkdir\f[R] command is safe to run, even if the directoryalready exists)..PPRemove the leftover files..IP.nf\f[C]cd .. && rm \-rf rclone\-*\-osx\-amd64 rclone\-current\-osx\-amd64.zip\f[R].fi.PPRun \f[C]rclone config\f[R] to setup.See rclone config docs (https://rclone.org/docs/) for more details..IP.nf\f[C]rclone config\f[R].fi.SS macOS installation from precompiled binary, using a web browser.PPWhen downloading a binary with a web browser, the browser will set themacOS gatekeeper quarantine attribute.Starting from Catalina, when attempting to run \f[C]rclone\f[R], apop\-up will appear saying:.IP.nf\f[C]\[lq]rclone\[rq] cannot be opened because the developer cannot be verified.macOS cannot verify that this app is free from malware.\f[R].fi.PPThe simplest fix is to run.IP.nf\f[C]xattr \-d com.apple.quarantine rclone\f[R].fi.SS Install with docker.PPThe rclone maintains a docker image forrclone (https://hub.docker.com/r/rclone/rclone).These images are autobuilt by docker hub from the rclone source based ona minimal Alpine linux image..PPThe \f[C]:latest\f[R] tag will always point to the latest stablerelease.You can use the \f[C]:beta\f[R] tag to get the latest build from master.You can also use version tags, e.g.\f[C]:1.49.1\f[R], \f[C]:1.49\f[R] or \f[C]:1\f[R]..IP.nf\f[C]$ docker pull rclone/rclone:latestlatest: Pulling from rclone/rcloneDigest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11\&...$ docker run \-\-rm rclone/rclone:latest versionrclone v1.49.1\- os/arch: linux/amd64\- go version: go1.12.9\f[R].fi.PPThere are a few command line options to consider when starting an rcloneDocker container from the rclone image..IP \[bu] 2You need to mount the host rclone config dir at \f[C]/config/rclone\f[R]into the Docker container.Due to the fact that rclone updates tokens inside its config file, andthat the update process involves a file rename, you need to mount thewhole host rclone config dir, not just the single host rclone configfile..IP \[bu] 2You need to mount a host data dir at \f[C]/data\f[R] into the Dockercontainer..IP \[bu] 2By default, the rclone binary inside a Docker container runs with UID=0(root).As a result, all files created in a run will have UID=0.If your config and data files reside on the host with a non\-rootUID:GID, you need to pass these on the container start command line..IP \[bu] 2If you want to access the RC interface (either via the API or the WebUI), it is required to set the \f[C]\-\-rc\-addr\f[R] to \f[C]:5572\f[R]in order to connect to it from outside the container.An explanation about why this is necessary is presenthere (https://web.archive.org/web/20200808071950/https://pythonspeed.com/articles/docker-connection-refused/)..RS 2.IP \[bu] 2NOTE: Users running this container with the docker network set to\f[C]host\f[R] should probably set it to listen to localhost only, with\f[C]127.0.0.1:5572\f[R] as the value for \f[C]\-\-rc\-addr\f[R].RE.IP \[bu] 2It is possible to use \f[C]rclone mount\f[R] inside a userspace Dockercontainer, and expose the resulting fuse mount to the host.The exact \f[C]docker run\f[R] options to do that might vary slightlybetween hosts.See, e.g.the discussion in thisthread (https://github.com/moby/moby/issues/9448)..RS 2.PPYou also need to mount the host \f[C]/etc/passwd\f[R] and\f[C]/etc/group\f[R] for fuse to work inside the container..RE.PPHere are some commands tested on an Ubuntu 18.04.3 host:.IP.nf\f[C]# config on host at \[ti]/.config/rclone/rclone.conf# data on host at \[ti]/data # make sure the config is ok by listing the remotesdocker run \-\-rm \[rs]    \-\-volume \[ti]/.config/rclone:/config/rclone \[rs]

Lines 1–500 of 49319.