% rclone(1) User Manual % Nick Craig-Wood % Jul 31, 2026 # NAME rclone - manage files on cloud storage # SYNOPSIS ``` Usage: rclone [flags] rclone [command] Available commands: about Get quota information from the remote. archive Perform an action on an archive. authorize Remote authorization. backend Run a backend-specific command. bisync Perform bidirectional synchronization between two paths. cat Concatenates any files and sends them to stdout. check Checks the files in the source and destination match. checksum Checks the files in the destination against a SUM file. cleanup Clean up the remote if possible. completion Output completion script for a given shell. config Enter an interactive configuration session. convmv Convert file and directory names in place. copy Copy files from source to dest, skipping identical files. copyto Copy files from source to dest, skipping identical files. copyurl Copy the contents of the URL supplied content to dest:path. cryptcheck Cryptcheck checks the integrity of an encrypted remote. cryptdecode Cryptdecode returns unencrypted file names. dedupe Interactively find duplicate filenames and delete/rename them. delete Remove the files in path. deletefile Remove a single file from remote. gendocs Output markdown docs for rclone to the directory supplied. gitannex Speaks with git-annex over stdin/stdout. gui Open the web based GUI. hashsum Produces a hashsum file for all the objects in the path. help Show help for rclone commands, flags and backends. link Generate public link to file/folder. listremotes List all the remotes in the config file and defined in environment variables. ls List the objects in the path with size and path. lsd List all directories/containers/buckets in the path. lsf List directories and objects in remote:path formatted for parsing. lsjson List directories and objects in the path in JSON format. lsl List the objects in path with modification time, size and path. md5sum Produces an md5sum file for all the objects in the path. mkdir Make the path if it doesn't already exist. mount Mount the remote as file system on a mountpoint. move Move files from source to dest. moveto Move file or directory from source to dest. ncdu Explore a remote with a text based user interface. nfsmount Mount the remote as file system on a mountpoint. obscure Obscure password for use in the rclone config file. purge Remove the path and all of its contents. rc Run a command against a running rclone. rcat Copies standard input to file on remote. rcd Run rclone listening to remote control commands only. rmdir Remove the empty directory at path. rmdirs Remove empty directories under the path. selfupdate Update the rclone binary. serve Serve a remote over a protocol. settier Changes storage class/tier of objects in remote. sha1sum Produces an sha1sum file for all the objects in the path. size Prints the total size and number of objects in remote:path. sync Make source and dest identical, modifying destination only. test Run a test command touch Create new file or change file modification time. tree List the contents of the remote in a tree like fashion. version Show the version number. Use "rclone [command] --help" for more information about a command. Use "rclone help flags" for to see the global flags. Use "rclone help backends" for a list of supported services. ``` # Rclone syncs your files to cloud storage rclone logo

- [About rclone](#about) - [What can rclone do for you?](#what) - [What features does rclone have?](#features) - [What providers does rclone support?](#providers) - [Download](https://rclone.org/downloads/) - [Install](https://rclone.org/install/) - [Donate.](https://rclone.org/donate/) ## About rclone {#about} Rclone is a command-line program to manage files on cloud storage. It is a feature-rich alternative to cloud vendors' web storage interfaces. [Over 70 cloud storage products](#providers) support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols. Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax includes shell pipeline support, and `--dry-run` protection. It is used at the command line, in scripts or via its [API](/rc). Users call rclone *"The Swiss army knife of cloud storage"*, and *"Technology indistinguishable from magic"*. Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can [check](https://rclone.org/commands/rclone_check/) the integrity of your files. Where possible, rclone employs server-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk. Virtual backends wrap local and cloud file systems to apply [encryption](https://rclone.org/crypt/), [compression](https://rclone.org/compress/), [chunking](https://rclone.org/chunker/), [hashing](https://rclone.org/hasher/) and [joining](https://rclone.org/union/). Rclone [mounts](https://rclone.org/commands/rclone_mount/) any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over [SFTP](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/) and [DLNA](https://rclone.org/commands/rclone_serve_dlna/). Rclone is mature, open-source software originally inspired by rsync and written in [Go](https://golang.org). The friendly support community is familiar with varied use cases. Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos. include rclone. For the latest version [downloading from rclone.org](https://rclone.org/downloads/) is recommended. Rclone is widely used on Linux, Windows and Mac. Third-party developers create innovative backup, restore, GUI and business process solutions using the rclone command line or API. Rclone does the heavy lifting of communicating with cloud storage. ## What can rclone do for you? {#what} Rclone helps you: - Backup (and encrypt) files to cloud storage - Restore (and decrypt) files from cloud storage - Mirror cloud data to other cloud services or locally - Migrate data to the cloud, or between cloud storage vendors - Mount multiple, encrypted, cached or diverse cloud storage as a disk - Analyse and account for data held on cloud storage using [lsf](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/) - [Union](https://rclone.org/union/) file systems together to present multiple local and/or cloud file systems as one ## Features {#features} - Transfers - MD5, SHA1 hashes are checked at all times for file integrity - Timestamps are preserved on files - Operations can be restarted at any time - Can be to and from network, e.g. two different cloud providers - Can use multi-threaded downloads to local disk - [Copy](https://rclone.org/commands/rclone_copy/) new or changed files to cloud storage - [Sync](https://rclone.org/commands/rclone_sync/) (one way) to make a directory identical - [Bisync](https://rclone.org/bisync/) (two way) to keep two directories in sync bidirectionally - [Move](https://rclone.org/commands/rclone_move/) files to cloud storage deleting the local after verification - [Check](https://rclone.org/commands/rclone_check/) hashes and for missing/extra files - [Mount](https://rclone.org/commands/rclone_mount/) your cloud storage as a network disk - [Serve](https://rclone.org/commands/rclone_serve/) local or remote files over [HTTP](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/) - Experimental [Web based GUI](https://rclone.org/gui/) ## Supported providers {#providers} (There are many others, built on standard protocols such as WebDAV or S3, that work out of the box.) - 1Fichier - Akamai Netstorage - Alibaba Cloud (Aliyun) Object Storage System (OSS) - Amazon S3 - Bizfly Cloud Simple Storage - Backblaze B2 - Box - Ceph - China Mobile Ecloud Elastic Object Storage (EOS) - Arvan Cloud Object Storage (AOS) - Citrix ShareFile - Cloudflare R2 - Cloudinary - Cubbit DS3 - DigitalOcean Spaces - Digi Storage - Dreamhost - Drime - Dropbox - Enterprise File Fabric - Exaba - Fastly Object Storage - Fastmail Files - FileLu Cloud Storage - FileLu S5 (S3-Compatible Object Storage) - Filen - Files.com - FlashBlade - FTP - Gofile - Google Cloud Storage - Google Drive - Google Photos - HDFS - Hetzner Object Storage - Hetzner Storage Box - HiDrive - Hitachi Content Platform (HCP) - HTTP - Huawei Drive - Huawei OBS - iCloud Drive - ImageKit - Internet Archive - Internxt - Jottacloud - IBM COS S3 - IDrive e2 - Impossible Cloud - Intercolo Object Storage - IONOS Cloud - Koofr - Leviia Object Storage - Liara Object Storage - Linkbox - Linode Object Storage - Magalu - Mail.ru Cloud - Memset Memstore - MEGA - MEGA S4 - Memory - Microsoft Azure Blob Storage - Microsoft Azure Files Storage - Microsoft OneDrive - Minio - Nextcloud - Blomp Cloud Storage - OpenDrive - OpenStack Swift - Oracle Cloud Storage Swift - Oracle Object Storage - Outscale - OVHcloud Object Storage (Swift) - OVHcloud Object Storage (S3-compatible) - ownCloud - pCloud - Petabox - PikPak - Pixeldrain - premiumize.me - put.io - Proton Drive - QingStor - Qiniu Cloud Object Storage (Kodo) - Quatrix by Maytech - Rabata Cloud Storage - RackCorp Object Storage - Rackspace Cloud Files - Rclone Serve S3 - rsync.net - Scaleway - Scality (RING / ARTESCA) - Seafile - Seagate Lyve Cloud - SeaweedFS - Selectel - Servercore Object Storage - SFTP - Shade - Sia - SMB / CIFS - Spectra Logic - Storj - Synology - SugarSync - Tencent Cloud Object Storage (COS) - Uloz.to - US3 - Wasabi - WebDAV - Yandex Disk - Zadara Object Storage - Zero Services (ZERO-Z3) - Zoho WorkDrive - Zata - The local filesystem ## Virtual providers These backends adapt or modify other storage providers: - Alias: Rename existing remotes - Archive: Read archive files - Cache: Cache remotes (DEPRECATED) - Chunker: Split large files - Combine: Combine multiple remotes into a directory tree - Compress: Compress files - Crypt: Encrypt files - Hasher: Hash files - Union: Join multiple remotes to work together ## Links - [Home page](https://rclone.org/) - [GitHub project page for source and bug tracker](https://github.com/rclone/rclone) - [Rclone Forum](https://forum.rclone.org) - [Downloads](https://rclone.org/downloads/) # Install Rclone is a Go program and comes as a single binary file. ## Quickstart - [Download](https://rclone.org/downloads/) the relevant binary. - Extract the `rclone` executable, `rclone.exe` on Windows, from the archive. - Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) for more details. - Optionally configure [automatic execution](#autostart). See below for some expanded Linux / macOS / Windows instructions. See the [usage](https://rclone.org/docs/) docs for how to use rclone, or run `rclone -h`. Already installed rclone can be easily updated to the latest version using the [rclone selfupdate](https://rclone.org/commands/rclone_selfupdate/) command. See [the release signing docs](https://rclone.org/release_signing/) for how to verify signatures on the release. ## Script installation To install rclone on Linux/macOS/BSD systems, run: ```console sudo -v ; curl https://rclone.org/install.sh | sudo bash ``` For beta installation, run: ```console sudo -v ; curl https://rclone.org/install.sh | sudo bash -s beta ``` Note that this script checks the version of rclone installed first and won't re-download if not needed. ## Linux installation {#linux} ### Precompiled binary {#linux-precompiled} Fetch and unpack ```console curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip unzip rclone-current-linux-amd64.zip cd rclone-*-linux-amd64 ``` Copy binary file ```console sudo cp rclone /usr/bin/ sudo chown root:root /usr/bin/rclone sudo chmod 755 /usr/bin/rclone ``` Install manpage ```console sudo mkdir -p /usr/local/share/man/man1 sudo cp rclone.1 /usr/local/share/man/man1/ sudo mandb ``` Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) for more details. ```console rclone config ``` ## macOS installation {#macos} ### Installation with brew {#macos-brew} ```console brew install rclone ``` NOTE: This version of rclone will not support `mount` any more (see [#5373](https://github.com/rclone/rclone/issues/5373)). If mounting is wanted on macOS, either install a precompiled binary or enable the relevant option when [installing from source](#source). Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below. [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/rclone.svg)](https://repology.org/project/rclone/versions) ### Installation with MacPorts {#macos-macports} On macOS, rclone can also be installed via [MacPorts](https://www.macports.org): ```console sudo port install rclone ``` Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below. [![MacPorts port](https://repology.org/badge/version-for-repo/macports/rclone.svg)](https://repology.org/project/rclone/versions) More information on [macports.org](https://ports.macports.org/port/rclone/). ### Precompiled binary, using curl {#macos-precompiled} To avoid problems with macOS gatekeeper enforcing the binary to be signed and notarized it is enough to download with `curl`. Download the latest version of rclone. ```console cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip ``` Unzip the download and cd to the extracted folder. ```console unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64 ``` Move rclone to your $PATH. You will be prompted for your password. ```console sudo mkdir -p /usr/local/bin sudo mv rclone /usr/local/bin/ ``` (the `mkdir` command is safe to run, even if the directory already exists). Remove the leftover files. ```console cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip ``` Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) for more details. ```console rclone config ``` ### Precompiled binary, using a web browser {#macos-precompiled-web} When downloading a binary with a web browser, the browser will set the macOS gatekeeper quarantine attribute. Starting from Catalina, when attempting to run `rclone`, a pop-up will appear saying: ```text "rclone" cannot be opened because the developer cannot be verified. macOS cannot verify that this app is free from malware. ``` The simplest fix is to run ```console xattr -d com.apple.quarantine rclone ``` ## Windows installation {#windows} ### Precompiled binary {#windows-precompiled} Fetch the correct binary for your processor type by clicking on these links. If not sure, use the first link. - [Intel/AMD - 64 Bit](https://downloads.rclone.org/rclone-current-windows-amd64.zip) - [Intel/AMD - 32 Bit](https://downloads.rclone.org/rclone-current-windows-386.zip) - [ARM - 64 Bit](https://downloads.rclone.org/rclone-current-windows-arm64.zip) Open this file in the Explorer and extract `rclone.exe`. Rclone is a portable executable so you can place it wherever is convenient. Open a CMD window (or powershell) and run the binary. Note that rclone does not launch a GUI by default, it runs in the CMD Window. - Run `rclone.exe config` to setup. See [rclone config docs](https://rclone.org/docs/) for more details. - Optionally configure [automatic execution](#autostart). If you are planning to use the [rclone mount](https://rclone.org/commands/rclone_mount/) feature then you will need to install the third party utility [WinFsp](https://winfsp.dev/) also. ### Windows package manager (Winget) {#windows-chocolatey} [Winget](https://learn.microsoft.com/en-us/windows/package-manager/) comes pre-installed with the latest versions of Windows. If not, update the [App Installer](https://www.microsoft.com/p/app-installer/9nblggh4nns1) package from the Microsoft store. To install rclone ```bat winget install Rclone.Rclone ``` To uninstall rclone ```bat winget uninstall Rclone.Rclone --force ``` ### Chocolatey package manager {#windows-chocolatey} Make sure you have [Choco](https://chocolatey.org/) installed ```bat choco search rclone choco install rclone ``` This will install rclone on your Windows machine. If you are planning to use [rclone mount](https://rclone.org/commands/rclone_mount/) then ```bat choco install winfsp ``` will install that too. Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below. [![Chocolatey package](https://repology.org/badge/version-for-repo/chocolatey/rclone.svg)](https://repology.org/project/rclone/versions) ### Scoop package manager {#windows-scoop} Make sure you have [Scoop](https://scoop.sh/) installed ```bat scoop install rclone ``` Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below. [![Scoop package](https://repology.org/badge/version-for-repo/scoop/rclone.svg)](https://repology.org/project/rclone/versions) ## Package manager installation {#package-manager} Many Linux, Windows, macOS and other OS distributions package and distribute rclone. The distributed versions of rclone are often quite out of date and for this reason we recommend one of the other installation methods if possible. You can get an idea of how up to date or not your OS distribution's package is here. [![Packaging status](https://repology.org/badge/vertical-allrepos/rclone.svg?columns=3)](https://repology.org/project/rclone/versions) ## Docker installation {#docker} The rclone developers maintain a [docker image for rclone](https://hub.docker.com/r/rclone/rclone). **Note:** We also now offer a paid version of rclone with enterprise-grade security and zero CVEs through our partner [SecureBuild](https://securebuild.com/blog/introducing-securebuild). If you are interested, check out their website and the [Rclone SecureBuild Image](https://securebuild.com/images/rclone). These images are built as part of the release process based on a minimal Alpine Linux. The `:latest` tag will always point to the latest stable release. You can use the `:beta` tag to get the latest build from master. You can also use version tags, e.g. `:1.49.1`, `:1.49` or `:1`. ```console $ docker pull rclone/rclone:latest latest: Pulling from rclone/rclone Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 ... $ docker run --rm rclone/rclone:latest version rclone v1.49.1 - os/arch: linux/amd64 - go version: go1.12.9 ``` There are a few command line options to consider when starting an rclone Docker container from the rclone image. - You need to mount the host rclone config dir at `/config/rclone` into the Docker container. Due to the fact that rclone updates tokens inside its config file, and that the update process involves a file rename, you need to mount the whole host rclone config dir, not just the single host rclone config file. - You need to mount a host data dir at `/data` into the Docker container. - By 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-root UID:GID, you need to pass these on the container start command line. - If you want to access the RC interface (either via the API or the Web UI), it is required to set the `--rc-addr` to `:5572` in order to connect to it from outside the container. An explanation about why this is necessary can be found in an old [pythonspeed.com](https://web.archive.org/web/20200808071950/https://pythonspeed.com/articles/docker-connection-refused/) article. - NOTE: Users running this container with the docker network set to `host` should probably set it to listen to localhost only, with `127.0.0.1:5572` as the value for `--rc-addr` - It is possible to use `rclone mount` inside a userspace Docker container, and expose the resulting fuse mount to the host. The exact `docker run` options to do that might vary slightly between hosts. See, e.g. the discussion in this [thread](https://github.com/moby/moby/issues/9448). You also need to mount the host `/etc/passwd` and `/etc/group` for fuse to work inside the container. Here are some commands tested on an Ubuntu 18.04.3 host: ```sh # config on host at ~/.config/rclone/rclone.conf # data on host at ~/data # add a remote interactively docker run --rm -it \ --volume ~/.config/rclone:/config/rclone \ --user $(id -u):$(id -g) \ rclone/rclone \ config # make sure the config is ok by listing the remotes docker run --rm \ --volume ~/.config/rclone:/config/rclone \ --user $(id -u):$(id -g) \ rclone/rclone \ listremotes # perform mount inside Docker container, expose result to host mkdir -p ~/data/mount docker run --rm \ --volume ~/.config/rclone:/config/rclone \ --volume ~/data:/data:shared \ --user $(id -u):$(id -g) \ --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \ --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \ rclone/rclone \ mount dropbox:Photos /data/mount & ls ~/data/mount kill %1 ``` ## Snap installation {#snap} [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/rclone) Make sure you have [Snapd installed](https://snapcraft.io/docs/installing-snapd) ```console sudo snap install rclone ``` Due to the strict confinement of Snap, rclone snap cannot access real `/home/$USER/.config/rclone` directory, default config path is as below. - Default config directory: - /home/$USER/snap/rclone/current/.config/rclone Note: Due to the strict confinement of Snap, `rclone mount` feature is `not` supported. If mounting is wanted, either install a precompiled binary or enable the relevant option when [installing from source](#source). Note that this is controlled by [community maintainer](https://github.com/boukendesho/rclone-snap) not the rclone developers so it may be out of date. Its current version is as below. [![rclone](https://snapcraft.io/rclone/badge.svg)](https://snapcraft.io/rclone) ## Source installation {#source} Make sure you have git and [Go](https://golang.org/) installed. Go version 1.25 or newer is required, the latest release is recommended. You can get it from your package manager, or download it from [golang.org/dl](https://golang.org/dl/). Then you can run the following: ```console git clone https://github.com/rclone/rclone.git cd rclone go build ``` This will check out the rclone source in subfolder rclone, which you can later modify and send pull requests with. Then it will build the rclone executable in the same folder. As an initial check you can now run `./rclone version` (`.\rclone version` on Windows). Note that on macOS and Windows the [mount](https://rclone.org/commands/rclone_mount/) command will not be available unless you specify an additional build tag `cmount`. ```console go build -tags cmount ``` This assumes you have a GCC compatible C compiler (GCC or Clang) in your PATH, as it uses [cgo](https://pkg.go.dev/cmd/cgo). But on Windows, the [cgofuse](https://github.com/winfsp/cgofuse) library that the cmount implementation is based on, also supports building [without cgo](https://github.com/golang/go/wiki/WindowsDLLs), i.e. by setting environment variable CGO_ENABLED to value 0 (static linking). This is how the official Windows release of rclone is being built, starting with version 1.59. It is still possible to build with cgo on Windows as well, by using the MinGW port of GCC, e.g. by installing it in a [MSYS2](https://www.msys2.org) distribution (make sure you install it in the classic mingw64 subsystem, the ucrt64 version is not compatible). Additionally, to build with mount on Windows, you must install the third party utility [WinFsp](https://winfsp.dev/), with the "Developer" feature selected. If building with cgo, you must also set environment variable CPATH pointing to the fuse include directory within the WinFsp installation (normally `C:\Program Files (x86)\WinFsp\inc\fuse`). You may add arguments `-ldflags -s` to omit symbol table and debug information, making the executable file smaller, and `-trimpath` to remove references to local file system paths. The official rclone releases are built with both of these. ```console go build -trimpath -ldflags -s -tags cmount ``` If you want to customize the version string, as reported by the `rclone version` command, you can set one of the variables `fs.Version`, `fs.VersionTag` (to keep default suffix but customize the number), or `fs.VersionSuffix` (to keep default number but customize the suffix). This can be done from the build command, by adding to the `-ldflags` argument value as shown below. ```console go build -trimpath -ldflags "-s -X github.com/rclone/rclone/fs.Version=v9.9.9-test" -tags cmount ``` On Windows, the official executables also have the version information, as well as a file icon, embedded as binary resources. To get that with your own build you need to run the following command **before** the build command. It generates a Windows resource system object file, with extension .syso, e.g. `resource_windows_amd64.syso`, that will be automatically picked up by future build commands. ```console go run bin/resource_windows.go ``` The above command will generate a resource file containing version information based on the fs.Version variable in source at the time you run the command, which means if the value of this variable changes you need to re-run the command for it to be reflected in the version information. Also, if you override this version variable in the build command as described above, you need to do that also when generating the resource file, or else it will still use the value from the source. ```console go run bin/resource_windows.go -version v9.9.9-test ``` Instead of executing the `go build` command directly, you can run it via the Makefile. The default target changes the version suffix from "-DEV" to "-beta" followed by additional commit details, embeds version information binary resources on Windows, and copies the resulting rclone executable into your GOPATH bin folder (`$(go env GOPATH)/bin`, which corresponds to `~/go/bin/rclone` by default). ```console make ``` To include mount command on macOS and Windows with Makefile build: ```console make GOTAGS=cmount ``` There are other make targets that can be used for more advanced builds, such as cross-compiling for all supported os/architectures, and packaging results into release artifacts. See [Makefile](https://github.com/rclone/rclone/blob/master/Makefile) and [cross-compile.go](https://github.com/rclone/rclone/blob/master/bin/cross-compile.go) for details. Another alternative method for source installation is to download the source, build and install rclone - all in one operation, as a regular Go package. The source will be stored it in the Go module cache, and the resulting executable will be in your GOPATH bin folder (`$(go env GOPATH)/bin`, which corresponds to `~/go/bin/rclone` by default). ```console go install github.com/rclone/rclone@latest ``` In some situations, rclone executable size might be too big for deployment in very restricted environments when all backends with large SDKs are included. To limit binary size unused backends can be commented out in `backends/all/all.go` and unused commands in `cmd/all/all.go` before building with `go build` or `make` ## Ansible installation {#ansible} This can be done with [Stefan Weichinger's ansible role](https://github.com/stefangweichinger/ansible-rclone). Instructions 1. `git clone https://github.com/stefangweichinger/ansible-rclone.git` into your local roles-directory 2. add the role to the hosts you want rclone installed to: ```yaml - hosts: rclone-hosts roles: - rclone ``` ## Portable installation {#portable} As mentioned [above](https://rclone.org/install/#quickstart), rclone is single executable (`rclone`, or `rclone.exe` on Windows) that you can download as a zip archive and extract into a location of your choosing. When executing different commands, it may create files in different locations, such as a configuration file and various temporary files. By default the locations for these are according to your operating system, e.g. configuration file in your user profile directory and temporary files in the standard temporary directory, but you can customize all of them, e.g. to make a completely self-contained, portable installation. Run the [config paths](https://rclone.org/commands/rclone_config_paths/) command to see the locations that rclone will use. To override them set the corresponding options (as command-line arguments, or as [environment variables](https://rclone.org/docs/#environment-variables)): - [--config](https://rclone.org/docs/#config-string) - [--cache-dir](https://rclone.org/docs/#cache-dir-string) - [--temp-dir](https://rclone.org/docs/#temp-dir-string) ## Autostart After installing and configuring rclone, as described above, you are ready to use rclone as an interactive command line utility. If your goal is to perform *periodic* operations, such as a regular [sync](https://rclone.org/commands/rclone_sync/), you will probably want to configure your rclone command in your operating system's scheduler. If you need to expose *service*-like features, such as [remote control](https://rclone.org/rc/), [GUI](https://rclone.org/gui/), [serve](https://rclone.org/commands/rclone_serve/) or [mount](https://rclone.org/commands/rclone_mount/), you will often want an rclone command always running in the background, and configuring it to run in a service infrastructure may be a better option. Below are some alternatives on how to achieve this on different operating systems. NOTE: Before setting up autorun it is highly recommended that you have tested your command manually from a Command Prompt first. ### Autostart on Windows The most relevant alternatives for autostart on Windows are: - Run at user log on using the Startup folder - Run at user log on, at system startup or at schedule using Task Scheduler - Run at system startup using Windows service #### Running in background Rclone is a console application, so if not starting from an existing Command Prompt, e.g. when starting rclone.exe from a shortcut, it will open a Command Prompt window. When configuring rclone to run from task scheduler and windows service you are able to set it to run hidden in background. From rclone version 1.54 you can also make it run hidden from anywhere by adding option `--no-console` (it may still flash briefly when the program starts). Since rclone normally writes information and any error messages to the console, you must redirect this to a file to be able to see it. Rclone has a built-in option `--log-file` for that. Example command to run a sync in background: ```bat c:\rclone\rclone.exe sync c:\files remote:/files --no-console --log-file c:\rclone\logs\sync_files.txt ``` #### User account As mentioned in the [mount](https://rclone.org/commands/rclone_mount/) documentation, mounted drives created as Administrator are not visible to other accounts, not even the account that was elevated as Administrator. By running the mount command as the built-in `SYSTEM` user account, it will create drives accessible for everyone on the system. Both scheduled task and Windows service can be used to achieve this. NOTE: Remember that when rclone runs as the `SYSTEM` user, the user profile that it sees will not be yours. This means that if you normally run rclone with configuration file in the default location, to be able to use the same configuration when running as the system user you must explicitly tell rclone where to find it with the [`--config`](https://rclone.org/docs/#config-string) option, or else it will look in the system users profile path (`C:\Windows\System32\config\systemprofile`). To test your command manually from a Command Prompt, you can run it with the [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec) utility from Microsoft's Sysinternals suite, which takes option `-s` to execute commands as the `SYSTEM` user. #### Start from Startup folder To quickly execute an rclone command you can simply create a standard Windows Explorer shortcut for the complete rclone command you want to run. If you store this shortcut in the special "Startup" start-menu folder, Windows will automatically run it at login. To open this folder in Windows Explorer, enter path `%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup`, or `C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp` if you want the command to start for *every* user that logs in. This is the easiest approach to autostarting of rclone, but it offers no functionality to set it to run as different user, or to set conditions or actions on certain events. Setting up a scheduled task as described below will often give you better results. #### Start from Task Scheduler Task Scheduler is an administrative tool built into Windows, and it can be used to configure rclone to be started automatically in a highly configurable way, e.g. periodically on a schedule, on user log on, or at system startup. It can run be configured to run as the current user, or for a mount command that needs to be available to all users it can run as the `SYSTEM` user. For technical information, see [Task Scheduler for developers](https://docs.microsoft.com/windows/win32/taskschd/task-scheduler-start-page). #### Run as service For running rclone at system startup, you can create a Windows service that executes your rclone command, as an alternative to scheduled task configured to run at startup. ##### Mount command built-in service integration For mount commands, rclone has a built-in Windows service integration via the third-party WinFsp library it uses. Registering as a regular Windows service easy, as you just have to execute the built-in PowerShell command `New-Service` (requires administrative privileges). Example of a PowerShell command that creates a Windows service for mounting some `remote:/files` as drive letter `X:`, for *all* users (service will be running as the local system account): ```powershell New-Service -Name Rclone -BinaryPathName 'c:\rclone\rclone.exe mount remote:/files X: --config c:\rclone\config\rclone.conf --log-file c:\rclone\logs\mount.txt' ``` The [WinFsp service infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture) supports incorporating services for file system implementations, such as rclone, into its own launcher service, as kind of "child services". This has the additional advantage that it also implements a network provider that integrates into Windows standard methods for managing network drives. This is currently not officially supported by Rclone, but with WinFsp version 2019.3 B2 / v1.5B2 or later it should be possible through path rewriting as described in [#3340](https://github.com/rclone/rclone/issues/3340). ##### Third-party service integration To Windows service running any rclone command, the excellent third-party utility [NSSM](http://nssm.cc), the "Non-Sucking Service Manager", can be used. It includes some advanced features such as adjusting process priority, defining process environment variables, redirect to file anything written to stdout, and customized response to different exit codes, with a GUI to configure everything from (although it can also be used from command line ). There are also several other alternatives. To mention one more, [WinSW](https://github.com/winsw/winsw), "Windows Service Wrapper", is worth checking out. It requires .NET Framework, but it is preinstalled on newer versions of Windows, and it also provides alternative standalone distributions which includes necessary runtime (.NET 5). WinSW is a command-line only utility, where you have to manually create an XML file with service configuration. This may be a drawback for some, but it can also be an advantage as it is easy to back up and reuse the configuration settings, without having go through manual steps in a GUI. One thing to note is that by default it does not restart the service on error, one have to explicit enable this in the configuration file (via the "onfailure" parameter). ### Autostart on Linux #### Start as a service To always run rclone in background, relevant for mount commands etc, you can use systemd to set up rclone as a system or user service. Running as a system service ensures that it is run at startup even if the user it is running as has no active session. Running rclone as a user service ensures that it only starts after the configured user has logged into the system. #### Run periodically from cron To run a periodic command, such as a copy/sync, you can set up a cron job. # Usage Rclone is a command line program to manage files on cloud storage. After [download](https://rclone.org/downloads/) and [install](/install), continue here to learn how to use it: Initial [configuration](#configure), what the [basic syntax](#basic-syntax) looks like, describes the various [subcommands](#subcommands), the various [options](#options), and more. ## Configure First, you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. (See the [`--config`](#config-string) entry for how to find the config file and choose its location.) The easiest way to make the config is to run rclone with the config option: ```console rclone config ``` See the following for detailed instructions for - [1Fichier](https://rclone.org/fichier/) - [Akamai Netstorage](https://rclone.org/netstorage/) - [Alias](https://rclone.org/alias/) - [Archive](https://rclone.org/archive/) - [Amazon S3](https://rclone.org/s3/) - [Backblaze B2](https://rclone.org/b2/) - [Box](https://rclone.org/box/) - [Chunker](https://rclone.org/chunker/) - transparently splits large files for other remotes - [Citrix ShareFile](https://rclone.org/sharefile/) - [Compress](https://rclone.org/compress/) - [Cloudinary](https://rclone.org/cloudinary/) - [Combine](https://rclone.org/combine/) - [Crypt](https://rclone.org/crypt/) - to encrypt other remotes - [DigitalOcean Spaces](https://rclone.org/s3/#digitalocean-spaces) - [Digi Storage](https://rclone.org/koofr/#digi-storage) - [Drime](https://rclone.org/drime/) - [Dropbox](https://rclone.org/dropbox/) - [Enterprise File Fabric](https://rclone.org/filefabric/) - [FileLu Cloud Storage](https://rclone.org/filelu/) - [Filen](https://rclone.org/filen/) - [Files.com](https://rclone.org/filescom/) - [FTP](https://rclone.org/ftp/) - [Gofile](https://rclone.org/gofile/) - [Google Cloud Storage](https://rclone.org/googlecloudstorage/) - [Google Drive](https://rclone.org/drive/) - [Google Photos](https://rclone.org/googlephotos/) - [Hasher](https://rclone.org/hasher/) - to handle checksums for other remotes - [HDFS](https://rclone.org/hdfs/) - [Hetzner Storage Box](https://rclone.org/sftp/#hetzner-storage-box) - [HiDrive](https://rclone.org/hidrive/) - [HTTP](https://rclone.org/http/) - [Huawei Drive](https://rclone.org/huaweidrive/) - [iCloud Drive](https://rclone.org/iclouddrive/) - [Internet Archive](https://rclone.org/internetarchive/) - [Internxt](https://rclone.org/internxt/) - [Jottacloud](https://rclone.org/jottacloud/) - [Koofr](https://rclone.org/koofr/) - [Linkbox](https://rclone.org/linkbox/) - [Mail.ru Cloud](https://rclone.org/mailru/) - [Mega](https://rclone.org/mega/) - [Memory](https://rclone.org/memory/) - [Microsoft Azure Blob Storage](https://rclone.org/azureblob/) - [Microsoft Azure Files Storage](https://rclone.org/azurefiles/) - [Microsoft OneDrive](https://rclone.org/onedrive/) - [OpenStack Swift / Rackspace Cloudfiles / Blomp Cloud Storage / Memset Memstore](https://rclone.org/swift/) - [OpenDrive](https://rclone.org/opendrive/) - [Oracle Object Storage](https://rclone.org/oracleobjectstorage/) - [Pcloud](https://rclone.org/pcloud/) - [PikPak](https://rclone.org/pikpak/) - [Pixeldrain](https://rclone.org/pixeldrain/) - [premiumize.me](https://rclone.org/premiumizeme/) - [put.io](https://rclone.org/putio/) - [Proton Drive](https://rclone.org/protondrive/) - [QingStor](https://rclone.org/qingstor/) - [Quatrix by Maytech](https://rclone.org/quatrix/) - [rsync.net](https://rclone.org/sftp/#rsync-net) - [Seafile](https://rclone.org/seafile/) - [SFTP](https://rclone.org/sftp/) - [Shade](https://rclone.org/shade/) - [Sia](https://rclone.org/sia/) - [SMB](https://rclone.org/smb/) - [Storj](https://rclone.org/storj/) - [SugarSync](https://rclone.org/sugarsync/) - [Union](https://rclone.org/union/) - [Uloz.to](https://rclone.org/ulozto/) - [WebDAV](https://rclone.org/webdav/) - [Yandex Disk](https://rclone.org/yandex/) - [Zoho WorkDrive](https://rclone.org/zoho/) - [The local filesystem](https://rclone.org/local/) ## Basic syntax Rclone syncs a directory tree from one storage system to another. Its syntax is like this ```console rclone subcommand [options] ``` A `subcommand` is an rclone operation required (e.g. `sync`, `copy`, `ls`). An `option` is a single letter flag (e.g. `-v`) or a group of single letter flags (e.g. `-Pv`) or a long flag (e.g. `--progress`). No options are required. Options can come after the `subcommand` or in between parameters too or on the end, but only global options can be used before the `subcommand`. Anything after a `--` option will not be interpreted as an option so if you need to add a parameter which starts with a `-` then put a `--` on its own first, eg ```console rclone lsf -- -directory-starting-with-dash ``` A `parameter` is usually a file path or [rclone remote](#syntax-of-remote-paths), eg `/path/to/file` or `remote:path/to/file` but it can be other things - the `subcommand` help will tell you what. Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, e.g. "drive:myfolder" to look at "myfolder" in Google drive. You can define as many storage paths as you like in the config file. Please use the [`--interactive`/`-i`](#interactive) flag while learning rclone to avoid accidental data loss. ## Subcommands rclone uses a system of subcommands. For example ```console rclone ls remote:path # lists a remote rclone copy /local/path remote:path # copies /local/path to the remote rclone sync --interactive /local/path remote:path # syncs /local/path to the remote ``` # rclone config Enter an interactive configuration session. ## Synopsis Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration. ``` rclone config [flags] ``` ## Options ``` -h, --help help for config ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone config create](https://rclone.org/commands/rclone_config_create/) - Create a new remote with name, type and options. * [rclone config delete](https://rclone.org/commands/rclone_config_delete/) - Delete an existing remote. * [rclone config disconnect](https://rclone.org/commands/rclone_config_disconnect/) - Disconnects user from remote * [rclone config dump](https://rclone.org/commands/rclone_config_dump/) - Dump the config file as JSON. * [rclone config edit](https://rclone.org/commands/rclone_config_edit/) - Enter an interactive configuration session. * [rclone config encryption](https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file * [rclone config file](https://rclone.org/commands/rclone_config_file/) - Show path of configuration file in use. * [rclone config password](https://rclone.org/commands/rclone_config_password/) - Update password in an existing remote. * [rclone config paths](https://rclone.org/commands/rclone_config_paths/) - Show paths used for configuration, cache, temp etc. * [rclone config providers](https://rclone.org/commands/rclone_config_providers/) - List in JSON format all the providers and options. * [rclone config reconnect](https://rclone.org/commands/rclone_config_reconnect/) - Re-authenticates user with remote. * [rclone config redacted](https://rclone.org/commands/rclone_config_redacted/) - Print redacted (decrypted) config file, or the redacted config for a single remote. * [rclone config show](https://rclone.org/commands/rclone_config_show/) - Print (decrypted) config file, or the config for a single remote. * [rclone config string](https://rclone.org/commands/rclone_config_string/) - Print connection string for a single remote. * [rclone config touch](https://rclone.org/commands/rclone_config_touch/) - Ensure configuration file exists. * [rclone config unset](https://rclone.org/commands/rclone_config_unset/) - Unset options in an existing remote. * [rclone config update](https://rclone.org/commands/rclone_config_update/) - Update options in an existing remote. * [rclone config userinfo](https://rclone.org/commands/rclone_config_userinfo/) - Prints info about logged in user of remote. # rclone copy Copy files from source to dest, skipping identical files. ## Synopsis Copy the source to the destination. Does not transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Doesn't delete files from the destination. If you want to also delete files from destination, to make it match source, use the [sync](https://rclone.org/commands/rclone_sync/) command instead. Note that it is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. To copy single files, use the [copyto](https://rclone.org/commands/rclone_copyto/) command instead. If dest:path doesn't exist, it is created and the source:path contents go there. For example ```sh rclone copy source:sourcepath dest:destpath ``` Let's say there are two files in sourcepath ```text sourcepath/one.txt sourcepath/two.txt ``` This copies them to ```text destpath/one.txt destpath/two.txt ``` Not to ```text destpath/sourcepath/one.txt destpath/sourcepath/two.txt ``` If you are familiar with `rsync`, rclone always works as if you had written a trailing `/` - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination. See the [--no-traverse](https://rclone.org/docs/#no-traverse) option for controlling whether rclone lists the destination directory or not. Supplying this option when copying a small number of files into a large destination can speed transfers up greatly. For example, if you have many files in /path/to/src but only a few of them change every day, you can copy all the files which have changed recently very efficiently like this: ```sh rclone copy --max-age 24h --no-traverse /path/to/src remote: ``` Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the `--metadata` flag. Note that the modification time and metadata for the root directory will **not** be synced. See [issue #7652](https://github.com/rclone/rclone/issues/7652) for more info. **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics. **Note**: Use the `--dry-run` or the `--interactive`/`-i` flag to test without copying anything. ## Logger Flags The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The `--dest-after` flag writes a list file using the same format flags as [`lsf`](https://rclone.org/commands/rclone_lsf/#synopsis) (including [customizable options for hash, modtime, etc.](https://rclone.org/commands/rclone_lsf/#synopsis)) Conceptually it is similar to rsync's `--itemize-changes`, but not identical -- it should output an accurate list of what will be on the destination after the command is finished. When the `--no-traverse` flag is set, all logs involving files that exist only on the destination will be incomplete or completely missing. Note that these logger flags have a few limitations, and certain scenarios are not currently supported: - `--max-duration` / `CutoffModeHard` - `--compare-dest` / `--copy-dest` - server-side moves of an entire dir at once - High-level retries, because there would be duplicates (use `--retries 1` to disable) - Possibly some unusual error scenarios Note also that each file is logged during execution, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID). ``` rclone copy source:path dest:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --combined string Make a combined report of changes to this file --create-empty-src-dirs Create empty source dirs on destination after copy --csv Output in CSV format --dest-after string Report all files that exist on the dest post-sync --differ string Report all non-matching files to this file -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --error string Report all files with errors (hashing or reading) to this file --files-only Only list files (default true) -F, --format string Output format - see lsf help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for copy --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file -s, --separator string Separator for the items in the format (default ";") -t, --timeformat string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone sync Make source and dest identical, modifying destination only. ## Synopsis Sync the source to the destination, changing the destination only. Doesn't transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files if necessary (except duplicate objects, see below). If you don't want to delete files from destination, use the [copy](https://rclone.org/commands/rclone_copy/) command instead. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`i` flag. ```sh rclone sync --interactive SOURCE remote:DESTINATION ``` Files in the destination won't be deleted if there were any errors at any point. Duplicate objects (files with the same name, on those providers that support it) are not yet handled. Files that are excluded won't be deleted unless `--delete-excluded` is used. Symlinks won't be transferred or deleted from local file systems unless `--links` is used. It is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See extended explanation in the [copy](https://rclone.org/commands/rclone_copy/) command if unsure. If dest:path doesn't exist, it is created and the source:path contents go there. It is not possible to sync overlapping remotes. However, you may exclude the destination from the sync with a filter rule or by putting an exclude-if-present file inside the destination directory and sync to a destination that is inside the source directory. Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the `--metadata` flag. Note that the modification time and metadata for the root directory will **not** be synced. See for more info. **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics **Note**: Use the `rclone dedupe` command to deal with "Duplicate object/directory found in source/destination - ignoring" errors. See [this forum post](https://forum.rclone.org/t/sync-not-clearing-duplicates/14372) for more info. ## Logger Flags The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The `--dest-after` flag writes a list file using the same format flags as [`lsf`](https://rclone.org/commands/rclone_lsf/#synopsis) (including [customizable options for hash, modtime, etc.](https://rclone.org/commands/rclone_lsf/#synopsis)) Conceptually it is similar to rsync's `--itemize-changes`, but not identical -- it should output an accurate list of what will be on the destination after the command is finished. When the `--no-traverse` flag is set, all logs involving files that exist only on the destination will be incomplete or completely missing. Note that these logger flags have a few limitations, and certain scenarios are not currently supported: - `--max-duration` / `CutoffModeHard` - `--compare-dest` / `--copy-dest` - server-side moves of an entire dir at once - High-level retries, because there would be duplicates (use `--retries 1` to disable) - Possibly some unusual error scenarios Note also that each file is logged during execution, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID). ``` rclone sync source:path dest:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --combined string Make a combined report of changes to this file --create-empty-src-dirs Create empty source dirs on destination after sync --csv Output in CSV format --dest-after string Report all files that exist on the dest post-sync --differ string Report all non-matching files to this file -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --error string Report all files with errors (hashing or reading) to this file --files-only Only list files (default true) -F, --format string Output format - see lsf help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for sync --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file -s, --separator string Separator for the items in the format (default ";") -t, --timeformat string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Sync Options Flags used for sync commands ```text --backup-dir string Make backups into hierarchy based in DIR --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring --delete-during When synchronizing, delete files during transfer --fix-case Force rename of case insensitive dest to match source --ignore-errors Delete even if there are I/O errors --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000) --max-delete int When synchronizing, limit the number of deletes (default -1) --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off) --suffix string Suffix to add to changed files --suffix-keep-extension Preserve the extension when using --suffix --track-renames When synchronizing, track file renames and do a server-side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone move Move files from source to dest. ## Synopsis Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server-side directory move operation. To move single files, use the [moveto](https://rclone.org/commands/rclone_moveto/) command instead. If no filters are in use and if possible this will server-side move `source:path` into `dest:path`. After this `source:path` will no longer exist. Otherwise for each file in `source:path` selected by the filters (if any) this will move it into `dest:path`. If possible a server-side move will be used, otherwise it will copy it (server-side if possible) into `dest:path` then delete the original (if no errors on copy) in `source:path`. If you want to delete empty source directories after move, use the `--delete-empty-src-dirs` flag. See the [--no-traverse](https://rclone.org/docs/#no-traverse) option for controlling whether rclone lists the destination directory or not. Supplying this option when moving a small number of files into a large destination can speed transfers up greatly. Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the `--metadata` flag. Note that the modification time and metadata for the root directory will **not** be synced. See for more info. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics. ## Logger Flags The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The `--dest-after` flag writes a list file using the same format flags as [`lsf`](https://rclone.org/commands/rclone_lsf/#synopsis) (including [customizable options for hash, modtime, etc.](https://rclone.org/commands/rclone_lsf/#synopsis)) Conceptually it is similar to rsync's `--itemize-changes`, but not identical -- it should output an accurate list of what will be on the destination after the command is finished. When the `--no-traverse` flag is set, all logs involving files that exist only on the destination will be incomplete or completely missing. Note that these logger flags have a few limitations, and certain scenarios are not currently supported: - `--max-duration` / `CutoffModeHard` - `--compare-dest` / `--copy-dest` - server-side moves of an entire dir at once - High-level retries, because there would be duplicates (use `--retries 1` to disable) - Possibly some unusual error scenarios Note also that each file is logged during execution, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID). ``` rclone move source:path dest:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --combined string Make a combined report of changes to this file --create-empty-src-dirs Create empty source dirs on destination after move --csv Output in CSV format --delete-empty-src-dirs Delete empty source dirs after move --dest-after string Report all files that exist on the dest post-sync --differ string Report all non-matching files to this file -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --error string Report all files with errors (hashing or reading) to this file --files-only Only list files (default true) -F, --format string Output format - see lsf help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for move --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file -s, --separator string Separator for the items in the format (default ";") -t, --timeformat string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone delete Remove the files in path. ## Synopsis Remove the files in path. Unlike [purge](https://rclone.org/commands/rclone_purge/) it obeys include/exclude filters so can be used to selectively delete files. `rclone delete` only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use the [purge](https://rclone.org/commands/rclone_purge/) command. If you supply the `--rmdirs` flag, it will remove all empty directories along with it. You can also use the separate command [rmdir](https://rclone.org/commands/rclone_rmdir/) or [rmdirs](https://rclone.org/commands/rclone_rmdirs/) to delete empty directories only. For example, to delete all files bigger than 100 MiB, you may first want to check what would be deleted (use either): ```sh rclone --min-size 100M lsl remote:path rclone --dry-run --min-size 100M delete remote:path ``` Then proceed with the actual delete: ```sh rclone --min-size 100M delete remote:path ``` That reads "delete everything with a minimum size of 100 MiB", hence delete all files bigger than 100 MiB. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. ``` rclone delete remote:path [flags] ``` ## Options ``` -h, --help help for delete --rmdirs rmdirs removes empty directories but leaves root intact ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone purge Remove the path and all of its contents. ## Synopsis Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use the [delete](https://rclone.org/commands/rclone_delete/) command if you want to selectively delete files. To delete empty directories only, use command [rmdir](https://rclone.org/commands/rclone_rmdir/) or [rmdirs](https://rclone.org/commands/rclone_rmdirs/). The concurrency of this operation is controlled by the `--checkers` global flag. However, some backends will implement this command directly, in which case `--checkers` will be ignored. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. ``` rclone purge remote:path [flags] ``` ## Options ``` -h, --help help for purge ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone mkdir Make the path if it doesn't already exist. ``` rclone mkdir remote:path [flags] ``` ## Options ``` -h, --help help for mkdir ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone rmdir Remove the empty directory at path. ## Synopsis This removes empty directory given by path. Will not remove the path if it has any objects in it, not even empty subdirectories. Use command [rmdirs](https://rclone.org/commands/rclone_rmdirs/) (or [delete](https://rclone.org/commands/rclone_delete/) with option `--rmdirs`) to do that. To delete a path and any objects in it, use [purge](https://rclone.org/commands/rclone_purge/) command. ``` rclone rmdir remote:path [flags] ``` ## Options ``` -h, --help help for rmdir ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone check Checks the files in the source and destination match. ## Synopsis Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files that don't match. It doesn't alter the source or destination. For the [crypt](https://rclone.org/crypt/) remote there is a dedicated command, [cryptcheck](https://rclone.org/commands/rclone_cryptcheck/), that are able to check the checksums of the encrypted files. If you supply the `--size-only` flag, it will only compare the sizes not the hashes as well. Use this for a quick check. If you supply the `--download` flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data. If you supply the `--checkfile HASH` flag with a valid hash name, the `source:path` must point to a text file in the SUM format. If you supply the `--one-way` flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The default number of parallel checks is 8. See the [--checkers](https://rclone.org/docs/#checkers-int) option for more information. ``` rclone check source:path dest:path [flags] ``` ## Options ``` -C, --checkfile string Treat source:path as a SUM file with hashes of given type --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file --download Check by downloading rather than with hash --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file --one-way Check one way only, source files must exist on remote ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Check Options Flags used for check commands ```text --max-backlog int Maximum number of objects in sync or check backlog (default 10000) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone ls List the objects in the path with size and path. ## Synopsis Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default. E.g. ```console $ rclone ls swift:bucket 60295 bevajer5jef 90613 canole 94467 diwogej7 37600 fubuwic ``` Any of the filtering options can be applied to this command. There are several related list commands - `ls` to list size and path of objects only - `lsl` to list modification time, size and path of objects only - `lsd` to list directories only - `lsf` to list objects and directories in easy to parse format - `lsjson` to list objects and directories in JSON format `ls`,`lsl`,`lsd` are designed to be human-readable. `lsf` is designed to be human and machine-readable. `lsjson` is designed to be machine-readable. Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. List commands prefer a recursive method that uses more memory but fewer transactions by default. Use `--disable ListR` to suppress the behavior. See [`--fast-list`](https://rclone.org/docs/#fast-list) for more details. Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). ``` rclone ls remote:path [flags] ``` ## Options ``` -h, --help help for ls ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone lsd List all directories/containers/buckets in the path. ## Synopsis Lists the directories in the source path to standard output. Does not recurse by default. Use the `-R` flag to recurse. This command lists the total size of the directory (if known, -1 if not), the modification time (if known, the current time if not), the number of objects in the directory (if known, -1 if not) and the name of the directory, E.g. ```console $ rclone lsd swift: 494000 2018-04-26 08:43:20 10000 10000files 65 2018-04-26 08:43:20 1 1File ``` Or ```console $ rclone lsd drive:test -1 2016-10-17 17:41:53 -1 1000files -1 2017-01-03 14:40:54 -1 2500files -1 2017-07-08 14:39:28 -1 4000files ``` If you just want the directory names use `rclone lsf --dirs-only`. Any of the filtering options can be applied to this command. There are several related list commands - `ls` to list size and path of objects only - `lsl` to list modification time, size and path of objects only - `lsd` to list directories only - `lsf` to list objects and directories in easy to parse format - `lsjson` to list objects and directories in JSON format `ls`,`lsl`,`lsd` are designed to be human-readable. `lsf` is designed to be human and machine-readable. `lsjson` is designed to be machine-readable. Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. List commands prefer a recursive method that uses more memory but fewer transactions by default. Use `--disable ListR` to suppress the behavior. See [`--fast-list`](https://rclone.org/docs/#fast-list) for more details. Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). ``` rclone lsd remote:path [flags] ``` ## Options ``` -h, --help help for lsd -R, --recursive Recurse into the listing ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone lsl List the objects in path with modification time, size and path. ## Synopsis Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default. E.g. ```console $ rclone lsl swift:bucket 60295 2016-06-25 18:55:41.062626927 bevajer5jef 90613 2016-06-25 18:55:43.302607074 canole 94467 2016-06-25 18:55:43.046609333 diwogej7 37600 2016-06-25 18:55:40.814629136 fubuwic ``` Any of the filtering options can be applied to this command. There are several related list commands - `ls` to list size and path of objects only - `lsl` to list modification time, size and path of objects only - `lsd` to list directories only - `lsf` to list objects and directories in easy to parse format - `lsjson` to list objects and directories in JSON format `ls`,`lsl`,`lsd` are designed to be human-readable. `lsf` is designed to be human and machine-readable. `lsjson` is designed to be machine-readable. Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. List commands prefer a recursive method that uses more memory but fewer transactions by default. Use `--disable ListR` to suppress the behavior. See [`--fast-list`](https://rclone.org/docs/#fast-list) for more details. Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). ``` rclone lsl remote:path [flags] ``` ## Options ``` -h, --help help for lsl ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone md5sum Produces an md5sum file for all the objects in the path. ## Synopsis Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. By default, the hash is requested from the remote. If MD5 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling MD5 for any remote. For other algorithms, see the [hashsum](https://rclone.org/commands/rclone_hashsum/) command. Running `rclone md5sum remote:path` is equivalent to running `rclone hashsum MD5 remote:path`. This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path). ``` rclone md5sum remote:path [flags] ``` ## Options ``` --base64 Output base64 encoded hashsum -C, --checkfile string Validate hashes against a given SUM file instead of printing them --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote -h, --help help for md5sum --output-file string Output hashsums to a file rather than the terminal ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone sha1sum Produces an sha1sum file for all the objects in the path. ## Synopsis Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. By default, the hash is requested from the remote. If SHA-1 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling SHA-1 for any remote. For other algorithms, see the [hashsum](https://rclone.org/commands/rclone_hashsum/) command. Running `rclone sha1sum remote:path` is equivalent to running `rclone hashsum SHA1 remote:path`. This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path). This command can also hash data received on STDIN, if not passing a remote:path. ``` rclone sha1sum remote:path [flags] ``` ## Options ``` --base64 Output base64 encoded hashsum -C, --checkfile string Validate hashes against a given SUM file instead of printing them --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote -h, --help help for sha1sum --output-file string Output hashsums to a file rather than the terminal ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone size Prints the total size and number of objects in remote:path. ## Synopsis Counts objects in the path and calculates the total size. Prints the result to standard output. By default the output is in human-readable format, but shows values in both human-readable format as well as the raw numbers (global option `--human-readable` is not considered). Use option `--json` to format output as JSON instead. Recurses by default, use `--max-depth 1` to stop the recursion. Some backends do not always provide file sizes, see for example [Google Photos](https://rclone.org/googlephotos/#size) and [Google Docs](https://rclone.org/drive/#limitations-of-google-docs). Rclone will then show a notice in the log indicating how many such files were encountered, and count them in as empty files in the output of the size command. ``` rclone size remote:path [flags] ``` ## Options ``` -h, --help help for size --json Format output as JSON ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone version Show the version number. ## Synopsis Show the rclone version number, the go version, the build target OS and architecture, the runtime OS and kernel version and bitness, build tags and the type of executable (static or dynamic). For example: ```console $ rclone version rclone v1.55.0 - os/version: ubuntu 18.04 (64 bit) - os/kernel: 4.15.0-136-generic (x86_64) - os/type: linux - os/arch: amd64 - go/version: go1.16 - go/linking: static - go/tags: none ``` Note: before rclone version 1.55 the os/type and os/arch lines were merged, and the "go/version" line was tagged as "go version". If you supply the --check flag, then it will do an online check to compare your version with the latest release and the latest beta. ```console $ rclone version --check yours: 1.42.0.6 latest: 1.42 (released 2018-06-16) beta: 1.42.0.5 (released 2018-06-17) ``` Or ```console $ rclone version --check yours: 1.41 latest: 1.42 (released 2018-06-16) upgrade: https://downloads.rclone.org/v1.42 beta: 1.42.0.5 (released 2018-06-17) upgrade: https://beta.rclone.org/v1.42-005-g56e1e820 ``` If you supply the --deps flag then rclone will print a list of all the packages it depends on and their versions along with some other information about the build. ``` rclone version [flags] ``` ## Options ``` --check Check for new version --deps Show the Go dependencies -h, --help help for version ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone cleanup Clean up the remote if possible. ## Synopsis Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes. ``` rclone cleanup remote:path [flags] ``` ## Options ``` -h, --help help for cleanup ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone dedupe Interactively find duplicate filenames and delete/rename them. ## Synopsis By default `dedupe` interactively finds files with duplicate names and offers to delete all but one or rename them to be different. This is known as deduping by name. Deduping by name is only useful with a small group of backends (e.g. Google Drive, Opendrive) that can have duplicate file names. It can be run on wrapping backends (e.g. crypt) if they wrap a backend which supports duplicate file names. However if `--by-hash` is passed in then dedupe will find files with duplicate hashes instead which will work on any backend which supports at least one hash. This can be used to find files with duplicate content. This is known as deduping by hash. If deduping by name, first rclone will merge directories with the same name. It will do this iteratively until all the identically named directories have been merged. Next, if deduping by name, for every group of duplicate file names / hashes, it will delete all but one identical file it finds without confirmation. This means that for most duplicated files the `dedupe` command will not be interactive. `dedupe` considers files to be identical if they have the same file path and the same hash. If the backend does not support hashes (e.g. crypt wrapping Google Drive) then they will never be found to be identical. If you use the `--size-only` flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes. Next rclone will resolve the remaining duplicates. Exactly which action is taken depends on the dedupe mode. By default, rclone will interactively query the user for each one. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. Here is an example run. Before - with duplicates ```console $ rclone lsl drive:dupes 6048320 2016-03-05 16:23:16.798000000 one.txt 6048320 2016-03-05 16:23:11.775000000 one.txt 564374 2016-03-05 16:23:06.731000000 one.txt 6048320 2016-03-05 16:18:26.092000000 one.txt 6048320 2016-03-05 16:22:46.185000000 two.txt 1744073 2016-03-05 16:22:38.104000000 two.txt 564374 2016-03-05 16:22:52.118000000 two.txt ``` Now the `dedupe` session ```console $ rclone dedupe drive:dupes 2016/03/05 16:24:37 Google drive root 'dupes': Looking for duplicates using interactive mode. one.txt: Found 4 files with duplicate names one.txt: Deleting 2/3 identical duplicates (MD5 "1eedaa9fe86fd4b8632e2ac549403b36") one.txt: 2 duplicates remain 1: 6048320 bytes, 2016-03-05 16:23:16.798000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 2: 564374 bytes, 2016-03-05 16:23:06.731000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 s) Skip and do nothing k) Keep just one (choose which in next step) r) Rename all to be different (by changing file.jpg to file-1.jpg) s/k/r> k Enter the number of the file to keep> 1 one.txt: Deleted 1 extra copies two.txt: Found 3 files with duplicate names two.txt: 3 duplicates remain 1: 564374 bytes, 2016-03-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 2: 6048320 bytes, 2016-03-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 3: 1744073 bytes, 2016-03-05 16:22:38.104000000, MD5 851957f7fb6f0bc4ce76be966d336802 s) Skip and do nothing k) Keep just one (choose which in next step) r) Rename all to be different (by changing file.jpg to file-1.jpg) s/k/r> r two-1.txt: renamed from: two.txt two-2.txt: renamed from: two.txt two-3.txt: renamed from: two.txt ``` The result being ```console $ rclone lsl drive:dupes 6048320 2016-03-05 16:23:16.798000000 one.txt 564374 2016-03-05 16:22:52.118000000 two-1.txt 6048320 2016-03-05 16:22:46.185000000 two-2.txt 1744073 2016-03-05 16:22:38.104000000 two-3.txt ``` Dedupe can be run non interactively using the `--dedupe-mode` flag or by using an extra parameter with the same value - `--dedupe-mode interactive` - interactive as above. - `--dedupe-mode skip` - removes identical files then skips anything left. - `--dedupe-mode first` - removes identical files then keeps the first one. - `--dedupe-mode newest` - removes identical files then keeps the newest one. - `--dedupe-mode oldest` - removes identical files then keeps the oldest one. - `--dedupe-mode largest` - removes identical files then keeps the largest one. - `--dedupe-mode smallest` - removes identical files then keeps the smallest one. - `--dedupe-mode rename` - removes identical files then renames the rest to be different. - `--dedupe-mode list` - lists duplicate dirs and files only and changes nothing. For example, to rename all the identically named photos in your Google Photos directory, do ```console rclone dedupe --dedupe-mode rename "drive:Google Photos" ``` Or ```console rclone dedupe rename "drive:Google Photos" ``` ``` rclone dedupe [mode] remote:path [flags] ``` ## Options ``` --by-hash Find identical hashes rather than names --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename (default "interactive") -h, --help help for dedupe ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone about Get quota information from the remote. ## Synopsis Prints quota information about a remote to standard output. The output is typically used, free, quota and trash contents. E.g. Typical output from `rclone about remote:` is: ```text Total: 17 GiB Used: 7.444 GiB Free: 1.315 GiB Trashed: 100.000 MiB Other: 8.241 GiB ``` Where the fields are: - Total: Total size available. - Used: Total size used. - Free: Total space available to this user. - Trashed: Total space used by trash. - Other: Total amount in other storage (e.g. Gmail, Google Photos). - Objects: Total number of objects in the storage. All sizes are in number of bytes. Applying a `--full` flag to the command prints the bytes in full, e.g. ```text Total: 18253611008 Used: 7993453766 Free: 1411001220 Trashed: 104857602 Other: 8849156022 ``` A `--json` flag generates conveniently machine-readable output, e.g. ```json { "total": 18253611008, "used": 7993453766, "trashed": 104857602, "other": 8849156022, "free": 1411001220 } ``` Not all backends print all fields. Information is not included if it is not provided by a backend. Where the value is unlimited it is omitted. Some backends does not support the `rclone about` command at all, see complete list in [documentation](https://rclone.org/overview/#optional-features). ``` rclone about remote: [flags] ``` ## Options ``` --full Full numbers instead of human-readable -h, --help help for about --json Format output as JSON ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone archive Perform an action on an archive. ## Synopsis Perform an action on an archive. Requires the use of a subcommand to specify the protocol, e.g. rclone archive list remote:file.zip Each subcommand has its own options which you can see in their help. See [rclone archive create](https://rclone.org/commands/rclone_archive_create/) for the archive formats supported. ``` rclone archive [opts] [] [flags] ``` ## Options ``` -h, --help help for archive ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone archive create](https://rclone.org/commands/rclone_archive_create/) - Archive source file(s) to destination. * [rclone archive extract](https://rclone.org/commands/rclone_archive_extract/) - Extract archives from source to destination. * [rclone archive list](https://rclone.org/commands/rclone_archive_list/) - List archive contents from source. # rclone archive create Archive source file(s) to destination. ## Synopsis Creates an archive from the files in source:path and saves the archive to dest:path. If dest:path is missing, it will write to the console. The valid formats for the `--format` flag are listed below. If `--format` is not set rclone will guess it from the extension of dest:path. | Format | Extensions | |:-------|:-----------| | zip | .zip | | tar | .tar | | tar.gz | .tar.gz, .tgz, .taz | | tar.bz2| .tar.bz2, .tb2, .tbz, .tbz2, .tz2 | | tar.lz | .tar.lz | | tar.lz4| .tar.lz4 | | tar.xz | .tar.xz, .txz | | tar.zst| .tar.zst, .tzst | | tar.br | .tar.br | | tar.sz | .tar.sz | | tar.mz | .tar.mz | The `--prefix` and `--full-path` flags control the prefix for the files in the archive. If the flag `--full-path` is set then the files will have the full source path as the prefix. If the flag `--prefix=` is set then the files will have `` as prefix. It's possible to create invalid file names with `--prefix=` so use with caution. Flag `--prefix` has priority over `--full-path`. Given a directory `/sourcedir` with the following: file1.txt dir1/file2.txt Running the command `rclone archive create /sourcedir /dest.tar.gz` will make an archive with the contents: file1.txt dir1/ dir1/file2.txt Running the command `rclone archive create --full-path /sourcedir /dest.tar.gz` will make an archive with the contents: sourcedir/file1.txt sourcedir/dir1/ sourcedir/dir1/file2.txt Running the command `rclone archive create --prefix=my_new_path /sourcedir /dest.tar.gz` will make an archive with the contents: my_new_path/file1.txt my_new_path/dir1/ my_new_path/dir1/file2.txt ``` rclone archive create [flags] [] ``` ## Options ``` --format string Create the archive with format or guess from extension. --full-path Set prefix for files in archive to source path -h, --help help for create --prefix string Set prefix for files in archive to entered value or source path ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone archive](https://rclone.org/commands/rclone_archive/) - Perform an action on an archive. # rclone archive extract Extract archives from source to destination. ## Synopsis Extract the archive contents to a destination directory auto detecting the format. See [rclone archive create](https://rclone.org/commands/rclone_archive_create/) for the archive formats supported. For example on this archive: ``` $ rclone archive list --long remote:archive.zip 6 2025-10-30 09:46:23.000000000 file.txt 0 2025-10-30 09:46:57.000000000 dir/ 4 2025-10-30 09:46:57.000000000 dir/bye.txt ``` You can run extract like this ``` $ rclone archive extract remote:archive.zip remote:extracted ``` Which gives this result ``` $ rclone tree remote:extracted / ├── dir │ └── bye.txt └── file.txt ``` The source or destination or both can be local or remote. Filters can be used to only extract certain files: ``` $ rclone archive extract archive.zip partial --include "bye.*" $ rclone tree partial / └── dir └── bye.txt ``` The [archive backend](https://rclone.org/archive/) can also be used to extract files. It can be used to read only mount archives also but it supports a different set of archive formats to the archive commands. ``` rclone archive extract [flags] ``` ## Options ``` -h, --help help for extract ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone archive](https://rclone.org/commands/rclone_archive/) - Perform an action on an archive. # rclone archive list List archive contents from source. ## Synopsis List the contents of an archive to the console, auto detecting the format. See [rclone archive create](https://rclone.org/commands/rclone_archive_create/) for the archive formats supported. For example: ``` $ rclone archive list remote:archive.zip 6 file.txt 0 dir/ 4 dir/bye.txt ``` Or with `--long` flag for more info: ``` $ rclone archive list --long remote:archive.zip 6 2025-10-30 09:46:23.000000000 file.txt 0 2025-10-30 09:46:57.000000000 dir/ 4 2025-10-30 09:46:57.000000000 dir/bye.txt ``` Or with `--plain` flag which is useful for scripting: ``` $ rclone archive list --plain /path/to/archive.zip file.txt dir/ dir/bye.txt ``` Or with `--dirs-only`: ``` $ rclone archive list --plain --dirs-only /path/to/archive.zip dir/ ``` Or with `--files-only`: ``` $ rclone archive list --plain --files-only /path/to/archive.zip file.txt dir/bye.txt ``` Filters may also be used: ``` $ rclone archive list --long archive.zip --include "bye.*" 4 2025-10-30 09:46:57.000000000 dir/bye.txt ``` The [archive backend](https://rclone.org/archive/) can also be used to list files. It can be used to read only mount archives also but it supports a different set of archive formats to the archive commands. ``` rclone archive list [flags] ``` ## Options ``` --dirs-only Only list directories --files-only Only list files -h, --help help for list --long List extra attributtes --plain Only list file names ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone archive](https://rclone.org/commands/rclone_archive/) - Perform an action on an archive. # rclone authorize Remote authorization. ## Synopsis Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser. Use as instructed by rclone config. See also the [remote setup documentation](/remote_setup). The command requires 1-3 arguments: - Name of a backend (e.g. "drive", "s3") - Either a base64 encoded JSON blob obtained from a previous rclone config session - Or a client_id and client_secret pair obtained from the remote service Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically. Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used. ``` rclone authorize [base64_json_blob | client_id client_secret] [flags] ``` ## Options ``` --auth-no-open-browser Do not automatically open auth link in default browser -h, --help help for authorize --template string The path to a custom Go template for generating HTML responses ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone backend Run a backend-specific command. ## Synopsis This runs a backend-specific command. The commands themselves (except for "help" and "features") are defined by the backends and you should see the backend docs for definitions. You can discover what commands a backend implements by using ```console rclone backend help remote: rclone backend help ``` You can also discover information about the backend using (see [operations/fsinfo](https://rclone.org/rc/#operations-fsinfo) in the remote control docs for more info). ```console rclone backend features remote: ``` Pass options to the backend command with -o. This should be key=value or key, e.g.: ```console rclone backend stats remote:path stats -o format=json -o long ``` Pass arguments to the backend by placing them on the end of the line ```console rclone backend cleanup remote:path file1 file2 file3 ``` Note to run these commands on a running backend then see [backend/command](https://rclone.org/rc/#backend-command) in the rc docs. ``` rclone backend remote:path [opts] [flags] ``` ## Options ``` -h, --help help for backend --json Always output in JSON format -o, --option stringArray Option in the form name=value or name ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone bisync Perform bidirectional synchronization between two paths. ## Synopsis Perform bidirectional synchronization between two paths. [Bisync](https://rclone.org/bisync/) provides a bidirectional cloud sync solution in rclone. It retains the Path1 and Path2 filesystem listings from the prior run. On each successive run it will: - list files on Path1 and Path2, and check for changes on each side. Changes include `New`, `Newer`, `Older`, and `Deleted` files. - Propagate changes on Path1 to Path2, and vice-versa. Bisync is considered an **advanced command**, so use with care. Make sure you have read and understood the entire [manual](https://rclone.org/bisync) (especially the [Limitations](https://rclone.org/bisync/#limitations) section) before using, or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/). See [full bisync description](https://rclone.org/bisync/) for details. ``` rclone bisync remote1:path1 remote2:path2 [flags] ``` ## Options ``` --backup-dir1 string --backup-dir for Path1. Must be a non-overlapping path on the same remote. --backup-dir2 string --backup-dir for Path2. Must be a non-overlapping path on the same remote. --check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort. --check-filename string Filename for --check-access (default: RCLONE_TEST) --check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true") --compare string Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime') --conflict-loser ConflictLoserAction Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num) --conflict-resolve string Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none") --conflict-suffix string Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict') --create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) --download-hash Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!) --filters-file string Read filtering patterns from a file --force Bypass --max-delete safety check and run the sync. Consider using with --verbose -h, --help help for bisync --ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks) --max-lock Duration Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s) --no-cleanup Retain working files (useful for troubleshooting and testing). --no-slow-hash Ignore listing checksums only on backends where they are slow --recover Automatically recover from interruptions without requiring --resync. --remove-empty-dirs Remove ALL empty directories at the final cleanup step. --resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. -1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first. --resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none") --slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls. --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Sync Options Flags used for sync commands ```text --backup-dir string Make backups into hierarchy based in DIR --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring --delete-during When synchronizing, delete files during transfer --fix-case Force rename of case insensitive dest to match source --ignore-errors Delete even if there are I/O errors --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000) --max-delete int When synchronizing, limit the number of deletes (default -1) --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off) --suffix string Suffix to add to changed files --suffix-keep-extension Preserve the extension when using --suffix --track-renames When synchronizing, track file renames and do a server-side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone cat Concatenates any files and sends them to stdout. ## Synopsis Sends any files to standard output. You can use it like this to output a single file ```sh rclone cat remote:path/to/file ``` Or like this to output any file in dir or its subdirectories. ```sh rclone cat remote:path/to/dir ``` Or like this to output any .txt files in dir or its subdirectories. ```sh rclone --include "*.txt" cat remote:path/to/dir ``` Use the `--head` flag to print characters only at the start, `--tail` for the end and `--offset` and `--count` to print a section in the middle. Note that if offset is negative it will count from the end, so `--offset -1 --count 1` is equivalent to `--tail 1`. Use the `--separator` flag to print a separator value between files. Be sure to shell-escape special characters. For example, to print a newline between files, use: - bash: ```sh rclone --include "*.txt" --separator $'\n' cat remote:path/to/dir ``` - powershell: ```powershell rclone --include "*.txt" --separator "`n" cat remote:path/to/dir ``` ``` rclone cat remote:path [flags] ``` ## Options ``` --count int Only print N characters (default -1) --discard Discard the output instead of printing --head int Only print the first N characters -h, --help help for cat --offset int Start printing at offset N (or from end if -ve) --separator string Separator to use between objects when printing multiple files --tail int Only print the last N characters ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone checksum Checks the files in the destination against a SUM file. ## Synopsis Checks that hashsums of destination files match the SUM file. It compares hashes (MD5, SHA1, etc) and logs a report of files which don't match. It doesn't alter the file system. The sumfile is treated as the source and the dst:path is treated as the destination for the purposes of the output. If you supply the `--download` flag, it will download the data from the remote and calculate the content hash on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data. Note that hash values in the SUM file are treated as case insensitive. If you supply the `--one-way` flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The default number of parallel checks is 8. See the [--checkers](https://rclone.org/docs/#checkers-int) option for more information. ``` rclone checksum sumfile dst:path [flags] ``` ## Options ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file --download Check by hashing the contents --error string Report all files with errors (hashing or reading) to this file -h, --help help for checksum --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file --one-way Check one way only, source files must exist on remote ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone completion Output completion script for a given shell. ## Synopsis Generates a shell completion script for rclone. Run with `--help` to list the supported shells. ## Options ``` -h, --help help for completion ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone completion bash](https://rclone.org/commands/rclone_completion_bash/) - Output bash completion script for rclone. * [rclone completion fish](https://rclone.org/commands/rclone_completion_fish/) - Output fish completion script for rclone. * [rclone completion powershell](https://rclone.org/commands/rclone_completion_powershell/) - Output powershell completion script for rclone. * [rclone completion zsh](https://rclone.org/commands/rclone_completion_zsh/) - Output zsh completion script for rclone. # rclone completion bash Output bash completion script for rclone. ## Synopsis Generates a bash shell autocompletion script for rclone. By default, when run without any arguments, ```console rclone completion bash ``` the generated script will be written to ```console /etc/bash_completion.d/rclone ``` and so rclone will probably need to be run as root, or with sudo. If you supply a path to a file as the command line argument, then the generated script will be written to that file, in which case you should not need root privileges. If output_file is "-", then the output will be written to stdout. If you have installed the script into the default location, you can logout and login again to use the autocompletion script. Alternatively, you can source the script directly ```console . /path/to/my_bash_completion_scripts/rclone ``` and the autocompletion functionality will be added to your current shell. ``` rclone completion bash [output_file] [flags] ``` ## Options ``` -h, --help help for bash ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone completion](https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. # rclone completion fish Output fish completion script for rclone. ## Synopsis Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g. ```console sudo rclone completion fish ``` Logout and login again to use the autocompletion scripts, or source them directly ```console . /etc/fish/completions/rclone.fish ``` If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. ``` rclone completion fish [output_file] [flags] ``` ## Options ``` -h, --help help for fish ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone completion](https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. # rclone completion powershell Output powershell completion script for rclone. ## Synopsis Generate the autocompletion script for powershell. To load completions in your current shell session: ```console rclone completion powershell | Out-String | Invoke-Expression ``` To load completions for every new session, add the output of the above command to your powershell profile. If output_file is "-" or missing, then the output will be written to stdout. ``` rclone completion powershell [output_file] [flags] ``` ## Options ``` -h, --help help for powershell ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone completion](https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. # rclone completion zsh Output zsh completion script for rclone. ## Synopsis Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g. ```console sudo rclone completion zsh ``` Logout and login again to use the autocompletion scripts, or source them directly ```console autoload -U compinit && compinit ``` If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. ``` rclone completion zsh [output_file] [flags] ``` ## Options ``` -h, --help help for zsh ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone completion](https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. # rclone config create Create a new remote with name, type and options. ## Synopsis Create a new remote of `name` with `type` and options. The options should be passed in pairs of `key` `value` or as `key=value`. For example, to make a swift remote of name myremote using auto config you would do: ```sh rclone config create myremote swift env_auth true rclone config create myremote swift env_auth=true ``` So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: ```sh rclone config create mydrive drive config_is_local=false ``` Note that if the config process would normally ask a question the default is taken (unless `--non-interactive` is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken. If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file. **NB** If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the `--obscure` flag, or if you are 100% certain you are already passing obscured passwords then use `--no-obscure`. You can also set obscured passwords using the `rclone config password` command. The flag `--non-interactive` is for use by applications that wish to configure rclone themselves, rather than using rclone's text based configuration questions. If this flag is set, and rclone needs to ask the user a question, a JSON blob will be returned with the question in it. This will look something like (some irrelevant detail removed): ```json { "State": "*oauth-islocal,teamdrive,,", "Option": { "Name": "config_is_local", "Help": "Use web browser to automatically authenticate rclone with remote?\n * Say Y if the machine running rclone has a web browser you can use\n * Say N if running rclone on a (remote) machine without web browser access\nIf not sure try Y. If Y failed, try N.\n", "Default": true, "Examples": [ { "Value": "true", "Help": "Yes" }, { "Value": "false", "Help": "No" } ], "Required": false, "IsPassword": false, "Type": "bool", "Exclusive": true, }, "Error": "", } ``` The format of `Option` is the same as returned by `rclone config providers`. The question should be asked to the user and returned to rclone as the `--result` option along with the `--state` parameter. The keys of `Option` are used as follows: - `Name` - name of variable - show to user - `Help` - help text. Hard wrapped at 80 chars. Any URLs should be clicky. - `Default` - default value - return this if the user just wants the default. - `Examples` - the user should be able to choose one of these - `Required` - the value should be non-empty - `IsPassword` - the value is a password and should be edited as such - `Type` - type of value, eg `bool`, `string`, `int` and others - `Exclusive` - if set no free-form entry allowed only the `Examples` - Irrelevant keys `Provider`, `ShortOpt`, `Hide`, `NoPrefix`, `Advanced` If `Error` is set then it should be shown to the user at the same time as the question. ```sh rclone config update name --continue --state "*oauth-islocal,teamdrive,," --result "true" ``` Note that when using `--continue` all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of `--continue`. At the end of the non interactive process, rclone will return a result with `State` as empty string. If `--all` is passed then rclone will ask all the config questions, not just the post config questions. Any parameters are used as defaults for questions as usual. Note that `bin/config.py` in the rclone source implements this protocol as a readable demonstration. ``` rclone config create name type [key value]* [flags] ``` ## Options ``` --all Ask the full set of config questions --continue Continue the configuration process with an answer -h, --help help for create --no-obscure Force any passwords not to be obscured --no-output Don't provide any output --non-interactive Don't interact with user and return questions --obscure Force any passwords to be obscured --result string Result - use with --continue --state string State - use with --continue ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config delete Delete an existing remote. ``` rclone config delete name [flags] ``` ## Options ``` -h, --help help for delete ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config disconnect Disconnects user from remote ## Synopsis This disconnects the remote: passed in to the cloud storage system. This normally means revoking the oauth token. To reconnect use "rclone config reconnect". ``` rclone config disconnect remote: [flags] ``` ## Options ``` -h, --help help for disconnect ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config dump Dump the config file as JSON. ``` rclone config dump [flags] ``` ## Options ``` -h, --help help for dump ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config edit Enter an interactive configuration session. ## Synopsis Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration. ``` rclone config edit [flags] ``` ## Options ``` -h, --help help for edit ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config encryption set, remove and check the encryption for the config file ## Synopsis This command sets, clears and checks the encryption for the config file using the subcommands below. ## Options ``` -h, --help help for encryption ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config encryption check](https://rclone.org/commands/rclone_config_encryption_check/) - Check that the config file is encrypted * [rclone config encryption remove](https://rclone.org/commands/rclone_config_encryption_remove/) - Remove the config file encryption password * [rclone config encryption set](https://rclone.org/commands/rclone_config_encryption_set/) - Set or change the config file encryption password # rclone config encryption check Check that the config file is encrypted ## Synopsis This checks the config file is encrypted and that you can decrypt it. It will attempt to decrypt the config using the password you supply. If decryption fails it will return a non-zero exit code if using `--password-command`, otherwise it will prompt again for the password. If the config file is not encrypted it will return a non zero exit code. ``` rclone config encryption check [flags] ``` ## Options ``` -h, --help help for check ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config encryption](https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file # rclone config encryption remove Remove the config file encryption password ## Synopsis Remove the config file encryption password This removes the config file encryption, returning it to un-encrypted. If `--password-command` is in use, this will be called to supply the old config password. If the config was not encrypted then no error will be returned and this command will do nothing. ``` rclone config encryption remove [flags] ``` ## Options ``` -h, --help help for remove ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config encryption](https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file # rclone config encryption set Set or change the config file encryption password ## Synopsis This command sets or changes the config file encryption password. If there was no config password set then it sets a new one, otherwise it changes the existing config password. Note that if you are changing an encryption password using `--password-command` then this will be called once to decrypt the config using the old password and then again to read the new password to re-encrypt the config. When `--password-command` is called to change the password then the environment variable `RCLONE_PASSWORD_CHANGE=1` will be set. So if changing passwords programmatically you can use the environment variable to distinguish which password you must supply. Alternatively you can remove the password first (with `rclone config encryption remove`), then set it again with this command which may be easier if you don't mind the unencrypted config file being on the disk briefly. ``` rclone config encryption set [flags] ``` ## Options ``` -h, --help help for set ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config encryption](https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file # rclone config file Show path of configuration file in use. ``` rclone config file [flags] ``` ## Options ``` -h, --help help for file ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config password Update password in an existing remote. ## Synopsis Update an existing remote's password. The password should be passed in pairs of `key` `password` or as `key=password`. The `password` should be passed in in clear (unobscured). For example, to set password of a remote of name myremote you would do: ```sh rclone config password myremote fieldname mypassword rclone config password myremote fieldname=mypassword ``` This command is obsolete now that "config update" and "config create" both support obscuring passwords directly. ``` rclone config password name [key value]+ [flags] ``` ## Options ``` -h, --help help for password ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config paths Show paths used for configuration, cache, temp etc. ``` rclone config paths [flags] ``` ## Options ``` -h, --help help for paths ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config providers List in JSON format all the providers and options. ``` rclone config providers [flags] ``` ## Options ``` -h, --help help for providers ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config reconnect Re-authenticates user with remote. ## Synopsis This reconnects remote: passed in to the cloud storage system. To disconnect the remote use "rclone config disconnect". This normally means going through the interactive oauth flow again. ``` rclone config reconnect remote: [flags] ``` ## Options ``` -h, --help help for reconnect ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config redacted Print redacted (decrypted) config file, or the redacted config for a single remote. ## Synopsis This prints a redacted copy of the config file, either the whole config file or for a given remote. The config file will be redacted by replacing all passwords and other sensitive info with XXX. This makes the config file suitable for posting online for support. It should be double checked before posting as the redaction may not be perfect. ``` rclone config redacted [] [flags] ``` ## Options ``` -h, --help help for redacted ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config show Print (decrypted) config file, or the config for a single remote. ``` rclone config show [] [flags] ``` ## Options ``` -h, --help help for show ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config string Print connection string for a single remote. ## Synopsis Print a connection string for a single remote. The [connection strings](https://rclone.org/docs/#connection-strings) can be used wherever a remote is needed and can be more convenient than using the config file, especially if using the RC API. Backend parameters may be provided to the command also. Example: ```sh $ rclone config string s3:rclone --s3-no-check-bucket :s3,access_key_id=XXX,no_check_bucket,provider=AWS,region=eu-west-2,secret_access_key=YYY:rclone ``` **NB** the strings are not quoted for use in shells (eg bash, powershell, windows cmd). Most will work if enclosed in "double quotes", however connection strings that contain double quotes will require further quoting which is very shell dependent. ``` rclone config string [flags] ``` ## Options ``` -h, --help help for string ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config touch Ensure configuration file exists. ``` rclone config touch [flags] ``` ## Options ``` -h, --help help for touch ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config unset Unset options in an existing remote. ## Synopsis Remove one or more options from an existing remote. The options to remove should be passed in as a list of key names. For example, to remove the `client_id` and `client_secret` options from a remote of name myremote you would do: ```sh rclone config unset myremote client_id client_secret ``` This removes the keys from the config file entirely, which is different from setting them to an empty string with `config update`. Removing a key restores rclone's default behaviour for that option, whereas setting it to an empty string overrides the default with an empty value. You can't unset the `type` of a remote - use `config delete` to remove the whole remote instead. ``` rclone config unset name [key]+ [flags] ``` ## Options ``` -h, --help help for unset ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config update Update options in an existing remote. ## Synopsis Update an existing remote's options. The options should be passed in pairs of `key` `value` or as `key=value`. For example, to update the env_auth field of a remote of name myremote you would do: ```sh rclone config update myremote env_auth true rclone config update myremote env_auth=true ``` If the remote uses OAuth the token will be updated, if you don't require this add an extra parameter thus: ```sh rclone config update myremote env_auth=true config_refresh_token=false ``` Note that if the config process would normally ask a question the default is taken (unless `--non-interactive` is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken. If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file. **NB** If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the `--obscure` flag, or if you are 100% certain you are already passing obscured passwords then use `--no-obscure`. You can also set obscured passwords using the `rclone config password` command. The flag `--non-interactive` is for use by applications that wish to configure rclone themselves, rather than using rclone's text based configuration questions. If this flag is set, and rclone needs to ask the user a question, a JSON blob will be returned with the question in it. This will look something like (some irrelevant detail removed): ```json { "State": "*oauth-islocal,teamdrive,,", "Option": { "Name": "config_is_local", "Help": "Use web browser to automatically authenticate rclone with remote?\n * Say Y if the machine running rclone has a web browser you can use\n * Say N if running rclone on a (remote) machine without web browser access\nIf not sure try Y. If Y failed, try N.\n", "Default": true, "Examples": [ { "Value": "true", "Help": "Yes" }, { "Value": "false", "Help": "No" } ], "Required": false, "IsPassword": false, "Type": "bool", "Exclusive": true, }, "Error": "", } ``` The format of `Option` is the same as returned by `rclone config providers`. The question should be asked to the user and returned to rclone as the `--result` option along with the `--state` parameter. The keys of `Option` are used as follows: - `Name` - name of variable - show to user - `Help` - help text. Hard wrapped at 80 chars. Any URLs should be clicky. - `Default` - default value - return this if the user just wants the default. - `Examples` - the user should be able to choose one of these - `Required` - the value should be non-empty - `IsPassword` - the value is a password and should be edited as such - `Type` - type of value, eg `bool`, `string`, `int` and others - `Exclusive` - if set no free-form entry allowed only the `Examples` - Irrelevant keys `Provider`, `ShortOpt`, `Hide`, `NoPrefix`, `Advanced` If `Error` is set then it should be shown to the user at the same time as the question. ```sh rclone config update name --continue --state "*oauth-islocal,teamdrive,," --result "true" ``` Note that when using `--continue` all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of `--continue`. At the end of the non interactive process, rclone will return a result with `State` as empty string. If `--all` is passed then rclone will ask all the config questions, not just the post config questions. Any parameters are used as defaults for questions as usual. Note that `bin/config.py` in the rclone source implements this protocol as a readable demonstration. ``` rclone config update name [key value]+ [flags] ``` ## Options ``` --all Ask the full set of config questions --continue Continue the configuration process with an answer -h, --help help for update --no-obscure Force any passwords not to be obscured --no-output Don't provide any output --non-interactive Don't interact with user and return questions --obscure Force any passwords to be obscured --result string Result - use with --continue --state string State - use with --continue ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone config userinfo Prints info about logged in user of remote. ## Synopsis This prints the details of the person logged in to the cloud storage system. ``` rclone config userinfo remote: [flags] ``` ## Options ``` -h, --help help for userinfo --json Format output as JSON ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. # rclone convmv Convert file and directory names in place. ## Synopsis convmv supports advanced path name transformations for converting and renaming files and directories by applying prefixes, suffixes, and other alterations. | Command | Description | |------|------| | `--name-transform prefix=XXXX` | Prepends XXXX to the file name. | | `--name-transform suffix=XXXX` | Appends XXXX to the file name after the extension. | | `--name-transform suffix_keep_extension=XXXX` | Appends XXXX to the file name while preserving the original file extension. | | `--name-transform trimprefix=XXXX` | Removes XXXX if it appears at the start of the file name. | | `--name-transform trimsuffix=XXXX` | Removes XXXX if it appears at the end of the file name. | | `--name-transform regex=pattern/replacement` | Applies a regex-based transformation. | | `--name-transform replace=old:new` | Replaces occurrences of old with new in the file name. | | `--name-transform date={YYYYMMDD}` | Appends or prefixes the specified date format. | | `--name-transform truncate=N` | Truncates the file name to a maximum of N characters. | | `--name-transform truncate_keep_extension=N` | Truncates the file name to a maximum of N characters while preserving the original file extension. | | `--name-transform truncate_bytes=N` | Truncates the file name to a maximum of N bytes (not characters). | | `--name-transform truncate_bytes_keep_extension=N` | Truncates the file name to a maximum of N bytes (not characters) while preserving the original file extension. | | `--name-transform base64encode` | Encodes the file name in Base64. | | `--name-transform base64decode` | Decodes a Base64-encoded file name. | | `--name-transform encoder=ENCODING` | Converts the file name to the specified encoding (e.g., ISO-8859-1, Windows-1252, Macintosh). | | `--name-transform decoder=ENCODING` | Decodes the file name from the specified encoding. | | `--name-transform charmap=MAP` | Applies a character mapping transformation. | | `--name-transform lowercase` | Converts the file name to lowercase. | | `--name-transform uppercase` | Converts the file name to UPPERCASE. | | `--name-transform titlecase` | Converts the file name to Title Case. | | `--name-transform ascii` | Strips non-ASCII characters. | | `--name-transform url` | URL-encodes the file name. | | `--name-transform nfc` | Converts the file name to NFC Unicode normalization form. | | `--name-transform nfd` | Converts the file name to NFD Unicode normalization form. | | `--name-transform nfkc` | Converts the file name to NFKC Unicode normalization form. | | `--name-transform nfkd` | Converts the file name to NFKD Unicode normalization form. | | `--name-transform command=/path/to/my/programfile names.` | Executes an external program to transform. | Conversion modes: ```text none nfc nfd nfkc nfkd replace prefix suffix suffix_keep_extension trimprefix trimsuffix index date truncate truncate_keep_extension truncate_bytes truncate_bytes_keep_extension base64encode base64decode encoder decoder ISO-8859-1 Windows-1252 Macintosh charmap lowercase uppercase titlecase ascii url regex command ``` Char maps: ```text IBM-Code-Page-037 IBM-Code-Page-437 IBM-Code-Page-850 IBM-Code-Page-852 IBM-Code-Page-855 Windows-Code-Page-858 IBM-Code-Page-860 IBM-Code-Page-862 IBM-Code-Page-863 IBM-Code-Page-865 IBM-Code-Page-866 IBM-Code-Page-1047 IBM-Code-Page-1140 ISO-8859-1 ISO-8859-2 ISO-8859-3 ISO-8859-4 ISO-8859-5 ISO-8859-6 ISO-8859-7 ISO-8859-8 ISO-8859-9 ISO-8859-10 ISO-8859-13 ISO-8859-14 ISO-8859-15 ISO-8859-16 KOI8-R KOI8-U Macintosh Macintosh-Cyrillic Windows-874 Windows-1250 Windows-1251 Windows-1252 Windows-1253 Windows-1254 Windows-1255 Windows-1256 Windows-1257 Windows-1258 X-User-Defined ``` Encoding masks: ```text Asterisk BackQuote BackSlash Colon CrLf Ctl Del Dollar Dot DoubleQuote Exclamation Hash InvalidUtf8 LeftCrLfHtVt LeftPeriod LeftSpace LeftTilde LtGt None Percent Pipe Question Raw RightCrLfHtVt RightPeriod RightSpace Semicolon SingleQuote Slash SquareBracket ``` Examples: ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,uppercase" // Output: STORIES/THE QUICK BROWN FOX!.TXT ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,replace=Fox:Turtle" --name-transform "all,replace=Quick:Slow" // Output: stories/The Slow Brown Turtle!.txt ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,base64encode" // Output: c3Rvcmllcw==/VGhlIFF1aWNrIEJyb3duIEZveCEudHh0 ``` ```console rclone convmv "c3Rvcmllcw==/VGhlIFF1aWNrIEJyb3duIEZveCEudHh0" --name-transform "all,base64decode" // Output: stories/The Quick Brown Fox!.txt ``` ```console rclone convmv "stories/The Quick Brown 🦊 Fox Went to the Café!.txt" --name-transform "all,nfc" // Output: stories/The Quick Brown 🦊 Fox Went to the Café!.txt ``` ```console rclone convmv "stories/The Quick Brown 🦊 Fox Went to the Café!.txt" --name-transform "all,nfd" // Output: stories/The Quick Brown 🦊 Fox Went to the Café!.txt ``` ```console rclone convmv "stories/The Quick Brown 🦊 Fox!.txt" --name-transform "all,ascii" // Output: stories/The Quick Brown Fox!.txt ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,trimsuffix=.txt" // Output: stories/The Quick Brown Fox! ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,prefix=OLD_" // Output: OLD_stories/OLD_The Quick Brown Fox!.txt ``` ```console rclone convmv "stories/The Quick Brown 🦊 Fox Went to the Café!.txt" --name-transform "all,charmap=ISO-8859-7" // Output: stories/The Quick Brown _ Fox Went to the Caf_!.txt ``` ```console rclone convmv "stories/The Quick Brown Fox: A Memoir [draft].txt" --name-transform "all,encoder=Colon,SquareBracket" // Output: stories/The Quick Brown Fox： A Memoir ［draft］.txt ``` ```console rclone convmv "stories/The Quick Brown 🦊 Fox Went to the Café!.txt" --name-transform "all,truncate=21" // Output: stories/The Quick Brown 🦊 Fox ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=echo" // Output: stories/The Quick Brown Fox!.txt ``` ```console rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}" // Output: stories/The Quick Brown Fox!-20260731 ``` ```console rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}" // Output: stories/The Quick Brown Fox!-2026-07-31 0340PM ``` ```console rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\.\\w]/ab" // Output: ababababababab/ababab ababababab ababababab ababab!abababab ``` The regex command generally accepts Perl-style regular expressions, the exact syntax is defined in the [Go regular expression reference](https://golang.org/pkg/regexp/syntax/). The replacement string may contain capturing group variables, referencing capturing groups using the syntax `$name` or `${name}`, where the name can refer to a named capturing group or it can simply be the index as a number. To insert a literal $, use $$. Multiple transformations can be used in sequence, applied in the order they are specified on the command line. The `--name-transform` flag is also available in `sync`, `copy`, and `move`. ## Files vs Directories By default `--name-transform` will only apply to file names. The means only the leaf file name will be transformed. However some of the transforms would be better applied to the whole path or just directories. To choose which which part of the file path is affected some tags can be added to the `--name-transform`. | Tag | Effect | |------|------| | `file` | Only transform the leaf name of files (DEFAULT) | | `dir` | Only transform name of directories - these may appear anywhere in the path | | `all` | Transform the entire path for files and directories | This is used by adding the tag into the transform name like this: `--name-transform file,prefix=ABC` or `--name-transform dir,prefix=DEF`. For some conversions using all is more likely to be useful, for example `--name-transform all,nfc`. Note that `--name-transform` may not add path separators `/` to the name. This will cause an error. ## Ordering and Conflicts - Transformations will be applied in the order specified by the user. - If the `file` tag is in use (the default) then only the leaf name of files will be transformed. - If the `dir` tag is in use then directories anywhere in the path will be transformed - If the `all` tag is in use then directories and files anywhere in the path will be transformed - Each transformation will be run one path segment at a time. - If a transformation adds a `/` or ends up with an empty path segment then that will be an error. - It is up to the user to put the transformations in a sensible order. - Conflicting transformations, such as `prefix` followed by `trimprefix` or `nfc` followed by `nfd`, are possible. - Instead of enforcing mutual exclusivity, transformations are applied in sequence as specified by the user, allowing for intentional use cases (e.g., trimming one prefix before adding another). - Users should be aware that certain combinations may lead to unexpected results and should verify transformations using `--dry-run` before execution. ## Race Conditions and Non-Deterministic Behavior Some transformations, such as `replace=old:new`, may introduce conflicts where multiple source files map to the same destination name. This can lead to race conditions when performing concurrent transfers. It is up to the user to anticipate these. - If two files from the source are transformed into the same name at the destination, the final state may be non-deterministic. - Running rclone check after a sync using such transformations may erroneously report missing or differing files due to overwritten results. To minimize risks, users should: - Carefully review transformations that may introduce conflicts. - Use `--dry-run` to inspect changes before executing a sync (but keep in mind that it won't show the effect of non-deterministic transformations). - Avoid transformations that cause multiple distinct source files to map to the same destination name. - Consider disabling concurrency with `--transfers=1` if necessary. - Certain transformations (e.g. `prefix`) will have a multiplying effect every time they are used. Avoid these when using `bisync`. ``` rclone convmv dest:path --name-transform XXX [flags] ``` ## Options ``` --create-empty-src-dirs Create empty source dirs on destination after move --delete-empty-src-dirs Delete empty source dirs after move -h, --help help for convmv ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone copyto Copy files from source to dest, skipping identical files. ## Synopsis If source:path is a file or directory then it copies it to a file or directory named dest:path. This can be used to copy a single file to a destination with a name different from its source - for example, uploading and renaming in one step. If the source is a directory then it acts exactly like the [copy](https://rclone.org/commands/rclone_copy/) command. So ```console rclone copyto src dst ``` where src and dst are rclone paths, either `remote:path` or `/path/to/local` or `C:\windows\path\if\on\windows`. This will: ```text if src is file copy it to dst, overwriting an existing file if it exists if src is directory copy it to dst, overwriting existing files if they exist see copy command for full details ``` This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. It doesn't delete files from the destination. *If you are looking to copy just a byte range of a file, please see `rclone cat --offset X --count Y`.* **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics. ## Logger Flags The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The `--dest-after` flag writes a list file using the same format flags as [`lsf`](https://rclone.org/commands/rclone_lsf/#synopsis) (including [customizable options for hash, modtime, etc.](https://rclone.org/commands/rclone_lsf/#synopsis)) Conceptually it is similar to rsync's `--itemize-changes`, but not identical -- it should output an accurate list of what will be on the destination after the command is finished. When the `--no-traverse` flag is set, all logs involving files that exist only on the destination will be incomplete or completely missing. Note that these logger flags have a few limitations, and certain scenarios are not currently supported: - `--max-duration` / `CutoffModeHard` - `--compare-dest` / `--copy-dest` - server-side moves of an entire dir at once - High-level retries, because there would be duplicates (use `--retries 1` to disable) - Possibly some unusual error scenarios Note also that each file is logged during execution, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID). ``` rclone copyto source:path dest:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --combined string Make a combined report of changes to this file --csv Output in CSV format --dest-after string Report all files that exist on the dest post-sync --differ string Report all non-matching files to this file -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --error string Report all files with errors (hashing or reading) to this file --files-only Only list files (default true) -F, --format string Output format - see lsf help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for copyto --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file -s, --separator string Separator for the items in the format (default ";") -t, --timeformat string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone copyurl Copy the contents of the URL supplied content to dest:path. ## Synopsis Download a URL's content and copy it to the destination without saving it in temporary storage. Setting `--auto-filename` will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path. With `--header-filename` in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. With `--print-filename` in addition, the resulting file name will be printed. Setting `--no-clobber` will prevent overwriting file on the destination if there is one with the same name. Setting `--stdout` or making the output file name `-` will cause the output to be written to standard output. Setting `--urls` allows you to input a CSV file of URLs in format: URL, FILENAME. If `--urls` is in use then replace the URL in the arguments with the file containing the URLs, e.g.: ```sh rclone copyurl --urls myurls.csv remote:dir ``` Missing filenames will be autogenerated equivalent to using `--auto-filename`. Note that `--stdout` and `--print-filename` are incompatible with `--urls`. This will do `--transfers` copies in parallel. Note that if `--auto-filename` is desired for all URLs then a file with only URLs and no filename can be used. Each FILENAME in the CSV file can start with a relative path which will be appended to the destination path provided at the command line. For example, running the command shown above with the following CSV file will write two files to the destination: `remote:dir/local/path/bar.json` and `remote:dir/another/local/directory/qux.json` ```csv https://example.org/foo/bar.json,local/path/bar.json https://example.org/qux/baz.json,another/local/directory/qux.json ``` ## Troubleshooting If you can't get `rclone copyurl` to work then here are some things you can try: - `--disable-http2` rclone will use HTTP2 if available - try disabling it - `--bind 0.0.0.0` rclone will use IPv6 if available - try disabling it - `--bind ::0` to disable IPv4 - `--user agent curl` - some sites have whitelists for curl's user-agent - try that - Make sure the site works with `curl` directly ``` rclone copyurl https://example.com dest:path [flags] ``` ## Options ``` -a, --auto-filename Get the file name from the URL and use it for destination file path --header-filename Get the file name from the Content-Disposition header -h, --help help for copyurl --no-clobber Prevent overwriting file with same name -p, --print-filename Print the resulting name from --auto-filename --stdout Write the output to stdout rather than a file --urls Use a CSV file of links to process multiple URLs ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone cryptcheck Cryptcheck checks the integrity of an encrypted remote. ## Synopsis Checks a remote against an [encrypted](https://rclone.org/crypt/) remote. This is the equivalent of running rclone [check](https://rclone.org/commands/rclone_check/), but able to check the checksums of the encrypted remote. For it to work the underlying remote of the cryptedremote must support some kind of checksum. It works by reading the nonce from each file on the cryptedremote: and using that to encrypt each file on the remote:. It then checks the checksum of the underlying file on the cryptedremote: against the checksum of the file it has just encrypted. Use it like this ```console rclone cryptcheck /path/to/files encryptedremote:path ``` You can use it like this also, but that will involve downloading all the files in `remote:path`. ```console rclone cryptcheck remote:path encryptedremote:path ``` After it has run it will log the status of the `encryptedremote:`. If you supply the `--one-way` flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The default number of parallel checks is 8. See the [--checkers](https://rclone.org/docs/#checkers-int) option for more information. ``` rclone cryptcheck remote:path cryptedremote:path [flags] ``` ## Options ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file --error string Report all files with errors (hashing or reading) to this file -h, --help help for cryptcheck --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file --one-way Check one way only, source files must exist on remote ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Check Options Flags used for check commands ```text --max-backlog int Maximum number of objects in sync or check backlog (default 10000) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone cryptdecode Cryptdecode returns unencrypted file names. ## Synopsis Returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items. If you supply the `--reverse` flag, it will return encrypted file names. use it like this ```console rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 rclone cryptdecode --reverse encryptedremote: filename1 filename2 ``` Another way to accomplish this is by using the `rclone backend encode` (or `decode`) command. See the documentation on the [crypt](https://rclone.org/crypt/) overlay for more info. ``` rclone cryptdecode encryptedremote: encryptedfilename [flags] ``` ## Options ``` -h, --help help for cryptdecode --reverse Reverse cryptdecode, encrypts filenames ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone deletefile Remove a single file from remote. ## Synopsis Remove a single file from remote. Unlike `delete` it cannot be used to remove a directory and it doesn't obey include/exclude filters - if the specified file exists, it will always be removed. ``` rclone deletefile remote:path [flags] ``` ## Options ``` -h, --help help for deletefile ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone gendocs Output markdown docs for rclone to the directory supplied. ## Synopsis This produces markdown docs for the rclone commands to the directory supplied. These are in a format suitable for hugo to render into the rclone.org website. ``` rclone gendocs output_directory [flags] ``` ## Options ``` -h, --help help for gendocs ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone gitannex Speaks with git-annex over stdin/stdout. ## Synopsis Rclone's `gitannex` subcommand enables [git-annex] to store and retrieve content from an rclone remote. It is meant to be run by git-annex, not directly by users. [git-annex]: https://git-annex.branchable.com/ ## Installation on Linux 1. Skip this step if your version of git-annex is [10.20240430] or newer. Otherwise, you must create a symlink somewhere on your PATH with a particular name. This symlink helps git-annex tell rclone it wants to run the "gitannex" subcommand. Create the helper symlink in "$HOME/bin": ```console ln -s "$(realpath rclone)" "$HOME/bin/git-annex-remote-rclone-builtin" Verify the new symlink is on your PATH: ```console which git-annex-remote-rclone-builtin ``` [10.20240430]: https://git-annex.branchable.com/news/version_10.20240430/ 2. Add a new remote to your git-annex repo. This new remote will connect git-annex with the `rclone gitannex` subcommand. Start by asking git-annex to describe the remote's available configuration parameters. If you skipped step 1: ```console git annex initremote MyRemote type=rclone --whatelse ``` If you created a symlink in step 1: ```console git annex initremote MyRemote type=external externaltype=rclone-builtin --whatelse ``` > **NOTE**: If you're porting an existing [git-annex-remote-rclone] remote to > use `rclone gitannex`, you can probably reuse the configuration parameters > verbatim without renaming them. Check parameter synonyms with `--whatelse` > as shown above. > > [git-annex-remote-rclone]: https://github.com/git-annex-remote-rclone/git-annex-remote-rclone The following example creates a new git-annex remote named "MyRemote" that will use the rclone remote named "SomeRcloneRemote". That rclone remote must be one configured in your rclone.conf file, which can be located with `rclone config file`. ```console git annex initremote MyRemote \ type=external \ externaltype=rclone-builtin \ encryption=none \ rcloneremotename=SomeRcloneRemote \ rcloneprefix=git-annex-content \ rclonelayout=nodir ``` 3. Before you trust this command with your precious data, be sure to **test the remote**. This command is very new and has not been tested on many rclone backends. Caveat emptor! ```console git annex testremote MyRemote ``` Happy annexing! ``` rclone gitannex [flags] ``` ## Options ``` -h, --help help for gitannex ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone gui Open the web based GUI. ## Synopsis This command starts an embedded web GUI for rclone and opens it in your default browser. This starts an RC API server and a GUI server on separate localhost ports, generates login credentials automatically unless --no-auth is specified, and opens the browser already authenticated. rclone gui By default rclone gui serves the web GUI that was embedded into the rclone binary at build time from https://github.com/rclone/rclone-web/ You can override this by passing a path to either an unpacked GUI directory or a dist.zip archive (e.g. one downloaded from the rclone-web releases page): rclone gui ./my-dist/ rclone gui ./dist.zip This is useful for iterating on the GUI locally without rebuilding rclone, or for serving a different GUI release than the one embedded. Use --no-open-browser to skip opening the browser automatically: rclone gui --no-open-browser Use --addr to bind the GUI to a specific address: rclone gui --addr localhost:5580 Use --user and --pass to set specific credentials: rclone gui --user admin --pass secret Use --no-auth to disable authentication entirely: rclone gui --no-auth For more help see [the GUI docs](https://rclone.org/gui/). ``` rclone gui [path] [flags] ``` ## Options ``` --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port) --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port) --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics -h, --help help for gui --no-auth Don't require auth for the RC API --no-open-browser Skip opening the browser automatically --pass string Password for RC authentication --user string User name for RC authentication ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### RC Options Flags to control the Remote Control API ```text --rc Enable the remote control server --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572) --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from --rc-baseurl string Prefix for URLs - leave blank for root --rc-cert string TLS PEM key (concatenation of certificate and CA certificate) --rc-client-ca string Client certificate authority to verify clients with --rc-enable-metrics Enable the Prometheus metrics path at the remote control server --rc-files string Path to local files to serve on the HTTP server --rc-htpasswd string A htpasswd file - if not provided no authentication is done --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s) --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s) --rc-key string TLS PEM Private key --rc-max-header-bytes int Maximum size of request header (default 4096) --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --rc-no-auth Don't require auth for certain methods --rc-pass string Password for authentication --rc-realm string Realm for authentication --rc-response-header stringArray Set HTTP header for all responses, overriding existing values --rc-salt string Password hashing salt (default "dlPL2MqE") --rc-serve Enable the serving of remote objects --rc-serve-no-modtime Don't read the modification time (can speed things up) --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --rc-template string User-specified template --rc-user string User name for authentication --rc-user-from-header string User name from a defined HTTP header --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-no-open-browser Don't open the browser automatically --rc-web-gui-update Check and update to latest version of web gui ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone hashsum Produces a hashsum file for all the objects in the path. ## Synopsis Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. By default, the hash is requested from the remote. If the hash is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling any hash for any remote. For the MD5 and SHA1 algorithms there are also dedicated commands, [md5sum](https://rclone.org/commands/rclone_md5sum/) and [sha1sum](https://rclone.org/commands/rclone_sha1sum/). This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path). Run without a hash to see the list of all supported hashes, e.g. ```console $ rclone hashsum Supported hashes are: - md5 - sha1 - whirlpool - crc32 - sha256 - sha512 - blake3 - xxh3 - xxh128 ``` Then ```console rclone hashsum MD5 remote:path ``` Note that hash names are case insensitive and values are output in lower case. ``` rclone hashsum [ remote:path] [flags] ``` ## Options ``` --base64 Output base64 encoded hashsum -C, --checkfile string Validate hashes against a given SUM file instead of printing them --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote -h, --help help for hashsum --output-file string Output hashsums to a file rather than the terminal ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone link Generate public link to file/folder. ## Synopsis Create, retrieve or remove a public link to the given file or folder. ```console rclone link remote:path/to/file rclone link remote:path/to/folder/ rclone link --unlink remote:path/to/folder/ rclone link --expire 1d remote:path/to/file ``` If you supply the --expire flag, it will set the expiration time otherwise it will use the default (100 years). **Note** not all backends support the --expire flag - if the backend doesn't support it then the link returned won't expire. Use the --unlink flag to remove existing public links to the file or folder. **Note** not all backends support "--unlink" flag - those that don't will just ignore it. If successful, the last line of the output will contain the link. Exact capabilities depend on the remote, but the link will always by default be created with the least constraints - e.g. no expiry, no password protection, accessible without account. ``` rclone link remote:path [flags] ``` ## Options ``` --expire Duration The amount of time that the link will be valid (default off) -h, --help help for link --unlink Remove existing public link to file/folder ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone listremotes List all the remotes in the config file and defined in environment variables. ## Synopsis Lists all the available remotes from the config file, or the remotes matching an optional filter. Prints the result in human-readable format by default, and as a simple list of remote names, or if used with flag `--long` a tabular format including the remote names, types and descriptions. Using flag `--json` produces machine-readable output instead, which always includes all attributes - including the source (file or environment). Result can be filtered by a filter argument which applies to all attributes, and/or filter flags specific for each attribute. The values must be specified according to regular rclone filtering pattern syntax. By default filtering uses non-anchored matching, so `--type box` also matches `dropbox`. Use `--exact` to match complete values only. ``` rclone listremotes [] [flags] ``` ## Options ``` --description string Filter remotes by description --exact Match filter strings exactly instead of using non-anchored glob matching -h, --help help for listremotes --json Format output as JSON --long Show type and description in addition to name --name string Filter remotes by name --order-by string Instructions on how to order the result, e.g. 'type,name=descending' --source string Filter remotes by source, e.g. 'file' or 'environment' --type string Filter remotes by type ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone lsf List directories and objects in remote:path formatted for parsing. ## Synopsis List the contents of the source path (directories and objects) to standard output in a form which is easy to parse by scripts. By default this will just be the names of the objects and directories, one per line. The directories will have a / suffix. E.g. ```console $ rclone lsf swift:bucket bevajer5jef canole diwogej7 ferejej3gux/ fubuwic ``` Use the `--format` option to control what gets listed. By default this is just the path, but you can use these parameters to control the output: ```text p - path s - size t - modification time h - hash i - ID of object o - Original ID of underlying object m - MimeType of object if known e - encrypted name T - tier of storage if known, e.g. "Hot" or "Cool" M - Metadata of object in JSON blob format, eg {"key":"value"} ``` Some backends use composite IDs. In particular, Google Drive shortcuts are normally dereferenced, and their "i" field contains the target object's ID followed by the shortcut's ID, separated by a tab. This tab is part of the ID field and is not changed by `--separator`. Use `--drive-skip-shortcuts` to omit shortcut entries. So if you wanted the path, size and modification time, you would use `--format "pst"`, or maybe `--format "tsp"` to put the path last. E.g. ```console $ rclone lsf --format "tsp" swift:bucket 2016-06-25 18:55:41;60295;bevajer5jef 2016-06-25 18:55:43;90613;canole 2016-06-25 18:55:43;94467;diwogej7 2018-04-26 08:50:45;0;ferejej3gux/ 2016-06-25 18:55:40;37600;fubuwic ``` If you specify "h" in the format you will get the MD5 hash by default, use the `--hash` flag to change which hash you want. Note that this can be returned as an empty string if it isn't available on the object (and for directories), "ERROR" if there was an error reading it from the object and "UNSUPPORTED" if that object does not support that hash type. For example, to emulate the md5sum command you can use ```console rclone lsf -R --hash MD5 --format hp --separator " " --files-only . ``` E.g. ```console $ rclone lsf -R --hash MD5 --format hp --separator " " --files-only swift:bucket 7908e352297f0f530b84a756f188baa3 bevajer5jef cd65ac234e6fea5925974a51cdd865cc canole 03b5341b4f234b9d984d03ad076bae91 diwogej7 8fd37c3810dd660778137ac3a66cc06d fubuwic 99713e14a4c4ff553acaf1930fad985b gixacuh7ku ``` (Though "rclone md5sum ." is an easier way of typing this.) By default the separator is ";" this can be changed with the `--separator` flag. Note that separators aren't escaped in the path so putting it last is a good strategy. E.g. ```console $ rclone lsf --separator "," --format "tshp" swift:bucket 2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef 2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole 2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 2018-04-26 08:52:53,0,,ferejej3gux/ 2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic ``` You can output in CSV standard format. This will escape things in " if they contain, E.g. ```console $ rclone lsf --csv --files-only --format ps remote:path test.log,22355 test.sh,449 "this file contains a comma, in the file name.txt",6 ``` Note that the `--absolute` parameter is useful for making lists of files to pass to an rclone copy with the `--files-from-raw` flag. For example, to find all the files modified within one day and copy those only (without traversing the whole directory structure): ```console rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files rclone copy --files-from-raw new_files /path/to/local remote:path ``` The default time format is `'2006-01-02 15:04:05'`. [Other formats](https://pkg.go.dev/time#pkg-constants) can be specified with the `--time-format` flag. Examples: ```console rclone lsf remote:path --format pt --time-format 'Jan 2, 2006 at 3:04pm (MST)' rclone lsf remote:path --format pt --time-format '2006-01-02 15:04:05.000000000' rclone lsf remote:path --format pt --time-format '2006-01-02T15:04:05.999999999Z07:00' rclone lsf remote:path --format pt --time-format RFC3339 rclone lsf remote:path --format pt --time-format DateOnly rclone lsf remote:path --format pt --time-format max rclone lsf remote:path --format pt --time-format unix rclone lsf remote:path --format pt --time-format unixnano ``` `--time-format max` will automatically truncate `2006-01-02 15:04:05.000000000` to the maximum precision supported by the remote. Any of the filtering options can be applied to this command. There are several related list commands - `ls` to list size and path of objects only - `lsl` to list modification time, size and path of objects only - `lsd` to list directories only - `lsf` to list objects and directories in easy to parse format - `lsjson` to list objects and directories in JSON format `ls`,`lsl`,`lsd` are designed to be human-readable. `lsf` is designed to be human and machine-readable. `lsjson` is designed to be machine-readable. Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. List commands prefer a recursive method that uses more memory but fewer transactions by default. Use `--disable ListR` to suppress the behavior. See [`--fast-list`](https://rclone.org/docs/#fast-list) for more details. Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). ``` rclone lsf remote:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --csv Output in CSV format -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --files-only Only list files -F, --format string Output format - see help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for lsf -R, --recursive Recurse into the listing -s, --separator string Separator for the items in the format (default ";") -t, --time-format string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone lsjson List directories and objects in the path in JSON format. ## Synopsis List directories and objects in the path in JSON format. The output is an array of Items, where each Item looks like this: ```json { "Hashes" : { "SHA-1" : "f572d396fae9206628714fb2ce00f72e94f2258f", "MD5" : "b1946ac92492d2347c6235b4d2611184", "DropboxHash" : "ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc" }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", "IsBucket" : false, "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file.txt", "Size" : 6, "Tier" : "hot", } ``` The exact set of properties included depends on the backend: - The property IsBucket will only be included for bucket-based remotes, and only for directories that are buckets. It will always be omitted when value is not true. - Properties Encrypted and EncryptedPath will only be included for encrypted remotes, and (as mentioned below) only if the `--encrypted` option is set. Different options may also affect which properties are included: - If `--hash` is not specified, the Hashes property will be omitted. The types of hash can be specified with the `--hash-type` parameter (which may be repeated). If `--hash-type` is set then it implies `--hash`. - If `--no-modtime` is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (e.g. s3, swift). - If `--no-mimetype` is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (e.g. s3, swift). - If `--encrypted` is not specified the Encrypted and EncryptedPath properties will be omitted - even for encrypted remotes. - If `--metadata` is set then an additional Metadata property will be returned. This will have [metadata](https://rclone.org/docs/#metadata) in rclone standard format as a JSON object. The default is to list directories and files/objects, but this can be changed with the following options: - If `--dirs-only` is specified then directories will be returned only, no files/objects. - If `--files-only` is specified then files will be returned only, no directories. If `--stat` is set then the output is not an array of items, but instead a single JSON blob will be returned about the item pointed to. This will return an error if the item isn't found, however on bucket based backends (like s3, gcs, b2, azureblob etc) if the item isn't found it will return an empty directory, as it isn't possible to tell empty directories from missing directories there. The Path field will only show folders below the remote path being listed. If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without `--recursive` the Path will always be the same as Name. The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the nearest millisecond (e.g. Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown ("2017-05-31T16:15:57+01:00"). The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written on individual lines (except with `--stat`). Any of the filtering options can be applied to this command. There are several related list commands - `ls` to list size and path of objects only - `lsl` to list modification time, size and path of objects only - `lsd` to list directories only - `lsf` to list objects and directories in easy to parse format - `lsjson` to list objects and directories in JSON format `ls`,`lsl`,`lsd` are designed to be human-readable. `lsf` is designed to be human and machine-readable. `lsjson` is designed to be machine-readable. Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. List commands prefer a recursive method that uses more memory but fewer transactions by default. Use `--disable ListR` to suppress the behavior. See [`--fast-list`](https://rclone.org/docs/#fast-list) for more details. Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). ``` rclone lsjson remote:path [flags] ``` ## Options ``` --dirs-only Show only directories in the listing --encrypted Show the encrypted names --files-only Show only files in the listing --hash Include hashes in the output (may take longer) --hash-type stringArray Show only this hash type (may be repeated) -h, --help help for lsjson -M, --metadata Add metadata to the listing --no-mimetype Don't read the mime type (can speed things up) --no-modtime Don't read the modification time (can speed things up) --original Show the ID of the underlying Object -R, --recursive Recurse into the listing --stat Just return the info for the pointed to file ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone mount Mount the remote as file system on a mountpoint. ## Synopsis Rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. First set up your remote using `rclone config`. Check it works with `rclone ls` etc. On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. Use the `--daemon` flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored. In background mode rclone acts as a generic Unix mount program: the main program starts, spawns background rclone process to setup and maintain the mount, waits until success or timeout and exits with appropriate code (killing the child process if it fails). On Linux/macOS/FreeBSD start the mount like this, where `/path/to/local/mount` is an **empty** **existing** directory: ```console rclone mount remote:path/to/files /path/to/local/mount ``` On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows) for details. If foreground mount is used interactively from a console window, rclone will serve the mount and occupy the console so another window should be used to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C. The following examples will mount to an automatically assigned drive, to specific drive letter `X:`, to path `C:\path\parent\mount` (where parent directory or drive must exist, and mount must **not** exist, and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), and the last example will mount as network share `\\cloud\remote` and map it to an automatically assigned drive: ```console rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\path\parent\mount rclone mount remote:path/to/files \\cloud\remote ``` When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped. When running in background mode the user will have to stop the mount manually: ```console # Linux fusermount -u /path/to/local/mount #... or on some systems fusermount3 -u /path/to/local/mount # OS X or Linux when using nfsmount umount /path/to/local/mount ``` The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually. The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/) command. Remotes with unlimited storage may report the used size only, then an additional 1 PiB of free space is assumed. If the remote does not [support](https://rclone.org/overview/#optional-features) the about feature at all, then 1 PiB is set as both the total and the free size. ## Installing on Windows To run `rclone mount on Windows`, you will need to download and install [WinFsp](https://winfsp.dev). [WinFsp](https://github.com/winfsp/winfsp) is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with [cgofuse](https://github.com/winfsp/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. ### Mounting modes on windows Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives. In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead. When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a **nonexistent** subdirectory of an **existing** parent directory or drive. Using the special value `*` will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples: ```console rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\path\parent\mount rclone mount remote:path/to/files X: ``` Option `--volname` can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path. To mount as network drive, you can add option `--network-mode` to your mount command. Mounting to a directory path is not supported in this mode, it is a limitation Windows imposes on junctions, so the remote must always be mounted to a drive letter. ```console rclone mount remote:path/to/files X: --network-mode ``` A volume name specified with `--volname` will be used to create the network share path. A complete UNC path, such as `\\cloud\remote`, optionally with path `\\cloud\remote\madeup\path`, will be used as is. Any other string will be used as the share part, after a default prefix `\\server\`. If no volume name is specified then `\\server\share` will be used. You must make sure the volume name is unique when you are mounting more than one drive, or else the mount command will fail. The share name will treated as the volume label for the mapped drive, shown in Windows Explorer etc, while the complete `\\server\share` will be reported as the remote UNC path by `net use` etc, just like a normal network drive mapping. If you specify a full network share UNC path with `--volname`, this will implicitly set the `--network-mode` option, so the following two examples have same result: ```console rclone mount remote:path/to/files X: --network-mode rclone mount remote:path/to/files X: --volname \\server\share ``` You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with `*` and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the `--volname` option. This will also implicitly set the `--network-mode` option. This means the following two examples have same result: ```console rclone mount remote:path/to/files \\cloud\remote rclone mount remote:path/to/files * --volname \\cloud\remote ``` There is yet another way to enable network mode, and to set the share path, and that is to pass the "native" libfuse/WinFsp option directly: `--fuse-flag --VolumePrefix=\server\share`. Note that the path must be with just a single backslash prefix in this case. *Note:* In previous versions of rclone this was the only supported method. [Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) See also [Limitations](#limitations) section below. ### Windows filesystem permissions The FUSE emulation layer on Windows must convert between the POSIX-based permission model used in FUSE, and the permission model used in Windows, based on access-control lists (ACL). The mounted filesystem will normally get three entries in its access-control list (ACL), representing permissions for the POSIX permission scopes: Owner, group and others. By default, the owner and group will be taken from the current user, and the built-in group "Everyone" will be used to represent others. The user/group can be customized with FUSE options "UserName" and "GroupName", e.g. `-o UserName=user123 -o GroupName="Authenticated Users"`. The permissions on each entry will be set according to [options](#options) `--dir-perms` and `--file-perms`, which takes a value in traditional Unix [numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation). The default permissions corresponds to `--file-perms 0666 --dir-perms 0777`, i.e. read and write permissions to everyone. This means you will not be able to start any programs from the mount. To be able to do that you must add execute permissions, e.g. `--file-perms 0777 --dir-perms 0777` to add it to everyone. If the program needs to write files, chances are you will have to enable [VFS File Caching](#vfs-file-caching) as well (see also [limitations](#limitations)). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the "write extended attributes", as explained next. The mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access for the group or others scope, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes". Windows will then show this as basic permission "Special" instead of "Write", because "Write" also covers the "write extended attributes" permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions "read attributes", "read extended attributes" and "read permissions". This is done for compatibility reasons, e.g. to allow users without additional permissions to be able to read basic metadata about files like in Unix. WinFsp 2021 (version 1.9) introduced a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using [SDDL](https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format). With this you get detailed control of the resulting permissions, compared to use of the POSIX permissions described above, and no additional permissions will be added automatically for compatibility with Unix. Some example use cases will following. If you set POSIX permissions for only allowing access to the owner, using `--file-perms 0600 --dir-perms 0700`, the user group and the built-in "Everyone" group will still be given some special permissions, as described above. Some programs may then (incorrectly) interpret this as the file being accessible by everyone, for example an SSH client may warn about "unprotected private key file". You can work around this by specifying `-o FileSecurity="D:P(A;;FA;;;OW)"`, which sets file all access (FA) to the owner (OW), and nothing else. When setting write permissions then, except for the owner, this does not include the "write extended attributes" permission, as mentioned above. This may prevent applications from writing to files, giving permission denied error instead. To set working write permissions for the built-in "Everyone" group, similar to what it gets by default but with the addition of the "write extended attributes", you can specify `-o FileSecurity="D:P(A;;FRFW;;;WD)"`, which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to `-o FileSecurity="D:P(A;;FRFWFX;;;WD)"`, or set file all access (FA) to get full access permissions, including delete, with `-o FileSecurity="D:P(A;;FA;;;WD)"`. ### Windows caveats Drives created as Administrator are not visible to other accounts, not even an account that was elevated to Administrator with the User Account Control (UAC) feature. A result of this is that if you mount to a drive letter from a Command Prompt run as Administrator, and then try to access the same drive from Windows Explorer (which does not run as Administrator), you will not be able to see the mounted drive. If you don't need to access the drive from applications running with administrative privileges, the easiest way around this is to always create the mount from a non-elevated command prompt. To make mapped drives available to the user account that created them regardless if elevated or not, there is a special Windows setting called [linked connections](https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry) that can be enabled. It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec), from Microsoft's Sysinternals suite, which has option `-s` to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the [WinFsp.Launcher infrastructure](https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)). Read more in the [install documentation](https://rclone.org/install/). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the [`--config`](https://rclone.org/docs/#config-string) option. Note also that it is now the SYSTEM account that will have the owner permissions, and other accounts will have permissions according to the group or others scopes. As mentioned above, these will then not get the "write extended attributes" permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above. Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations. ## Mounting on macOS Mounting on macOS can be done either via [built-in NFS server](https://rclone.org/commands/rclone_serve_nfs/), [macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or [FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local server. ### Unicode Normalization It is highly recommended to keep the default of `--no-unicode-normalization=false` for all `mount` and `serve` commands on macOS. For details, see [vfs-case-sensitivity](https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity). ### NFS mount This method spins up an NFS server using [serve nfs](https://rclone.org/commands/rclone_serve_nfs/) command and mounts it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to send SIGTERM signal to the rclone process using |kill| command to stop the mount. Note that `--nfs-cache-handle-limit` controls the maximum number of cached file handles stored by the `nfsmount` caching handler. This should not be set too low or you may experience errors when trying to access files. The default is 1000000, but consider lowering this limit if the server's system resource usage causes problems. ### macFUSE Notes If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from the website, rclone will locate the macFUSE libraries without any further intervention. If however, macFUSE is installed using the [macports](https://www.macports.org/) package manager, the following addition steps are required. ```console sudo mkdir /usr/local/lib cd /usr/local/lib sudo ln -s /opt/local/lib/libfuse.2.dylib ``` ### FUSE-T Limitations, Caveats, and Notes There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14. #### ModTime update on read As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats): > File access and modification times cannot be set separately as it seems to be > an issue with the NFS client which always modifies both. Can be reproduced > with `touch -m` and `touch -a` commands This means that viewing files with various tools, notably macOS Finder, will cause rlcone to update the modification time of the file. This may make rclone upload a full new copy of the file. #### Read Only mounts When mounting with `--read-only`, attempts to write to files will fail *silently* as opposed to with a clear warning as in macFUSE. ## Mounting on Linux On newer versions of Ubuntu, you may encounter the following error when running `rclone mount`: > NOTICE: mount helper error: fusermount3: mount failed: Permission denied > CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1 This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions, which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to `sudo apt install apparmor-utils` beforehand). ## Mounting on OpenBSD `rclone nfsmount` works on OpenBSD by spinning up the [serve nfs](https://rclone.org/commands/rclone_serve_nfs/) server and mounting it with the system `mount_nfs(8)`, the same approach used for the NFS mount method on macOS. There is no FUSE-based mount option on OpenBSD, so `nfsmount` is the only way to mount rclone remotes as a local file system there. ### portmap registration OpenBSD's kernel NFS client locates `mountd` through the system portmapper rather than connecting to a fixed port, so rclone's in-process NFS server needs to be registered with portmap before it can be mounted. Start the `serve nfs` server on a fixed port, stop the system NFS services so they don't conflict with it, then register that port with portmap for both the `nfs` and `mountd` RPC programs (this is the recipe from [hjicks in #8578](https://github.com/rclone/rclone/issues/8578#issuecomment-2799229652)): ```console rclone serve nfs --addr localhost: remote:path doas rcctl stop nfsd portmap doas pkill -9 mountd # mountd can't be stopped via rcctl(8) doas rcctl -f start portmap doas rpcinfo -s nfs 3 doas rpcinfo -s mountd 3 ``` Replace `` with the port passed to `--addr`. Port 2049 works too, but needs either running rclone as root or adjusting `sysctl(8)` at securelevel 0, so a non-privileged port is simpler for testing. ### Use `mount_nfs -T`, not `mount` Mount the exported NFS share directly with `mount_nfs(8)` using the `-T` flag to force TCP, rather than the generic `mount(8)` wrapper - OpenBSD's `mount(8)` does not understand `-T` and rejects it with `unknown option -- T`: ```console mount_nfs -T localhost:/ /path/to/local/mount ``` `rclone nfsmount` does this for you automatically on OpenBSD (it calls `mount_nfs` directly with `-T` instead of going through `mount`), so this is only needed if you are mounting the `serve nfs` export by hand. ### AUTH_UNIX and existing limitations OpenBSD's (and the other BSDs') kernel NFS client requires the server to offer the `AUTH_UNIX` authentication flavor during the MOUNT RPC handshake; a server that only offers `AUTH_NULL` is rejected with `mount_nfs: can't access /: Authentication error`. rclone's NFS server advertises `AUTH_UNIX` for this reason, though it does not implement any per-user access control on top of it - see [issue #8578](https://github.com/rclone/rclone/issues/8578) for the background on this and for the current state of OpenBSD support. ## Limitations Without the use of `--vfs-cache-mode` this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without `--vfs-cache-mode writes` or `--vfs-cache-mode full`. See the [VFS File Caching](#vfs-file-caching) section for more info. When using NFS mount on macOS, if you don't specify |--vfs-cache-mode| the mount point will be read-only. Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage and B2 - can't store empty directories. Of these, only Azure Blob, Google Cloud Storage and S3 can preserve them when you add `--xxx-directory_markers`; otherwise, empty directories will vanish once they drop out of the directory cache. When `rclone mount` is invoked on Unix with `--daemon` flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the `--daemon-wait` flag. On Linux it can check mount status using ProcFS so the flag in fact sets **maximum** time to wait, while the real wait can be less. On macOS / BSD the time to wait is constant and the check is performed only at the end. We advise you to set wait time on macOS reasonably. Only supported on Linux, FreeBSD, OS X and Windows at the moment. ## rclone mount vs rclone sync/copy File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the [VFS File Caching](#vfs-file-caching) for solutions to make mount more reliable. ## Attribute caching You can use the flag `--attr-timeout` to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries. The default is `1s` which caches files just long enough to avoid too many callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as [rclone using too much memory](https://github.com/rclone/rclone/issues/2157), [rclone not serving files to samba](https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112) and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). The kernel can cache the info about a file for the time given by `--attr-timeout`. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With `--attr-timeout 1s` this is very unlikely but not impossible. The higher you set `--attr-timeout` the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above. If you set it higher (`10s` or `1m` say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above. If files don't change on the remote outside of the control of rclone then there is no chance of corruption. This is the same as setting the attr_timeout option in mount.fuse. ## Filters Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. ## systemd When running rclone mount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode. Note that systemd runs mount units without any environment variables including `PATH` or `HOME`. This means that tilde (`~`) expansion will not work and you should provide `--config` and `--cache-dir` explicitly as absolute paths via rclone arguments. Since mounting requires the `fusermount` or `fusermount3` program, rclone will use the fallback PATH of `/bin:/usr/bin` in this scenario. Please ensure that `fusermount`/`fusermount3` is present on this PATH. ## Rclone as Unix mount helper The core Unix program `/bin/mount` normally takes the `-t FSTYPE` argument then runs the `/sbin/mount.FSTYPE` helper program passing it mount options as `-o key=val,...` or `--opt=...`. Automount (classic or systemd) behaves in a similar way. rclone by default expects GNU-style flags `--key val`. To run it as a mount helper you should symlink rclone binary to `/sbin/mount.rclone` and optionally `/usr/bin/rclonefs`, e.g. `ln -s /usr/bin/rclone /sbin/mount.rclone`. rclone will detect it and translate command-line arguments appropriately. Now you can run classic mounts like this: ```console mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem ``` or create systemd mount units: ```ini # /etc/systemd/system/mnt-data.mount [Unit] Description=Mount for /mnt/data [Mount] Type=rclone What=sftp1:subdir Where=/mnt/data Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone ``` optionally accompanied by systemd automount unit ```ini # /etc/systemd/system/mnt-data.automount [Unit] Description=AutoMount for /mnt/data [Automount] Where=/mnt/data TimeoutIdleSec=600 [Install] WantedBy=multi-user.target ``` or add in `/etc/fstab` a line like ```console sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0 ``` or use classic Automountd. Remember to provide explicit `config=...,cache-dir=...` as a workaround for mount units being run without `HOME`. Rclone in the mount helper mode will split `-o` argument(s) by comma, replace `_` by `-` and prepend `--` to get the command-line flags. Options containing commas or spaces can be wrapped in single or double quotes. Any inner quotes inside outer quotes of the same type should be doubled. Mount option syntax includes a few extra options treated specially: - `env.NAME=VALUE` will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don't allow setting custom environment for mount helpers. Typically you will use `env.HTTPS_PROXY=proxy.host:3128` or `env.HOME=/root` - `command=cmount` can be used to run `cmount` or any other rclone command rather than the default `mount`. - `args2env` will pass mount options to the mount helper running in background via environment variables instead of command line arguments. This allows to hide secrets from such commands as `ps` or `pgrep`. - `vv...` will be transformed into appropriate `--verbose=N` - standard mount options like `x-systemd.automount`, `_netdev`, `nosuid` and alike are intended only for Automountd and ignored by rclone. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone mount remote:path /path/to/mountpoint [flags] ``` ## Options ``` --allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only) --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) --allow-other Allow access to other users (not supported on Windows) --allow-root Allow access to root user (not supported on Windows) --async-read Use asynchronous reads (not supported on Windows) (default true) --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) --debug-fuse Debug the FUSE internals - needs -v --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) --devname string Set the device name - default is remote:path --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --direct-io Use Direct IO, disables caching of data --file-perms FileMode File permissions (default 666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for mount --link-perms FileMode Link permissions (default 666) --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) --volname string Set the volume name (supported on Windows and OSX only) --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone moveto Move file or directory from source to dest. ## Synopsis If source:path is a file or directory then it moves it to a file or directory named dest:path. This can be used to rename files or upload single files to other than their existing name. If the source is a directory then it acts exactly like the [move](https://rclone.org/commands/rclone_move/) command. So ```console rclone moveto src dst ``` where src and dst are rclone paths, either remote:path or /path/to/local or C:\windows\path\if\on\windows. This will: ```text if src is file move it to dst, overwriting an existing file if it exists if src is directory move it to dst, overwriting existing files if they exist see move command for full details ``` This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. src will be deleted on successful transfer. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics. ## Logger Flags The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are present on both the source and destination but different. The `--combined` flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files. - `= path` means path was found in source and destination and was identical - `- path` means path was missing on the source, so only in the destination - `+ path` means path was missing on the destination, so only in the source - `* path` means path was present in source and destination but different. - `! path` means there was an error reading or hashing the source or dest. The `--dest-after` flag writes a list file using the same format flags as [`lsf`](https://rclone.org/commands/rclone_lsf/#synopsis) (including [customizable options for hash, modtime, etc.](https://rclone.org/commands/rclone_lsf/#synopsis)) Conceptually it is similar to rsync's `--itemize-changes`, but not identical -- it should output an accurate list of what will be on the destination after the command is finished. When the `--no-traverse` flag is set, all logs involving files that exist only on the destination will be incomplete or completely missing. Note that these logger flags have a few limitations, and certain scenarios are not currently supported: - `--max-duration` / `CutoffModeHard` - `--compare-dest` / `--copy-dest` - server-side moves of an entire dir at once - High-level retries, because there would be duplicates (use `--retries 1` to disable) - Possibly some unusual error scenarios Note also that each file is logged during execution, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID). ``` rclone moveto source:path dest:path [flags] ``` ## Options ``` --absolute Put a leading / in front of path names --combined string Make a combined report of changes to this file --csv Output in CSV format --dest-after string Report all files that exist on the dest post-sync --differ string Report all non-matching files to this file -d, --dir-slash Append a slash to directory names (default true) --dirs-only Only list directories --error string Report all files with errors (hashing or reading) to this file --files-only Only list files (default true) -F, --format string Output format - see lsf help for details (default "p") --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") -h, --help help for moveto --match string Report all matching files to this file --missing-on-dst string Report all files missing from the destination to this file --missing-on-src string Report all files missing from the source to this file -s, --separator string Separator for the items in the format (default ";") -t, --timeformat string Specify a custom time format - see docs for details (default: 2006-01-02 15:04:05) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Copy Options Flags for anything which can copy a file ```text --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone ncdu Explore a remote with a text based user interface. ## Synopsis This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?". To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along. You can interact with the user interface using key presses, press '?' to toggle the help on and off. The supported keys are: ```text ↑,↓ or k,j to Move →,l to enter ←,h to return g toggle graph c toggle counts a toggle average size in directory m toggle modified time u toggle human-readable format n,s,C,A,M sort by name,size,count,asize,mtime d delete file/directory v select file/directory V enter visual select mode D delete selected files/directories y copy current path to clipboard Y display current path ^L refresh screen (fix screen corruption) r recalculate file sizes ? to toggle help on and off ESC to close the menu box q/^c to quit ``` Listed files/directories may be prefixed by a one-character flag, some of them combined with a description in brackets at end of line. These flags have the following meaning: ```text e means this is an empty directory, i.e. contains no files (but may contain empty subdirectories) ~ means this is a directory where some of the files (possibly in subdirectories) have unknown size, and therefore the directory size may be underestimated (and average size inaccurate, as it is average of the files with known sizes). . means an error occurred while reading a subdirectory, and therefore the directory size may be underestimated (and average size inaccurate) ! means an error occurred while reading this directory ``` This an homage to the [ncdu tool](https://dev.yorhel.nl/ncdu) but for rclone remotes. It is missing lots of features at the moment but is useful as it stands. Unlike ncdu it does not show excluded files. Note that it might take some time to delete big files/directories. The UI won't respond in the meantime since the deletion is done synchronously. For a non-interactive listing of the remote, see the [tree](https://rclone.org/commands/rclone_tree/) command. To just get the total size of the remote you can also use the [size](https://rclone.org/commands/rclone_size/) command. ``` rclone ncdu remote:path [flags] ``` ## Options ``` -h, --help help for ncdu ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone nfsmount Mount the remote as file system on a mountpoint. ## Synopsis Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. First set up your remote using `rclone config`. Check it works with `rclone ls` etc. On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. Use the `--daemon` flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored. In background mode rclone acts as a generic Unix mount program: the main program starts, spawns background rclone process to setup and maintain the mount, waits until success or timeout and exits with appropriate code (killing the child process if it fails). On Linux/macOS/FreeBSD start the mount like this, where `/path/to/local/mount` is an **empty** **existing** directory: ```console rclone nfsmount remote:path/to/files /path/to/local/mount ``` On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows) for details. If foreground mount is used interactively from a console window, rclone will serve the mount and occupy the console so another window should be used to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C. The following examples will mount to an automatically assigned drive, to specific drive letter `X:`, to path `C:\path\parent\mount` (where parent directory or drive must exist, and mount must **not** exist, and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), and the last example will mount as network share `\\cloud\remote` and map it to an automatically assigned drive: ```console rclone nfsmount remote:path/to/files * rclone nfsmount remote:path/to/files X: rclone nfsmount remote:path/to/files C:\path\parent\mount rclone nfsmount remote:path/to/files \\cloud\remote ``` When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped. When running in background mode the user will have to stop the mount manually: ```console # Linux fusermount -u /path/to/local/mount #... or on some systems fusermount3 -u /path/to/local/mount # OS X or Linux when using nfsmount umount /path/to/local/mount ``` The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually. The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/) command. Remotes with unlimited storage may report the used size only, then an additional 1 PiB of free space is assumed. If the remote does not [support](https://rclone.org/overview/#optional-features) the about feature at all, then 1 PiB is set as both the total and the free size. ## Installing on Windows To run `rclone nfsmount on Windows`, you will need to download and install [WinFsp](https://winfsp.dev). [WinFsp](https://github.com/winfsp/winfsp) is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with [cgofuse](https://github.com/winfsp/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone nfsmount for Windows. ### Mounting modes on windows Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives. In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead. When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a **nonexistent** subdirectory of an **existing** parent directory or drive. Using the special value `*` will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples: ```console rclone nfsmount remote:path/to/files * rclone nfsmount remote:path/to/files X: rclone nfsmount remote:path/to/files C:\path\parent\mount rclone nfsmount remote:path/to/files X: ``` Option `--volname` can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path. To mount as network drive, you can add option `--network-mode` to your nfsmount command. Mounting to a directory path is not supported in this mode, it is a limitation Windows imposes on junctions, so the remote must always be mounted to a drive letter. ```console rclone nfsmount remote:path/to/files X: --network-mode ``` A volume name specified with `--volname` will be used to create the network share path. A complete UNC path, such as `\\cloud\remote`, optionally with path `\\cloud\remote\madeup\path`, will be used as is. Any other string will be used as the share part, after a default prefix `\\server\`. If no volume name is specified then `\\server\share` will be used. You must make sure the volume name is unique when you are mounting more than one drive, or else the mount command will fail. The share name will treated as the volume label for the mapped drive, shown in Windows Explorer etc, while the complete `\\server\share` will be reported as the remote UNC path by `net use` etc, just like a normal network drive mapping. If you specify a full network share UNC path with `--volname`, this will implicitly set the `--network-mode` option, so the following two examples have same result: ```console rclone nfsmount remote:path/to/files X: --network-mode rclone nfsmount remote:path/to/files X: --volname \\server\share ``` You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with `*` and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the `--volname` option. This will also implicitly set the `--network-mode` option. This means the following two examples have same result: ```console rclone nfsmount remote:path/to/files \\cloud\remote rclone nfsmount remote:path/to/files * --volname \\cloud\remote ``` There is yet another way to enable network mode, and to set the share path, and that is to pass the "native" libfuse/WinFsp option directly: `--fuse-flag --VolumePrefix=\server\share`. Note that the path must be with just a single backslash prefix in this case. *Note:* In previous versions of rclone this was the only supported method. [Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) See also [Limitations](#limitations) section below. ### Windows filesystem permissions The FUSE emulation layer on Windows must convert between the POSIX-based permission model used in FUSE, and the permission model used in Windows, based on access-control lists (ACL). The mounted filesystem will normally get three entries in its access-control list (ACL), representing permissions for the POSIX permission scopes: Owner, group and others. By default, the owner and group will be taken from the current user, and the built-in group "Everyone" will be used to represent others. The user/group can be customized with FUSE options "UserName" and "GroupName", e.g. `-o UserName=user123 -o GroupName="Authenticated Users"`. The permissions on each entry will be set according to [options](#options) `--dir-perms` and `--file-perms`, which takes a value in traditional Unix [numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation). The default permissions corresponds to `--file-perms 0666 --dir-perms 0777`, i.e. read and write permissions to everyone. This means you will not be able to start any programs from the mount. To be able to do that you must add execute permissions, e.g. `--file-perms 0777 --dir-perms 0777` to add it to everyone. If the program needs to write files, chances are you will have to enable [VFS File Caching](#vfs-file-caching) as well (see also [limitations](#limitations)). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the "write extended attributes", as explained next. The mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access for the group or others scope, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes". Windows will then show this as basic permission "Special" instead of "Write", because "Write" also covers the "write extended attributes" permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions "read attributes", "read extended attributes" and "read permissions". This is done for compatibility reasons, e.g. to allow users without additional permissions to be able to read basic metadata about files like in Unix. WinFsp 2021 (version 1.9) introduced a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using [SDDL](https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format). With this you get detailed control of the resulting permissions, compared to use of the POSIX permissions described above, and no additional permissions will be added automatically for compatibility with Unix. Some example use cases will following. If you set POSIX permissions for only allowing access to the owner, using `--file-perms 0600 --dir-perms 0700`, the user group and the built-in "Everyone" group will still be given some special permissions, as described above. Some programs may then (incorrectly) interpret this as the file being accessible by everyone, for example an SSH client may warn about "unprotected private key file". You can work around this by specifying `-o FileSecurity="D:P(A;;FA;;;OW)"`, which sets file all access (FA) to the owner (OW), and nothing else. When setting write permissions then, except for the owner, this does not include the "write extended attributes" permission, as mentioned above. This may prevent applications from writing to files, giving permission denied error instead. To set working write permissions for the built-in "Everyone" group, similar to what it gets by default but with the addition of the "write extended attributes", you can specify `-o FileSecurity="D:P(A;;FRFW;;;WD)"`, which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to `-o FileSecurity="D:P(A;;FRFWFX;;;WD)"`, or set file all access (FA) to get full access permissions, including delete, with `-o FileSecurity="D:P(A;;FA;;;WD)"`. ### Windows caveats Drives created as Administrator are not visible to other accounts, not even an account that was elevated to Administrator with the User Account Control (UAC) feature. A result of this is that if you mount to a drive letter from a Command Prompt run as Administrator, and then try to access the same drive from Windows Explorer (which does not run as Administrator), you will not be able to see the mounted drive. If you don't need to access the drive from applications running with administrative privileges, the easiest way around this is to always create the mount from a non-elevated command prompt. To make mapped drives available to the user account that created them regardless if elevated or not, there is a special Windows setting called [linked connections](https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry) that can be enabled. It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec), from Microsoft's Sysinternals suite, which has option `-s` to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the [WinFsp.Launcher infrastructure](https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)). Read more in the [install documentation](https://rclone.org/install/). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the [`--config`](https://rclone.org/docs/#config-string) option. Note also that it is now the SYSTEM account that will have the owner permissions, and other accounts will have permissions according to the group or others scopes. As mentioned above, these will then not get the "write extended attributes" permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above. Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations. ## Mounting on macOS Mounting on macOS can be done either via [built-in NFS server](https://rclone.org/commands/rclone_serve_nfs/), [macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or [FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local server. ### Unicode Normalization It is highly recommended to keep the default of `--no-unicode-normalization=false` for all `mount` and `serve` commands on macOS. For details, see [vfs-case-sensitivity](https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity). ### NFS mount This method spins up an NFS server using [serve nfs](https://rclone.org/commands/rclone_serve_nfs/) command and mounts it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to send SIGTERM signal to the rclone process using |kill| command to stop the mount. Note that `--nfs-cache-handle-limit` controls the maximum number of cached file handles stored by the `nfsmount` caching handler. This should not be set too low or you may experience errors when trying to access files. The default is 1000000, but consider lowering this limit if the server's system resource usage causes problems. ### macFUSE Notes If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from the website, rclone will locate the macFUSE libraries without any further intervention. If however, macFUSE is installed using the [macports](https://www.macports.org/) package manager, the following addition steps are required. ```console sudo mkdir /usr/local/lib cd /usr/local/lib sudo ln -s /opt/local/lib/libfuse.2.dylib ``` ### FUSE-T Limitations, Caveats, and Notes There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14. #### ModTime update on read As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats): > File access and modification times cannot be set separately as it seems to be > an issue with the NFS client which always modifies both. Can be reproduced > with `touch -m` and `touch -a` commands This means that viewing files with various tools, notably macOS Finder, will cause rlcone to update the modification time of the file. This may make rclone upload a full new copy of the file. #### Read Only mounts When mounting with `--read-only`, attempts to write to files will fail *silently* as opposed to with a clear warning as in macFUSE. ## Mounting on Linux On newer versions of Ubuntu, you may encounter the following error when running `rclone mount`: > NOTICE: mount helper error: fusermount3: mount failed: Permission denied > CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1 This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions, which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to `sudo apt install apparmor-utils` beforehand). ## Mounting on OpenBSD `rclone nfsmount` works on OpenBSD by spinning up the [serve nfs](https://rclone.org/commands/rclone_serve_nfs/) server and mounting it with the system `mount_nfs(8)`, the same approach used for the NFS mount method on macOS. There is no FUSE-based mount option on OpenBSD, so `nfsmount` is the only way to mount rclone remotes as a local file system there. ### portmap registration OpenBSD's kernel NFS client locates `mountd` through the system portmapper rather than connecting to a fixed port, so rclone's in-process NFS server needs to be registered with portmap before it can be mounted. Start the `serve nfs` server on a fixed port, stop the system NFS services so they don't conflict with it, then register that port with portmap for both the `nfs` and `mountd` RPC programs (this is the recipe from [hjicks in #8578](https://github.com/rclone/rclone/issues/8578#issuecomment-2799229652)): ```console rclone serve nfs --addr localhost: remote:path doas rcctl stop nfsd portmap doas pkill -9 mountd # mountd can't be stopped via rcctl(8) doas rcctl -f start portmap doas rpcinfo -s nfs 3 doas rpcinfo -s mountd 3 ``` Replace `` with the port passed to `--addr`. Port 2049 works too, but needs either running rclone as root or adjusting `sysctl(8)` at securelevel 0, so a non-privileged port is simpler for testing. ### Use `mount_nfs -T`, not `mount` Mount the exported NFS share directly with `mount_nfs(8)` using the `-T` flag to force TCP, rather than the generic `mount(8)` wrapper - OpenBSD's `mount(8)` does not understand `-T` and rejects it with `unknown option -- T`: ```console mount_nfs -T localhost:/ /path/to/local/mount ``` `rclone nfsmount` does this for you automatically on OpenBSD (it calls `mount_nfs` directly with `-T` instead of going through `mount`), so this is only needed if you are mounting the `serve nfs` export by hand. ### AUTH_UNIX and existing limitations OpenBSD's (and the other BSDs') kernel NFS client requires the server to offer the `AUTH_UNIX` authentication flavor during the MOUNT RPC handshake; a server that only offers `AUTH_NULL` is rejected with `mount_nfs: can't access /: Authentication error`. rclone's NFS server advertises `AUTH_UNIX` for this reason, though it does not implement any per-user access control on top of it - see [issue #8578](https://github.com/rclone/rclone/issues/8578) for the background on this and for the current state of OpenBSD support. ## Limitations Without the use of `--vfs-cache-mode` this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without `--vfs-cache-mode writes` or `--vfs-cache-mode full`. See the [VFS File Caching](#vfs-file-caching) section for more info. When using NFS mount on macOS, if you don't specify |--vfs-cache-mode| the mount point will be read-only. Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage and B2 - can't store empty directories. Of these, only Azure Blob, Google Cloud Storage and S3 can preserve them when you add `--xxx-directory_markers`; otherwise, empty directories will vanish once they drop out of the directory cache. When `rclone mount` is invoked on Unix with `--daemon` flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the `--daemon-wait` flag. On Linux it can check mount status using ProcFS so the flag in fact sets **maximum** time to wait, while the real wait can be less. On macOS / BSD the time to wait is constant and the check is performed only at the end. We advise you to set wait time on macOS reasonably. Only supported on Linux, FreeBSD, OS X and Windows at the moment. ## rclone nfsmount vs rclone sync/copy File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone nfsmount can't use retries in the same way without making local copies of the uploads. Look at the [VFS File Caching](#vfs-file-caching) for solutions to make nfsmount more reliable. ## Attribute caching You can use the flag `--attr-timeout` to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries. The default is `1s` which caches files just long enough to avoid too many callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as [rclone using too much memory](https://github.com/rclone/rclone/issues/2157), [rclone not serving files to samba](https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112) and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). The kernel can cache the info about a file for the time given by `--attr-timeout`. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With `--attr-timeout 1s` this is very unlikely but not impossible. The higher you set `--attr-timeout` the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above. If you set it higher (`10s` or `1m` say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above. If files don't change on the remote outside of the control of rclone then there is no chance of corruption. This is the same as setting the attr_timeout option in mount.fuse. ## Filters Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. ## systemd When running rclone nfsmount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone nfsmount service specified as a requirement will see all files and folders immediately in this mode. Note that systemd runs mount units without any environment variables including `PATH` or `HOME`. This means that tilde (`~`) expansion will not work and you should provide `--config` and `--cache-dir` explicitly as absolute paths via rclone arguments. Since mounting requires the `fusermount` or `fusermount3` program, rclone will use the fallback PATH of `/bin:/usr/bin` in this scenario. Please ensure that `fusermount`/`fusermount3` is present on this PATH. ## Rclone as Unix mount helper The core Unix program `/bin/mount` normally takes the `-t FSTYPE` argument then runs the `/sbin/mount.FSTYPE` helper program passing it mount options as `-o key=val,...` or `--opt=...`. Automount (classic or systemd) behaves in a similar way. rclone by default expects GNU-style flags `--key val`. To run it as a mount helper you should symlink rclone binary to `/sbin/mount.rclone` and optionally `/usr/bin/rclonefs`, e.g. `ln -s /usr/bin/rclone /sbin/mount.rclone`. rclone will detect it and translate command-line arguments appropriately. Now you can run classic mounts like this: ```console mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem ``` or create systemd mount units: ```ini # /etc/systemd/system/mnt-data.mount [Unit] Description=Mount for /mnt/data [Mount] Type=rclone What=sftp1:subdir Where=/mnt/data Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone ``` optionally accompanied by systemd automount unit ```ini # /etc/systemd/system/mnt-data.automount [Unit] Description=AutoMount for /mnt/data [Automount] Where=/mnt/data TimeoutIdleSec=600 [Install] WantedBy=multi-user.target ``` or add in `/etc/fstab` a line like ```console sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0 ``` or use classic Automountd. Remember to provide explicit `config=...,cache-dir=...` as a workaround for mount units being run without `HOME`. Rclone in the mount helper mode will split `-o` argument(s) by comma, replace `_` by `-` and prepend `--` to get the command-line flags. Options containing commas or spaces can be wrapped in single or double quotes. Any inner quotes inside outer quotes of the same type should be doubled. Mount option syntax includes a few extra options treated specially: - `env.NAME=VALUE` will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don't allow setting custom environment for mount helpers. Typically you will use `env.HTTPS_PROXY=proxy.host:3128` or `env.HOME=/root` - `command=cmount` can be used to run `cmount` or any other rclone command rather than the default `mount`. - `args2env` will pass mount options to the mount helper running in background via environment variables instead of command line arguments. This allows to hide secrets from such commands as `ps` or `pgrep`. - `vv...` will be transformed into appropriate `--verbose=N` - standard mount options like `x-systemd.automount`, `_netdev`, `nosuid` and alike are intended only for Automountd and ignored by rclone. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone nfsmount remote:path /path/to/mountpoint [flags] ``` ## Options ``` --addr string IPaddress:Port or :Port to bind server to --allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only) --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) --allow-other Allow access to other users (not supported on Windows) --allow-root Allow access to root user (not supported on Windows) --async-read Use asynchronous reads (not supported on Windows) (default true) --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) --debug-fuse Debug the FUSE internals - needs -v --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) --devname string Set the device name - default is remote:path --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --direct-io Use Direct IO, disables caching of data --file-perms FileMode File permissions (default 666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for nfsmount --link-perms FileMode Link permissions (default 666) --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) --nfs-cache-dir string The directory the NFS handle cache will use if set --nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000) --nfs-cache-type memory|disk|symlink Type of NFS handle cache to use (default memory) --nfs-mount-path string Subpath of the remote to mount via NFS (must be an existing directory). (default "/") --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --sudo Use sudo to run the mount/umount commands as root. --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) --volname string Set the volume name (supported on Windows and OSX only) --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone obscure Obscure password for use in the rclone config file. ## Synopsis In the rclone config file, human-readable passwords are obscured. Obscuring them is done by encrypting them and writing them out in base64. This is **not** a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent "eyedropping" - namely someone seeing a password in the rclone config file by accident. Many equally important things (like access tokens) are not obscured in the config file. However it is very hard to shoulder surf a 64 character hex token. This command can also accept a password through STDIN instead of an argument by passing a hyphen as an argument. This will use the first line of STDIN as the password not including the trailing newline. ```console echo 'secretpassword' | rclone obscure - ``` If there is no data on STDIN to read, rclone obscure will default to obfuscating the hyphen itself. If you want to encrypt the config file then please use config file encryption - see [rclone config](https://rclone.org/commands/rclone_config/) for more info. ``` rclone obscure password [flags] ``` ## Options ``` -h, --help help for obscure ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone rc Run a command against a running rclone. ## Synopsis This runs a command against a running rclone. Use the `--url` flag to specify an non default URL to connect on. This can be either a ":port" which is taken to mean or a "host:port" which is taken to mean . A username and password can be passed in with `--user` and `--pass`. Note that `--rc-addr`, `--rc-user`, `--rc-pass` will be read also for `--url`, `--user`, `--pass`. The `--unix-socket` flag can be used to connect over a unix socket like this ```sh # start server on /tmp/my.socket rclone rcd --rc-addr unix:///tmp/my.socket # Connect to it rclone rc --unix-socket /tmp/my.socket core/stats ``` Arguments should be passed in as parameter=value. The result will be returned as a JSON object by default. The `--json` parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values. The `-o`/`--opt` option can be used to set a key "opt" with key, value options in the form `-o key=value` or `-o key`. It can be repeated as many times as required. This is useful for rc commands which take the "opt" parameter which by convention is a dictionary of strings. ```text -o key=value -o key2 ``` Will place this in the "opt" value ```json {"key":"value", "key2","") ``` The `-a`/`--arg` option can be used to set strings in the "arg" value. It can be repeated as many times as required. This is useful for rc commands which take the "arg" parameter which by convention is a list of strings. ```text -a value -a value2 ``` Will place this in the "arg" value ```json ["value", "value2"] ``` Use `--loopback` to connect to the rclone instance running `rclone rc`. This is very useful for testing commands without having to run an rclone rc server, e.g.: ```sh rclone rc --loopback operations/about fs=/ ``` Use `rclone rc` to see a list of all possible commands. ``` rclone rc commands parameter [flags] ``` ## Options ``` -a, --arg stringArray Argument placed in the "arg" array -h, --help help for rc --json string Input JSON - use instead of key=value args --loopback If set connect to this rclone instance not via HTTP --no-output If set, don't output the JSON result -o, --opt stringArray Option in the form name=value or name placed in the "opt" array --pass string Password to use to connect to rclone remote control --unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly --url string URL to connect to rclone remote control (default "http://localhost:5572/") --user string Username to use to rclone remote control ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone rcat Copies standard input to file on remote. ## Synopsis Reads from standard input (stdin) and copies it to a single remote file. ```console echo "hello world" | rclone rcat remote:path/to/file ffmpeg - | rclone rcat remote:path/to/file ``` If the remote file already exists, it will be overwritten. rcat will try to upload small files in a single request, which is usually more efficient than the streaming/chunked upload endpoints, which use multiple requests. Exact behaviour depends on the remote. What is considered a small file may be set through `--streaming-upload-cutoff`. Uploading only starts after the cutoff is reached or if the file ends before that. The data must fit into RAM. The cutoff needs to be small enough to adhere the limits of your remote, please see there. Generally speaking, setting this cutoff too high will decrease your performance. Use the `--size` flag to preallocate the file in advance at the remote end and actually stream it, even if remote backend doesn't support streaming. `--size` should be the exact size of the input stream in bytes. If the size of the stream is different in length to the `--size` passed in then the transfer will likely fail. Note that the upload cannot be retried because the data is not stored. If the backend supports multipart uploading then individual chunks can be retried. If you need to transfer a lot of data, you may be better off caching it locally and then `rclone move` it to the destination which can use retries. ``` rclone rcat remote:path [flags] ``` ## Options ``` -h, --help help for rcat --size int File size hint to preallocate (default -1) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone rcd Run rclone listening to remote control commands only. ## Synopsis This runs rclone so that it only listens to remote control commands. This is useful if you are controlling rclone via the rc API. If you pass in a path to a directory, rclone will serve that directory for GET requests on the URL passed in. It will also open the URL in the browser when rclone is run. See the [rc documentation](https://rclone.org/rc/) for more info on the rc flags. ## Server options Use `--rc-addr` to specify which IP address and port the server should listen on, eg `--rc-addr 1.2.3.4:8000` or `--rc-addr :8080` to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set `--rc-addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name. `--rc-addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. `--rc-server-read-timeout` and `--rc-server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer. `--rc-max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header. `--rc-response-header` can be used to set an HTTP header for all responses, will overriding existing values. The flag may be repeated to add multiple headers. Use the format `Header-Name: value`. `--rc-baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--rc-baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--rc-baseurl`, so `--rc-baseurl "rclone"`, `--rc-baseurl "/rclone"` and `--rc-baseurl "/rclone/"` are all treated identically. `--rc-disable-zip` may be set to disable the zipping download option. ### Protocol The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing HTTP/2 without encryption. ### TLS (SSL) By default this will serve over http. If you want you can serve over https. You will need to supply the `--rc-cert` and `--rc-key` flags. If you wish to do client side certificate validation then you will need to supply `--rc-client-ca` also. When TLS is configured every listener given with `--rc-addr` serves TLS. An individual listener can be prefixed with `http://` to serve unencrypted HTTP on that address, or with `tls://` to state explicitly that it must serve TLS. Using a `tls://` address without `--rc-cert` and `--rc-key` is an error. `--rc-cert` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--rc-key` must be set to the path of a file with the PEM encoded private key. If setting `--rc-client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates. `--rc-min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## Socket activation Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--rc-addr`). This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command ```console systemd-socket-activate -l 8000 -- rclone serve ``` This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template `--rc-template` allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages: | Parameter | Subparameter | Description | | :---------- | :----------- | :---------- | | .Name | | The full path of a file/directory. | | .Title | | Directory listing of '.Name'. | | .Sort | | The current sort used. This is changeable via '?sort=' parameter. Possible values: namedirfirst, name, size, time (default namedirfirst). | | .Order | | The current ordering used. This is changeable via '?order=' parameter. Possible values: asc, desc (default asc). | | .Query | | Currently unused. | | .Breadcrumb | | Allows for creating a relative navigation. | | | .Link | The link of the Text relative to the root. | | | .Text | The Name of the directory. | | .Entries | | Information about a specific file/directory. | | | .URL | The url of an entry. | | | .Leaf | Currently same as '.URL' but intended to be just the name. | | | .IsDir | Boolean for if an entry is a directory or not. | | | .Size | Size in bytes of the entry. | | | .ModTime | The UTC timestamp of an entry. | The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions. | Function | Description | | :---------- | :---------- | | afterEpoch | Returns the time since the epoch for the given time. | | contains | Checks whether a given substring is present or not in a given string. | | hasPrefix | Checks whether the given string begins with the specified prefix. | | hasSuffix | Checks whether the given string end with the specified suffix. | ### Authentication By default this will serve files without needing a login. You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--rc-user` and `--rc-pass` flags. Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured header with `--user-from-header` (e.g., `--rc-user-from-header=x-remote-user`). Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration may lead to unauthorized access. If either of the above authentication methods is not configured and client certificates are required by the `--client-ca` flag passed to the server, the client certificate common name will be considered as the username. Use `--rc-htpasswd /path/to/htpasswd` to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. To create an htpasswd file: ```console touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser ``` The password file can be updated while rclone is running. Use `--rc-realm` to set the authentication realm. Use `--rc-salt` to change the password hashing salt from the default. ``` rclone rcd * [flags] ``` ## Options ``` -h, --help help for rcd ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### RC Options Flags to control the Remote Control API ```text --rc Enable the remote control server --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572) --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from --rc-baseurl string Prefix for URLs - leave blank for root --rc-cert string TLS PEM key (concatenation of certificate and CA certificate) --rc-client-ca string Client certificate authority to verify clients with --rc-enable-metrics Enable the Prometheus metrics path at the remote control server --rc-files string Path to local files to serve on the HTTP server --rc-htpasswd string A htpasswd file - if not provided no authentication is done --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s) --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s) --rc-key string TLS PEM Private key --rc-max-header-bytes int Maximum size of request header (default 4096) --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --rc-no-auth Don't require auth for certain methods --rc-pass string Password for authentication --rc-realm string Realm for authentication --rc-response-header stringArray Set HTTP header for all responses, overriding existing values --rc-salt string Password hashing salt (default "dlPL2MqE") --rc-serve Enable the serving of remote objects --rc-serve-no-modtime Don't read the modification time (can speed things up) --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --rc-template string User-specified template --rc-user string User name for authentication --rc-user-from-header string User name from a defined HTTP header --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-no-open-browser Don't open the browser automatically --rc-web-gui-update Check and update to latest version of web gui ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone rmdirs Remove empty directories under the path. ## Synopsis This recursively removes any empty directories (including directories that only contain empty directories), that it finds under the path. The root path itself will also be removed if it is empty, unless you supply the `--leave-root` flag. Use command [rmdir](https://rclone.org/commands/rclone_rmdir/) to delete just the empty directory given by path, not recurse. This is useful for tidying up remotes that rclone has left a lot of empty directories in. For example the [delete](https://rclone.org/commands/rclone_delete/) command will delete files but leave the directory structure (unless used with option `--rmdirs`). This will delete `--checkers` directories concurrently so if you have thousands of empty directories consider increasing this number. To delete a path and any objects in it, use the [purge](https://rclone.org/commands/rclone_purge/) command. ``` rclone rmdirs remote:path [flags] ``` ## Options ``` -h, --help help for rmdirs --leave-root Do not remove root directory if empty ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone selfupdate Update the rclone binary. ## Synopsis This command downloads the latest release of rclone and replaces the currently running binary. The download is verified with a hashsum and cryptographically signed signature; see [the release signing docs](https://rclone.org/release_signing/) for details. If used without flags (or with implied `--stable` flag), this command will install the latest stable release. However, some issues may be fixed (or features added) only in the latest beta release. In such cases you should run the command with the `--beta` flag, i.e. `rclone selfupdate --beta`. You can check in advance what version would be installed by adding the `--check` flag, then repeat the command without it when you are satisfied. Sometimes the rclone team may recommend you a concrete beta or stable rclone release to troubleshoot your issue or add a bleeding edge feature. The `--version VER` flag, if given, will update to the concrete version instead of the latest one. If you omit micro version from `VER` (for example `1.53`), the latest matching micro version will be used. Upon successful update rclone will print a message that contains a previous version number. You will need it if you later decide to revert your update for some reason. Then you'll have to note the previous version and run the following command: `rclone selfupdate [--beta] OLDVER`. If the old version contains only dots and digits (for example `v1.54.0`) then it's a stable release so you won't need the `--beta` flag. Beta releases have an additional information similar to `v1.54.0-beta.5111.06f1c0c61`. (if you are a developer and use a locally built rclone, the version number will end with `-DEV`, you will have to rebuild it as it obviously can't be distributed). If you previously installed rclone via a package manager, the package may include local documentation or configure services. You may wish to update with the flag `--package deb` or `--package rpm` (whichever is correct for your OS) to update these too. This command with the default `--package zip` will update only the rclone executable so the local manual may become inaccurate after it. The [rclone mount](https://rclone.org/commands/rclone_mount/) command may or may not support extended FUSE options depending on the build and OS. `selfupdate` will refuse to update if the capability would be discarded. Note: Windows forbids deletion of a currently running executable so this command will rename the old executable to 'rclone.old.exe' upon success. Please note that this command was not available before rclone version 1.55. If it fails for you with the message `unknown command "selfupdate"` then you will need to update manually following the [install documentation](https://rclone.org/install/). ``` rclone selfupdate [flags] ``` ## Options ``` --beta Install beta release --check Check for latest release, do not download -h, --help help for selfupdate --output string Save the downloaded binary at a given path (default: replace running binary) --package string Package format: zip|deb|rpm (default: zip) --stable Install stable release (this is the default) --version string Install the given rclone version (default: latest) ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone serve Serve a remote over a protocol. ## Synopsis Serve a remote over a given protocol. Requires the use of a subcommand to specify the protocol, e.g. ```console rclone serve http remote: ``` When the "--metadata" flag is enabled, the following metadata fields will be provided as headers: - "content-disposition" - "cache-control" - "content-language" - "content-encoding" Note: The availability of these fields depends on whether the remote supports metadata. Each subcommand has its own options which you can see in their help. ``` rclone serve [opts] [flags] ``` ## Options ``` -h, --help help for serve ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone serve dlna](https://rclone.org/commands/rclone_serve_dlna/) - Serve remote:path over DLNA * [rclone serve docker](https://rclone.org/commands/rclone_serve_docker/) - Serve any remote on docker's volume plugin API. * [rclone serve ftp](https://rclone.org/commands/rclone_serve_ftp/) - Serve remote:path over FTP. * [rclone serve http](https://rclone.org/commands/rclone_serve_http/) - Serve the remote over HTTP. * [rclone serve nfs](https://rclone.org/commands/rclone_serve_nfs/) - Serve the remote as an NFS mount * [rclone serve restic](https://rclone.org/commands/rclone_serve_restic/) - Serve the remote for restic's REST API. * [rclone serve s3](https://rclone.org/commands/rclone_serve_s3/) - Serve remote:path over s3. * [rclone serve sftp](https://rclone.org/commands/rclone_serve_sftp/) - Serve the remote over SFTP. * [rclone serve webdav](https://rclone.org/commands/rclone_serve_webdav/) - Serve remote:path over WebDAV. # rclone serve dlna Serve remote:path over DLNA ## Synopsis Run a DLNA media server for media stored in an rclone remote. Many devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast packets (SSDP) and will thus only work on LANs. Rclone will list all files present in the remote, without filtering based on media formats or file extensions. Additionally, there is no media transcoding support. This means that some players might show files that they are not able to play back correctly. Rclone will add external subtitle files (.srt) to videos if they have the same filename as the video file itself (except the extension), either in the same directory as the video, or in a "Subs" subdirectory. ## Server options Use `--addr` to specify which IP address and port the server should listen on, e.g. `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. Use `--name` to choose the friendly server name, which is by default "rclone (hostname)". Use `--log-trace` in conjunction with `-vv` to enable additional debug logging of all UPNP traffic. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone serve dlna remote:path [flags] ``` ## Options ``` --addr string The ip:port or :port to bind the DLNA http server to (default ":7879") --announce-interval Duration The interval between SSDP announcements (default 12m0s) --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for dlna --interface stringArray The interface to use for SSDP (repeat as necessary) --link-perms FileMode Link permissions (default 666) --log-trace Enable trace logging of SOAP traffic --name string Name of DLNA server --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve docker Serve any remote on docker's volume plugin API. ## Synopsis This command implements the Docker volume plugin API allowing docker to use rclone as a data storage mechanism for various cloud providers. rclone provides [docker volume plugin](/docker) based on it. To create a docker plugin, one must create a Unix or TCP socket that Docker will look for when you use the plugin and then it listens for commands from docker daemon and runs the corresponding code when necessary. Docker plugins can run as a managed plugin under control of the docker daemon or as an independent native service. For testing, you can just run it directly from the command line, for example: ```console sudo rclone serve docker --base-dir /tmp/rclone-volumes --socket-addr localhost:8787 -vv ``` Running `rclone serve docker` will create the said socket, listening for commands from Docker to create the necessary Volumes. Normally you need not give the `--socket-addr` flag. The API will listen on the unix domain socket at `/run/docker/plugins/rclone.sock`. In the example above rclone will create a TCP socket and a small file `/etc/docker/plugins/rclone.spec` containing the socket address. We use `sudo` because both paths are writeable only by the root user. If you later decide to change listening socket, the docker daemon must be restarted to reconnect to `/run/docker/plugins/rclone.sock` or parse new `/etc/docker/plugins/rclone.spec`. Until you restart, any volume related docker commands will timeout trying to access the old socket. Running directly is supported on **Linux only**, not on Windows or MacOS. This is not a problem with managed plugin mode described in details in the [full documentation](https://rclone.org/docker). The command will create volume mounts under the path given by `--base-dir` (by default `/var/lib/docker-volumes/rclone` available only to root) and maintain the JSON formatted file `docker-plugin.state` in the rclone cache directory with book-keeping records of created and mounted volumes. All mount and VFS options are submitted by the docker daemon via API, but you can also provide defaults on the command line as well as set path to the config file and cache directory or adjust logging verbosity. # Restarting or upgrading the plugin When the plugin is restarted (for example with `docker plugin disable rclone && docker plugin enable rclone`, when upgrading the plugin, or when the host reboots) rclone reads its `docker-plugin.state` file and restores the volumes and mounts that were active before. The plugin starts serving its socket straight away and re-establishes the mounts in the background, so a slow or unreachable remote no longer prevents the plugin from coming back up. However, restarting the plugin necessarily stops and restarts the process that serves the FUSE mounts. Any container that is **already running** and holding files open on an rclone volume keeps a handle to the old, now dead mount, so those handles start returning `transport endpoint is not connected` until the container is restarted. This is a limitation of replacing the process behind a live FUSE mount and cannot be avoided by rclone - the plugin itself recovers and newly started containers work normally, but: - **Restart any containers that were using rclone volumes** after you restart or upgrade the plugin (e.g. `docker restart `), or stop them before and start them after. - Databases and other applications that keep files open continuously (Grafana, Prometheus, SQLite-backed apps, etc.) are the most affected and should always be restarted. # Security The plugin API accepts a `remote` (aka `fs`) option on volume creation, and this is parsed exactly like an rclone connection string. Connection strings are trusted configuration: they may carry inline backend options, and some backends use those options to run local commands (for example the `sftp` backend's `ssh` option spawns an external binary). Anyone who can send requests to the plugin socket can therefore make rclone run arbitrary commands as the user running `rclone serve docker` (typically root). Treat access to the socket as equivalent to that level of access and only expose it to trusted callers. When listening on the default unix socket at `/run/docker/plugins/rclone.sock` rclone creates it with mode `0660` owned by `root` and the group given by `--socket-gid` (the process GID by default), so only root and members of that group - normally just the docker daemon - can reach it. Do not loosen these permissions or hand the group to untrusted users. When using `--socket-addr` to listen on a TCP socket there is no authentication and the API is reachable by anyone who can open the port, so bind it to a loopback or otherwise trusted address and protect it with a firewall. Note that holding Docker daemon access is already equivalent to root on the host, so a caller able to issue `docker volume create` does not gain anything new from this; the concern is exposing the socket more widely than the daemon itself. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone serve docker [flags] ``` ## Options ``` --allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only) --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) --allow-other Allow access to other users (not supported on Windows) --allow-root Allow access to root user (not supported on Windows) --async-read Use asynchronous reads (not supported on Windows) (default true) --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) --base-dir string Base directory for volumes (default "/var/lib/docker-volumes/rclone") --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) --debug-fuse Debug the FUSE internals - needs -v --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) --devname string Set the device name - default is remote:path --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --direct-io Use Direct IO, disables caching of data --file-perms FileMode File permissions (default 666) --forget-state Skip restoring previous state --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for docker --link-perms FileMode Link permissions (default 666) --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --no-spec Do not write spec file --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --socket-addr string Address or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) --volname string Set the volume name (supported on Windows and OSX only) --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve ftp Serve remote:path over FTP. ## Synopsis Run a basic FTP server to serve a remote over FTP protocol. This can be viewed with a FTP client or you can make a remote of type FTP to read and write it. ## Server options Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. ### Authentication By default this will serve files without needing a login. You can set a single username and password with the --user and --pass flags. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. This config generated must have this extra parameter - `_root` - root to use for the backend And it may have this parameter - `_obscure` - comma separated strings for parameters to obscure If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "pass": "mypassword" } ``` If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" } ``` And as an example return this on STDOUT ```json { "type": "sftp", "_root": "", "_obscure": "pass", "user": "me", "pass": "mypassword", "host": "sftp.example.com" } ``` This would mean that an SFTP backend would be created on the fly for the `user` and `pass`/`public_key` returned in the output to the host given. Note that since `_obscure` is set to `pass`, rclone will obscure the `pass` parameter before creating the backend (which is required for sftp backends). The program can manipulate the supplied `user` in any way, for example to make proxy to many different sftp backends, you could make the `user` be `user@example.com` and then set the `host` to `example.com` in the output and the user to `user`. For security you'd probably want to restrict the `host` to a limited list. An internal cache of backends is keyed on the `user` and a hash of the `pass` or `public_key`. This means that if a user's password or public-key changes, or the proxy returns different config parameters (eg a rotated `api_key`), a fresh backend will be created on the next request rather than the cached one being reused. This can be used to build general purpose proxies to any kind of backend that rclone supports. ``` rclone serve ftp remote:path [flags] ``` ## Options ``` --addr string IPaddress:Port or :Port to bind server to (default "localhost:2121") --auth-proxy string A program to use to create the backend from the auth --cert string TLS PEM key (concatenation of certificate and CA certificate) --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for ftp --key string TLS PEM Private key --link-perms FileMode Link permissions (default 666) --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --pass string Password for authentication (empty value allow every password) --passive-port string Passive port range to use (default "30000-32000") --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --user string User name for authentication (default "anonymous") --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve http Serve the remote over HTTP. ## Synopsis Run a basic web server to serve a remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. You can use the filter flags (e.g. `--include`, `--exclude`) to control what is served. The server will log errors. Use `-v` to see access logs. `--bwlimit` will be respected for file transfers. Use `--stats` to control the stats printing. ## Server options Use `--addr` to specify which IP address and port the server should listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set `--addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name. `--addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. `--server-read-timeout` and `--server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer. `--max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header. `--response-header` can be used to set an HTTP header for all responses, will overriding existing values. The flag may be repeated to add multiple headers. Use the format `Header-Name: value`. `--baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`, `--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated identically. `--disable-zip` may be set to disable the zipping download option. ### Protocol The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing HTTP/2 without encryption. ### TLS (SSL) By default this will serve over http. If you want you can serve over https. You will need to supply the `--cert` and `--key` flags. If you wish to do client side certificate validation then you will need to supply `--client-ca` also. When TLS is configured every listener given with `--addr` serves TLS. An individual listener can be prefixed with `http://` to serve unencrypted HTTP on that address, or with `tls://` to state explicitly that it must serve TLS. Using a `tls://` address without `--cert` and `--key` is an error. `--cert` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--key` must be set to the path of a file with the PEM encoded private key. If setting `--client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates. `--min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## Socket activation Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--addr`). This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command ```console systemd-socket-activate -l 8000 -- rclone serve ``` This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template `--template` allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages: | Parameter | Subparameter | Description | | :---------- | :----------- | :---------- | | .Name | | The full path of a file/directory. | | .Title | | Directory listing of '.Name'. | | .Sort | | The current sort used. This is changeable via '?sort=' parameter. Possible values: namedirfirst, name, size, time (default namedirfirst). | | .Order | | The current ordering used. This is changeable via '?order=' parameter. Possible values: asc, desc (default asc). | | .Query | | Currently unused. | | .Breadcrumb | | Allows for creating a relative navigation. | | | .Link | The link of the Text relative to the root. | | | .Text | The Name of the directory. | | .Entries | | Information about a specific file/directory. | | | .URL | The url of an entry. | | | .Leaf | Currently same as '.URL' but intended to be just the name. | | | .IsDir | Boolean for if an entry is a directory or not. | | | .Size | Size in bytes of the entry. | | | .ModTime | The UTC timestamp of an entry. | The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions. | Function | Description | | :---------- | :---------- | | afterEpoch | Returns the time since the epoch for the given time. | | contains | Checks whether a given substring is present or not in a given string. | | hasPrefix | Checks whether the given string begins with the specified prefix. | | hasSuffix | Checks whether the given string end with the specified suffix. | ### Authentication By default this will serve files without needing a login. You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--user` and `--pass` flags. Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`). Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration may lead to unauthorized access. If either of the above authentication methods is not configured and client certificates are required by the `--client-ca` flag passed to the server, the client certificate common name will be considered as the username. Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. To create an htpasswd file: ```console touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser ``` The password file can be updated while rclone is running. Use `--realm` to set the authentication realm. Use `--salt` to change the password hashing salt from the default. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. This config generated must have this extra parameter - `_root` - root to use for the backend And it may have this parameter - `_obscure` - comma separated strings for parameters to obscure If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "pass": "mypassword" } ``` If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" } ``` And as an example return this on STDOUT ```json { "type": "sftp", "_root": "", "_obscure": "pass", "user": "me", "pass": "mypassword", "host": "sftp.example.com" } ``` This would mean that an SFTP backend would be created on the fly for the `user` and `pass`/`public_key` returned in the output to the host given. Note that since `_obscure` is set to `pass`, rclone will obscure the `pass` parameter before creating the backend (which is required for sftp backends). The program can manipulate the supplied `user` in any way, for example to make proxy to many different sftp backends, you could make the `user` be `user@example.com` and then set the `host` to `example.com` in the output and the user to `user`. For security you'd probably want to restrict the `host` to a limited list. An internal cache of backends is keyed on the `user` and a hash of the `pass` or `public_key`. This means that if a user's password or public-key changes, or the proxy returns different config parameters (eg a rotated `api_key`), a fresh backend will be created on the next request rather than the cached one being reused. This can be used to build general purpose proxies to any kind of backend that rclone supports. ``` rclone serve http remote:path [flags] ``` ## Options ``` --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080) --allow-origin string Origin which cross-domain request (CORS) can be executed from --auth-proxy string A program to use to create the backend from the auth --baseurl string Prefix for URLs - leave blank for root --cert string TLS PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --disable-dir-list Disable HTML directory list on GET request for a directory --disable-zip Disable zip download of directories --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for http --htpasswd string A htpasswd file - if not provided no authentication is done --key string TLS PEM Private key --link-perms FileMode Link permissions (default 666) --max-header-bytes int Maximum size of request header (default 4096) --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --realm string Realm for authentication --response-header stringArray Set HTTP header for all responses, overriding existing values --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --template string User-specified template --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --user string User name for authentication --user-from-header string User name from a defined HTTP header --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve nfs Serve the remote as an NFS mount ## Synopsis Create an NFS server that serves the given remote over the network. This implements an NFSv3 server to serve any rclone remote via NFS. The primary purpose for this command is to enable the [mount command](https://rclone.org/commands/rclone_mount/) on recent macOS versions where installing FUSE is very cumbersome. This server does not implement any authentication so any client will be able to access the data. To limit access, you can use `serve nfs` on the loopback address or rely on secure tunnels (such as SSH) or use firewalling. For this reason, by default, a random TCP port is chosen and the loopback interface is used for the listening address by default; meaning that it is only available to the local machine. If you want other machines to access the NFS mount over local network, you need to specify the listening address and port using the `--addr` flag. Modifying files through the NFS protocol requires VFS caching. Usually you will need to specify `--vfs-cache-mode` in order to be able to write to the mountpoint (`full` is recommended). If you don't specify VFS cache mode, the mount will be read-only. `--nfs-cache-type` controls the type of the NFS handle cache. By default this is `memory` where new handles will be randomly allocated when needed. These are stored in memory. If the server is restarted the handle cache will be lost and connected NFS clients will get stale handle errors. `--nfs-cache-type disk` uses an on disk NFS handle cache. Rclone hashes the path of the object and stores it in a file named after the hash. These hashes are stored on disk the directory controlled by `--cache-dir` or the exact directory may be specified with `--nfs-cache-dir`. Using this means that the NFS server can be restarted at will without affecting the connected clients. `--nfs-cache-type symlink` is similar to `--nfs-cache-type disk` in that it uses an on disk cache, but the cache entries are held as symlinks. Rclone will use the handle of the underlying file as the NFS handle which improves performance. This sort of cache can't be backed up and restored as the underlying handles will change. This is Linux only. It requires running rclone as root or with `CAP_DAC_READ_SEARCH`. You can run rclone with this extra permission by doing this to the rclone binary `sudo setcap cap_dac_read_search+ep /path/to/rclone`. `--nfs-cache-handle-limit` controls the maximum number of cached NFS handles stored by the caching handler. This should not be set too low or you may experience errors when trying to access files. The default is `1000000`, but consider lowering this limit if the server's system resource usage causes problems. This is only used by the `memory` type cache. To serve NFS over the network use following command: ```sh rclone serve nfs remote: --addr 0.0.0.0:$PORT --vfs-cache-mode=full ``` This specifies a port that can be used in the mount command. To mount the server under Linux/macOS, use the following command: ```sh mount -t nfs -o port=$PORT,mountport=$PORT,tcp $HOSTNAME:/ path/to/mountpoint ``` Where `$PORT` is the same port number used in the `serve nfs` command and `$HOSTNAME` is the network address of the machine that `serve nfs` was run on. NFS clients can also mount a subdirectory of the served remote by including it in the mount path. For example to mount only the `photos/2024` subdirectory: ```sh mount -t nfs -o port=$PORT,mountport=$PORT,tcp $HOSTNAME:/photos/2024 path/to/mountpoint ``` The subpath is resolved within the served remote and must refer to an existing directory (not a file or a symlink). Subpath mounts are a convenience equivalent to mounting `/` and changing directory: they share access to the same underlying VFS and the same file handles, so they do not isolate the client from siblings or parents of the mounted subdirectory. If `--vfs-metadata-extension` is in use then for the `--nfs-cache-type disk` and `--nfs-cache-type cache` the metadata files will have the file handle of their parent file suffixed with `0x00, 0x00, 0x00, 0x01`. This means they can be looked up directly from the parent file handle is desired. This command is only available on Unix platforms. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone serve nfs remote:path [flags] ``` ## Options ``` --addr string IPaddress:Port or :Port to bind server to --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for nfs --link-perms FileMode Link permissions (default 666) --nfs-cache-dir string The directory the NFS handle cache will use if set --nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000) --nfs-cache-type memory|disk|symlink Type of NFS handle cache to use (default memory) --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve restic Serve the remote for restic's REST API. ## Synopsis Run a basic web server to serve a remote over restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly. [Restic](https://restic.net/) is a command-line program for doing backups. The server will log errors. Use -v to see access logs. `--bwlimit` will be respected for file transfers. Use `--stats` to control the stats printing. ## Setting up rclone for use by restic First [set up a remote for your chosen cloud provider](https://rclone.org/docs/#configure). Once you have set up the remote, check it is working with, for example "rclone lsd remote:". You may have called the remote something other than "remote:" - just substitute whatever you called it in the following instructions. Now start the rclone restic server ```console rclone serve restic -v remote:backup ``` Where you can replace "backup" in the above by whatever path in the remote you wish to use. By default this will serve on "localhost:8080" you can change this with use of the `--addr` flag. You might wish to start this server on boot. Adding `--cache-objects=false` will cause rclone to stop caching objects returned from the List call. Caching is normally desirable as it speeds up downloading objects, saves transactions and uses very little memory. ## Setting up restic to use rclone Now you can [follow the restic instructions](http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) on setting up restic. Note that you will need restic 0.8.2 or later to interoperate with rclone. For the example above you will want to use "http://localhost:8080/" as the URL for the REST server. For example: ```console $ export RESTIC_REPOSITORY=rest:http://localhost:8080/ $ export RESTIC_PASSWORD=yourpassword $ restic init created restic backend 8b1a4b56ae at rest:http://localhost:8080/ Please note that knowledge of your password is required to access the repository. Losing your password means that your data is irrecoverably lost. $ restic backup /path/to/files/to/backup scan [/path/to/files/to/backup] scanned 189 directories, 312 files in 0:00 [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 duration: 0:00 snapshot 45c8fdd8 saved ``` ### Multiple repositories Note that you can use the endpoint to host multiple repositories. Do this by adding a directory name or path after the URL. Note that these **must** end with /. Eg ```console $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ # backup user1 stuff $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff ``` ### Private repositories The`--private-repos` flag can be used to limit users to repositories starting with a path of `//`. ## Server options Use `--addr` to specify which IP address and port the server should listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set `--addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name. `--addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. `--server-read-timeout` and `--server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer. `--max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header. `--response-header` can be used to set an HTTP header for all responses, will overriding existing values. The flag may be repeated to add multiple headers. Use the format `Header-Name: value`. `--baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`, `--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated identically. `--disable-zip` may be set to disable the zipping download option. ### Protocol The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing HTTP/2 without encryption. ### TLS (SSL) By default this will serve over http. If you want you can serve over https. You will need to supply the `--cert` and `--key` flags. If you wish to do client side certificate validation then you will need to supply `--client-ca` also. When TLS is configured every listener given with `--addr` serves TLS. An individual listener can be prefixed with `http://` to serve unencrypted HTTP on that address, or with `tls://` to state explicitly that it must serve TLS. Using a `tls://` address without `--cert` and `--key` is an error. `--cert` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--key` must be set to the path of a file with the PEM encoded private key. If setting `--client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates. `--min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## Socket activation Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--addr`). This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command ```console systemd-socket-activate -l 8000 -- rclone serve ``` This will socket-activate rclone on the first connection to port 8000 over TCP. ### Authentication By default this will serve files without needing a login. You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--user` and `--pass` flags. Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`). Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration may lead to unauthorized access. If either of the above authentication methods is not configured and client certificates are required by the `--client-ca` flag passed to the server, the client certificate common name will be considered as the username. Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. To create an htpasswd file: ```console touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser ``` The password file can be updated while rclone is running. Use `--realm` to set the authentication realm. Use `--salt` to change the password hashing salt from the default. ``` rclone serve restic remote:path [flags] ``` ## Options ``` --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080) --allow-origin string Origin which cross-domain request (CORS) can be executed from --append-only Disallow deletion of repository data --baseurl string Prefix for URLs - leave blank for root --cache-objects Cache listed objects (default true) --cert string TLS PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with -h, --help help for restic --htpasswd string A htpasswd file - if not provided no authentication is done --key string TLS PEM Private key --max-header-bytes int Maximum size of request header (default 4096) --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --pass string Password for authentication --private-repos Users can only access their private repo --realm string Realm for authentication --response-header stringArray Set HTTP header for all responses, overriding existing values --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --stdio Run an HTTP2 server on stdin/stdout --user string User name for authentication --user-from-header string User name from a defined HTTP header ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve s3 Serve remote:path over s3. ## Synopsis `serve s3` implements a basic s3 server that serves a remote via s3. This can be viewed with an s3 client, or you can make an [s3 type remote](https://rclone.org/s3/) to read and write to it with rclone. `serve s3` is considered **Experimental** so use with care. S3 server supports Signature Version 4 authentication. Just use `--auth-key accessKey,secretKey` and set the `Authorization` header correctly in the request. (See the [AWS docs](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)). `--auth-key` can be repeated for multiple auth pairs. If `--auth-key` is not provided then `serve s3` will allow anonymous access. Like all rclone flags `--auth-key` can be set via environment variables, in this case `RCLONE_AUTH_KEY`. Since this flag can be repeated, the input to `RCLONE_AUTH_KEY` is CSV encoded. Because the `accessKey,secretKey` has a comma in, this means it needs to be in quotes. ```console export RCLONE_AUTH_KEY='"user,pass"' rclone serve s3 ... ``` Or to supply multiple identities: ```console export RCLONE_AUTH_KEY='"user1,pass1","user2,pass2"' rclone serve s3 ... ``` Setting this variable without quotes will produce an error. Please note that some clients may require HTTPS endpoints. See [the SSL docs](#tls-ssl) for more information. This command uses the [VFS directory cache](#vfs-virtual-file-system). All the functionality will work with `--vfs-cache-mode off`. Using `--vfs-cache-mode full` (or `writes`) can be used to cache objects locally to improve performance. Use `--force-path-style=false` if you want to use the bucket name as a part of the hostname (such as mybucket.local) Use `--etag-hash` if you want to change the hash uses for the `ETag`. Note that using anything other than `MD5` (the default) is likely to cause problems for S3 clients which rely on the Etag being the MD5. ## Quickstart For a simple set up, to serve `remote:path` over s3, run the server like this: ```console rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path ``` For example, to use a simple folder in the filesystem, run the server with a command like this: ```console rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY local:/path/to/folder ``` The `rclone.conf` for the server could look like this: ```ini [local] type = local ``` The `local` configuration is optional though. If you run the server with a `remote:path` like `/path/to/folder` (without the `local:` prefix and without an `rclone.conf` file), rclone will fall back to a default configuration, which will be visible as a warning in the logs. But it will run nonetheless. This will be compatible with an rclone (client) remote configuration which is defined like this: ```ini [serves3] type = s3 provider = Rclone endpoint = http://127.0.0.1:8080/ access_key_id = ACCESS_KEY_ID secret_access_key = SECRET_ACCESS_KEY ``` ## Multipart uploads By default `serve s3` **streams** each multipart upload, in part-number order, into a single `PutStream` upload to the underlying remote, so the whole file is never buffered in memory - memory use stays bounded by the parts in flight. The remote then performs its own internal upload (for example its own multipart upload, still with bounded memory). This works for any remote that supports `PutStream`, which is nearly all of them, including through `crypt`. The upload is atomic so the destination object only ever changes on a successful completion. A failed or aborted upload never affects any object already stored under that name. Remotes that upload atomically already (object stores such as `s3`) are streamed straight to the destination. On remotes where a partial upload would otherwise be visible (such as `local`), the parts are streamed to a temporary object that is moved into place, server-side, on completion; these remotes therefore also need to support a server-side move or copy. **Features** - The whole object is never buffered in memory; memory use is bounded by the parts in flight, not the upload size. - Parts can be any size. Clients that don't produce uniform-sized parts work fine - for example PostgreSQL backup tools such as **pgBarman** and **pgBackRest**, which flush an upload buffer once it grows past the chunk size, so each part is the chunk size plus a variable overshoot. - Works through `crypt` for any part size, since the object is encrypted as one continuous stream. - The destination object only ever changes atomically, on completion: an aborted or failed upload leaves any pre-existing object of the same name untouched, and a partly-uploaded object never becomes visible. - Backend-agnostic - it only needs the remote to support `PutStream` (plus a server-side move or copy on remotes that don't upload atomically). **Limitations** - Parts must arrive in ascending, contiguous part-number order (1, 2, 3, ...). Parts the client uploads concurrently or out of order are buffered until their turn. The memory used for this buffering is capped, per upload, by `--multipart-streaming-buffer-limit` (default `256M`, `0` for no limit): a part that would take the buffer over the limit is stalled until the stream drains, so a client that uploads faster than the remote can accept sees backpressure rather than unbounded server memory use. Since a stalled part holds its HTTP request open, clients whose upload concurrency times chunk size exceeds the limit may need a longer read timeout when the remote is slow. Non-contiguous part numbers are rejected on completion. Configure the client to upload in part order, ideally with low concurrency, for the lowest memory use. - A part uploaded again before completion - typically a client retrying after a timeout - is accepted: if the earlier copy is still buffered it is replaced, and if it has already been streamed an identical re-upload is a no-op. What isn't possible is replacing a part that has already been streamed with *different* content - that is rejected. A failure in the stream to the remote itself still aborts the whole upload and the client must start it again. (The remote's own upload still retries its internal chunks.) - Parts are serialised into one stream, so ingest from the client is effectively single-threaded, although the remote's own upload still runs concurrently. - On remotes that don't upload atomically (such as `local`), the completed object is moved into place with a server-side operation. This is a cheap rename on most such remotes. On these remotes, if `serve s3` is killed part-way through an upload the temporary object (named with a leading `.rclone_multipart_upload_`) may be left behind; it is hidden from S3 listings but must be removed manually. ### Disabling streaming If you pass `--disable-multipart-streaming`, or the remote doesn't support `PutStream` (or doesn't upload atomically and can't move or copy server-side), multipart uploads are instead **buffered in memory** by the underlying S3 library: every part is held in memory and the whole object is written out in one go when the upload completes (the previous behaviour). This removes the in-order/contiguous-part restriction above, so parts can be uploaded in any order, but **memory use grows with the size of the upload**, so it is only suitable for small objects. A one-off `NOTICE` is logged the first time this happens. Alternatively, if the client is an rclone `s3` remote (like the `[serves3]` example above), you can set `use_multipart_uploads = false` on it so it uploads each object as a single stream and skips multipart uploads altogether. ## Bugs Multipart server side copies do not work (see [#7454](https://github.com/rclone/rclone/issues/7454)). These take a very long time and eventually fail. The default threshold for multipart server side copies is 5G which is the maximum it can be, so files above this side will fail to be server side copied. For a current list of `serve s3` bugs see the [serve s3](https://github.com/rclone/rclone/labels/serve%20s3) bug category on GitHub. ## Limitations `serve s3` will treat all directories in the root as buckets and ignore all files in the root. You can use `CreateBucket` to create folders under the root, but you can't create empty folders under other folders not in the root. When using `PutObject` or `DeleteObject`, rclone will automatically create or clean up empty folders. If you don't want to clean up empty folders automatically, use `--no-cleanup`. When using `ListObjects`, rclone will use `/` when the delimiter is empty. This reduces backend requests with no effect on most operations, but if the delimiter is something other than `/` and empty, rclone will do a full recursive search of the backend, which can take some time. Versioning is not currently supported. Metadata will only be saved in memory other than the rclone `mtime` metadata which will be set as the modification time of the file. ## Object names `serve s3` stores objects as files in the backend, so object keys are mapped to file paths rather than treated as the opaque strings AWS S3 allows. Keys must be in canonical path form: keys that contain `..` or `.` path segments, repeated slashes (`//`), or a leading or trailing slash are rejected with a `400 Bad Request` (`InvalidArgument`) instead of being normalised, since normalising them could alias two distinct keys to the same file or resolve a key outside its bucket. This matches the behaviour of other S3 servers such as MinIO. ## Supported operations `serve s3` currently supports the following operations. - Bucket - `ListBuckets` - `CreateBucket` - `DeleteBucket` - Object - `HeadObject` - `ListObjects` - `GetObject` - `PutObject` - `DeleteObject` - `DeleteObjects` - `CreateMultipartUpload` - `CompleteMultipartUpload` - `AbortMultipartUpload` - `CopyObject` - `UploadPart` Other operations will return error `Unimplemented`. ### Authentication By default this will serve files without needing a login. You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--user` and `--pass` flags. Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`). Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration may lead to unauthorized access. If either of the above authentication methods is not configured and client certificates are required by the `--client-ca` flag passed to the server, the client certificate common name will be considered as the username. Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. To create an htpasswd file: ```console touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser ``` The password file can be updated while rclone is running. Use `--realm` to set the authentication realm. Use `--salt` to change the password hashing salt from the default. ## Server options Use `--addr` to specify which IP address and port the server should listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set `--addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name. `--addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. `--server-read-timeout` and `--server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer. `--max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header. `--response-header` can be used to set an HTTP header for all responses, will overriding existing values. The flag may be repeated to add multiple headers. Use the format `Header-Name: value`. `--baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`, `--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated identically. `--disable-zip` may be set to disable the zipping download option. ### Protocol The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing HTTP/2 without encryption. ### TLS (SSL) By default this will serve over http. If you want you can serve over https. You will need to supply the `--cert` and `--key` flags. If you wish to do client side certificate validation then you will need to supply `--client-ca` also. When TLS is configured every listener given with `--addr` serves TLS. An individual listener can be prefixed with `http://` to serve unencrypted HTTP on that address, or with `tls://` to state explicitly that it must serve TLS. Using a `tls://` address without `--cert` and `--key` is an error. `--cert` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--key` must be set to the path of a file with the PEM encoded private key. If setting `--client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates. `--min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## Socket activation Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--addr`). This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command ```console systemd-socket-activate -l 8000 -- rclone serve ``` This will socket-activate rclone on the first connection to port 8000 over TCP. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ``` rclone serve s3 remote:path [flags] ``` ## Options ``` --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080) --allow-origin string Origin which cross-domain request (CORS) can be executed from --auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key --auth-proxy string A program to use to create the backend from the auth --baseurl string Prefix for URLs - leave blank for root --cert string TLS PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --disable-multipart-streaming Buffer multipart uploads in memory instead of streaming them to the backend (see the Multipart uploads docs section) --etag-hash string Which hash to use for the ETag, or auto or blank for off (default "MD5") --file-perms FileMode File permissions (default 666) --force-path-style If true use path style access if false use virtual hosted style (default true) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for s3 --htpasswd string A htpasswd file - if not provided no authentication is done --key string TLS PEM Private key --link-perms FileMode Link permissions (default 666) --max-header-bytes int Maximum size of request header (default 4096) --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --multipart-streaming-buffer-limit SizeSuffix Maximum memory buffered per streamed multipart upload for parts arriving out of order, 0 for unlimited (see the Multipart uploads docs section) (default 256Mi) --no-checksum Don't compare checksums on up/download --no-cleanup Not to cleanup empty folder after object is deleted --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --realm string Realm for authentication --response-header stringArray Set HTTP header for all responses, overriding existing values --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --user string User name for authentication --user-from-header string User name from a defined HTTP header --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve sftp Serve the remote over SFTP. ## Synopsis Run an SFTP server to serve a remote over SFTP. This can be used with an SFTP client or you can make a remote of type [sftp](/sftp) to use with it. You can use the [filter](/filtering) flags (e.g. `--include`, `--exclude`) to control what is served. The server will respond to a small number of shell commands, mainly md5sum, sha1sum and df, which enable it to provide support for checksums and the about feature when accessed from an sftp remote. Note that this server uses standard 32 KiB packet payload size, which means you must not configure the client to expect anything else, e.g. with the [chunk_size](https://rclone.org/sftp/#sftp-chunk-size) option on an sftp remote. The server will log errors. Use `-v` to see access logs. `--bwlimit` will be respected for file transfers. Use `--stats` to control the stats printing. You must provide some means of authentication, either with `--user`/`--pass`, an authorized keys file (specify location with `--authorized-keys` - the default is the same as ssh), an `--auth-proxy`, or set the `--no-auth` flag for no authentication when logging in. If you don't supply a host `--key` then rclone will generate rsa, ecdsa and ed25519 variants, and cache them for later use in rclone's cache directory (see `rclone help flags cache-dir`) in the "serve-sftp" directory. By default the server binds to localhost:2022 - if you want it to be reachable externally then supply `--addr :2022` for example. This also supports being run with socket activation, in which case it will listen on the first passed FD. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command: ```console systemd-socket-activate -l 2222 -- rclone serve sftp :local:vfs/ ``` This will socket-activate rclone on the first connection to port 2222 over TCP. Note that the default of `--vfs-cache-mode off` is fine for the rclone sftp backend, but it may not be with other SFTP clients. If `--stdio` is specified, rclone will serve SFTP over stdio, which can be used with sshd via ~/.ssh/authorized_keys, for example: ```text restrict,command="rclone serve sftp --stdio ./photos" ssh-rsa ... ``` On the client you need to set `--transfers 1` when using `--stdio`. Otherwise multiple instances of the rclone server are started by OpenSSH which can lead to "corrupted on transfer" errors. This is the case because the client chooses indiscriminately which server to send commands to while the servers all have different views of the state of the filing system. The "restrict" in authorized_keys prevents SHA1SUMs and MD5SUMs from being used. Omitting "restrict" and using `--sftp-path-override` to enable checksumming is possible but less secure and you could use the SFTP server provided by OpenSSH in this case. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. This config generated must have this extra parameter - `_root` - root to use for the backend And it may have this parameter - `_obscure` - comma separated strings for parameters to obscure If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "pass": "mypassword" } ``` If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" } ``` And as an example return this on STDOUT ```json { "type": "sftp", "_root": "", "_obscure": "pass", "user": "me", "pass": "mypassword", "host": "sftp.example.com" } ``` This would mean that an SFTP backend would be created on the fly for the `user` and `pass`/`public_key` returned in the output to the host given. Note that since `_obscure` is set to `pass`, rclone will obscure the `pass` parameter before creating the backend (which is required for sftp backends). The program can manipulate the supplied `user` in any way, for example to make proxy to many different sftp backends, you could make the `user` be `user@example.com` and then set the `host` to `example.com` in the output and the user to `user`. For security you'd probably want to restrict the `host` to a limited list. An internal cache of backends is keyed on the `user` and a hash of the `pass` or `public_key`. This means that if a user's password or public-key changes, or the proxy returns different config parameters (eg a rotated `api_key`), a fresh backend will be created on the next request rather than the cached one being reused. This can be used to build general purpose proxies to any kind of backend that rclone supports. ``` rclone serve sftp remote:path [flags] ``` ## Options ``` --addr string IPaddress:Port or :Port to bind server to (default "localhost:2022") --auth-proxy string A program to use to create the backend from the auth --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for sftp --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) --link-perms FileMode Link permissions (default 666) --no-auth Allow connections with no authentication if set --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --stdio Run an sftp server on stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --user string User name for authentication --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone serve webdav Serve remote:path over WebDAV. ## Synopsis Run a basic WebDAV server to serve a remote over HTTP via the WebDAV protocol. This can be viewed with a WebDAV client, through a web browser, or you can make a remote of type WebDAV to read and write it. ## WebDAV options ### --etag-hash This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object. If this flag is set to "auto" then rclone will choose the first supported hash on the backend or you can use a named hash such as "MD5" or "SHA-1". Use the [hashsum](https://rclone.org/commands/rclone_hashsum/) command to see the full list. ## Gzip compression The server will compress certain response bodies (text and XML, including WebDAV PROPFIND responses) using gzip when the client advertises gzip support via the `Accept-Encoding: gzip` request header. This reduces bandwidth usage. ## Access WebDAV on Windows WebDAV shared folder can be mapped as a drive on Windows, however the default settings prevent it. Windows will fail to connect to the server using insecure Basic authentication. It will not even display any login dialog. Windows requires SSL / HTTPS connection to be used with Basic. If you try to connect via Add Network Location Wizard you will get the following error: "The folder you entered does not appear to be valid. Please choose another". However, you still can connect if you set the following registry key on a client machine: `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters\BasicAuthLevel` to 2. The BasicAuthLevel can be set to the following values: ```text 0 - Basic authentication disabled 1 - Basic authentication enabled for SSL connections only 2 - Basic authentication enabled for SSL connections and for non-SSL connections ``` If required, increase the FileSizeLimitInBytes to a higher value. Navigate to the Services interface, then restart the WebClient service. ## Access Office applications on WebDAV Navigate to following registry `HKEY_CURRENT_USER\Software\Microsoft\Office\[14.0/15.0/16.0]\Common\Internet` Create a new DWORD BasicAuthLevel with value 2. ```text 0 - Basic authentication disabled 1 - Basic authentication enabled for SSL connections only 2 - Basic authentication enabled for SSL and for non-SSL connections ``` ## Serving over a unix socket You can serve the webdav on a unix socket like this: ```console rclone serve webdav --addr unix:///tmp/my.socket remote:path ``` and connect to it like this using rclone and the webdav backend: ```console rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :webdav: ``` Note that there is no authentication on http protocol - this is expected to be done by the permissions on the socket. ## Symlinks / Junction points The webdav protocol does not support symlinks or junction points and by default rclone will skip them completely. You can use `-L` to get rclone to follow symlinks or you can use `--local-links` to make rclone show `.rclonelink` files in place of the symlinks. **NB** Do not use `--links` as since v1.69 this applies to the VFS layer too, use `--local-links` which only applies to the local backend only. ## Server options Use `--addr` to specify which IP address and port the server should listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. If you set `--addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name. `--addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. `--server-read-timeout` and `--server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer. `--max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header. `--response-header` can be used to set an HTTP header for all responses, will overriding existing values. The flag may be repeated to add multiple headers. Use the format `Header-Name: value`. `--baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`, `--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated identically. `--disable-zip` may be set to disable the zipping download option. ### Protocol The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing HTTP/2 without encryption. ### TLS (SSL) By default this will serve over http. If you want you can serve over https. You will need to supply the `--cert` and `--key` flags. If you wish to do client side certificate validation then you will need to supply `--client-ca` also. When TLS is configured every listener given with `--addr` serves TLS. An individual listener can be prefixed with `http://` to serve unencrypted HTTP on that address, or with `tls://` to state explicitly that it must serve TLS. Using a `tls://` address without `--cert` and `--key` is an error. `--cert` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--key` must be set to the path of a file with the PEM encoded private key. If setting `--client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates. `--min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## Socket activation Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--addr`). This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in . Socket activation can be tested ad-hoc with the `systemd-socket-activate`command ```console systemd-socket-activate -l 8000 -- rclone serve ``` This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template `--template` allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages: | Parameter | Subparameter | Description | | :---------- | :----------- | :---------- | | .Name | | The full path of a file/directory. | | .Title | | Directory listing of '.Name'. | | .Sort | | The current sort used. This is changeable via '?sort=' parameter. Possible values: namedirfirst, name, size, time (default namedirfirst). | | .Order | | The current ordering used. This is changeable via '?order=' parameter. Possible values: asc, desc (default asc). | | .Query | | Currently unused. | | .Breadcrumb | | Allows for creating a relative navigation. | | | .Link | The link of the Text relative to the root. | | | .Text | The Name of the directory. | | .Entries | | Information about a specific file/directory. | | | .URL | The url of an entry. | | | .Leaf | Currently same as '.URL' but intended to be just the name. | | | .IsDir | Boolean for if an entry is a directory or not. | | | .Size | Size in bytes of the entry. | | | .ModTime | The UTC timestamp of an entry. | The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions. | Function | Description | | :---------- | :---------- | | afterEpoch | Returns the time since the epoch for the given time. | | contains | Checks whether a given substring is present or not in a given string. | | hasPrefix | Checks whether the given string begins with the specified prefix. | | hasSuffix | Checks whether the given string end with the specified suffix. | ### Authentication By default this will serve files without needing a login. You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--user` and `--pass` flags. Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`). Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration may lead to unauthorized access. If either of the above authentication methods is not configured and client certificates are required by the `--client-ca` flag passed to the server, the client certificate common name will be considered as the username. Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. To create an htpasswd file: ```console touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser ``` The password file can be updated while rclone is running. Use `--realm` to set the authentication realm. Use `--salt` to change the password hashing salt from the default. ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below. The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. ## VFS Directory Cache Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache. ```text --dir-cache-time duration Time to cache directory entries for (default 5m0s) --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s) ``` However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval. You can send a `SIGHUP` signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: ```console kill -SIGHUP $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use rclone rc to flush the whole directory cache: ```console rclone rc vfs/forget ``` Or individual files or directories: ```console rclone rc vfs/forget file=path/to/file dir=path/to/dir ``` ## VFS File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared. This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. ## VFS File Caching These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility. For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. ```text --cache-dir string Directory rclone will use for caching. --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) --vfs-write-back duration Time to writeback files after last use when using cache (default 5s) ``` If run with `-vv` rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with `--cache-dir` or setting the appropriate environment variable. The cache has 4 different modes selected by `--vfs-cache-mode`. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. Note that files are written back to the remote only when they are closed and if they haven't been accessed for `--vfs-write-back` seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every `--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. When `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. The `--vfs-cache-max-age` will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w . You **should not** run two copies of rclone using the same VFS cache with the same or overlapping remotes if using `--vfs-cache-mode > off`. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with `--cache-dir`. You don't need to worry about this if the remotes in use don't overlap. ### --vfs-cache-mode off In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. This will mean some operations are not possible - Files can't be opened for both read AND write - Files opened for write can't be seeked - Existing files opened for write must have O_TRUNC set - Files open for read with O_TRUNC will be opened write only - Files open for write only will behave as if O_TRUNC was supplied - Open modes O_APPEND, O_TRUNC are ignored - If an upload fails it can't be retried ### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space. These operations are not possible - Files opened for write only can't be seeked - Existing files opened for write must have O_TRUNC set - Files opened for write only will ignore O_APPEND, O_TRUNC - If an upload fails it can't be retried ### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first. This mode should support all normal file system operations. If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. ### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them. This mode should support all normal file system operations and is otherwise identical to `--vfs-cache-mode` writes. When reading a file rclone will read `--buffer-size` plus `--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory whereas the `--vfs-read-ahead` is buffered on disk. When using this mode it is recommended that `--buffer-size` is not set too large and `--vfs-read-ahead` is set large if required. **IMPORTANT** not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected. ### Fingerprinting Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from: - size - modification time - hash where available on an object. On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). For example `hash` is slow with the `local` and `sftp` backends as they have to read the entire file and hash it, and `modtime` is slow with the `s3`, `swift`, `ftp` and `qinqstor` backends because they need to do an extra API call to fetch it. If you use the `--vfs-fast-fingerprint` flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files. If you are running a vfs cache over `local`, `s3` or `swift` backends then using this flag is recommended. Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again. ## VFS Chunked Reading When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests. These flags control the chunking: ```text --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once ``` The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter. ### `--vfs-read-chunk-streams` == 0 Rclone will start reading a chunk of size `--vfs-read-chunk-size`, and then double the size for each read. When `--vfs-read-chunk-size-limit` is specified, and greater than `--vfs-read-chunk-size`, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely. With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading. The chunks will not be buffered in memory. ### `--vfs-read-chunk-streams` > 0 Rclone reads `--vfs-read-chunk-streams` chunks of size `--vfs-read-chunk-size` concurrently. The size for each read will stay constant. This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. Some experimentation will be needed to find the optimum values of `--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will depend on the backend in use and the latency to the backend. For high performance object stores (eg AWS S3) a reasonable place to start might be `--vfs-read-chunk-streams 16` and `--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance scaled roughly as the `--vfs-read-chunk-streams` setting. Similar settings should work for high latency links, but depending on the latency they may need more `--vfs-read-chunk-streams` in order to get the throughput. ## VFS Performance These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the [chunked reading](#vfs-chunked-reading) feature. In particular S3 and Swift benefit hugely from the `--no-modtime` flag (or use `--use-server-modtime` for a slightly different effect) as each read of the modification time takes a transaction. ```text --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --read-only Only allow read-only access. ``` Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file. ```text --vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s) ``` When using VFS write caching (`--vfs-cache-mode` with value writes or full), the global flag `--transfers` can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag `--checkers` has no effect on the VFS). ```text --transfers int Number of file transfers to run in parallel (default 4) ``` ## Symlinks By default the VFS does not support symlinks. However this may be enabled with either of the following flags: ```text --links Translate symlinks to/from regular files with a '.rclonelink' extension. --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS ``` As most cloud storage systems do not support symlinks directly, rclone stores the symlink as a normal file with a special extension. So a file which appears as a symlink `link-to-file.txt` would be stored on cloud storage as `link-to-file.txt.rclonelink` and the contents would be the path to the symlink destination. Note that `--links` enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). `--vfs-links` just enables it for the VFS layer. This scheme is compatible with that used by the [local backend with the --local-links flag](https://rclone.org/local/#symlinks-junction-points). The `--vfs-links` flag has been designed for `rclone mount`, `rclone nfsmount` and `rclone serve nfs`. It hasn't been tested with the other `rclone serve` commands yet. A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree ```text . ├── dir │ └── file.txt └── linked-dir -> dir ``` The VFS will correctly resolve `linked-dir` but not `linked-dir/file.txt`. This is not a problem for the tested commands but may be for other commands. **Note** that there is an outstanding issue with symlink support [issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate files being created when symlinks are moved into directories where there is a file of the same name (or vice versa). ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. The `--vfs-case-insensitive` VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below. The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote. Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true". The `--no-unicode-normalization` flag controls whether a similar "fixup" is performed for filenames that differ but are [canonically equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of `false` on macOS, to avoid encoding compatibility issues. In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes` flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. `--vfs-block- norm-dupes` prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in `rclone sync`. ## VFS Disk Options This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically. ```text --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) ``` ## Alternate report of used bytes Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running `df` on the filesystem, then pass the flag `--vfs-used-is-size` to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to `rclone size` and compute the total used space itself. **WARNING**: Contrary to `rclone size`, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching. ## VFS Metadata If you use the `--vfs-metadata-extension` flag you can get the VFS to expose files which contain the [metadata](https://rclone.org/docs/#metadata) as a JSON blob. These files will not appear in the directory listing, but can be `stat`-ed and opened and once they have been they **will** appear in directory listings until the directory cache expires. Note that some backends won't create metadata unless you pass in the `--metadata` flag. For example, using `rclone mount` with `--metadata --vfs-metadata-extension .metadata` we get ```console $ ls -l /mnt/ total 1048577 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G $ cat /mnt/1G.metadata { "atime": "2025-03-04T17:34:22.317069787Z", "btime": "2025-03-03T16:03:37.708253808Z", "gid": "1000", "mode": "100664", "mtime": "2025-03-03T16:03:39.640238323Z", "uid": "1000" } $ ls -l /mnt/ total 1048578 -rw-rw-r-- 1 user user 1073741824 Mar 3 16:03 1G -rw-rw-r-- 1 user user 185 Mar 3 16:03 1G.metadata ``` If the file has no metadata it will be returned as `{}` and if there is an error reading the metadata the error will be returned as `{"error":"error string"}`. ## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. This config generated must have this extra parameter - `_root` - root to use for the backend And it may have this parameter - `_obscure` - comma separated strings for parameters to obscure If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "pass": "mypassword" } ``` If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: ```json { "user": "me", "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" } ``` And as an example return this on STDOUT ```json { "type": "sftp", "_root": "", "_obscure": "pass", "user": "me", "pass": "mypassword", "host": "sftp.example.com" } ``` This would mean that an SFTP backend would be created on the fly for the `user` and `pass`/`public_key` returned in the output to the host given. Note that since `_obscure` is set to `pass`, rclone will obscure the `pass` parameter before creating the backend (which is required for sftp backends). The program can manipulate the supplied `user` in any way, for example to make proxy to many different sftp backends, you could make the `user` be `user@example.com` and then set the `host` to `example.com` in the output and the user to `user`. For security you'd probably want to restrict the `host` to a limited list. An internal cache of backends is keyed on the `user` and a hash of the `pass` or `public_key`. This means that if a user's password or public-key changes, or the proxy returns different config parameters (eg a rotated `api_key`), a fresh backend will be created on the next request rather than the cached one being reused. This can be used to build general purpose proxies to any kind of backend that rclone supports. ``` rclone serve webdav remote:path [flags] ``` ## Options ``` --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080) --allow-origin string Origin which cross-domain request (CORS) can be executed from --auth-proxy string A program to use to create the backend from the auth --baseurl string Prefix for URLs - leave blank for root --cert string TLS PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --disable-dir-list Disable HTML directory list on GET request for a directory --disable-zip Disable zip download of directories --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 666) --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) -h, --help help for webdav --htpasswd string A htpasswd file - if not provided no authentication is done --key string TLS PEM Private key --link-perms FileMode Link permissions (default 666) --max-header-bytes int Maximum size of request header (default 4096) --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --no-checksum Don't compare checksums on up/download --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --read-only Only allow read-only access --realm string Realm for authentication --response-header stringArray Set HTTP header for all responses, overriding existing values --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --template string User-specified template --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002) --user string User name for authentication --user-from-header string User name from a defined HTTP header --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) --vfs-case-insensitive If a file name not found, find a case insensitive match --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection --vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s) --vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS --vfs-metadata-extension string Set the extension to read metadata from --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off) --vfs-read-chunk-streams int The number of parallel streams to read at once --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) --vfs-refresh Refreshes the directory cache recursively in the background on start --vfs-used-is-size rclone size Use the rclone size algorithm for Used size --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## See Also * [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. # rclone settier Changes storage class/tier of objects in remote. ## Synopsis Changes storage tier or class at remote if supported. Few cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc. Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible.true You can use it to tier single object ```console rclone settier Cool remote:path/file ``` Or use rclone filters to set tier on only specific files ```console rclone --include "*.txt" settier Hot remote:path/dir ``` Or just provide remote directory and all files in directory will be tiered ```console rclone settier tier remote:path/dir ``` ``` rclone settier tier remote:path [flags] ``` ## Options ``` -h, --help help for settier ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone test Run a test command ## Synopsis Rclone test is used to run test commands. Select which test command you want with the subcommand, eg ```console rclone test memory remote: ``` Each subcommand has its own options which you can see in their help. **NB** Be careful running these commands, they may do strange things so reading their documentation first is recommended. ## Options ``` -h, --help help for test ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone test changenotify](https://rclone.org/commands/rclone_test_changenotify/) - Log any change notify requests for the remote passed in. * [rclone test histogram](https://rclone.org/commands/rclone_test_histogram/) - Makes a histogram of file name characters. * [rclone test info](https://rclone.org/commands/rclone_test_info/) - Discovers file name or other limitations for paths. * [rclone test makefile](https://rclone.org/commands/rclone_test_makefile/) - Make files with random contents of the size given * [rclone test makefiles](https://rclone.org/commands/rclone_test_makefiles/) - Make a random file hierarchy in a directory * [rclone test memory](https://rclone.org/commands/rclone_test_memory/) - Load all the objects at remote:path into memory and report memory stats. * [rclone test speed](https://rclone.org/commands/rclone_test_speed/) - Run a speed test to the remote # rclone test changenotify Log any change notify requests for the remote passed in. ``` rclone test changenotify remote: [flags] ``` ## Options ``` -h, --help help for changenotify --poll-interval Duration Time to wait between polling for changes (default 10s) ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test histogram Makes a histogram of file name characters. ## Synopsis This command outputs JSON which shows the histogram of characters used in filenames in the remote:path specified. The data doesn't contain any identifying information but is useful for the rclone developers when developing filename compression. ``` rclone test histogram [remote:path] [flags] ``` ## Options ``` -h, --help help for histogram ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test info Discovers file name or other limitations for paths. ## Synopsis Discovers what filenames and upload methods are possible to write to the paths passed in and how long they can be. It can take some time. It will write test files into the remote:path passed in. It outputs a bit of go code for each one. **NB** this can create undeletable files and other hazards - use with care! ``` rclone test info [remote:path]+ [flags] ``` ## Options ``` --all Run all tests --check-base32768 Check can store all possible base32768 characters --check-control Check control characters --check-length Check max filename length --check-normalization Check UTF-8 Normalization --check-streaming Check uploads with indeterminate file size -h, --help help for info --keep-test-files Keep test files after execution --upload-wait Duration Wait after writing a file (default 0s) --write-json string Write results to file ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test makefile Make files with random contents of the size given ``` rclone test makefile []+ [flags] ``` ## Options ``` --ascii Fill files with random ASCII printable bytes only --chargen Fill files with a ASCII chargen pattern -h, --help help for makefile --pattern Fill files with a periodic pattern --seed int Seed for the random number generator (0 for random) (default 1) --sparse Make the files sparse (appear to be filled with ASCII 0x00) --zero Fill files with ASCII 0x00 ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test makefiles Make a random file hierarchy in a directory ``` rclone test makefiles [flags] ``` ## Options ``` --ascii Fill files with random ASCII printable bytes only --chargen Fill files with a ASCII chargen pattern --files int Number of files to create (default 1000) --files-per-directory int Average number of files per directory (default 10) --flat If set create all files in the root directory -h, --help help for makefiles --max-depth int Maximum depth of directory hierarchy (default 10) --max-file-size SizeSuffix Maximum size of files to create (default 100) --max-name-length int Maximum size of file names (default 12) --min-file-size SizeSuffix Minimum size of file to create --min-name-length int Minimum size of file names (default 4) --pattern Fill files with a periodic pattern --seed int Seed for the random number generator (0 for random) (default 1) --sparse Make the files sparse (appear to be filled with ASCII 0x00) --zero Fill files with ASCII 0x00 ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test memory Load all the objects at remote:path into memory and report memory stats. ``` rclone test memory remote:path [flags] ``` ## Options ``` -h, --help help for memory ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone test speed Run a speed test to the remote ## Synopsis Run a speed test to the remote. This command runs a series of uploads and downloads to the remote, measuring and printing the speed of each test using varying file sizes and numbers of files. Test time can be innaccurate with small file caps and large files. As it uses the results of an initial test to determine how many files to use in each subsequent test. It is recommended to use -q flag for a simpler output. e.g.: rclone test speed remote: -q **NB** This command will create and delete files on the remote in a randomly named directory which will be automatically removed on a clean exit. You can use the --json flag to only print the results in JSON format. ``` rclone test speed [flags] ``` ## Options ``` --ascii Fill files with random ASCII printable bytes only --chargen Fill files with a ASCII chargen pattern --file-cap int Maximum number of files to use in each test (default 100) -h, --help help for speed --json Output only results in JSON format --large SizeSuffix Size of large files (default 1Gi) --medium SizeSuffix Size of medium files (default 10Mi) --pattern Fill files with a periodic pattern --seed int Seed for the random number generator (0 for random) (default 1) --small SizeSuffix Size of small files (default 1Ki) --sparse Make the files sparse (appear to be filled with ASCII 0x00) --test-time Duration Length for each test to run (default 15s) --zero Fill files with ASCII 0x00 ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. ## See Also * [rclone test](https://rclone.org/commands/rclone_test/) - Run a test command # rclone touch Create new file or change file modification time. ## Synopsis Set the modification time on file(s) as specified by remote:path to have the current time. If remote:path does not exist then a zero sized file will be created, unless `--no-create` or `--recursive` is provided. If `--recursive` is used then recursively sets the modification time on all existing files that is found under the path. Filters are supported, and you can test with the `--dry-run` or the `--interactive`/`-i` flag. This will touch `--transfers` files concurrently. If `--timestamp` is used then sets the modification time to that time instead of the current time. Times may be specified as one of: - 'YYMMDD' - e.g. 17.10.30 - 'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05 - 'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789 Note that value of `--timestamp` is in UTC. If you want local time then add the `--localtime` flag. Metadata can be added when creating a new file with `--metadata-set`. For example: rclone touch remote:path -M --metadata-set key=value ``` rclone touch remote:path [flags] ``` ## Options ``` -h, --help help for touch --localtime Use localtime for timestamp, not UTC -C, --no-create Do not create the file if it does not exist (implied with --recursive) -R, --recursive Recursively touch all files -t, --timestamp string Use specified time instead of the current time of day ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Important Options Important flags useful for most commands ```text -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. # rclone tree List the contents of the remote in a tree like fashion. ## Synopsis Lists the contents of a remote in a similar way to the unix tree command. For example ```text $ rclone tree remote:path / ├── file1 ├── file2 ├── file3 └── subdir ├── file4 └── file5 1 directories, 5 files ``` You can use any of the filtering options with the tree command (e.g. `--include` and `--exclude`. You can also use `--fast-list`. The tree command has many options for controlling the listing which are compatible with the tree command, for example you can include file sizes with `--size`. Note that not all of them have short options as they conflict with rclone's short options. For a more interactive navigation of the remote see the [ncdu](https://rclone.org/commands/rclone_ncdu/) command. ``` rclone tree remote:path [flags] ``` ## Options ``` -a, --all All files are listed (list . files too) -d, --dirs-only List directories only --dirsfirst List directories before files (-U disables) --full-path Print the full path prefix for each file -h, --help help for tree --level int Descend only level directories deep -D, --modtime Print the date of last modification. --noindent Don't print indentation lines --noreport Turn off file/directory count at end of tree listing -o, --output string Output to file instead of stdout -p, --protections Print the protections for each file. -Q, --quote Quote filenames with double quotes. -s, --size Print the size in bytes of each file. --sort string Select sort: name,version,size,mtime,ctime --sort-ctime Sort files by last status change time -t, --sort-modtime Sort files by last modification time -r, --sort-reverse Reverse the order of the sort -U, --unsorted Leave files unsorted --version Sort files alphanumerically by version ``` Options shared with other commands are described next. See the [global flags page](https://rclone.org/flags/) for global options not listed here. ### Filter Options Flags for filtering directory listings ```text --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ### Listing Options Flags for listing directories ```text --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## See Also * [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. ## Copying single files rclone normally syncs or copies directories. However, if the source remote points to a file, rclone will just copy that file. The destination remote must point to a directory - rclone will give the error `Failed to create file system for "remote:file": is a file not a directory` if it isn't. For example, suppose you have a remote with a file in called `test.jpg`, then you could copy just that file like this ```console rclone copy remote:test.jpg /tmp/download ``` The file `test.jpg` will be placed inside `/tmp/download`. This is equivalent to specifying ```console rclone copy --files-from /tmp/files remote: /tmp/download ``` Where `/tmp/files` contains the single line ```console test.jpg ``` It is recommended to use `copy` when copying individual files, not `sync`. They have pretty much the same effect but `copy` will use a lot less memory. ## Syntax of remote paths The syntax of the paths passed to the rclone command are as follows. ### /path/to/dir This refers to the local file system. On Windows `\` may be used instead of `/` in local paths **only**, non local paths must use `/`. See [local filesystem](https://rclone.org/local/#paths-on-windows) documentation for more about Windows-specific paths. These paths needn't start with a leading `/` - if they don't then they will be relative to the current directory. ### remote:path/to/dir This refers to a directory `path/to/dir` on `remote:` as defined in the config file (configured with `rclone config`). ### remote:/path/to/dir On most backends this is refers to the same directory as `remote:path/to/dir` and that format should be preferred. On a very small number of remotes (FTP, SFTP, Dropbox for business) this will refer to a different directory. On these, paths without a leading `/` will refer to your "home" directory and paths with a leading `/` will refer to the root. ### :backend:path/to/dir This is an advanced form for creating remotes on the fly. `backend` should be the name or prefix of a backend (the `type` in the config file) and all the configuration for the backend should be provided on the command line (or in environment variables). Here are some examples: ```console rclone lsd --http-url https://pub.rclone.org :http: ``` To list all the directories in the root of `https://pub.rclone.org/`. ```console rclone lsf --http-url https://example.com :http:path/to/dir ``` To list files and directories in `https://example.com/path/to/dir/` ```console rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir ``` To copy files and directories in `https://example.com/path/to/dir` to `/tmp/dir`. ```console rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir ``` To copy files and directories from `example.com` in the relative directory `path/to/dir` to `/tmp/dir` using sftp. ### Connection strings {#connection-strings} The above examples can also be written using a connection string syntax, so instead of providing the arguments as command line parameters `--http-url https://pub.rclone.org` they are provided as part of the remote specification as a kind of connection string. ```console rclone lsd ":http,url='https://pub.rclone.org':" rclone lsf ":http,url='https://example.com':path/to/dir" rclone copy ":http,url='https://example.com':path/to/dir" /tmp/dir rclone copy :sftp,host=example.com:path/to/dir /tmp/dir ``` These can apply to modify existing remotes as well as create new remotes with the on the fly syntax. This example is equivalent to adding the `--drive-shared-with-me` parameter to the remote `gdrive:`. ```console rclone lsf "gdrive,shared_with_me:path/to/dir" ``` The major advantage to using the connection string style syntax is that it only applies to the remote, not to all the remotes of that type of the command line. A common confusion is this attempt to copy a file shared on google drive to the normal drive which **does not work** because the `--drive-shared-with-me` flag applies to both the source and the destination. ```console rclone copy --drive-shared-with-me gdrive:shared-file.txt gdrive: ``` However using the connection string syntax, this does work. ```console rclone copy "gdrive,shared_with_me:shared-file.txt" gdrive: ``` Note that the connection string only affects the options of the immediate backend. If for example gdriveCrypt is a crypt based on gdrive, then the following command **will not work** as intended, because `shared_with_me` is ignored by the crypt backend: ```console rclone copy "gdriveCrypt,shared_with_me:shared-file.txt" gdriveCrypt: ``` The connection strings have the following syntax ```text remote,parameter=value,parameter2=value2:path/to/dir :backend,parameter=value,parameter2=value2:path/to/dir ``` If the `parameter` has a `:` or `,` then it must be placed in quotes `"` or `'`, so ```text remote,parameter="colon:value",parameter2="comma,value":path/to/dir :backend,parameter='colon:value',parameter2='comma,value':path/to/dir ``` If a quoted value needs to include that quote, then it should be doubled, so ```text remote,parameter="with""quote",parameter2='with''quote':path/to/dir ``` This will make `parameter` be `with"quote` and `parameter2` be `with'quote`. If you leave off the `=parameter` then rclone will substitute `=true` which works very well with flags. For example, to use s3 configured in the environment you could use: ```console rclone lsd :s3,env_auth: ``` Which is equivalent to ```console rclone lsd :s3,env_auth=true: ``` Note that on the command line you might need to surround these connection strings with `"` or `'` to stop the shell interpreting any special characters within them. If you are a shell master then you'll know which strings are OK and which aren't, but if you aren't sure then enclose them in `"` and use `'` as the inside quote. This syntax works on all OSes. ```console rclone copy ":http,url='https://example.com':path/to/dir" /tmp/dir ``` On Linux/macOS some characters are still interpreted inside `"` strings in the shell (notably `\` and `$` and `"`) so if your strings contain those you can swap the roles of `"` and `'` thus. (This syntax does not work on Windows.) ```console rclone copy ':http,url="https://example.com":path/to/dir' /tmp/dir ``` You can use [rclone config string](https://rclone.org/commands/rclone_config_string/) to convert a remote into a connection string. #### Connection strings, config and logging If you supply extra configuration to a backend by command line flag, environment variable or connection string then rclone will add a suffix based on the hash of the config to the name of the remote, eg ```console rclone -vv lsf --s3-chunk-size 20M s3: ``` Has the log message ```text DEBUG : s3: detected overridden config - adding "{Srj1p}" suffix to name ``` This is so rclone can tell the modified remote apart from the unmodified remote when caching the backends. This should only be noticeable in the logs. This means that on the fly backends such as ```console rclone -vv lsf :s3,env_auth: ``` Will get their own names ```text DEBUG : :s3: detected overridden config - adding "{YTu53}" suffix to name ``` ### Valid remote names Remote names are case sensitive, and must adhere to the following rules: - May contain number, letter, `_`, `-`, `.`, `+`, `@` and space. - May not start with `-` or space. - May not end with space. Starting with rclone version 1.61, any Unicode numbers and letters are allowed, while in older versions it was limited to plain ASCII (0-9, A-Z, a-z). If you use the same rclone configuration from different shells, which may be configured with different character encoding, you must be cautious to use characters that are possible to write in all of them. This is mostly a problem on Windows, where the console traditionally uses a non-Unicode character set - defined by the so-called "code page". Do not use single character names on Windows as it creates ambiguity with Windows drives' names, e.g.: remote called `C` is indistinguishable from `C` drive. Rclone will always assume that single letter name refers to a drive. ## Adding global configuration to a remote {#globalconfig} It is possible to add global configuration to the remote configuration which will be applied just before the remote is created. This can be done in two ways. The first is to use `override.var = value` in the config file or the connection string for a temporary change, and the second is to use `global.var = value` in the config file or connection string for a permanent change. This is explained fully below. ### override.var This is used to override a global variable **just** for the duration of the remote creation. It won't affect other remotes even if they are created at the same time. This is very useful for overriding networking config needed for just for that remote. For example, say you have a remote which needs `--no-check-certificate` as it is running on test infrastructure without a proper certificate. You could supply the `--no-check-certificate` flag to rclone, but this will affect **all** the remotes. To make it just affect this remote you use an override. You could put this in the config file: ```ini [remote] type = XXX ... override.no_check_certificate = true ``` or use it in the connection string `remote,override.no_check_certificate=true:` (or just `remote,override.no_check_certificate:`). Note how the global flag name loses its initial `--` and gets `-` replaced with `_` and gets an `override.` prefix. Not all global variables make sense to be overridden like this as the config is only applied during the remote creation. Here is a non exhaustive list of ones which might be useful: - `bind_addr` - `ca_cert` - `client_cert` - `client_key` - `connect_timeout` - `disable_http2` - `disable_http_keep_alives` - `dump` - `expect_continue_timeout` - `headers` - `http_proxy` - `low_level_retries` - `max_connections` - `no_check_certificate` - `no_gzip` - `timeout` - `traffic_class` - `use_cookies` - `use_server_modtime` - `user_agent` An `override.var` will override all other config methods, but **just** for the duration of the creation of the remote. ### global.var This is used to set a global variable **for everything**. The global variable is set just before the remote is created. This is useful for parameters (eg sync parameters) which can't be set as an `override`. For example, say you have a remote where you would always like to use the `--checksum` flag. You could supply the `--checksum` flag to rclone on every command line, but instead you could put this in the config file: ```ini [remote] type = XXX ... global.checksum = true ``` or use it in the connection string `remote,global.checksum=true:` (or just `remote,global.checksum:`). This is equivalent to using the `--checksum` flag. Note how the global flag name loses its initial `--` and gets `-` replaced with `_` and gets a `global.` prefix. Any global variable can be set like this and it is exactly equivalent to using the equivalent flag on the command line. This means it will affect all uses of rclone. If two remotes set the same global variable then the first one instantiated will be overridden by the second one. A `global.var` will override all other config methods when the remote is created. ## Quoting and the shell When you are typing commands to your computer you are using something called the command line shell. This interprets various characters in an OS specific way. Here are some gotchas which may help users unfamiliar with the shell rules ### Linux / macOS If your names have spaces or shell metacharacters (e.g. `*`, `?`, `$`, `'`, `"`, etc.) then you must quote them. Use single quotes `'` by default. ```console rclone copy 'Important files?' remote:backup ``` If you want to send a `'` you will need to use `"`, e.g. ```console rclone copy "O'Reilly Reviews" remote:backup ``` The rules for quoting metacharacters are complicated and if you want the full details you'll have to consult the manual page for your shell. ### Windows If your names have spaces in you need to put them in `"`, e.g. ```bat rclone copy "E:\folder name\folder name\folder name" remote:backup ``` If you are using the root directory on its own then don't quote it (see [#464](https://github.com/rclone/rclone/issues/464) for why), e.g. ```bat rclone copy E:\ remote:backup ``` ## Copying files or directories with `:` in the names rclone uses `:` to mark a remote name. This is, however, a valid filename component in non-Windows OSes. The remote name parser will only search for a `:` up to the first `/` so if you need to act on a file or directory like this then use the full path starting with a `/`, or use `./` as a current directory prefix. So to sync a directory called `sync:me` to a remote called `remote:` use ```console rclone sync --interactive ./sync:me remote:path ``` or ```console rclone sync --interactive /full/path/to/sync:me remote:path ``` ## Server-side copy Most remotes (but not all - see [the overview](https://rclone.org/overview/#optional-features)) support server-side copy. This means if you want to copy one folder to another then rclone won't download all the files and re-upload them; it will instruct the server to copy them in place. Eg ```console rclone copy s3:oldbucket s3:newbucket ``` Will copy the contents of `oldbucket` to `newbucket` without downloading and re-uploading. Remotes which don't support server-side copy **will** download and re-upload in this case. Server-side copies are used with `sync` and `copy` and will be identified in the log when using the `-v` flag. The `move` command may also use them if remote doesn't support server-side move directly. This is done by issuing a server-side copy then a delete which is much quicker than a download and re-upload. Server-side copies will only be attempted if the remote names are the same. This can be used when scripting to make aged backups efficiently, e.g. ```console rclone sync --interactive remote:current-backup remote:previous-backup rclone sync --interactive /path/to/files remote:current-backup ``` ## Metadata support {#metadata} Metadata is data about a file (or directory) which isn't the contents of the file (or directory). Normally rclone only preserves the modification time and the content (MIME) type where possible. Rclone supports preserving all the available metadata on files and directories when using the `--metadata` or `-M` flag. Exactly what metadata is supported and what that support means depends on the backend. Backends that support metadata have a metadata section in their docs and are listed in the [features table](https://rclone.org/overview/#features) (Eg [local](https://rclone.org/local/#metadata), [s3](/s3/#metadata)) Some backends don't support metadata, some only support metadata on files and some support metadata on both files and directories. Rclone only supports a one-time sync of metadata. This means that metadata will be synced from the source object to the destination object only when the source object has changed and needs to be re-uploaded. If the metadata subsequently changes on the source object without changing the object itself then it won't be synced to the destination object. This is in line with the way rclone syncs `Content-Type` without the `--metadata` flag. Using `--metadata` when syncing from local to local will preserve file attributes such as file mode, owner, extended attributes (not Windows). Note that arbitrary metadata may be added to objects using the `--metadata-set key=value` flag when the object is first uploaded. This flag can be repeated as many times as necessary. The [--metadata-mapper](#metadata-mapper) flag can be used to pass the name of a program in which can transform metadata when it is being copied from source to destination. Rclone supports `--metadata-set` and `--metadata-mapper` when doing server-side `Move` and server-side `Copy`, but not when doing server side `DirMove` (renaming a directory) as this would involve recursing into the directory. Note that you can disable `DirMove` with `--disable DirMove` and rclone will revert back to using `Move` for each individual object where `--metadata-set` and `--metadata-mapper` are supported. ### Types of metadata Metadata is divided into two type. System metadata and User metadata. Metadata which the backend uses itself is called system metadata. For example on the local backend the system metadata `uid` will store the user ID of the file when used on a unix based platform. Arbitrary metadata is called user metadata and this can be set however is desired. When objects are copied from backend to backend, they will attempt to interpret system metadata if it is supplied. Metadata may change from being user metadata to system metadata as objects are copied between different backends. For example copying an object from s3 sets the `content-type` metadata. In a backend which understands this (like `azureblob`) this will become the Content-Type of the object. In a backend which doesn't understand this (like the `local` backend) this will become user metadata. However should the local object be copied back to s3, the Content-Type will be set correctly. ### Metadata framework Rclone implements a metadata framework which can read metadata from an object and write it to the object when (and only when) it is being uploaded. This metadata is stored as a dictionary with string keys and string values. There are some limits on the names of the keys (these may be clarified further in the future). - must be lower case - may be `a-z` `0-9` containing `.` `-` or `_` - length is backend dependent Each backend can provide system metadata that it understands. Some backends can also store arbitrary user metadata. Where possible the key names are standardized, so, for example, it is possible to copy object metadata from s3 to azureblob for example and metadata will be translated appropriately. Some backends have limits on the size of the metadata and rclone will give errors on upload if they are exceeded. ### Metadata preservation The goal of the implementation is to 1. Preserve metadata if at all possible 2. Interpret metadata if at all possible The consequences of 1 is that you can copy an S3 object to a local disk then back to S3 losslessly. Likewise you can copy a local file with file attributes and xattrs from local disk to s3 and back again losslessly. The consequence of 2 is that you can copy an S3 object with metadata to Azureblob (say) and have the metadata appear on the Azureblob object also. ### Standard system metadata Here is a table of standard system metadata which, if appropriate, a backend may implement. | key | description | example | |---------------------|-------------|---------| | mode | File type and mode: octal, unix style | 0100664 | | uid | User ID of owner: decimal number | 500 | | gid | Group ID of owner: decimal number | 500 | | rdev | Device ID (if special file) => hexadecimal | 0 | | atime | Time of last access: RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | | mtime | Time of last modification: RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | | btime | Time of file creation (birth): RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | | utime | Time of file upload: RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | | cache-control | Cache-Control header | no-cache | | content-disposition | Content-Disposition header | inline | | content-encoding | Content-Encoding header | gzip | | content-language | Content-Language header | en-US | | content-type | Content-Type header | text/plain | The metadata keys `mtime` and `content-type` will take precedence if supplied in the metadata over reading the `Content-Type` or modification time of the source object. Hashes are not included in system metadata as there is a well defined way of reading those already. ## Options Rclone has a number of options to control its behaviour. These are documented below, and in the [flags](/flags) page. Options that take parameters can have the values passed in two ways, `--option=value` or `--option value`. However boolean (true/false) options behave slightly differently to the other options in that `--boolean` sets the option to `true` and the absence of the flag sets it to `false`. It is also possible to specify `--boolean=false` or `--boolean=true`. Note that `--boolean false` is not valid - this is parsed as `--boolean` and the `false` is parsed as an extra command line argument for rclone. String values that are recognized as special identifiers, e.g. the name of the log level to set with option `--log-level`, are case insensitive, e.g. `--log-level ERROR` and `--log-level error` are identical. Options documented to take a `stringArray` parameter accept multiple values. To pass more than one value, repeat the option; for example: `--include value1 --include value2`. Other options may only accept a single value, and should only be specified once, but where the specified parameter may indicate a list of values separated by space or comma. Such options are documented to take a `CommaSepList` parameter, if comma separated, and `SpaceSepList` if space separated, although some may also have different parameters such as `DumpFlags` or just `string` and the help text explains that this will be interpreted as a list. Floating-point values with fractional part must use period (`.`) as decimal separator, common in English-speaking countries, regardless of your configured system locale. Parameter type `float` accepts decimal and hexadecimal floating-point numbers as defined by the Go syntax for [floating-point literals](https://go.dev/ref/spec#Floating-point_literals). ### Time and duration options {#time-options} Options that take a `Time` or `Duration` parameter must be specified as a formatted string describing an absolute or relative time. Note that both `Time` and `Duration` parameter types can be expressed as either absolute or relative time, just with different interpretations, e.g. a relative time will be treated as an offset from the current time when passed as a `Time` value. An absolute time can be specified as a string in one of the following formats: - RFC3339 - e.g. `2006-01-02T15:04:05Z` or `2006-01-02T15:04:05+07:00` - ISO8601 Date and time, local timezone - `2006-01-02T15:04:05` - ISO8601 Date and time, local timezone - `2006-01-02 15:04:05` - ISO8601 Date - `2006-01-02` (YYYY-MM-DD) A relative time is a string with a, possibly signed, sequence of decimal numbers, each with optional fraction, and each with a unit suffix. If the string only contains a single number, then the unit suffix is optional and will default to seconds, i.e. a plain decimal value will be treated as a number of seconds. The following suffixes are valid: - `ms` - Milliseconds - `s` - Seconds - `m` - Minutes - `h` - Hours - `d` - Days - `w` - Weeks - `M` - Months - `y` - Years Examples: "10", "300ms", "-1.5h" or "2h45m". ### Size options Options that take a SizeSuffix parameter can be specified as an integer value, which will then be assumed to represent a KiB value (multiples of 1024 bytes) by default. The interpretation can be changed by appending a suffix: `B` for Byte, `K` for KiB, `M` for MiB, `G` for GiB, `T` for TiB and `P` for PiB. These are the binary units, e.g. 1, 2\*\*10, 2\*\*20, 2\*\*30 respectively. See also [--human-readable](#human-readable). ## Main options ### --backup-dir string When using [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/), any files which would have been overwritten or deleted are moved in their original hierarchy into this directory. If `--suffix` is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in the directory, then it will be overwritten. The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory without it being excluded by a filter rule. For example ```console rclone sync --interactive /path/to/local remote:current --backup-dir remote:old ``` will sync `/path/to/local` to `remote:current`, but for any files which would have been updated or deleted will be stored in `remote:old`. If running rclone from a script you might want to use today's date as the directory name passed to `--backup-dir` to store the old files, or you might want to pass `--suffix` with today's date. This can be done with `--suffix $(date +%F)` in bash, and `--suffix $(Get-Date -Format 'yyyy-MM-dd')` in PowerShell. See `--compare-dest` and `--copy-dest`. ### --bind string Local address to bind to for outgoing connections. This can be an IPv4 address (1.2.3.4), an IPv6 address (1234::789A) or host name. If the host name doesn't resolve or resolves to more than one IP address it will give an error. You can use `--bind 0.0.0.0` to force rclone to use IPv4 addresses and `--bind ::0` to force rclone to use IPv6 addresses. ### --bwlimit BwTimetable This option controls the bandwidth limit. For example ```text --bwlimit 10M ``` would mean limit the upload and download bandwidth to 10 MiB/s. **NB** this is **bytes** per second not **bits** per second. To use a single limit, specify the desired bandwidth in KiB/s, or use a suffix B|K|M|G|T|P. The default is `0` which means to not limit bandwidth. The upload and download bandwidth can be specified separately, as `--bwlimit UP:DOWN`, so ```text --bwlimit 10M:100k ``` would mean limit the upload bandwidth to 10 MiB/s and the download bandwidth to 100 KiB/s. Either limit can be "off" meaning no limit, so to just limit the upload bandwidth you would use ```text --bwlimit 10M:off ``` this would limit the upload bandwidth to 10 MiB/s but the download bandwidth would be unlimited. When specified as above the bandwidth limits last for the duration of run of the rclone binary. It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as `WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...` where: `WEEKDAY` is optional element. - `BANDWIDTH` can be a single number, e.g.`100k` or a pair of numbers for upload:download, e.g.`10M:1M`. - `WEEKDAY` can be written as the whole word or only using the first 3 characters. It is optional. - `HH:MM` is an hour from 00:00 to 23:59. Entries can be separated by spaces or semicolons. **Note:** Semicolons can be used as separators instead of spaces to avoid parsing issues in environments like Docker. An example of a typical timetable to avoid link saturation during daytime working hours could be: Using spaces as separators: `--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"` Using semicolons as separators: `--bwlimit "08:00,512k;12:00,10M;13:00,512k;18:00,30M;23:00,off"` In these examples, the transfer bandwidth will be set to 512 KiB/s at 8am every day. At noon, it will rise to 10 MiB/s, and drop back to 512 KiB/sec at 1pm. At 6pm, the bandwidth limit will be set to 30 MiB/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited. An example of timetable with `WEEKDAY` could be: Using spaces as separators: `--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"` Using semicolons as separators: `--bwlimit "Mon-00:00,512;Fri-23:59,10M;Sat-10:00,1M;Sun-20:00,off"` It means that, the transfer bandwidth will be set to 512 KiB/s on Monday. It will rise to 10 MiB/s before the end of Friday. At 10:00 on Saturday it will be set to 1 MiB/s. From 20:00 on Sunday it will be unlimited. Timeslots without `WEEKDAY` are extended to the whole week. So this example: ```text --bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off" ``` Is equivalent to this: ```text --bwlimit "Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off" ``` Bandwidth limit apply to the data transfer for all backends. For most backends the directory listing bandwidth is also included (exceptions being the non HTTP backends, `ftp`, `sftp` and `storj`). Note that the units are **Byte/s**, not **bit/s**. Typically connections are measured in bit/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625 MiB/s so you would use a `--bwlimit 0.625M` parameter for rclone. On Unix systems (Linux, macOS, …) the bandwidth limiter can be toggled by sending a `SIGUSR2` signal to rclone. This allows to remove the limitations of a long running rclone transfer and to restore it back to the value specified with `--bwlimit` quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this: ```console kill -SIGUSR2 $(pidof rclone) ``` If you configure rclone with a [remote control](/rc) then you can use change the bwlimit dynamically: ```console rclone rc core/bwlimit rate=1M ``` ### --bwlimit-file BwTimetable This option controls per file bandwidth limit. For the options see the `--bwlimit` flag. For example use this to allow no transfers to be faster than 1 MiB/s ```text --bwlimit-file 1M ``` This can be used in conjunction with `--bwlimit`. Note that if a schedule is provided the file will use the schedule in effect at the start of the transfer. ### --buffer-size SizeSuffix Use this sized buffer to speed up file transfers. Each `--transfer` will use this much memory for buffering. When using `mount` or `cmount` each open file descriptor will use this much memory for buffering. See the [mount](https://rclone.org/commands/rclone_mount/#file-buffering) documentation for more details. Set to `0` to disable the buffering for the minimum memory usage. Note that the memory allocation of the buffers is influenced by the [--use-mmap](#use-mmap) flag. ### --cache-dir string Specify the directory rclone will use for caching, to override the default. Default value is depending on operating system: - Windows `%LocalAppData%\rclone`, if `LocalAppData` is defined. - macOS `$HOME/Library/Caches/rclone` if `HOME` is defined. - Unix `$XDG_CACHE_HOME/rclone` if `XDG_CACHE_HOME` is defined, else `$HOME/.cache/rclone` if `HOME` is defined. - Fallback (on all OS) to `$TMPDIR/rclone`, where `TMPDIR` is the value from [--temp-dir](#temp-dir-string). You can use the [config paths](https://rclone.org/commands/rclone_config_paths/) command to see the current value. Cache directory is heavily used by the [VFS File Caching](https://rclone.org/commands/rclone_mount/#vfs-file-caching) mount feature, but also by [serve](https://rclone.org/commands/rclone_serve/), [GUI](/gui) and other parts of rclone. ### --check-first If this flag is set then in a [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/), rclone will do all the checks to see whether files need to be transferred before doing any of the transfers. Normally rclone would start running transfers as soon as possible. This flag can be useful on IO limited systems where transfers interfere with checking. It can also be useful to ensure perfect ordering when using `--order-by`. If both `--check-first` and `--order-by` are set when doing `rclone move` then rclone will use the transfer thread to delete source files which don't need transferring. This will enable perfect ordering of the transfers and deletes but will cause the transfer stats to have more items in than expected. Using this flag can use more memory as it effectively sets `--max-backlog` to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start. ### --checkers int Originally controlling just the number of file checkers to run in parallel, e.g. by `rclone copy`. Now a fairly universal parallelism control used by `rclone` in several places. Note: checkers do the equality checking of files during a sync. For some storage systems (e.g. S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel. The default is to run 8 checkers in parallel. However, in case of slow-reacting backends you may need to lower (rather than increase) this default by setting `--checkers` to 4 or less threads. This is especially advised if you are experiencing backend server crashes during file checking phase (e.g. on subsequent or top-up backups where little or no file copying is done and checking takes up most of the time). Increase this setting only with utmost care, while monitoring your server health and file checking throughput. ### -c, --checksum Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check the file hash and size to determine if files are equal. This is useful when the remote doesn't support setting modified time and a more accurate sync is desired than just checking the file size. This is very useful when transferring between remotes which store the same hash type on the object, e.g. Drive and Swift. For details of which remotes support which hash type see the table in the [overview section](https://rclone.org/overview/). Eg `rclone --checksum sync s3:/bucket swift:/bucket` would run much quicker than without the `--checksum` flag. When using this flag, rclone won't update mtimes of remote files if they are incorrect as it would normally. ### --color AUTO|NEVER|ALWAYS Specify when colors (and other ANSI codes) should be added to the output. `AUTO` only allows ANSI codes when the output is a terminal. This is the default. `NEVER` never allow ANSI codes. `ALWAYS` always add ANSI codes, regardless of the output format (terminal or file). ### --compare-dest stringArray When using [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/), the specified paths are checked in addition to the destination for files. If a file identical to the source is found, that file is **not** copied from source. This is useful to copy just files that have changed since the last backup. You must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. See `--copy-dest` and `--backup-dir`. ### --config string Specify the location of the rclone configuration file, to override the default. E.g. `rclone config --config="rclone.conf"`. The exact default is a bit complex to describe, due to changes introduced through different versions of rclone while preserving backwards compatibility, but in most cases it is as simple as: - `%APPDATA%/rclone/rclone.conf` on Windows - `~/.config/rclone/rclone.conf` on other The complete logic is as follows: Rclone will look for an existing configuration file in any of the following locations, in priority order: 1. `rclone.conf` (in program directory, where rclone executable is) 2. `%APPDATA%/rclone/rclone.conf` (only on Windows) 3. `$XDG_CONFIG_HOME/rclone/rclone.conf` (on all systems, including Windows) 4. `~/.config/rclone/rclone.conf` (see below for explanation of ~ symbol) 5. `~/.rclone.conf` If no existing configuration file is found, then a new one will be created in the following location: - On Windows: Location 2 listed above, except in the unlikely event that `APPDATA` is not defined, then location 4 is used instead. - On Unix: Location 3 if `XDG_CONFIG_HOME` is defined, else location 4. - Fallback to location 5 (on all OS), when the rclone directory cannot be created, but if also a home directory was not found then path `.rclone.conf` relative to current working directory will be used as a final resort. The `~` symbol in paths above represent the home directory of the current user on any OS, and the value is defined as following: - On Windows: `%HOME%` if defined, else `%USERPROFILE%`, or else `%HOMEDRIVE%\%HOMEPATH%`. - On Unix: `$HOME` if defined, else by looking up current user in OS-specific user database (e.g. passwd file), or else use the result from shell command `cd && pwd`. If you run `rclone config file` you will see where the default location is for you. Running `rclone config touch` will ensure a configuration file exists, creating an empty one in the default location if there is none. The fact that an existing file `rclone.conf` in the same directory as the rclone executable is always preferred, means that it is easy to run in "portable" mode by downloading rclone executable to a writable directory and then create an empty file `rclone.conf` in the same directory. If the location is set to empty string `""` or path to a file with name `notfound`, or the os null device represented by value `NUL` on Windows and `/dev/null` on Unix systems, then rclone will keep the configuration file in memory only. You may see a log message "Config file not found - using defaults" if there is no configuration file. This can be suppressed, e.g. if you are using rclone entirely with [on the fly remotes](https://rclone.org/docs/#backend-path-to-dir), by using memory-only configuration file or by creating an empty configuration file, as described above. The file format is basic [INI](https://en.wikipedia.org/wiki/INI_file#Format): Sections of text, led by a `[section]` header and followed by `key=value` entries on separate lines. In rclone each remote is represented by its own section, where the section name defines the name of the remote. Options are specified as the `key=value` entries, where the key is the option name without the `--backend-` prefix, in lowercase and with `_` instead of `-`. E.g. option `--mega-hard-delete` corresponds to key `hard_delete`. Only backend options can be specified. A special, and required, key `type` identifies the [storage system](https://rclone.org/overview/), where the value is the internal lowercase name as returned by command `rclone help backends`. Comments are indicated by `;` or `#` at the beginning of a line. Example: ```ini [megaremote] type = mega user = you@example.com pass = PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH ``` Note that passwords are in [obscured](https://rclone.org/commands/rclone_obscure/) form. Also, many storage systems uses token-based authentication instead of passwords, and this requires additional steps. It is easier, and safer, to use the interactive command `rclone config` instead of manually editing the configuration file. The configuration file will typically contain login information, and should therefore have restricted permissions so that only the current user can read it. Rclone tries to ensure this when it writes the file. You may also choose to [encrypt](#configuration-encryption) the file. When token-based authentication are used, the configuration file must be writable, because rclone needs to update the tokens inside it. To reduce risk of corrupting an existing configuration file, rclone will not write directly to it when saving changes. Instead it will first write to a new, temporary, file. If a configuration file already existed, it will (on Unix systems) try to mirror its permissions to the new file. Then it will rename the existing file to a temporary name as backup. Next, rclone will rename the new file to the correct name, before finally cleaning up by deleting the backup file. If the configuration file path used by rclone is a symbolic link, then this will be evaluated and rclone will write to the resolved path, instead of overwriting the symbolic link. Temporary files used in the process (described above) will be written to the same parent directory as that of the resolved configuration file, but if this directory is also a symbolic link it will not be resolved and the temporary files will be written to the location of the directory symbolic link. ### --contimeout Duration Set the connection timeout. This should be in go time format which looks like `5s` for 5 seconds, `10m` for 10 minutes, or `3h30m`. The connection timeout is the amount of time rclone will wait for a connection to go through to a remote object storage system. It is `1m` by default. ### --copy-dest stringArray When using [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/), the specified paths are checked in addition to the destination for files. This part is the same as `--compare-dest`, but the difference is that with `--copy-dest`, if a file identical to the source is found, that file is server-side copied from the specified paths to the destination. This is useful for incremental backup. The remote in use must support server-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. See `--compare-dest` and `--backup-dir`. ### --dedupe-mode interactive|skip|first|newest|oldest|largest|smallest|rename|list Mode to run dedupe command in. One of `interactive`, `skip`, `first`, `newest`, `oldest`, `largest`, `smallest`, `rename` `list`. The default is `interactive`. See the [dedupe](https://rclone.org/commands/rclone_dedupe/) command for more information as to what these options mean. ### --default-time Time If a file or directory does have a modification time rclone can read then rclone will display this fixed time instead. The default is `2000-01-01 00:00:00 UTC`. This can be configured in any of the ways shown in [time options](#time-options). For example `--default-time 2020-06-01` to set the default time to the 1st of June 2020 or `--default-time 0s` to set the default time to the time rclone started up. ### --disable string This disables a comma separated list of optional features. For example to disable server-side move and server-side copy use: ```text --disable move,copy ``` The features can be put in any case. To see a list of which features can be disabled use: ```text --disable help ``` The features a remote has can be seen in JSON format with: ```console rclone backend features remote: ``` See the overview [features](https://rclone.org/overview/#features) and [optional features](https://rclone.org/overview/#optional-features) to get an idea of which feature does what. Note that some features can be set to `true` if they are `true`/`false` feature flag features by prefixing them with `!`. For example the `CaseInsensitive` feature can be forced to `false` with `--disable CaseInsensitive` and forced to `true` with `--disable '!CaseInsensitive'`. In general it isn't a good idea doing this but it may be useful in extremis. (Note that `!` is a shell command which you will need to escape with single quotes or a backslash on unix like platforms.) This flag can be useful for debugging and in exceptional circumstances (e.g. Google Drive limiting the total volume of server-side copies to 100 GiB/day). ### --disable-http2 This stops rclone from trying to use HTTP/2 if available. This can sometimes speed up transfers due to a [problem in the Go standard library](https://github.com/golang/go/issues/37373). ### --dscp string Specify a DSCP value or name to use in connections. This could help QoS system to identify traffic class. BE, EF, DF, LE, CSx and AFxx are allowed. See the description of [differentiated services](https://en.wikipedia.org/wiki/Differentiated_services) to get an idea of this field. Setting this to 1 (LE) to identify the flow to SCAVENGER class can avoid occupying too much bandwidth in a network with DiffServ support ([RFC 8622](https://tools.ietf.org/html/rfc8622)). For example, if you configured QoS on router to handle LE properly. Running: ```console rclone copy --dscp LE from:/from to:/to ``` would make the priority lower than usual internet flows. This option has no effect on Windows (see [golang/go#42728](https://github.com/golang/go/issues/42728)). ### -n, --dry-run Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the [sync](https://rclone.org/commands/rclone_sync/) command which deletes files in the destination. ### --expect-continue-timeout Duration This specifies the amount of time to wait for a server's first response headers after fully writing the request headers if the request has an "Expect: 100-continue" header. Not all backends support using this. Zero means no timeout and causes the body to be sent immediately, without waiting for the server to approve. This time does not include the time to send the request header. The default is `1s`. Set to `0` to disable. ### --error-on-no-transfer By default, rclone will exit with return code 0 if there were no errors. This option allows rclone to return exit code 9 if no files were transferred between the source and destination. This allows using rclone in scripts, and triggering follow-on actions if data was copied, or skipping if not. NB: Enabling this option turns a usually non-fatal error into a potentially fatal one - please check and adjust your scripts accordingly! ### --fix-case Normally, a sync to a case insensitive dest (such as macOS / Windows) will not result in a matching filename if the source and dest filenames have casing differences but are otherwise identical. For example, syncing `hello.txt` to `HELLO.txt` will normally result in the dest filename remaining `HELLO.txt`. If `--fix-case` is set, then `HELLO.txt` will be renamed to `hello.txt` to match the source. NB: - directory names with incorrect casing will also be fixed - `--fix-case` will be ignored if `--immutable` is set - using `--local-case-sensitive` instead is not advisable; it will cause `HELLO.txt` to get deleted! - the old dest filename must not be excluded by filters. Be especially careful with [`--files-from`](https://rclone.org/filtering/#files-from-read-list-of-source-file-names), which does not respect [`--ignore-case`](https://rclone.org/filtering/#ignore-case-make-searches-case-insensitive)! - on remotes that do not support server-side move, `--fix-case` will require downloading the file and re-uploading it. To avoid this, do not use `--fix-case`. ### --fs-cache-expire-duration Duration When using rclone via the API rclone caches created remotes for 5 minutes by default in the "fs cache". This means that if you do repeated actions on the same remote then rclone won't have to build it again from scratch, which makes it more efficient. This flag sets the time that the remotes are cached for. If you set it to `0` (or negative) then rclone won't cache the remotes at all. Note that if you use some flags, eg `--backup-dir` and if this is set to `0` rclone may build two remotes (one for the source or destination and one for the `--backup-dir` where it may have only built one before. ### --fs-cache-expire-interval Duration This controls how often rclone checks for cached remotes to expire. See the `--fs-cache-expire-duration` documentation above for more info. The default is 60s, set to 0 to disable expiry. ### --header stringArray Add an HTTP header for all transactions. The flag can be repeated to add multiple headers. If you want to add headers only for uploads use `--header-upload` and if you want to add headers only for downloads use `--header-download`. This flag is supported for all HTTP based backends even those not supported by `--header-upload` and `--header-download` so may be used as a workaround for those with care. ```console rclone ls remote:test --header "X-Rclone: Foo" --header "X-LetMeIn: Yes" ``` ### --header-download stringArray Add an HTTP header for all download transactions. The flag can be repeated to add multiple headers. ```console rclone sync --interactive s3:test/src ~/dst --header-download "X-Amz-Meta-Test: Foo" --header-download "X-Amz-Meta-Test2: Bar" ``` See GitHub issue [#59](https://github.com/rclone/rclone/issues/59) for currently supported backends. ### --header-upload stringArray Add an HTTP header for all upload transactions. The flag can be repeated to add multiple headers. ```console rclone sync --interactive ~/src s3:test/dst --header-upload "Content-Disposition: attachment; filename='cool.html'" --header-upload "X-Amz-Meta-Test: FooBar" ``` See GitHub issue [#59](https://github.com/rclone/rclone/issues/59) for currently supported backends. ### --http-proxy string Use this option to set an HTTP proxy for all HTTP based services to use. Rclone also supports the standard HTTP proxy environment variables which it will pick up automatically. The is the way the HTTP proxy will normally be set but this flag can be used to override it. ### --human-readable Rclone commands output values for sizes (e.g. number of bytes) and counts (e.g. number of files) either as *raw* numbers, or in *human-readable* format. In human-readable format the values are scaled to larger units, indicated with a suffix shown after the value, and rounded to three decimals. Rclone consistently uses binary units (powers of 2) for sizes and decimal units (powers of 10) for counts. The unit prefix for size is according to IEC standard notation, e.g. `Ki` for kibi. Used with byte unit, `1 KiB` means 1024 Byte. In list type of output, only the unit prefix appended to the value (e.g. `9.762Ki`), while in more textual output the full unit is shown (e.g. `9.762 KiB`). For counts the SI standard notation is used, e.g. prefix `k` for kilo. Used with file counts, `1k` means 1000 files. The various [list](https://rclone.org/commands/rclone_ls/) commands output raw numbers by default. Option `--human-readable` will make them output values in human-readable format instead (with the short unit prefix). The [about](https://rclone.org/commands/rclone_about/) command outputs human-readable by default, with a command-specific option `--full` to output the raw numbers instead. Command [size](https://rclone.org/commands/rclone_size/) outputs both human-readable and raw numbers in the same output. The [tree](https://rclone.org/commands/rclone_tree/) command also considers `--human-readable`, but it will not use the exact same notation as the other commands: It rounds to one decimal, and uses single letter suffix, e.g. `K` instead of `Ki`. The reason for this is that it relies on an external library. The interactive command [ncdu](https://rclone.org/commands/rclone_ncdu/) shows human-readable by default, and responds to key `u` for toggling human-readable format. ### --ignore-case-sync Using this option will cause rclone to ignore the case of the files when synchronizing so files will not be copied/synced when the existing filenames are the same, even if the casing is different. ### --ignore-checksum Normally rclone will check that the checksums of transferred files match, and give an error "corrupted on transfer" if they don't. You can use this option to skip that check. You should only use it if you have had the "corrupted on transfer" error message and you are sure you might want to transfer potentially corrupted data. ### --ignore-existing Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files. While this isn't a generally recommended option, it can be useful in cases where your files change due to encryption. However, it cannot correct partial transfers in case a transfer was interrupted. When performing a `move`/`moveto` command, this flag will leave skipped files in the source location unchanged when a file with the same name exists on the destination. ### --ignore-size Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check only the modification time. If `--checksum` is set then it only checks the checksum. It will also cause rclone to skip verifying the sizes are the same after transfer. This can be useful for transferring files to and from OneDrive which occasionally misreports the size of image files (see [#399](https://github.com/rclone/rclone/issues/399) for more info). ### -I, --ignore-times Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination. Normally rclone would skip any files that have the same modification time and are the same size (or have the same checksum if using `--checksum`). ### --immutable Treat source and destination files as immutable and disallow modification. With this option set, files will be created and deleted as requested, but existing files will never be updated. If an existing file does not match between the source and destination, rclone will give the error `Source and destination exist but do not match: immutable file modified`. Note that only commands which transfer files (e.g. [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/)) are affected by this behavior, and only modification is disallowed. Files may still be deleted explicitly (e.g. [delete](https://rclone.org/commands/rclone_delete/), [purge](https://rclone.org/commands/rclone_purge/)) or implicitly (e.g. [sync](https://rclone.org/commands/rclone_sync/), [move](https://rclone.org/commands/rclone_move/)). Use `copy --immutable` if it is desired to avoid deletion as well as modification. This can be useful as an additional layer of protection for immutable or append-only data sets (notably backup archives), where modification implies corruption and should not be propagated. ### --inplace {#inplace} The `--inplace` flag changes the behaviour of rclone when uploading files to some backends (backends with the `PartialUploads` feature flag set) such as: - local - ftp - sftp - pcloud Without `--inplace` (the default) rclone will first upload to a temporary file with an extension like this, where `XXXXXX` represents a hash of the source file's fingerprint and `.partial` is [--partial-suffix](#partial-suffix) value (`.partial` by default). ```text original-file-name.XXXXXX.partial ``` (rclone will make sure the final name is no longer than 100 characters by truncating the `original-file-name` part if necessary). When the upload is complete, rclone will rename the `.partial` file to the correct name, overwriting any existing file at that point. If the upload fails then the `.partial` file will be deleted. This prevents other users of the backend from seeing partially uploaded files in their new names and prevents overwriting the old file until the new one is completely uploaded. If the `--inplace` flag is supplied, rclone will upload directly to the final name without creating a `.partial` file. This means that an incomplete file will be visible in the directory listings while the upload is in progress and any existing files will be overwritten as soon as the upload starts. If the transfer fails then the file will be deleted. This can cause data loss of the existing file if the transfer fails. Note that on the local file system if you don't use `--inplace` hard links (Unix only) will be broken. And if you do use `--inplace` you won't be able to update in use executables. Note also that versions of rclone prior to v1.63.0 behave as if the `--inplace` flag is always supplied. ### -i, --interactive {#interactive} This flag can be used to tell rclone that you wish a manual confirmation before destructive operations. It is **recommended** that you use this flag while learning rclone especially with `rclone sync`. For example ```console $ rclone delete --interactive /tmp/dir rclone: delete "important-file.txt"? y) Yes, this is OK (default) n) No, skip this s) Skip all delete operations with no more questions !) Do all delete operations with no more questions q) Exit rclone now. y/n/s/!/q> n ``` The options mean - `y`: **Yes**, this operation should go ahead. You can also press Return for this to happen. You'll be asked every time unless you choose `s` or `!`. - `n`: **No**, do not do this operation. You'll be asked every time unless you choose `s` or `!`. - `s`: **Skip** all the following operations of this type with no more questions. This takes effect until rclone exits. If there are any different kind of operations you'll be prompted for them. - `!`: **Do all** the following operations with no more questions. Useful if you've decided that you don't mind rclone doing that kind of operation. This takes effect until rclone exits . If there are any different kind of operations you'll be prompted for them. - `q`: **Quit** rclone now, just in case! ### --leave-root During rmdirs it will not remove root directory, even if it's empty. ### -l, --links Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows). Ignored files won't be copied, moved or deleted in a sync. If you supply this flag then rclone will copy symbolic links from any supported backend backend, and store them as text files, with a `.rclonelink` suffix in the destination. The text file will contain the target of the symbolic link. The `--links` / `-l` flag enables this feature for all supported backends and the VFS. There are individual flags for just enabling it for the VFS `--vfs-links` and the local backend `--local-links` if required. ### --list-cutoff int {#list-cutoff} When syncing rclone needs to sort directory entries before comparing them. Below this threshold (1,000,000) by default, rclone will store the directory entries in memory. 1,000,000 entries will take approx 1GB of RAM to store. Above this threshold rclone will store directory entries on disk and sort them without using a lot of memory. Doing this is slightly less efficient then sorting them in memory and will only work well for the bucket based backends (eg s3, b2, azureblob, swift) but these are the only backends likely to have millions of entries in a directory. ### --log-file string Log all of rclone's output to a file. This is not active by default. This can be useful for tracking down problems with syncs in combination with the `-v` flag. See the [logging](#logging) section for more info. If the file exists, then rclone will append to it. Note that if you are using the `logrotate` program to manage rclone's logs, then you should use the `copytruncate` option as rclone doesn't have a signal to rotate logs. Alternatively you can use the options below to manage rclone's built in log rotation. ### --log-file-max-size SizeSuffix Maximum size of the log file before it's rotated (eg `10M`). This SizeSuffix is rounded to the nearest MiB or 1 MiB if lower. If `--log-file` is not set then this option will be ignored. If this option is not set, then the other log rotation options will be ignored. For example if the following flags are in use ```console rclone --log-file rclone.log --log-file-max-size 1M --log-file-max-backups 3 ``` Then this will create log files which look like this ```console $ ls -l -rw------- 1 user user 1048491 Apr 11 17:15 rclone-2025-04-11T17-15-29.998.log -rw------- 1 user user 1048511 Apr 11 17:15 rclone-2025-04-11T17-15-30.467.log -rw------- 1 user user 1048559 Apr 11 17:15 rclone-2025-04-11T17-15-30.543.log -rw------- 1 user user 521602 Apr 11 17:15 rclone.log ``` The file `rclone.log` being the current one. ### --log-file-compress If set, compress rotated log files using gzip. This changes the extension of the old log files to `.log.gz`. Defaults to false - don't compress log files. ### --log-file-max-age Duration Maximum duration to retain old log files (eg `7d`). This is rounded to the dearest day, or 1 day if lower. The default is to retain all old log files. ### --log-file-max-backups int Maximum number of old log files to retain The default is to retain all old log files. ### --log-format string Comma separated list of log format options. The accepted options are: - `date` - Add a date in the format YYYY/MM/YY to the log. - `time` - Add a time to the log in format HH:MM:SS. - `microseconds` - Add microseconds to the time in format HH:MM:SS.SSSSSS. - `UTC` - Make the logs in UTC not localtime. - `longfile` - Adds the source file and line number of the log statement. - `shortfile` - Adds the source file and line number of the log statement. - `pid` - Add the process ID to the log - useful with `rclone mount --daemon`. - `nolevel` - Don't add the level to the log. - `json` - Equivalent to adding `--use-json-log` They are added to the log line in the order above. The default log format is `"date,time"`. ### --log-level LogLevel This sets the log level for rclone. The default log level is `NOTICE`. `DEBUG` is equivalent to `-vv`. It outputs lots of debug info - useful for bug reports and really finding out what rclone is doing. `INFO` is equivalent to `-v`. It outputs information about each transfer and prints stats once a minute by default. `NOTICE` is the default log level if no logging flags are supplied. It outputs very little when things are working normally. It outputs warnings and significant events. `ERROR` is equivalent to `-q`. It only outputs error messages. See also the [logging](#logging) section. ### --windows-event-log-level LogLevel If this is configured (the default is `OFF`) then logs of this level and above will be logged to the Windows event log in **addition** to the normal logs. These will be logged in JSON format as described below regardless of what format the main logs are configured for. The Windows event log only has 3 levels of severity `Info`, `Warning` and `Error`. If enabled we map rclone levels like this. - `Error` ← `ERROR` (and above) - `Warning` ← `WARNING` (note that this level is defined but not currently used). - `Info` ← `NOTICE`, `INFO` and `DEBUG`. Rclone will declare its log source as "rclone" if it is has enough permissions to create the registry key needed. If not then logs will appear as "Application". You can run `rclone version --windows-event-log-level DEBUG` once as administrator to create the registry key in advance. **Note** that the `--windows-event-log-level` level must be greater (more severe) than or equal to the `--log-level`. For example to log DEBUG to a log file but ERRORs to the event log you would use ```text --log-file rclone.log --log-level DEBUG --windows-event-log-level ERROR ``` This option is only supported Windows platforms. ### --use-json-log This switches the log format to JSON. The log messages are then streamed as individual JSON objects, with fields: `level`, `msg`, `source`, and `time`. The resulting format is what is sometimes referred to as [newline-delimited JSON](https://en.wikipedia.org/wiki/JSON_streaming#Newline-delimited_JSON) (NDJSON), or JSON Lines (JSONL). This is well suited for processing by traditional line-oriented tools and shell pipelines, but a complete log file is not strictly valid JSON and needs a parser that can handle it. The JSON logs will be printed on a single line, but are shown expanded here for clarity. ```json { "time": "2025-05-13T17:30:51.036237518+01:00", "level": "debug", "msg": "4 go routines active\n", "source": "cmd/cmd.go:298" } ``` Completed data transfer logs will have extra `size` information. Logs which are about a particular object will have `object` and `objectType` fields also. ```json { "time": "2025-05-13T17:38:05.540846352+01:00", "level": "info", "msg": "Copied (new) to: file2.txt", "size": 6, "object": "file.txt", "objectType": "*local.Object", "source": "operations/copy.go:368" } ``` Stats logs will contain a `stats` field which is the same as returned from the rc call [core/stats](https://rclone.org/rc/#core-stats). ```json { "time": "2025-05-13T17:38:05.540912847+01:00", "level": "info", "msg": "...text version of the stats...", "stats": { "bytes": 6, "checks": 0, "deletedDirs": 0, "deletes": 0, "elapsedTime": 0.000904825, ...truncated for clarity... "totalBytes": 6, "totalChecks": 0, "totalTransfers": 1, "transferTime": 0.000882794, "transfers": 1 }, "source": "accounting/stats.go:569" } ``` ### --low-level-retries int This controls the number of low level retries rclone does. A low level retry is used to retry a failing operation - typically one HTTP request. This might be uploading a chunk of a big file for example. You will see low level retries in the log with the `-v` flag. This shouldn't need to be changed from the default in normal operations. However, if you get a lot of low level retries you may wish to reduce the value so rclone moves on to a high level retry (see the `--retries` flag) quicker. Disable low level retries with `--low-level-retries 1`. ### --max-backlog int This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred. This can be set arbitrarily large. It will only use memory when the queue is in use. Note that it will use in the order of N KiB of memory when the backlog is in use. Setting this large allows rclone to calculate how many files are pending more accurately, give a more accurate estimated finish time and make `--order-by` work more accurately. Setting this small will make rclone more synchronous to the listings of the remote which may be desirable. Setting this to a negative number will make the backlog as large as possible. ### --max-buffer-memory SizeSuffix {#max-buffer-memory} If set, don't allocate more than given amount of memory as buffers. If not set or set to `0` or `off` this will not limit the amount of memory in use. This includes memory used by buffers created by the `--buffer` flag and buffers used by multi-thread transfers. Most multi-thread transfers do not take additional memory, but some do depending on the backend (eg the s3 backend for uploads). This means there is a tension between total setting `--transfers` as high as possible and memory use. Setting `--max-buffer-memory` allows the buffer memory to be controlled so that it doesn't overwhelm the machine and allows `--transfers` to be set large. ### --max-connections int This sets the maximum number of concurrent calls to the backend API. It may not map 1:1 to TCP or HTTP connections depending on the backend in use and the use of HTTP1 vs HTTP2. When downloading files, backends only limit the initial opening of the stream. The bulk data download is not counted as a connection. This means that the `--max--connections` flag won't limit the total number of downloads. Note that it is possible to cause deadlocks with this setting so it should be used with care. If you are doing a sync or copy then make sure `--max-connections` is one more than the sum of `--transfers` and `--checkers`. If you use `--check-first` then `--max-connections` just needs to be one more than the maximum of `--checkers` and `--transfers`. So for `--max-connections 3` you'd use `--checkers 2 --transfers 2 --check-first` or `--checkers 1 --transfers 1`. Setting this flag can be useful for backends which do multipart uploads to limit the number of simultaneous parts being transferred. ### --max-delete int This tells rclone not to delete more than N files. If that limit is exceeded then a fatal error will be generated and rclone will stop the operation in progress. ### --max-delete-size SizeSuffix Rclone will stop deleting files when the total size of deletions has reached the size specified. It defaults to off. If that limit is exceeded then a fatal error will be generated and rclone will stop the operation in progress. ### --max-depth int This modifies the recursion depth for all the commands except purge. So if you do `rclone --max-depth 1 ls remote:path` you will see only the files in the top level directory. Using `--max-depth 2` means you will see all the files in first two directory levels and so on. For historical reasons the `lsd` command defaults to using a `--max-depth` of 1 - you can override this with the command line flag. You can use this command to disable recursion (with `--max-depth 1`). Note that if you use this with `sync` and `--delete-excluded` the files not recursed through are considered excluded and will be deleted on the destination. Test first with `--dry-run` if you are not sure what will happen. ### --max-duration Duration Rclone will stop transferring when it has run for the duration specified. Defaults to off. When the limit is reached all transfers will stop immediately. Use `--cutoff-mode` to modify this behaviour. Rclone will exit with exit code 10 if the duration limit is reached. ### --max-transfer SizeSuffix Rclone will stop transferring when it has reached the size specified. Defaults to off. When the limit is reached all transfers will stop immediately. Use `--cutoff-mode` to modify this behaviour. Rclone will exit with exit code 8 if the transfer limit is reached. ### --cutoff-mode HARD|SOFT|CAUTIOUS Configure the behavior of `--max-transfer` and `--max-duration`. `HARD` will stop transferring immediately when rclone reaches the limit. This is the default. `SOFT` will stop starting new transfers when rclone reaches the limit. `CAUTIOUS` will try to prevent rclone from reaching the limit. Only applicable for `--max-transfer`. ### -M, --metadata Setting this flag enables rclone to copy the metadata from the source to the destination. For local backends this is ownership, permissions, xattr etc. See the [metadata section](#metadata) for more info. ### --metadata-mapper SpaceSepList {#metadata-mapper} If you supply the parameter `--metadata-mapper /path/to/program` then rclone will use that program to map metadata from source object to destination object. The argument to this flag should be a command with an optional space separated list of arguments. If one of the arguments has a space in then enclose it in `"`, if you want a literal `"` in an argument then enclose the argument in `"` and double the `"`. See [CSV encoding](https://godoc.org/encoding/csv) for more info. ```text --metadata-mapper "python bin/test_metadata_mapper.py" --metadata-mapper 'python bin/test_metadata_mapper.py "argument with a space"' --metadata-mapper 'python bin/test_metadata_mapper.py "argument with ""two"" quotes"' ``` This uses a simple JSON based protocol with input on STDIN and output on STDOUT. This will be called for every file and directory copied and may be called concurrently. The program's job is to take a metadata blob on the input and turn it into a metadata blob on the output suitable for the destination backend. Input to the program (via STDIN) might look like this. This provides some context for the `Metadata` which may be important. - `SrcFs` is the config string for the remote that the object is currently on. - `SrcFsType` is the name of the source backend. - `DstFs` is the config string for the remote that the object is being copied to - `DstFsType` is the name of the destination backend. - `Remote` is the path of the object relative to the root. - `Size`, `MimeType`, `ModTime` are attributes of the object. - `IsDir` is `true` if this is a directory (not yet implemented). - `ID` is the source `ID` of the object if known. - `Metadata` is the backend specific metadata as described in the backend docs. ```json { "SrcFs": "gdrive:", "SrcFsType": "drive", "DstFs": "newdrive:user", "DstFsType": "onedrive", "Remote": "test.txt", "Size": 6, "MimeType": "text/plain; charset=utf-8", "ModTime": "2022-10-11T17:53:10.286745272+01:00", "IsDir": false, "ID": "xyz", "Metadata": { "btime": "2022-10-11T16:53:11Z", "content-type": "text/plain; charset=utf-8", "mtime": "2022-10-11T17:53:10.286745272+01:00", "owner": "user1@domain1.com", "permissions": "...", "description": "my nice file", "starred": "false" } } ``` The program should then modify the input as desired and send it to STDOUT. The returned `Metadata` field will be used in its entirety for the destination object. Any other fields will be ignored. Note in this example we translate user names and permissions and add something to the description: ```json { "Metadata": { "btime": "2022-10-11T16:53:11Z", "content-type": "text/plain; charset=utf-8", "mtime": "2022-10-11T17:53:10.286745272+01:00", "owner": "user1@domain2.com", "permissions": "...", "description": "my nice file [migrated from domain1]", "starred": "false" } } ``` Metadata can be removed here too. An example python program might look something like this to implement the above transformations. ```python import sys, json i = json.load(sys.stdin) metadata = i["Metadata"] # Add tag to description if "description" in metadata: metadata["description"] += " [migrated from domain1]" else: metadata["description"] = "[migrated from domain1]" # Modify owner if "owner" in metadata: metadata["owner"] = metadata["owner"].replace("domain1.com", "domain2.com") o = { "Metadata": metadata } json.dump(o, sys.stdout, indent="\t") ``` You can find this example (slightly expanded) in the rclone source code at [bin/test_metadata_mapper.py](https://github.com/rclone/rclone/blob/master/bin/test_metadata_mapper.py). If you want to see the input to the metadata mapper and the output returned from it in the log you can use `-vv --dump mapper`. See the [metadata section](#metadata) for more info. ### --metadata-set stringArray Specify value as string in format `key=value` to add metadata `key` with value `value` when uploading. This can be repeated as many times as required. See the [metadata section](#metadata) for more info. ### --modify-window Duration When checking whether a file has been modified, this is the maximum allowed time difference that a file can have and still be considered equivalent. The default is `1ns` unless this is overridden by a remote. For example OS X only stores modification times to the nearest second so if you are reading and writing to an OS X filing system this will be `1s` by default. This command line flag allows you to override that computed default. ### --multi-thread-write-buffer-size SizeSuffix When transferring with multiple threads, rclone will buffer the specified number of bytes in memory before writing to disk for each thread. This can improve performance if the underlying filesystem does not deal well with a lot of small writes in different positions of the file, so if you see transfers being limited by disk write speed, you might want to experiment with different values. Specially for magnetic drives and remote file systems a higher value can be useful. Nevertheless, the default of `128k` should be fine for almost all use cases, so before changing it ensure that network is not really your bottleneck. As a final hint, size is not the only factor: block size (or similar concept) can have an impact. In one case, we observed that exact multiples of 16k performed much better than other values. ### --multi-thread-chunk-size SizeSuffix Normally the chunk size for multi thread transfers is set by the backend. However some backends such as `local` and `smb` (which implement `OpenWriterAt` but not `OpenChunkWriter`) don't have a natural chunk size. In this case the value of this option is used (default 64Mi). ### --multi-thread-cutoff SizeSuffix {#multi-thread-cutoff} When transferring files above specified size to capable backends, rclone will use multiple threads to transfer the file (default 256M). Capable backends are marked in the [overview](https://rclone.org/overview/#optional-features) as `MultithreadUpload`. (They need to implement either the `OpenWriterAt` or `OpenChunkWriter` internal interfaces). These include include, `local`, `s3`, `azureblob`, `b2`, `oracleobjectstorage` and `smb` at the time of writing. On the local disk, rclone preallocates the file (using `fallocate(FALLOC_FL_KEEP_SIZE)` on unix or `NTSetInformationFile` on Windows both of which takes no time) then each thread writes directly into the file at the correct place. This means that rclone won't create fragmented or sparse files and there won't be any assembly time at the end of the transfer. The number of threads used to transfer is controlled by `--multi-thread-streams`. Use `-vv` if you wish to see info about the threads. This will work with the [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) and [move](https://rclone.org/commands/rclone_move/) commands, and friends [copyto](https://rclone.org/commands/rclone_copyto/), [moveto](https://rclone.org/commands/rclone_moveto/). Multi thread transfers will be used with `rclone mount` and `rclone serve` if `--vfs-cache-mode` is set to `writes` or above. Most multi-thread transfers do not take additional memory, but some do (for example uploading to s3). In the worst case memory usage can be at maximum `--transfers` \* `--multi-thread-chunk-size` \* `--multi-thread-streams` or specifically for the s3 backend `--transfers` \* `--s3-chunk-size` \* `--s3-concurrency`. However you can use the the [--max-buffer-memory](https://rclone.org/docs/#max-buffer-memory) flag to control the maximum memory used here. **NB** that this **only** works with supported backends as the destination but will work with any backend as the source. **NB** that multi-thread copies are disabled for local to local copies as they are faster without unless `--multi-thread-streams` is set explicitly. **NB** on Windows using multi-thread transfers to the local disk will cause the resulting files to be [sparse](https://en.wikipedia.org/wiki/Sparse_file). Use `--local-no-sparse` to disable sparse files (which may cause long delays at the start of transfers) or disable multi-thread transfers with `--multi-thread-streams 0` ### --multi-thread-streams int When using multi thread transfers (see above `--multi-thread-cutoff`) this sets the number of streams to use. Set to `0` to disable multi thread transfers (Default 4). If the backend has a `--backend-upload-concurrency` setting (eg `--s3-upload-concurrency`) then this setting will be used as the number of transfers instead if it is larger than the value of `--multi-thread-streams` or `--multi-thread-streams` isn't set. ### --name-transform stringArray `--name-transform` introduces path name transformations for `rclone copy`, `rclone sync`, and `rclone move`. These transformations enable modifications to source and destination file names by applying prefixes, suffixes, and other alterations during transfer operations. For detailed docs and examples, see [`convmv`](https://rclone.org/commands/rclone_convmv/). ### --no-check-dest The `--no-check-dest` can be used with `move` or `copy` and it causes rclone not to check the destination at all when copying files. This means that: - the destination is not listed minimising the API calls - files are always transferred - this can cause duplicates on remotes which allow it (e.g. Google Drive) - `--retries 1` is recommended otherwise you'll transfer everything again on a retry This flag is useful to minimise the transactions if you know that none of the files are on the destination. This is a specialized flag which should be ignored by most users! ### --no-gzip-encoding Don't set `Accept-Encoding: gzip`. This means that rclone won't ask the server for compressed files automatically. Useful if you've set the server to return files with `Content-Encoding: gzip` but you uploaded compressed files. There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone. ### --no-traverse The `--no-traverse` flag controls whether the destination file system is traversed when using the `copy` or `move` commands. `--no-traverse` is not compatible with `sync` and will be ignored if you supply it with `sync`. If you are only copying a small number of files (or are filtering most of the files) and/or have a large number of files on the destination then `--no-traverse` will stop rclone listing the destination and save time. However, if you are copying a large number of files, especially if you are doing a copy where lots of the files under consideration haven't changed and won't need copying then you shouldn't use `--no-traverse`. See [rclone copy](https://rclone.org/commands/rclone_copy/) for an example of how to use it. ### --no-unicode-normalization Don't normalize unicode characters in filenames during the sync routine. Sometimes, an operating system will store filenames containing unicode parts in their decomposed form (particularly macOS). Some cloud storage systems will then recompose the unicode, resulting in duplicate files if the data is ever copied back to a local filesystem. Using this flag will disable that functionality, treating each unicode character as unique. For example, by default é and é will be normalized into the same character. With `--no-unicode-normalization` they will be treated as unique characters. ### --no-update-modtime When using this flag, rclone won't update modification times of remote files if they are incorrect as it would normally. This can be used if the remote is being synced with another tool also (e.g. the Google Drive client). ### --no-update-dir-modtime When using this flag, rclone won't update modification times of remote directories if they are incorrect as it would normally. ### --order-by string The `--order-by` flag controls the order in which files in the backlog are processed in `rclone sync`, `rclone copy` and `rclone move`. The order by string is constructed like this. The first part describes what aspect is being measured: - `size` - order by the size of the files - `name` - order by the full path of the files - `modtime` - order by the modification date of the files This can have a modifier appended with a comma: - `ascending` or `asc` - order so that the smallest (or oldest) is processed first - `descending` or `desc` - order so that the largest (or newest) is processed first - `mixed` - order so that the smallest is processed first for some threads and the largest for others If the modifier is `mixed` then it can have an optional percentage (which defaults to `50`), e.g. `size,mixed,25` which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The `mixed` mode can be useful to minimise the transfer time when you are transferring a mixture of large and small files - the large files are guaranteed upload threads and bandwidth and the small files will be processed continuously. If no modifier is supplied then the order is `ascending`. For example - `--order-by size,desc` - send the largest files first - `--order-by modtime,ascending` - send the oldest files first - `--order-by name` - send the files with alphabetically by path first If the `--order-by` flag is not supplied or it is supplied with an empty string then the default ordering will be used which is as scanned. With `--checkers 1` this is mostly alphabetical, however with the default `--checkers 8` it is somewhat random. #### Limitations The `--order-by` flag does not do a separate pass over the data. This means that it may transfer some files out of the order specified if - there are no files in the backlog or the source has not been fully scanned yet - there are more than [--max-backlog](#max-backlog-int) files in the backlog Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of `--order-by` as being more of a best efforts flag rather than a perfect ordering. If you want perfect ordering then you will need to specify [--check-first](#check-first) which will find all the files which need transferring first before transferring any. ### --partial-suffix string {#partial-suffix} When [--inplace](#inplace) is not used, it causes rclone to use the `--partial-suffix` as suffix for temporary files. Suffix length limit is 16 characters. The default is `.partial`. ### --password-command SpaceSepList {#password-command} This flag supplies a program which should supply the config password when run. This is an alternative to rclone prompting for the password or setting the `RCLONE_CONFIG_PASS` variable. It is also used when setting the config password for the first time. The argument to this should be a command with a space separated list of arguments. If one of the arguments has a space in then enclose it in `"`, if you want a literal `"` in an argument then enclose the argument in `"` and double the `"`. See [CSV encoding](https://godoc.org/encoding/csv) for more info. Eg ```text --password-command "echo hello" --password-command 'echo "hello with space"' --password-command 'echo "hello with ""quotes"" and space"' ``` Note that when changing the configuration password the environment variable `RCLONE_PASSWORD_CHANGE=1` will be set. This can be used to distinguish initial decryption of the config file from the new password. See the [Configuration Encryption](#configuration-encryption) for more info. See a [Windows PowerShell example on the Wiki](https://github.com/rclone/rclone/wiki/Windows-Powershell-use-rclone-password-command-for-Config-file-password). ### -P, --progress This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer. Any log messages will scroll above the static block. Log messages will push the static block down to the bottom of the terminal where it will stay. Normally this is updated every 500mS but this period can be overridden with the `--stats` flag. This can be used with the `--stats-one-line` flag for a simpler display. To change the display length of filenames (for different terminal widths), see the `--stats-file-name-length` option. The default output is formatted for 80 character wide terminals. Note: On Windows until [this bug](https://github.com/Azure/go-ansiterm/issues/26) is fixed all non-ASCII characters will be replaced with `.` when `--progress` is in use. ### --progress-terminal-title This flag, when used with `-P/--progress`, will print the string `ETA: %s` to the terminal title. ### -q, --quiet This flag will limit rclone's output to error messages only. ### --refresh-times The `--refresh-times` flag can be used to update modification times of existing files when they are out of sync on backends which don't support hashes. This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them. This flag is **only** useful for destinations which don't support hashes (e.g. `crypt`). This can be used any of the sync commands [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/). To use this flag you will need to be doing a modification time sync (so not using `--size-only` or `--checksum`). The flag will have no effect when using `--size-only` or `--checksum`. If this flag is used when rclone comes to upload a file it will check to see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match rclone will upload the new file. If the checksum is absent (e.g. on a `crypt` backend) then rclone will update the timestamp. Note that some remotes can't set the modification time without re-uploading the file so this flag is less useful on them. Normally if you are doing a modification time sync rclone will update modification times without `--refresh-times` provided that the remote supports checksums **and** the checksums match on the file. However if the checksums are absent then rclone will upload the file rather than setting the timestamp as this is the safe behaviour. ### --retries int Retry the entire sync if it fails this many times it fails (default 3). Some remotes can be unreliable and a few retries help pick up the files which didn't get transferred because of errors. Disable retries with `--retries 1`. ### --retries-sleep Duration This sets the interval between each retry specified by `--retries` The default is `0`. Use `0` to disable. ### --server-side-across-configs Allow server-side operations (e.g. copy or move) to work across different configurations. This can be useful if you wish to do a server-side copy or move between two remotes which use the same backend but are configured differently. Note that this isn't enabled by default because it isn't easy for rclone to tell if it will work between any two configurations. ### --size-only Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check only the size. This can be useful transferring files from Dropbox which have been modified by the desktop sync client which doesn't set checksums of modification times in the same way as rclone. ### --stats Duration Commands which transfer data ([sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/), [copyto](https://rclone.org/commands/rclone_copyto/), [move](https://rclone.org/commands/rclone_move/), [moveto](https://rclone.org/commands/rclone_moveto/)) will print data transfer stats at regular intervals to show their progress. This sets the interval. The default is `1m`. Use `0` to disable. If you set the stats interval then all commands can show stats. This can be useful when running other commands, `check` or `mount` for example. Stats are logged at `INFO` level by default which means they won't show at default log level `NOTICE`. Use `--stats-log-level NOTICE` or `-v` to make them show. See the [logging](#logging) section for more info on log levels. Note that on macOS you can send a SIGINFO (which is normally ctrl-T in the terminal) to make the stats print immediately. ### --stats-file-name-length int By default, the `--stats` output will truncate file names and paths longer than 40 characters. This is equivalent to providing `--stats-file-name-length 40`. Use `--stats-file-name-length 0` to disable any truncation of file names printed by stats. ### --stats-log-level LogLevel Log level to show `--stats` output at. This can be `DEBUG`, `INFO`, `NOTICE`, or `ERROR`. The default is `INFO`. This means at the default level of logging, which is `NOTICE`, the stats won't show - if you want them to then use `--stats-log-level NOTICE`. See the [logging](#logging) section for more details on log levels. ### --stats-one-line When this is specified, rclone condenses the stats into a single line showing the most important stats only. ### --stats-one-line-date When this is specified, rclone enables the single-line stats and prepends the display with a date string. The default is `2006/01/02 15:04:05 - ` ### --stats-one-line-date-format string When this is specified, rclone enables the single-line stats and prepends the display with a user-supplied date string. The date string MUST be enclosed in quotes. Follow [golang specs](https://golang.org/pkg/time/#Time.Format) for date formatting syntax. ### --stats-unit string By default, data transfer rates will be printed in bytes per second, corresponding to `--stats-unit bytes`. This option allows the data rate to be printed in bits per second, by specifying `--stats-unit bits`. Data transfer volume will still be reported in bytes. The rate is reported as a binary unit, not SI unit. So 1 Mbit/s equals 1,048,576 bit/s and not 1,000,000 bit/s. ### --suffix string When using [sync](https://rclone.org/commands/rclone_sync/), [copy](https://rclone.org/commands/rclone_copy/) or [move](https://rclone.org/commands/rclone_move/) any files which would have been overwritten or deleted will have the suffix added to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten. The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. This is for use with files to add the suffix in the current directory or with `--backup-dir`. See `--backup-dir` for more info. For example ```console rclone copy --interactive /path/to/local/file remote:current --suffix .bak ``` will copy `/path/to/local` to `remote:current`, but for any files which would have been updated or deleted have .bak added. If using `rclone sync` with `--suffix` and without `--backup-dir` then it is recommended to put a filter rule in excluding the suffix otherwise the `sync` will delete the backup files. ```console rclone sync --interactive /path/to/local/file remote:current --suffix .bak --exclude "*.bak" ``` ### --suffix-keep-extension When using `--suffix`, setting this causes rclone put the SUFFIX before the extension of the files that it backs up rather than after. So let's say we had `--suffix -2019-01-01`, without the flag `file.txt` would be backed up to `file.txt-2019-01-01` and with the flag it would be backed up to `file-2019-01-01.txt`. This can be helpful to make sure the suffixed files can still be opened. If a file has two (or more) extensions and the second (or subsequent) extension is recognised as a valid mime type, then the suffix will go before that extension. So `file.tar.gz` would be backed up to `file-2019-01-01.tar.gz` whereas `file.badextension.gz` would be backed up to `file.badextension-2019-01-01.gz`. ### --syslog On capable OSes (not Windows or Plan9) send all log output to syslog. This can be useful for running rclone in a script or `rclone mount`. ### --syslog-facility string If using `--syslog` this sets the syslog facility (e.g. `KERN`, `USER`). See `man syslog` for a list of possible facilities. The default facility is `DAEMON`. ### --temp-dir string Specify the directory rclone will use for temporary files, to override the default. Make sure the directory exists and have accessible permissions. By default the operating system's temp directory will be used: - On Unix systems, `$TMPDIR` if non-empty, else `/tmp`. - On Windows, the first non-empty value from `%TMP%`, `%TEMP%`, `%USERPROFILE%`, or the Windows directory. When overriding the default with this option, the specified path will be set as value of environment variable `TMPDIR` on Unix systems and `TMP` and `TEMP` on Windows. You can use the [config paths](https://rclone.org/commands/rclone_config_paths/) command to see the current value. ### --tpslimit float Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second. A transaction is roughly defined as an API call; its exact meaning will depend on the backend. For HTTP based backends it is an HTTP PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip transaction over TCP. For example, to limit rclone to 10 transactions per second use `--tpslimit 10`, or to 1 transaction every 2 seconds use `--tpslimit 0.5`. Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (e.g. getting you banned or rate limited). This can be very useful for `rclone mount` to control the behaviour of applications using it. This limit applies to all HTTP based backends and to the FTP and SFTP backends. It does not apply to the local backend or the Storj backend. See also `--tpslimit-burst`. ### --tpslimit-burst int Max burst of transactions for `--tpslimit` (default `1`). Normally `--tpslimit` will do exactly the number of transaction per second specified. However if you supply `--tps-burst` then rclone can save up some transactions from when it was idle giving a burst of up to the parameter supplied. For example if you provide `--tpslimit-burst 10` then if rclone has been idle for more than 10*`--tpslimit` then it can do 10 transactions very quickly before they are limited again. This may be used to increase performance of `--tpslimit` without changing the long term average number of transactions per second. ### --track-renames By default, rclone doesn't keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy. An rclone sync with `--track-renames` runs like a normal sync, but keeps track of objects which exist in the destination but not in the source (which would normally be deleted), and which objects exist in the source but not the destination (which would normally be transferred). These objects are then candidates for renaming. After the sync, rclone matches up the source only and destination only objects using the `--track-renames-strategy` specified and either renames the destination object or transfers the source and deletes the destination object. `--track-renames` is stateless like all of rclone's syncs. To use this flag the destination must support server-side copy or server-side move, and to use a hash based `--track-renames-strategy` (the default) the source and the destination must have a compatible hash. If the destination does not support server-side copy or move, rclone will fall back to the default behaviour and log an error level message to the console. Encrypted destinations are not currently supported by `--track-renames` if `--track-renames-strategy` includes `hash`. Note that `--track-renames` is incompatible with `--no-traverse` and that it uses extra memory to keep track of all the rename candidates. Note also that `--track-renames` is incompatible with `--delete-before` and will select `--delete-after` instead of `--delete-during`. ### --track-renames-strategy string This option changes the file matching criteria for `--track-renames`. The matching is controlled by a comma separated selection of these tokens: - `modtime` - the modification time of the file - not supported on all backends - `hash` - the hash of the file contents - not supported on all backends - `leaf` - the name of the file not including its directory name - `size` - the size of the file (this is always enabled) The default option is `hash`. Using `--track-renames-strategy modtime,leaf` would match files based on modification time, the leaf of the file name and the size only. Using `--track-renames-strategy modtime` or `leaf` can enable `--track-renames` support for encrypted destinations. Note that the `hash` strategy is not supported with encrypted destinations. ### --delete-(before,during,after) This option allows you to specify when files on your destination are deleted when you sync folders. Specifying the value `--delete-before` will delete all files present on the destination, but not on the source *before* starting the transfer of any new or updated files. This uses two passes through the file systems, one for the deletions and one for the copies. Specifying `--delete-during` will delete files while checking and uploading files. This is the fastest option and uses the least memory. Specifying `--delete-after` (the default value) will delay deletion of files until all new/updated files have been successfully transferred. The files to be deleted are collected in the copy pass then deleted after the copy pass has completed successfully. The files to be deleted are held in memory so this mode may use more memory. This is the safest mode as it will only delete files if there have been no errors subsequent to that. If there have been errors before the deletions start then you will get the message `not deleting files as there were IO errors`. ### --fast-list When doing anything which involves a directory listing (e.g. `sync`, `copy`, `ls` - in fact nearly every command), rclone has different strategies to choose from. The basic strategy is to list one directory and processes it before using more directory lists to process any subdirectories. This is a mandatory backend feature, called `List`, which means it is supported by all backends. This strategy uses small amount of memory, and because it can be parallelised it is fast for operations involving processing of the list results. Some backends provide the support for an alternative strategy, where all files beneath a directory can be listed in one (or a small number) of transactions. Rclone supports this alternative strategy through an optional backend feature called [`ListR`](https://rclone.org/overview/#listr). You can see in the storage system overview documentation's [optional features](https://rclone.org/overview/#optional-features) section which backends it is enabled for (these tend to be the bucket-based ones, e.g. S3, B2, GCS, Swift). This strategy requires fewer transactions for highly recursive operations, which is important on backends where this is charged or heavily rate limited. It may be faster (due to fewer transactions) or slower (because it can't be parallelized) depending on different parameters, and may require more memory if rclone has to keep the whole listing in memory. Which listing strategy rclone picks for a given operation is complicated, but in general it tries to choose the best possible. It will prefer `ListR` in situations where it doesn't need to store the listed files in memory, e.g. for unlimited recursive `ls` command variants. In other situations it will prefer `List`, e.g. for `sync` and `copy`, where it needs to keep the listed files in memory, and is performing operations on them where parallelization may be a huge advantage. Rclone is not able to take all relevant parameters into account for deciding the best strategy, and therefore allows you to influence the choice in two ways: You can stop rclone from using `ListR` by disabling the feature, using the [--disable](#disable-string) option (`--disable ListR`), or you can allow rclone to use `ListR` where it would normally choose not to do so due to higher memory usage, using the `--fast-list` option. Rclone should always produce identical results either way. Using `--disable ListR` or `--fast-list` on a remote which doesn't support `ListR` does nothing, rclone will just ignore it. A rule of thumb is that if you pay for transactions and can fit your entire sync listing into memory, then `--fast-list` is recommended. If you have a very big sync to do, then don't use `--fast-list`, otherwise you will run out of memory. Run some tests and compare before you decide, and if in doubt then just leave the default, let rclone decide, i.e. not use `--fast-list`. ### --timeout Duration This sets the IO idle timeout. If a transfer has started but then becomes idle for this long it is considered broken and disconnected. The default is `5m`. Set to `0` to disable. ### --transfers int The number of file transfers to run in parallel. It can sometimes be useful to set this to a smaller number if the remote is giving a lot of timeouts or bigger if you have lots of bandwidth and a fast remote. The default is to run 4 file transfers in parallel. Look at --multi-thread-streams if you would like to control single file transfers. ### -u, --update This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. This can be useful in avoiding needless transfers when transferring to a remote which doesn't support modification times directly (or when using `--use-server-modtime` to avoid extra API calls) as it is more accurate than a `--size-only` check and faster than using `--checksum`. On such remotes (or when using `--use-server-modtime`) the time checked will be the uploaded time. If an existing destination file has a modification time older than the source file's, it will be updated if the sizes are different. If the sizes are the same, it will be updated if the checksum is different or not available. If an existing destination file has a modification time equal (within the computed modify window) to the source file's, it will be updated if the sizes are different. The checksum will not be checked in this case unless the `--checksum` flag is provided. In all other cases the file will not be updated. Consider using the `--modify-window` flag to compensate for time skews between the source and the backend, for backends that do not support mod times, and instead use uploaded times. However, if the backend does not support checksums, note that syncing or copying within the time skew window may still result in additional transfers for safety. ### --use-mmap If this flag is set then rclone will use anonymous memory allocated by mmap on Unix based platforms and VirtualAlloc on Windows for its transfer buffers (size controlled by `--buffer-size`). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with. If this flag is not set then rclone will allocate and free the buffers using the Go memory allocator which may use more memory as memory pages are returned less aggressively to the OS. It is possible this does not work well on all platforms so it is disabled by default; in the future it may be enabled by default. ### --use-server-modtime Some object-store backends (e.g, Swift, S3) do not preserve file modification times (modtime). On these backends, rclone stores the original modtime as additional metadata on the object. By default it will make an API call to retrieve the metadata when the modtime is needed by an operation. Use this flag to disable the extra API call and rely instead on the server's modified time. In cases such as a local to remote sync using `--update`, knowing the local file is newer than the time it was last uploaded to the remote is sufficient. In those cases, this flag can speed up the process and reduce the number of API calls necessary. This flag is only supported on certain backends and will be silently ignored on unsupported backends. Supported backends include `azureblob`, `oracleobjectstorage`, `s3`, `swift`. Using this flag on a sync operation without also using `--update` would cause all files modified at any time other than the last upload time to be uploaded again, which is probably not what you want. ### -v, -vv, --verbose With `-v` rclone will tell you about each file that is transferred and a small number of significant events. With `-vv` rclone will become very verbose telling you about every file it considers and transfers. Please send bug reports with a log with this setting. When setting verbosity as an environment variable, use `RCLONE_VERBOSE=1` or `RCLONE_VERBOSE=2` for `-v` and `-vv` respectively. ### -V, --version Prints the version number ## SSL/TLS options The outgoing SSL/TLS connections rclone makes can be controlled with these options. For example this can be very useful with the HTTP or WebDAV backends. Rclone HTTP servers have their own set of configuration for SSL/TLS which you can find in their documentation. ### --ca-cert stringArray This loads the PEM encoded certificate authority certificates and uses it to verify the certificates of the servers rclone connects to. If you have generated certificates signed with a local CA then you will need this flag to connect to servers using those certificates. ### --client-cert string This loads the PEM encoded client side certificate. This is used for [mutual TLS authentication](https://en.wikipedia.org/wiki/Mutual_authentication). The `--client-key` flag is required too when using this. ### --client-key string This loads the PEM encoded client side private key used for mutual TLS authentication. Used in conjunction with `--client-cert`. Supported types are: - Unencrypted PKCS#1 ("BEGIN RSA PRIVATE KEY") - Unencrypted PKCS#8 ("BEGIN PRIVATE KEY") - Encrypted PKCS#8 ("BEGIN ENCRYPTED PRIVATE KEY") - Legacy PEM encryption (e.g., DEK-Info headers), which are automatically detected. ### --client-pass string This can be used to supply an optional password to decrypt the client key file. **NB** the password should be obscured so it should be the output of `rclone obscure YOURPASSWORD`. ### --no-check-certificate `--no-check-certificate` controls whether a client verifies the server's certificate chain and host name. If `--no-check-certificate` is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks. This option defaults to `false`. **This should be used only for testing.** ## Configuration encryption Your configuration file contains information for logging in to your cloud services. This means that you should keep your `rclone.conf` file in a secure location. If you are in an environment where that isn't possible, you can add a password to your configuration. This means that you will have to supply the password every time you start rclone. To add a password to your rclone configuration, execute `rclone config`. ```console $ rclone config Current remotes: e) Edit existing remote n) New remote d) Delete remote s) Set configuration password q) Quit config e/n/d/s/q> ``` Go into `s`, Set configuration password: ```text e/n/d/s/q> s Your configuration is not encrypted. If you add a password, you will protect your login information to cloud services. a) Add Password q) Quit to main menu a/q> a Enter NEW configuration password: password: Confirm NEW password: password: Password set Your configuration is encrypted. c) Change Password u) Unencrypt configuration q) Quit to main menu c/u/q> ``` Your configuration is now encrypted, and every time you start rclone you will have to supply the password. See below for details. In the same menu, you can change the password or completely remove encryption from your configuration. There is no way to recover the configuration if you lose your password. You can also use - [rclone config encryption set](https://rclone.org/commands/rclone_config_encryption_set/) to set the config encryption directly - [rclone config encryption remove](https://rclone.org/commands/rclone_config_encryption_remove/) to remove it - [rclone config encryption check](https://rclone.org/commands/rclone_config_encryption_check/) to check that it is encrypted properly. rclone uses [nacl secretbox](https://godoc.org/golang.org/x/crypto/nacl/secretbox) which in turn uses XSalsa20 and Poly1305 to encrypt and authenticate your configuration with secret-key cryptography. The password is SHA-256 hashed, which produces the key for secretbox. The hashed password is not stored. While this provides very good security, we do not recommend storing your encrypted rclone configuration in public if it contains sensitive information, maybe except if you use a very strong password. If it is safe in your environment, you can set the `RCLONE_CONFIG_PASS` environment variable to contain your password, in which case it will be used for decrypting the configuration. You can set this for a session from a script. For unix like systems save this to a file called `set-rclone-password`: ```sh #!/bin/echo Source this file don't run it read -s RCLONE_CONFIG_PASS export RCLONE_CONFIG_PASS ``` Then source the file when you want to use it. From the shell you would do `source set-rclone-password`. It will then ask you for the password and set it in the environment variable. An alternate means of supplying the password is to provide a script which will retrieve the password and print on standard output. This script should have a fully specified path name and not rely on any environment variables. The script is supplied either via [`--password-command="..."`](#password-command) command line argument or via the `RCLONE_PASSWORD_COMMAND` environment variable. One useful example of this is using the `passwordstore` application to retrieve the password: ```console export RCLONE_PASSWORD_COMMAND="pass rclone/config" ``` If the `passwordstore` password manager holds the password for the rclone configuration, using the script method means the password is primarily protected by the `passwordstore` system, and is never embedded in the clear in scripts, nor available for examination using the standard commands available. It is quite possible with long running rclone sessions for copies of passwords to be innocently captured in log files or terminal scroll buffers, etc. Using the script method of supplying the password enhances the security of the config password considerably. If you are running rclone inside a script, unless you are using the `--password-command` method, you might want to disable password prompts. To do that, pass the parameter `--ask-password=false` to rclone. This will make rclone fail instead of asking for a password if `RCLONE_CONFIG_PASS` doesn't contain a valid password, and `--password-command` has not been supplied. Whenever running commands that may be affected by options in a configuration file, rclone will look for an existing file according to the rules described [above](#config-string), and load any it finds. If an encrypted file is found, this includes decrypting it, with the possible consequence of a password prompt. When executing a command line that you know are not actually using anything from such a configuration file, you can avoid it being loaded by overriding the location, e.g. with one of the documented special values for memory-only configuration. Since only backend options can be stored in configuration files, this is normally unnecessary for commands that do not operate on backends, e.g. `completion`. However, it will be relevant for commands that do operate on backends in general, but are used without referencing a stored remote, e.g. listing local filesystem paths, or [connection strings](#connection-strings): `rclone --config="" ls .` ### Configuration encryption cheatsheet You can quickly apply a configuration encryption without plain-text at rest or transfer. Detailed instructions for popular OSes: #### Mac - Generate and store a password ```console security add-generic-password -a rclone -s config -w $(openssl rand -base64 40) ``` - Add the retrieval instruction to your `.zprofile` / `.profile` ```console export RCLONE_PASSWORD_COMMAND="/usr/bin/security find-generic-password -a rclone -s config -w" ``` #### Linux - Prerequisite: Linux doesn't come with a default password manager. Let's install the "pass" utility using a package manager, e.g. `apt install pass`, `yum install pass`, [etc.](https://www.passwordstore.org/#download); then initialize a password store: `pass init rclone`. - Generate and store a password ```console echo $(openssl rand -base64 40) | pass insert -m rclone/config ``` - Add the retrieval instruction ```console export RCLONE_PASSWORD_COMMAND="/usr/bin/pass rclone/config" ``` #### Windows - Generate and store a password ```powershell New-Object -TypeName PSCredential -ArgumentList "rclone", (ConvertTo-SecureString -String ([System.Web.Security.Membership]::GeneratePassword(40, 10)) -AsPlainText -Force) | Export-Clixml -Path "rclone-credential.xml" ``` - Add the password retrieval instruction ```powershell [Environment]::SetEnvironmentVariable("RCLONE_PASSWORD_COMMAND", "[System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR((Import-Clixml -Path "rclone-credential.xml").Password))") ``` #### Encrypt the config file (all systems) - Execute `rclone config`, and select option `s) Set configuration password` - Add/update the password from previous steps ## Developer options These options are useful when developing or debugging rclone. There are also some more remote specific options which aren't documented here which are used for testing. These start with remote name e.g. `--drive-test-option` - see the docs for the remote in question. ### --cpuprofile string Write CPU profile to a file. This can be analysed with `go tool pprof`. ### --memprofile string Write memory profile to a file. This can be analysed with `go tool pprof`. ### --dump DumpFlags The `--dump` flag takes a comma separated list of flags to dump info about. Note that some headers, such as `Accept-Encoding`, may not be correct as shown in the request, and the response may not show `Content-Encoding` if the go standard libraries auto gzip encoding was in effect. In this case the body of the request will be gunzipped before showing it. The available flags are: - `headers` dumps HTTP headers. Any `Authorization:` headers will be excluded, but output may still contain sensitive information. Can be very verbose. Useful for debugging only. Use `auth` if you do want the `Authorization:` headers. - `auth` dumps HTTP headers like `headers`, but also includes any `Authorization:` headers. This means the output will probably contain sensitive information. Use `headers` to dump without `Authorization:` headers. Can be very verbose. Useful for debugging only. This flag also makes the debug log of the config process (e.g. `rclone config -vv`) show answers to questions, passwords and tokens which are otherwise redacted. - `bodies` dumps HTTP headers and bodies. May contain sensitive info. Can be very verbose. Useful for debugging only. Note that the bodies are buffered in memory so don't use this for enormous files. - `requests` is similar to `bodies`, but dumps the request bodies and the response headers. Useful for debugging download problems. - `responses` is similar to `bodies`, but dumps the response bodies and the request headers. Useful for debugging upload problems. - `filters` dumps the filters. Useful to see exactly what include and exclude options are filtering on. - `goroutines` dumps a list of the running go-routines at the end of the command. - `openfiles` dumps a list of the open files at the end of the command. It uses the `lsof` Unix command to do that, so you'll need that installed to use it. - `mapper` dumps the JSON blobs being sent to the program supplied with `--metadata-mapper` and received from it. It can be useful for debugging the metadata mapper interface. - `curl` dumps the HTTP request as a `curl` command. Can be used with the other HTTP debugging flags (e.g. `requests`, `bodies`). By default the auth will be masked - use with `auth` to have the curl commands with authentication too. - `errors` only dumps the HTTP transactions which fail with a retryable error - that is a transport error, an HTTP 429 (too many requests) or an HTTP 5xx server error. The other dump flags control what is dumped, so for example use `--dump errors,bodies` to dump the headers and bodies of failed transactions only. On its own `--dump errors` dumps the headers. This lets you capture first-failure diagnostics without the noise of dumping every transaction. May contain sensitive info. - `trace` logs connection level events for each HTTP transaction using Go's `net/http/httptrace` - DNS resolution, TCP connect, TLS handshake (including the negotiated TLS version, cipher, ALPN protocol and server certificate), connection reuse, request write and time to first response byte. Each line is tagged with the time elapsed since the start of the transaction so you can see where the time goes. This is complementary to the other dump flags: it shows how the connection behaved rather than what was sent, so it is useful for debugging connectivity, DNS, TLS, proxy and keep-alive problems. It does not dump headers or bodies - combine it with `headers` or `bodies` for that. ## Filtering For the filtering options - `--delete-excluded` - `--filter` - `--filter-from` - `--exclude` - `--exclude-from` - `--exclude-if-present` - `--include` - `--include-from` - `--files-from` - `--files-from-raw` - `--files-from0` - `--min-size` - `--max-size` - `--min-age` - `--max-age` - `--hash-filter` - `--dump filters` - `--metadata-include` - `--metadata-include-from` - `--metadata-exclude` - `--metadata-exclude-from` - `--metadata-filter` - `--metadata-filter-from` See the [filtering section](https://rclone.org/filtering/). ## Remote control For the remote control options and for instructions on how to remote control rclone: - `--rc` - Anything starting with `--rc-` See [the remote control section](https://rclone.org/rc/). ## Logging rclone has 4 levels of logging, `ERROR`, `NOTICE`, `INFO` and `DEBUG`. By default, rclone logs to standard error. This means you can redirect standard error and still see the normal output of rclone commands (e.g. `rclone ls`). By default, rclone will produce `Error` and `Notice` level messages. If you use the `-q` flag, rclone will only produce `Error` messages. If you use the `-v` flag, rclone will produce `Error`, `Notice` and `Info` messages. If you use the `-vv` flag, rclone will produce `Error`, `Notice`, `Info` and `Debug` messages. You can also control the log levels with the `--log-level` flag. If you use the `--log-file` option, rclone will redirect `Error`, `Info` and `Debug` messages along with standard error to a file. If you use the `--syslog` flag then rclone will log to syslog and the `--syslog-facility` control which facility it uses. Rclone prefixes all log messages with their level in capitals, e.g. INFO which makes it easy to grep the log file for different kinds of information. ## Metrics Rclone can publish metrics in the OpenMetrics/Prometheus format. To enable the metrics endpoint, use the `--metrics-addr` flag. Metrics can also be published on the `--rc-addr` port if the `--rc` flag and `--rc-enable-metrics` flags are supplied or if using rclone rcd `--rc-enable-metrics` Rclone provides extensive configuration options for the metrics HTTP endpoint. These settings are grouped under the Metrics section and have a prefix `--metrics-*`. When metrics are enabled with `--rc-enable-metrics`, they will be published on the same port as the rc API. In this case, the `--metrics-*` flags will be ignored, and the HTTP endpoint configuration will be managed by the `--rc-*` parameters. ## Exit code If any errors occur during the command execution, rclone will exit with a non-zero exit code. This allows scripts to detect when rclone operations have failed. During the startup phase, rclone will exit immediately if an error is detected in the configuration. There will always be a log message immediately before exiting. When rclone is running it will accumulate errors as it goes along, and only exit with a non-zero exit code if (after retries) there were still failed transfers. For every error counted there will be a high priority log message (visible with `-q`) showing the message and which file caused the problem. A high priority message is also shown when starting a retry so the user can see that any previous error messages may not be valid after the retry. If rclone has done a retry it will log a high priority message if the retry was successful. ### List of exit codes - `0` - Success - `1` - Error not otherwise categorised - `2` - Syntax or usage error - `3` - Directory not found - `4` - File not found - `5` - Temporary error (one that more retries might fix) (Retry errors) - `6` - Less serious errors (like 461 errors from dropbox) (NoRetry errors) - `7` - Fatal error (one that more retries won't fix, like account suspended) (Fatal errors) - `8` - Transfer exceeded - limit set by --max-transfer reached - `9` - Operation successful, but no files transferred (Requires [`--error-on-no-transfer`](#error-on-no-transfer)) - `10` - Duration exceeded - limit set by --max-duration reached ## Environment variables Rclone can be configured entirely using environment variables. These can be used to set defaults for options or config file entries. ### Options Every option in rclone can have its default set by environment variable. To find the name of the environment variable, first, take the long option name, strip the leading `--`, change `-` to `_`, make upper case and prepend `RCLONE_`. For example, to always set `--stats 5s`, set the environment variable `RCLONE_STATS=5s`. If you set stats on the command line this will override the environment variable setting. Or to always use the trash in drive `--drive-use-trash`, set `RCLONE_DRIVE_USE_TRASH=true`. Verbosity is slightly different, the environment variable equivalent of `--verbose` or `-v` is `RCLONE_VERBOSE=1`, or for `-vv`, `RCLONE_VERBOSE=2`. The same parser is used for the options and the environment variables so they take exactly the same form. The options set by environment variables can be seen with the `-vv` flag, e.g. `rclone version -vv`. Options that can appear multiple times (type `stringArray`) are treated slightly differently as environment variables can only be defined once. In order to allow a simple mechanism for adding one or many items, the input is treated as a [CSV encoded](https://godoc.org/encoding/csv) string. For example | Environment variable | Equivalent options | |----------------------|--------------------| | `RCLONE_EXCLUDE="*.jpg"` | `--exclude "*.jpg"` | | `RCLONE_EXCLUDE="*.jpg,*.png"` | `--exclude "*.jpg"` `--exclude "*.png"` | | `RCLONE_EXCLUDE='"*.jpg","*.png"'` | `--exclude "*.jpg"` `--exclude "*.png"` | | `RCLONE_EXCLUDE='"/directory with comma , in it /**"'` | `--exclude "/directory with comma , in it /**" | If `stringArray` options are defined as environment variables **and** options on the command line then all the values will be used. ### Config file You can set defaults for values in the config file on an individual remote basis. The names of the config items are documented in the page for each backend. To find the name of the environment variable, you need to set, take `RCLONE_CONFIG_` + name of remote + `_` + name of config file option and make it all uppercase. Note one implication here is the remote's name must be convertible into a valid environment variable name, so it can only contain letters, digits, or the `_` (underscore) character. For example, to configure an S3 remote named `mys3:` without a config file (using unix ways of setting environment variables): ```console $ export RCLONE_CONFIG_MYS3_TYPE=s3 $ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX $ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX $ rclone lsd mys3: -1 2016-09-21 12:54:21 -1 my-bucket $ rclone listremotes | grep mys3 mys3: ``` Note that if you want to create a remote using environment variables you must create the `..._TYPE` variable as above. Note that the name of a remote created using environment variable is case insensitive, in contrast to regular remotes stored in config file as documented [above](#valid-remote-names). You must write the name in uppercase in the environment variable, but as seen from example above it will be listed and can be accessed in lowercase, while you can also refer to the same remote in uppercase: ```console $ rclone lsd mys3: -1 2016-09-21 12:54:21 -1 my-bucket $ rclone lsd MYS3: -1 2016-09-21 12:54:21 -1 my-bucket ``` Note that you can only set the options of the immediate backend, so RCLONE_CONFIG_MYS3CRYPT_ACCESS_KEY_ID has no effect, if myS3Crypt is a crypt remote based on an S3 remote. However RCLONE_S3_ACCESS_KEY_ID will set the access key of all remotes using S3, including myS3Crypt. Note also that now rclone has [connection strings](#connection-strings), it is probably easier to use those instead which makes the above example ```console rclone lsd :s3,access_key_id=XXX,secret_access_key=XXX: ``` ### Precedence The various different methods of backend configuration are read in this order and the first one with a value is used. - Parameters in connection strings, e.g. `myRemote,skip_links:` - Flag values as supplied on the command line, e.g. `--skip-links` - Remote specific environment vars, e.g. `RCLONE_CONFIG_MYREMOTE_SKIP_LINKS` (see above). - Backend-specific environment vars, e.g. `RCLONE_LOCAL_SKIP_LINKS`. - Backend generic environment vars, e.g. `RCLONE_SKIP_LINKS`. - Config file, e.g. `skip_links = true`. - Default values, e.g. `false` - these can't be changed. So if both `--skip-links` is supplied on the command line and an environment variable `RCLONE_LOCAL_SKIP_LINKS` is set, the command line flag will take preference. The backend configurations set by environment variables can be seen with the `-vv` flag, e.g. `rclone about myRemote: -vv`. For non backend configuration the order is as follows: - Flag values as supplied on the command line, e.g. `--stats 5s`. - Environment vars, e.g. `RCLONE_STATS=5s`. - Default values, e.g. `1m` - these can't be changed. ### Other environment variables - `RCLONE_CONFIG_PASS` set to contain your config file password (see [Configuration Encryption](#configuration-encryption) section) - `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` (or the lowercase versions thereof). - `HTTPS_PROXY` takes precedence over `HTTP_PROXY` for https requests. - The environment values may be either a complete URL or a "host[:port]" for, in which case the "http" scheme is assumed. - `USER` and `LOGNAME` values are used as fallbacks for current username. The primary method for looking up username is OS-specific: Windows API on Windows, real user ID in /etc/passwd on Unix systems. In the documentation the current username is simply referred to as `$USER`. - `RCLONE_CONFIG_DIR` - rclone **sets** this variable for use in config files and sub processes to point to the directory holding the config file. The options set by environment variables can be seen with the `-vv` and `--log-level=DEBUG` flags, e.g. `rclone version -vv`. # Configuring rclone on a remote / headless machine Some of the configurations (those involving oauth2) require an internet-connected web browser. If you are trying to set rclone up on a remote or headless machine with no browser available on it (e.g. a NAS or a server in a datacenter), then you will need to use an alternative means of configuration. There are three ways of doing it, described below. ## Configuring using rclone authorize On the headless machine run [rclone config](/commands/rclone_config), but answer `N` to the question `Use web browser to automatically authenticate rclone with remote?`. ```text Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes (default) n) No y/n> n Option config_token. For this to work, you will need rclone available on a machine that has a web browser available. For more help and alternate methods see: https://rclone.org/remote_setup/ Execute the following on the machine with the web browser (same rclone version recommended): rclone authorize "onedrive" Then paste the result. Enter a value. config_token> ``` Then on your main desktop machine, run [rclone authorize](https://rclone.org/commands/rclone_authorize/). ```text rclone authorize "onedrive" NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config. NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx NOTICE: Log in and authorize rclone for access NOTICE: Waiting for code... Got code Paste the following into your remote machine ---> SECRET_TOKEN <---End paste ``` Then back to the headless machine, paste in the code. ```text config_token> SECRET_TOKEN -------------------- [acd12] client_id = client_secret = token = SECRET_TOKEN -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> ``` ## Configuring by copying the config file Rclone stores all of its configuration in a single file. This can easily be copied to configure a remote rclone (although some backends do not support reusing the same configuration, consult your backend documentation to be sure). Start by running [rclone config](/commands/rclone_config) to create the configuration file on your desktop machine. ```console rclone config ``` Then locate the file by running [rclone config file](/commands/rclone_config_file). ```console $ rclone config file Configuration file is stored at: /home/user/.rclone.conf ``` Finally, transfer the file to the remote machine (scp, cut paste, ftp, sftp, etc.) and place it in the correct location (use [rclone config file](/commands/rclone_config_file) on the remote machine to find out where). ## Configuring using SSH Tunnel If you have an SSH client installed on your local machine, you can set up an SSH tunnel to redirect the port 53682 into the headless machine by using the following command: ```console ssh -L localhost:53682:localhost:53682 username@remote_server ``` Then on the headless machine run [rclone config](/commands/rclone_config) and answer `Y` to the question `Use web browser to automatically authenticate rclone with remote?`. ```text Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes (default) n) No y/n> y NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config. NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx NOTICE: Log in and authorize rclone for access NOTICE: Waiting for code... ``` Finally, copy and paste the presented URL `http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx` to the browser on your local machine, complete the auth and you are done. # Filtering, includes and excludes Filter flags determine which files rclone `sync`, `move`, `ls`, `lsl`, `md5sum`, `sha1sum`, `size`, `delete`, `check` and similar commands apply to. They are specified in terms of path/file name patterns; path/file lists; file age and size, or presence of a file in a directory. Bucket based remotes without the concept of directory apply filters to object key, age and size in an analogous way. Rclone `purge` does not obey filters. To test filters without risk of damage to data, apply them to `rclone ls`, or with the `--dry-run` and `-vv` flags. Rclone filter patterns can only be used in filter command line options, not in the specification of a remote. E.g. `rclone copy "remote:dir*.jpg" /path/to/dir` does not have a filter effect. `rclone copy remote:dir /path/to/dir --include "*.jpg"` does. **Important** Avoid mixing any two of `--include...`, `--exclude...` or `--filter...` flags in an rclone command. The results might not be what you expect. Instead use a `--filter...` flag. ## Patterns for matching path/file names ### Pattern syntax {#patterns} Here is a formal definition of the pattern syntax, [examples](#examples) are below. Rclone matching rules follow a glob style: ```text * matches any sequence of non-separator (/) characters ** matches any sequence of characters including / separators ? matches any single non-separator (/) character [ [ ! ] { character-range } ] character class (must be non-empty) { pattern-list } pattern alternatives {{ regexp }} regular expression to match c matches character c (c != *, **, ?, \, [, {, }) \c matches reserved character c (c = *, **, ?, \, [, {, }) or character class ``` character-range: ```text c matches character c (c != \, -, ]) \c matches reserved character c (c = \, -, ]) lo - hi matches character c for lo <= c <= hi ``` pattern-list: ```text pattern { , pattern } comma-separated (without spaces) patterns ``` character classes (see [Go regular expression reference](https://golang.org/pkg/regexp/syntax/)) include: ```text Named character classes (e.g. [\d], [^\d], [\D], [^\D]) Perl character classes (e.g. \s, \S, \w, \W) ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]]) ``` regexp for advanced users to insert a regular expression - see [below](#regexp) for more info: ```text Any re2 regular expression not containing `}}` ``` If the filter pattern starts with a `/` then it only matches at the top level of the directory tree, **relative to the root of the remote** (not necessarily the root of the drive). If it does not start with `/` then it is matched starting at the **end of the path/file name** but it only matches a complete path element - it must match from a `/` separator or the beginning of the path/file. ```text file.jpg - matches "file.jpg" - matches "directory/file.jpg" - doesn't match "afile.jpg" - doesn't match "directory/afile.jpg" /file.jpg - matches "file.jpg" in the root directory of the remote - doesn't match "afile.jpg" - doesn't match "directory/file.jpg" ``` The top level of the remote might not be the top level of the drive. E.g. for a Microsoft Windows local directory structure ```text F: ├── bkp ├── data │ ├── excl │ │ ├── 123.jpg │ │ └── 456.jpg │ ├── incl │ │ └── document.pdf ``` To copy the contents of folder `data` into folder `bkp` excluding the contents of subfolder `excl`the following command treats `F:\data` and `F:\bkp` as top level for filtering. `rclone copy F:\data\ F:\bkp\ --exclude=/excl/**` **Important** Use `/` in path/file name patterns and not `\` even if running on Microsoft Windows. Simple patterns are case sensitive unless the `--ignore-case` flag is used. Without `--ignore-case` (default) ```text potato - matches "potato" - doesn't match "POTATO" ``` With `--ignore-case` ```text potato - matches "potato" - matches "POTATO" ``` ## Using regular expressions in filter patterns {#regexp} The syntax of filter patterns is glob style matching (like `bash` uses) to make things easy for users. However this does not provide absolute control over the matching, so for advanced users rclone also provides a regular expression syntax. Rclone generally accepts Perl-style regular expressions, the exact syntax is defined in the [Go regular expression reference](https://golang.org/pkg/regexp/syntax/). Regular expressions should be enclosed in `{{` `}}`. They will match only the last path segment if the glob doesn't start with `/` or the whole path name if it does. Note that rclone does not attempt to parse the supplied regular expression, meaning that using any regular expression filter will prevent rclone from using [directory filter rules](#directory_filter), as it will instead check every path against the supplied regular expression(s). Here is how the `{{regexp}}` is transformed into an full regular expression to match the entire path: ```text {{regexp}} becomes (^|/)(regexp)$ /{{regexp}} becomes ^(regexp)$ ``` Regexp syntax can be mixed with glob syntax, for example ```text *.{{jpe?g}} to match file.jpg, file.jpeg but not file.png ``` You can also use regexp flags - to set case insensitive, for example ```text *.{{(?i)jpg}} to match file.jpg, file.JPG but not file.png ``` Be careful with wildcards in regular expressions - you don't want them to match path separators normally. To match any file name starting with `start` and ending with `end` write ```text {{start[^/]*end\.jpg}} ``` Not ```text {{start.*end\.jpg}} ``` Which will match a directory called `start` with a file called `end.jpg` in it as the `.*` will match `/` characters. Note that you can use `-vv --dump filters` to show the filter patterns in regexp format - rclone implements the glob patterns by transforming them into regular expressions. ## Filter pattern examples {#examples} | Description | Pattern | Matches | Does not match | | ----------- |-------- | ------- | -------------- | | Wildcard | `*.jpg` | `/file.jpg` | `/file.png` | | | | `/dir/file.jpg` | `/dir/file.png` | | Rooted | `/*.jpg` | `/file.jpg` | `/file.png` | | | | `/file2.jpg` | `/dir/file.jpg` | | Alternates | `*.{jpg,png}` | `/file.jpg` | `/file.gif` | | | | `/dir/file.png` | `/dir/file.gif` | | Path Wildcard | `dir/**` | `/dir/anyfile` | `file.png` | | | | `/subdir/dir/subsubdir/anyfile` | `/subdir/file.png` | | Any Char | `*.t?t` | `/file.txt` | `/file.qxt` | | | | `/dir/file.tzt` | `/dir/file.png` | | Range | `*.[a-z]` | `/file.a` | `/file.0` | | | | `/dir/file.b` | `/dir/file.1` | | Escape | `*.\?\?\?` | `/file.???` | `/file.abc` | | | | `/dir/file.???` | `/dir/file.def` | | Class | `*.\d\d\d` | `/file.012` | `/file.abc` | | | | `/dir/file.345` | `/dir/file.def` | | Regexp | `*.{{jpe?g}}` | `/file.jpeg` | `/file.png` | | | | `/dir/file.jpg` | `/dir/file.jpeeg` | | Rooted Regexp | `/{{.*\.jpe?g}}` | `/file.jpeg` | `/file.png` | | | | `/file.jpg` | `/dir/file.jpg` | ## How filter rules are applied to files {#how-filter-rules-work} Rclone path/file name filters are made up of one or more of the following flags: - `--include` - `--include-from` - `--exclude` - `--exclude-from` - `--filter` - `--filter-from` There can be more than one instance of individual flags. Rclone internally uses a combined list of all the include and exclude rules. The order in which rules are processed can influence the result of the filter. All flags of the same type are processed together in the order above, regardless of what order the different types of flags are included on the command line. Multiple instances of the same flag are processed from left to right according to their position in the command line. To mix up the order of processing includes and excludes use `--filter...` flags. Within `--include-from`, `--exclude-from` and `--filter-from` flags rules are processed from top to bottom of the referenced file. If there is an `--include` or `--include-from` flag specified, rclone implies a `- **` rule which it adds to the bottom of the internal rule list. Specifying a `+` rule with a `--filter...` flag does not imply that rule. Each path/file name passed through rclone is matched against the combined filter list. At first match to a rule the path/file name is included or excluded and no further filter rules are processed for that path/file. If rclone does not find a match, after testing against all rules (including the implied rule if appropriate), the path/file name is included. Any path/file included at that stage is processed by the rclone command. `--files-from`, `--files-from-raw` and `--files-from0` flags over-ride and cannot be combined with other filter options. To see the internal combined rule list, in regular expression form, for a command add the `--dump filters` flag. Running an rclone command with `--dump filters` and `-vv` flags lists the internal filter elements and shows how they are applied to each source path/file. There is not currently a means provided to pass regular expression filter options into rclone directly though character class filter rules contain character classes. [Go regular expression reference](https://golang.org/pkg/regexp/syntax/) ### How filter rules are applied to directories {#directory_filter} Rclone commands are applied to path/file names not directories. The entire contents of a directory can be matched to a filter by the pattern `directory/*` or recursively by `directory/**`. Directory filter rules are defined with a closing `/` separator. E.g. `/directory/subdirectory/` is an rclone directory filter rule. Rclone commands can use directory filter rules to determine whether they recurse into subdirectories. This potentially optimises access to a remote by avoiding listing unnecessary directories. Whether optimisation is desirable depends on the specific filter rules and source remote content. If any [regular expression filters](#regexp) are in use, then no directory recursion optimisation is possible, as rclone must check every path against the supplied regular expression(s). Directory recursion optimisation occurs if either: - A source remote does not support the rclone `ListR` primitive. local, sftp, Microsoft OneDrive and WebDAV do not support `ListR`. Google Drive and most bucket type storage do. [Full list](https://rclone.org/overview/#optional-features) - On other remotes (those that support `ListR`), if the rclone command is not naturally recursive, and provided it is not run with the `--fast-list` flag. `ls`, `lsf -R` and `size` are naturally recursive but `sync`, `copy` and `move` are not. - Whenever the `--disable ListR` flag is applied to an rclone command. Rclone commands imply directory filter rules from path/file filter rules. To view the directory filter rules rclone has implied for a command specify the `--dump filters` flag. E.g. for an include rule ```text /a/*.jpg ``` Rclone implies the directory include rule ```text /a/ ``` Directory filter rules specified in an rclone command can limit the scope of an rclone command but path/file filters still have to be specified. E.g. `rclone ls remote: --include /directory/` will not match any files. Because it is an `--include` option the `--exclude **` rule is implied, and the `/directory/` pattern serves only to optimise access to the remote by ignoring everything outside of that directory. E.g. `rclone ls remote: --filter-from filter-list.txt` with a file `filter-list.txt`: ```text - /dir1/ - /dir2/ + *.pdf - ** ``` All files in directories `dir1` or `dir2` or their subdirectories are completely excluded from the listing. Only files of suffix `pdf` in the root of `remote:` or its subdirectories are listed. The `- **` rule prevents listing of any path/files not previously matched by the rules above. Option `exclude-if-present` creates a directory exclude rule based on the presence of a file in a directory and takes precedence over other rclone directory filter rules. When using pattern list syntax, if a pattern item contains either `/` or `**`, then rclone will not able to imply a directory filter rule from this pattern list. E.g. for an include rule ```text {dir1/**,dir2/**} ``` Rclone will match files below directories `dir1` or `dir2` only, but will not be able to use this filter to exclude a directory `dir3` from being traversed. Directory recursion optimisation may affect performance, but normally not the result. One exception to this is sync operations with option `--create-empty-src-dirs`, where any traversed empty directories will be created. With the pattern list example `{dir1/**,dir2/**}` above, this would create an empty directory `dir3` on destination (when it exists on source). Changing the filter to `{dir1,dir2}/**`, or splitting it into two include rules `--include dir1/** --include dir2/**`, will match the same files while also filtering directories, with the result that an empty directory `dir3` will no longer be created. ### `--exclude` - Exclude files matching pattern Excludes path/file names from an rclone command based on a single exclude rule. This flag can be repeated. See above for the order filter flags are processed in. `--exclude` should not be used with `--include`, `--include-from`, `--filter` or `--filter-from` flags. `--exclude` has no effect when combined with `--files-from`, `--files-from-raw` or `--files-from0` flags. E.g. `rclone ls remote: --exclude *.bak` excludes all .bak files from listing. E.g. `rclone size remote: --exclude "/dir/**"` returns the total size of all files on `remote:` excluding those in root directory `dir` and sub directories. E.g. on Microsoft Windows `rclone ls remote: --exclude "*\[{JP,KR,HK}\]*"` lists the files in `remote:` without `[JP]` or `[KR]` or `[HK]` in their name. Quotes prevent the shell from interpreting the `\` characters.`\` characters escape the `[` and `]` so an rclone filter treats them literally rather than as a character-range. The `{` and `}` define an rclone pattern list. For other operating systems single quotes are required ie `rclone ls remote: --exclude '*\[{JP,KR,HK}\]*'` ### `--exclude-from` - Read exclude patterns from file Excludes path/file names from an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules. For an example `exclude-file.txt`: ```text # a sample exclude rule file *.bak file2.jpg ``` `rclone ls remote: --exclude-from exclude-file.txt` lists the files on `remote:` except those named `file2.jpg` or with a suffix `.bak`. That is equivalent to `rclone ls remote: --exclude file2.jpg --exclude "*.bak"`. This flag can be repeated. See above for the order filter flags are processed in. The `--exclude-from` flag is useful where multiple exclude filter rules are applied to an rclone command. `--exclude-from` should not be used with `--include`, `--include-from`, `--filter` or `--filter-from` flags. `--exclude-from` has no effect when combined with `--files-from`, `--files-from-raw` or `--files-from0` flags. `--exclude-from` followed by `-` reads filter rules from standard input. ### `--include` - Include files matching pattern Adds a single include rule based on path/file names to an rclone command. This flag can be repeated. See above for the order filter flags are processed in. `--include` has no effect when combined with `--files-from`, `--files-from-raw` or `--files-from0` flags. `--include` implies `--exclude **` at the end of an rclone internal filter list. Therefore if you mix `--include` and `--include-from` flags with `--exclude`, `--exclude-from`, `--filter` or `--filter-from`, you must use include rules for all the files you want in the include statement. For more flexibility use the `--filter-from` flag. E.g. `rclone ls remote: --include "*.{png,jpg}"` lists the files on `remote:` with suffix `.png` and `.jpg`. All other files are excluded. E.g. multiple rclone copy commands can be combined with `--include` and a pattern-list. ```console rclone copy /vol1/A remote:A rclone copy /vol1/B remote:B ``` is equivalent to: ```console rclone copy /vol1 remote: --include "{A,B}/**" ``` E.g. `rclone ls remote:/wheat --include "??[^[:punct:]]*"` lists the files `remote:` directory `wheat` (and subdirectories) whose third character is not punctuation. This example uses an [ASCII character class](https://golang.org/pkg/regexp/syntax/). ### `--include-from` - Read include patterns from file Adds path/file names to an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules. For an example `include-file.txt`: ```text # a sample include rule file *.jpg file2.avi ``` `rclone ls remote: --include-from include-file.txt` lists the files on `remote:` with name `file2.avi` or suffix `.jpg`. That is equivalent to `rclone ls remote: --include file2.avi --include "*.jpg"`. This flag can be repeated. See above for the order filter flags are processed in. The `--include-from` flag is useful where multiple include filter rules are applied to an rclone command. `--include-from` implies `--exclude **` at the end of an rclone internal filter list. Therefore if you mix `--include` and `--include-from` flags with `--exclude`, `--exclude-from`, `--filter` or `--filter-from`, you must use include rules for all the files you want in the include statement. For more flexibility use the `--filter-from` flag. `--include-from` has no effect when combined with `--files-from`, `--files-from-raw` or `--files-from0` flags. `--include-from` followed by `-` reads filter rules from standard input. ### `--filter` - Add a file-filtering rule Specifies path/file names to an rclone command, based on a single include or exclude rule, in `+` or `-` format. This flag can be repeated. See above for the order filter flags are processed in. `--filter +` differs from `--include`. In the case of `--include` rclone implies an `--exclude *` rule which it adds to the bottom of the internal rule list. `--filter...+` does not imply that rule. `--filter` has no effect when combined with `--files-from`, `--files-from-raw` or `--files-from0` flags. `--filter` should not be used with `--include`, `--include-from`, `--exclude` or `--exclude-from` flags. E.g. `rclone ls remote: --filter "- *.bak"` excludes all `.bak` files from a list of `remote:`. ### `--filter-from` - Read filtering patterns from a file Adds path/file names to an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules. Include rules start with `+ ` and exclude rules with `- `. `!` clears existing rules. Rules are processed in the order they are defined. This flag can be repeated. See above for the order filter flags are processed in. Arrange the order of filter rules with the most restrictive first and work down. Lines starting with # or ; are ignored, and can be used to write comments. Inline comments are not supported. *Use `-vv --dump filters` to see how they appear in the final regexp.* E.g. for `filter-file.txt`: ```text # a sample filter rule file - secret*.jpg + *.jpg + *.png + file2.avi - /dir/tmp/** # WARNING! This text will be treated as part of the path. - /dir/Trash/** + /dir/** # exclude everything else - * ``` `rclone ls remote: --filter-from filter-file.txt` lists the path/files on `remote:` including all `jpg` and `png` files, excluding any matching `secret*.jpg` and including `file2.avi`. It also includes everything in the directory `dir` at the root of `remote`, except `remote:dir/Trash` which it excludes. Everything else is excluded. E.g. for an alternative `filter-file.txt`: ```text - secret*.jpg + *.jpg + *.png + file2.avi - * ``` Files `file1.jpg`, `file3.png` and `file2.avi` are listed whilst `secret17.jpg` and files without the suffix `.jpg` or `.png` are excluded. E.g. for an alternative `filter-file.txt`: ```text + *.jpg + *.gif ! + 42.doc - * ``` Only file 42.doc is listed. Prior rules are cleared by the `!`. ### `--files-from` - Read list of source-file names Adds path/files to an rclone command from a list in a named file. Rclone processes the path/file names in the order of the list, and no others. Other filter flags (`--include`, `--include-from`, `--exclude`, `--exclude-from`, `--filter` and `--filter-from`) are ignored when `--files-from`, `--files-from-raw` or `--files-from0` is used. `--files-from` expects a list of files as its input. Leading or trailing whitespace is stripped from the input lines. Lines starting with `#` or `;` are ignored. `--files-from` followed by `-` reads the list of files from standard input. Rclone commands with a `--files-from` flag traverse the remote, treating the names in `--files-from` as a set of filters. If the `--no-traverse` and `--files-from` flags are used together an rclone command does not traverse the remote. Instead it addresses each path/file named in the file individually. For each path/file name, that requires typically 1 API call. This can be efficient for a short `--files-from` list and a remote containing many files. Rclone commands do not error if any names in the `--files-from` file are missing from the source remote. The `--files-from` flag can be repeated in a single rclone command to read path/file names from more than one file. The files are read from left to right along the command line. Paths within the `--files-from` file are interpreted as starting with the root specified in the rclone command. Leading `/` separators are ignored. See [--files-from-raw](#files-from-raw-read-list-of-source-file-names-without-any-processing) if you need the input to be processed in a raw manner. E.g. for a file `files-from.txt`: ```text # comment file1.jpg subdir/file2.jpg ``` `rclone copy --files-from files-from.txt /home/me/pics remote:pics` copies the following, if they exist, and only those files. ```text /home/me/pics/file1.jpg → remote:pics/file1.jpg /home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg ``` E.g. to copy the following files referenced by their absolute paths: ```text /home/user1/42 /home/user1/dir/ford /home/user2/prefect ``` First find a common subdirectory - in this case `/home` and put the remaining files in `files-from.txt` with or without leading `/`, e.g. ```text user1/42 user1/dir/ford user2/prefect ``` Then copy these to a remote: ```console rclone copy --files-from files-from.txt /home remote:backup ``` The three files are transferred as follows: ```text /home/user1/42 → remote:backup/user1/important /home/user1/dir/ford → remote:backup/user1/dir/file /home/user2/prefect → remote:backup/user2/stuff ``` Alternatively if `/` is chosen as root `files-from.txt` will be: ```text /home/user1/42 /home/user1/dir/ford /home/user2/prefect ``` The copy command will be: ```console rclone copy --files-from files-from.txt / remote:backup ``` Then there will be an extra `home` directory on the remote: ```text /home/user1/42 → remote:backup/home/user1/42 /home/user1/dir/ford → remote:backup/home/user1/dir/ford /home/user2/prefect → remote:backup/home/user2/prefect ``` ### `--files-from-raw` - Read list of source-file names without any processing This flag is the same as `--files-from` except that input is read in a raw manner. Lines with leading / trailing whitespace, and lines starting with `;` or `#` are read without any processing. [rclone lsf](https://rclone.org/commands/rclone_lsf/) has a compatible format that can be used to export file lists from remotes for input to `--files-from-raw`. ### `--files-from0` - Read NUL separated list of source-file names This flag is the same as `--files-from-raw` except that input is split on NUL (`\0`) characters instead of newlines. This allows handling filenames that contain embedded newline characters. It is similar to the `-print0` option of `find` and the `-0` option of `xargs`. E.g. to copy files listed by `find`: ```console find /path -print0 | rclone copy --files-from0 - / remote:path ``` ### `--ignore-case` - make searches case insensitive By default, rclone filter patterns are case sensitive. The `--ignore-case` flag makes all of the filters patterns on the command line case insensitive. E.g. `--include "zaphod.txt"` does not match a file `Zaphod.txt`. With `--ignore-case` a match is made. ## Quoting shell metacharacters Rclone commands with filter patterns containing shell metacharacters may not as work as expected in your shell and may require quoting. E.g. linux, OSX (`*` metacharacter) - `--include \*.jpg` - `--include '*.jpg'` - `--include='*.jpg'` Microsoft Windows expansion is done by the command, not shell, so `--include *.jpg` does not require quoting. If the rclone error `Command .... needs .... arguments maximum: you provided .... non flag arguments:` is encountered, the cause is commonly spaces within the name of a remote or flag value. The fix then is to quote values containing spaces. ## Other filters ### `--min-size` - Don't transfer any file smaller than this Controls the minimum size file within the scope of an rclone command. Default units are `KiB` but abbreviations `B`, `K`, `M`, `G`, `T` or `P` are valid. E.g. `rclone ls remote: --min-size 50k` lists files on `remote:` of 50 KiB size or larger. See [the size option docs](https://rclone.org/docs/#size-options) for more info. ### `--max-size` - Don't transfer any file larger than this Controls the maximum size file within the scope of an rclone command. Default units are `KiB` but abbreviations `B`, `K`, `M`, `G`, `T` or `P` are valid. E.g. `rclone ls remote: --max-size 1G` lists files on `remote:` of 1 GiB size or smaller. See [the size option docs](https://rclone.org/docs/#size-options) for more info. ### `--max-age` - Don't transfer any file older than this Controls the maximum age of files within the scope of an rclone command. `--max-age` applies only to files and not to directories. E.g. `rclone ls remote: --max-age 2d` lists files on `remote:` of 2 days old or less. See [the time option docs](https://rclone.org/docs/#time-options) for valid formats. ### `--min-age` - Don't transfer any file younger than this Controls the minimum age of files within the scope of an rclone command. (see `--max-age` for valid formats) `--min-age` applies only to files and not to directories. E.g. `rclone ls remote: --min-age 2d` lists files on `remote:` of 2 days old or more. See [the time option docs](https://rclone.org/docs/#time-options) for valid formats. ### `--hash-filter` - Deterministically select a subset of files {#hash-filter} The `--hash-filter` flag enables selecting a deterministic subset of files, useful for: 1. Running large sync operations across multiple machines. 2. Checking a subset of files for bitrot. 3. Any other operations where a sample of files is required. #### Syntax The flag takes two parameters expressed as a fraction: ```text --hash-filter K/N ``` - `N`: The total number of partitions (must be a positive integer). - `K`: The specific partition to select (an integer from `0` to `N`). For example: - `--hash-filter 1/3`: Selects the first third of the files. - `--hash-filter 2/3` and `--hash-filter 3/3`: Select the second and third partitions, respectively. Each partition is non-overlapping, ensuring all files are covered without duplication. #### Random Partition Selection Use `@` as `K` to randomly select a partition: ```text --hash-filter @/M ``` For example, `--hash-filter @/3` will randomly select a number between 0 and 2. This will stay constant across retries. #### How It Works - Rclone takes each file's full path, normalizes it to lowercase, and applies Unicode normalization. - It then hashes the normalized path into a 64 bit number. - The hash result is reduced modulo `N` to assign the file to a partition. - If the calculated partition does not match `K` the file is excluded. - Other filters may apply if the file is not excluded. **Important:** Rclone will traverse all directories to apply the filter. #### Usage Notes - Safe to use with `rclone sync`; source and destination selections will match. - **Do not** use with `--delete-excluded`, as this could delete unselected files. - Ignored if `--files-from`, `--files-from-raw` or `--files-from0` is used. #### Examples ##### Dividing files into 4 partitions Assuming the current directory contains `file1.jpg` through `file9.jpg`: ```console $ rclone lsf --hash-filter 0/4 . file1.jpg file5.jpg $ rclone lsf --hash-filter 1/4 . file3.jpg file6.jpg file9.jpg $ rclone lsf --hash-filter 2/4 . file2.jpg file4.jpg $ rclone lsf --hash-filter 3/4 . file7.jpg file8.jpg $ rclone lsf --hash-filter 4/4 . # the same as --hash-filter 0/4 file1.jpg file5.jpg ``` ##### Syncing the first quarter of files ```console rclone sync --hash-filter 1/4 source:path destination:path ``` ##### Checking a random 1% of files for integrity ```console rclone check --download --hash-filter @/100 source:path destination:path ``` ## Other flags ### `--delete-excluded` - Delete files on dest excluded from sync **Important** this flag is dangerous to your data - use with `--dry-run` and `-v` first. In conjunction with `rclone sync`, `--delete-excluded` deletes any files on the destination which are excluded from the command. E.g. the scope of `rclone sync --interactive A: B:` can be restricted: ```console rclone --min-size 50k --delete-excluded sync A: B: ``` All files on `B:` which are less than 50 KiB are deleted because they are excluded from the rclone sync command. ### `--dump filters` - dump the filters to the output Dumps the defined filters to standard output in regular expression format. Useful for debugging. ## Exclude directory based on a file The `--exclude-if-present` flag controls whether a directory is within the scope of an rclone command based on the presence of a named file within it. The flag can be repeated to check for multiple file names, presence of any of them will exclude the directory. This flag has a priority over other filter flags. E.g. for the following directory structure: ```text dir1/file1 dir1/dir2/file2 dir1/dir2/dir3/file3 dir1/dir2/dir3/.ignore ``` The command `rclone ls --exclude-if-present .ignore dir1` does not list `dir3`, `file3` or `.ignore`. ## Metadata filters {#metadata} The metadata filters work in a very similar way to the normal file name filters, except they match [metadata](https://rclone.org/docs/#metadata) on the object. The metadata should be specified as `key=value` patterns. This may be wildcarded using the normal [filter patterns](#patterns) or [regular expressions](#regexp). For example if you wished to list only local files with a mode of `100664` you could do that with: ```console rclone lsf -M --files-only --metadata-include "mode=100664" . ``` Or if you wished to show files with an `atime`, `mtime` or `btime` at a given date: ```console rclone lsf -M --files-only --metadata-include "[abm]time=2022-12-16*" . ``` Like file filtering, metadata filtering only applies to files not to directories. The filters can be applied using these flags. - `--metadata-include` - Include metadatas matching pattern - `--metadata-include-from` - Read metadata include patterns from file (use - to read from stdin) - `--metadata-exclude` - Exclude metadatas matching pattern - `--metadata-exclude-from` - Read metadata exclude patterns from file (use - to read from stdin) - `--metadata-filter` - Add a metadata filtering rule - `--metadata-filter-from` - Read metadata filtering patterns from a file (use - to read from stdin) Each flag can be repeated. See the section on [how filter rules are applied](#how-filter-rules-work) for more details - these flags work in an identical way to the file name filtering flags, but instead of file name patterns have metadata patterns. ## Common pitfalls The most frequent filter support issues on the [rclone forum](https://forum.rclone.org/) are: - Not using paths relative to the root of the remote - Not using `/` to match from the root of a remote - Not using `**` to match the contents of a directory # rclone gui The `rclone gui` command starts the official Web GUI that comes bundled with rclone. With this command, rclone can serve a web-based GUI (graphical user interface) that is accessible from a normal web browser. Run it in a terminal and rclone will initialize and then start the GUI. ```console rclone gui ``` This will produce logs like this. The terminal window needs to stay open to continue to run the GUI: ```console 2026/04/14 11:36:04 NOTICE: Serving remote control on http://127.0.0.1:50803/ 2026/04/14 11:36:04 NOTICE: Serving GUI on http://127.0.0.1:50802/ 2026/04/14 11:36:04 NOTICE: GUI available at http://127.0.0.1:50802/login?pass=XXX&url=http%3A%2F%2F127.0.0.1%3A50803%2F&user=gui ``` You can also add debugging flags when running the GUI, such as `-v`, which will show more logging output from the rc server. ## Using the GUI Once the browser opens, you will be presented with the Dashboard, the main screen where you can see the status of your remotes and system. At the top, starting from the left, you will see a series of tabs you can click on. On the right side you will have the logout button and potentially an "Update available" message if a new rclone version has been released. ### Dashboard See live metrics, learn if your remotes are near capacity, and read the changelog for the current version. ### Explorer Explore and manage both local disks and remotes, download files and directories and start transfers. ### Remotes Scroll the list of remotes and tap on it to navigate to the explorer. There you can navigate the contents of your remotes, transfer, download, and even upload files. ### Mounts Mount remotes as local drives on your computer and check on your existing mounts. ### Serves Get quick info about your active serve instances, and start new ones. ### Settings Edit your `rclone.conf` file directly, set logging flags, and performance parameters. ## How it works When you run `rclone gui` this is what happens - Rclone starts the remote control API ("rc"). - Rclone starts a second server to serve the Web GUI. - If a port, username or password is not specified, then missing values will be auto-generated. - Unless `--no-open-browser` is passed, a browser window will open. - The URL already contains the username & password, in which case the GUI will use those values and log you in automatically. ## Security It's important to think first about what rclone has access to and what you might be sharing. A few good measures: - Don't use `--no-auth` (this is for testing only). - Do not expose to the local network (eg with `--api-addr :5572 --addr :8080`) unless you trust all devices on your local network. Prefer `127.0.0.1` or `localhost` (the default). - Use a strong password and non-obvious usernames like "admin" or "rclone" if you are using `--user` and `--pass`. - If you want to host it on a server and access it remotely, make sure you're only exposing the GUI and not the RC API. They listen on different ports. If you want to access it remotely but want to avoid running a proxy and exposing ports, you can use Cloudflare Tunnels or localhost.run or Tailscale (all free). ## Options ```console --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port) --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port) --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics -h, --help help for gui --no-auth Don't require auth for the RC API --no-open-browser Skip opening the browser automatically --pass string Password for RC authentication --user string User name for RC authentication ``` ## History In v1.74 the GUI was redone and embedded within rclone for ease of use. The GUI bundle ships as a compressed zip embedded in the rclone binary and is served from the zip at runtime. # Remote controlling rclone with its API If rclone is run with the `--rc` flag then it starts an HTTP server which can be used to remote control rclone using its API. You can either use the [rc](#api-rc) command to access the API or [use HTTP directly](#api-http). If you just want to run a remote control then see the [rcd](https://rclone.org/commands/rclone_rcd/) command. ## Security {#security} **Access to the rc API is equivalent to shell access as the user running rclone.** Treat the rc port as you would an interactive login on the host. Any caller who can reach the API (and pass authentication, if it is enabled) can, among other things: - **Run OS commands** as the rclone user. `core/command` re-executes the rclone binary with arbitrary arguments, and several backend options shell out to programs, so even creating a remote with `config/create` can lead to command execution. - **Read and write any file** reachable by the rclone process, by pointing `operations/*` or `sync/*` at a `local` remote (or via `--rc-files` / `--rc-serve`). Writing arbitrary files as the rclone user is itself a route to code execution. - **Read back stored credentials.** rclone configs routinely hold cloud-provider secrets. `config/dump` and friends expose them, so a compromise of the rc reaches every configured backend. - **Change rclone's runtime behaviour** with `options/set`, **manage remotes** with `config/*`, and **stop the process** with `core/quit`. There is currently no per-endpoint capability or scope system: authentication is all-or-nothing. Granting any access grants all of the above. Consequently: - **Do not bind the rc to a network address you do not control.** The default bind is loopback (`localhost:5572`); keep it there unless you have a specific reason to change it. - **Do not use `--rc-no-auth` on a non-loopback bind.** It disables authentication on the endpoints that access remotes — see [`--rc-no-auth`](#--rc-no-auth). - **Use authentication and TLS** (`--rc-user`/`--rc-pass` or `--rc-htpasswd`, plus `--rc-cert`/`--rc-key`) whenever the port is reachable by anyone you do not fully trust, and raise `--rc-min-tls-version`. ## Supported parameters ### --rc Flag to start the http server listen on remote requests. ### --rc-addr=IP IPaddress:Port or :Port to bind server to. (default "localhost:5572"). ### --rc-cert=KEY SSL PEM key (concatenation of certificate and CA certificate). ### --rc-client-ca=PATH Client certificate authority to verify clients with. ### --rc-htpasswd=PATH htpasswd file - if not provided no authentication is done. ### --rc-key=PATH TLS PEM private key file. ### --rc-max-header-bytes=VALUE Maximum size of request header (default 4096). ### --rc-min-tls-version=VALUE The minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ### --rc-user=VALUE User name for authentication. ### --rc-pass=VALUE Password for authentication. ### --rc-realm=VALUE Realm for authentication (default "rclone"). ### --rc-server-read-timeout=DURATION Timeout for server reading data (default 1h0m0s). ### --rc-server-write-timeout=DURATION Timeout for server writing data (default 1h0m0s). ### --rc-serve Enable the serving of remote objects via the HTTP interface. This means objects will be accessible at `http://127.0.0.1:5572/` by default, so you can browse to `http://127.0.0.1:5572/` or `http://127.0.0.1:5572/*` to see a listing of the remotes. Objects may be requested from remotes using this syntax `http://127.0.0.1:5572/[remote:path]/path/to/object` Unless the rc server has authentication configured (`--rc-user`/`--rc-pass` or `--rc-htpasswd`) or the `--rc-no-auth` flag is set, only remotes already present in the config file may be served this way. Inline remotes (e.g. `[:webdav,url=...:]`), connection string parameters and bare local paths are rejected, since instantiating them from an unauthenticated request could run commands or read arbitrary local files. Default Off. ### global.* connection string options and the rc Remotes instantiated by the rc do not let [connection string](https://rclone.org/docs/#connection-strings) `global.*` options change rclone's process-wide configuration. Remotes created directly on the command line or defined in the config file are unaffected. A `global.*` option still takes effect for the individual backend it is set on (exactly like an `override.*` option), it just does not leak into the global config for the rest of the process. ### --rc-serve-no-modtime Set this flag to skip reading the modification time (can speed things up). Default Off. ### --rc-files /path/to/directory Path to local files to serve on the HTTP server. If this is set then rclone will serve the files in that directory. It will also open the root in the web browser if specified. This is for implementing browser based GUIs for rclone functions. If `--rc-user` or `--rc-pass` is set then the URL that is opened will have the authorization in the URL in the `http://user:pass@localhost/` style. Default Off. ### --rc-enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at `/metrics`. If more control over the metrics is desired (for example running it on a different port or with different auth) then endpoint can be enabled with the `--metrics-*` flags instead. Default Off. ### --rc-web-gui Set this flag to serve the default web gui on the same port as rclone. Default Off. ### --rc-allow-origin Set the allowed Access-Control-Allow-Origin for rc requests. Can be used with --rc-web-gui if the rclone is running on different IP than the web-gui. Default is IP address on which rc is running. ### --rc-web-fetch-url Set the URL to fetch the rclone-web-gui files from. Default . ### --rc-web-gui-update Set this flag to check and update rclone-webui-react from the rc-web-fetch-url. Default Off. ### --rc-web-gui-force-update Set this flag to force update rclone-webui-react from the rc-web-fetch-url. Default Off. ### --rc-web-gui-no-open-browser Set this flag to disable opening browser automatically when using web-gui. Default Off. ### --rc-job-expire-duration=DURATION Expire finished async jobs older than DURATION (default 60s). ### --rc-job-expire-interval=DURATION Interval duration to check for expired async jobs (default 10s). ### --rc-no-auth By default rclone will require authorisation to have been set up on the rc interface in order to use any methods which access any rclone remotes. Eg `operations/list` is denied as it involved creating a remote as is `sync/copy`. If this is set then no authorisation will be required on the server to use these methods. The alternative is to use `--rc-user` and `--rc-pass` and use these credentials in the request. Default Off. ### --rc-baseurl Prefix for URLs. Default is root ### --rc-template User-specified template. ## Accessing the remote control via the rclone rc command {#api-rc} Rclone itself implements the remote control protocol in its `rclone rc` command. You can use it like this: ```console $ rclone rc rc/noop param1=one param2=two { "param1": "one", "param2": "two" } ``` If the remote is running on a different URL than the default `http://localhost:5572/`, use the `--url` option to specify it: ```console rclone rc --url http://some.remote:1234/ rc/noop ``` Or, if the remote is listening on a Unix socket, use the `--unix-socket` option instead: ```console rclone rc --unix-socket /tmp/rclone.sock rc/noop ``` Run `rclone rc` on its own, without any commands, to see the help for the installed remote control commands. Note that this also needs to connect to the remote server. ## JSON input `rclone rc` also supports a `--json` flag which can be used to send more complicated input parameters. ```console $ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 } }' rc/noop { "p1": [ 1, "2", null, 4 ], "p2": { "a": 1, "b": 2 } } ``` If the parameter being passed is an object then it can be passed as a JSON string rather than using the `--json` flag which simplifies the command line. ```console rclone rc operations/list fs=/tmp remote=test opt='{"showHash": true}' ``` Rather than ```console rclone rc operations/list --json '{"fs": "/tmp", "remote": "test", "opt": {"showHash": true}}' ``` ## Special parameters The rc interface supports some special parameters which apply to **all** commands. These start with `_` to show they are different. ### Running asynchronous jobs with _async = true Each rc call is classified as a job and it is assigned its own id. By default jobs are executed immediately as they are created or synchronously. If `_async` has a true value when supplied to an rc call then it will return immediately with a job id and execute id, and the task will be run in the background. The `job/status` call can be used to get information of the background job. The job can be queried for up to 1 minute after it has finished. It is recommended that potentially long running jobs, e.g. `sync/sync`, `sync/copy`, `sync/move`, `operations/purge` are run with the `_async` flag to avoid any potential problems with the HTTP request and response timing out. As an alternative to `_async`, you can send the HTTP header `Prefer: respond-async` (RFC 7240). This has the same effect as `_async = true` but additionally returns HTTP status 202 (Accepted) instead of 200, and includes a `Preference-Applied: respond-async` response header. The 202 status code makes it easy for clients to distinguish an async response from a completed one without inspecting the body. Starting a job with the `_async` flag: ```console $ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 }, "_async": true }' rc/noop { "jobid": 2, "executeId": "d794c33c-463e-4acf-b911-f4b23e4f40b7" } ``` The `jobid` is a unique identifier for the job within this rclone instance. The `executeId` identifies the rclone process instance and changes after rclone restart. Together, the pair (`executeId`, `jobid`) uniquely identifies a job across rclone restarts. Query the status to see if the job has finished. For more information on the meaning of these return parameters see the `job/status` call. ```console $ rclone rc --json '{ "jobid":2 }' job/status { "duration": 0.000124163, "endTime": "2018-10-27T11:38:07.911245881+01:00", "error": "", "executeId": "d794c33c-463e-4acf-b911-f4b23e4f40b7", "finished": true, "id": 2, "output": { "_async": true, "p1": [ 1, "2", null, 4 ], "p2": { "a": 1, "b": 2 } }, "startTime": "2018-10-27T11:38:07.911121728+01:00", "success": true } ``` `job/list` can be used to show running or recently completed jobs along with their status ```console $ rclone rc job/list { "executeId": "d794c33c-463e-4acf-b911-f4b23e4f40b7", "finished_ids": [ 1 ], "jobids": [ 1, 2 ], "running_ids": [ 2 ] } ``` This shows: - `executeId` - the current rclone instance ID (same for all jobs, changes after restart) - `jobids` - array of all job IDs (both running and finished) - `running_ids` - array of currently running job IDs - `finished_ids` - array of finished job IDs ### Setting config flags with _config If you wish to set config (the equivalent of the global flags) for the duration of an rc call only then pass in the `_config` parameter. Alternatively, you can pass config options flat at the top level of the parameter map. The option names are the same as their CLI flags without `--` and with `-` replaced by `_` (e.g. `transfers` instead of `Transfers` inside `_config`). This should be in the same format as the `main` key returned by [options/get](#options-get). ```console rclone rc --loopback options/get blocks=main ``` You can see more help on these options with this command (see [the options blocks section](#option-blocks) for more info). ```console rclone rc --loopback options/info blocks=main ``` For example, if you wished to run a sync with the `--checksum` parameter, you would pass this parameter in your JSON blob. ```json "_config":{"CheckSum": true} ``` Or pass it flat at the top level: ```json "checksum": true ``` If using `rclone rc` this could be passed as ```console rclone rc sync/sync ... _config='{"CheckSum": true}' ``` Or simply flat: ```console rclone rc sync/sync ... checksum=true ``` If both flat parameters and `_config` are supplied, the parameters in the legacy `_config` block will take precedence. Any config parameters you don't set will inherit the global defaults which were set with command line flags or environment variables. Note that it is possible to set some values as strings or integers - see [data types](#data-types) for more info. Here is an example setting the equivalent of `--buffer-size` in string or integer format. ```json "_config":{"BufferSize": "42M"} "_config":{"BufferSize": 44040192} ``` Or flat: ```json "buffer_size": "42M" "buffer_size": 44040192 ``` If you wish to check the `_config` assignment has worked properly then calling `options/local` will show what the value got set to. ### Setting filter flags with _filter If you wish to set filters for the duration of an rc call only then pass in the `_filter` parameter. Alternatively, you can pass filter options flat at the top level of the parameter map. The option names are the same as their CLI flags without `--` and with `-` replaced by `_` (e.g. `exclude` instead of `Exclude` inside `_filter`). This should be in the same format as the `filter` key returned by [options/get](#options-get). ```console rclone rc --loopback options/get blocks=filter ``` You can see more help on these options with this command (see [the options blocks section](#option-blocks) for more info). ```console rclone rc --loopback options/info blocks=filter ``` For example, if you wished to run a sync with these flags ```text --max-size 1M --max-age 42s --include "a" --include "b" ``` you would pass this parameter in your JSON blob. ```json "_filter":{"MaxSize":"1M", "IncludeRule":["a","b"], "MaxAge":"42s"} ``` Or pass them flat at the top level: ```json "max_size":"1M", "include":["a","b"], "max_age":"42s" ``` If using `rclone rc` this could be passed as ```console rclone rc ... _filter='{"MaxSize":"1M", "IncludeRule":["a","b"], "MaxAge":"42s"}' ``` Or simply flat: ```console rclone rc ... max_size=1M include="a,b" max_age=42s ``` If both flat parameters and `_filter` are supplied, the parameters in the legacy `_filter` block will take precedence. Any filter parameters you don't set will inherit the global defaults which were set with command line flags or environment variables. Note that it is possible to set some values as strings or integers - see [data types](#data-types) for more info. Here is an example setting the equivalent of `--buffer-size` in string or integer format. ```json "_filter":{"MinSize": "42M"} "_filter":{"MinSize": 44040192} ``` Or flat: ```json "min_size": "42M" ``` If you wish to check the `_filter` assignment has worked properly then calling `options/local` will show what the value got set to. ### Assigning operations to groups with _group = value Each rc call has its own stats group for tracking its metrics. By default grouping is done by the composite group name from prefix `job/` and id of the job like so `job/1`. If `_group` has a value then stats for that request will be grouped under that value. This allows caller to group stats under their own name. Stats for specific group can be accessed by passing `group` to `core/stats`: ```console $ rclone rc --json '{ "group": "job/1" }' core/stats { "speed": 12345 ... } ``` ## Data types {#data-types} When the API returns types, these will mostly be straight forward integer, string or boolean types. However some of the types returned by the [options/get](#options-get) call and taken by the [options/set](#options-set) calls as well as the `vfsOpt`, `mountOpt` and the `_config` parameters. - `Duration` - these are returned as an integer duration in nanoseconds. They may be set as an integer, or they may be set with time string, eg "5s". See the [options section](https://rclone.org/docs/#options) for more info. - `Size` - these are returned as an integer number of bytes. They may be set as an integer or they may be set with a size suffix string, eg "10M". See the [options section](https://rclone.org/docs/#options) for more info. - Enumerated type (such as `CutoffMode`, `DumpFlags`, `LogLevel`, `VfsCacheMode` - these will be returned as an integer and may be set as an integer but more conveniently they can be set as a string, eg "HARD" for `CutoffMode` or `DEBUG` for `LogLevel`. - `BandwidthSpec` - this will be set and returned as a string, eg "1M". ### Option blocks {#option-blocks} The calls [options/info](#options-info) (for the main config) and [config/providers](#config-providers) (for the backend config) may be used to get information on the rclone configuration options. This can be used to build user interfaces for displaying and setting any rclone option. These consist of arrays of `Option` blocks. These have the following format. Each block describes a single option. | Field | Type | Optional | Description | |-------|------|----------|-------------| | Name | string | N | name of the option in snake_case | | FieldName | string | N | name of the field used in the rc - if blank use Name. May contain "." for nested fields. | | Help | string | N | help, started with a single sentence on a single line | | Groups | string | Y | groups this option belongs to - comma separated string for options classification | | Provider | string | Y | set to filter on provider | | Default | any | N | default value, if set (and not to nil or "") then Required does nothing | | Value | any | N | value to be set by flags | | Examples | Examples | Y | predefined values that can be selected from list (multiple-choice option) | | ShortOpt | string | Y | the short command line option for this | | Hide | Visibility | N | if non zero, this option is hidden from the configurator or the command line | | Required | bool | N | this option is required, meaning value cannot be empty unless there is a default | | IsPassword | bool | N | set if the option is a password | | NoPrefix | bool | N | set if the option for this should not use the backend prefix | | Advanced | bool | N | set if this is an advanced config option | | Exclusive | bool | N | set if the answer can only be one of the examples (empty string allowed unless Required or Default is set) | | Sensitive | bool | N | set if this option should be redacted when using `rclone config redacted` | An example of this might be the `--log-level` flag. Note that the `Name` of the option becomes the command line flag with `_` replaced with `-`. ```json { "Advanced": false, "Default": 5, "DefaultStr": "NOTICE", "Examples": [ { "Help": "", "Value": "EMERGENCY" }, { "Help": "", "Value": "ALERT" }, ... ], "Exclusive": true, "FieldName": "LogLevel", "Groups": "Logging", "Help": "Log level DEBUG|INFO|NOTICE|ERROR", "Hide": 0, "IsPassword": false, "Name": "log_level", "NoPrefix": true, "Required": true, "Sensitive": false, "Type": "LogLevel", "Value": null, "ValueStr": "NOTICE" }, ``` Note that the `Help` may be multiple lines separated by `\n`. The first line will always be a short sentence and this is the sentence shown when running `rclone help flags`. ## Specifying remotes to work on Remotes are specified with the `fs=`, `srcFs=`, `dstFs=` parameters depending on the command being used. The parameters can be a string as per the rest of rclone, eg `s3:bucket/path` or `:sftp:/my/dir`. They can also be specified as JSON blobs. If specifying a JSON blob it should be a object mapping strings to strings. These values will be used to configure the remote. There are 3 special values which may be set: - `type` - set to `type` to specify a remote called `:type:` - `_name` - set to `name` to specify a remote called `name:` - `_root` - sets the root of the remote - may be empty One of `_name` or `type` should normally be set. If the `local` backend is desired then `type` should be set to `local`. If `_root` isn't specified then it defaults to the root of the remote. For example this JSON is equivalent to `remote:/tmp` ```json { "_name": "remote", "_root": "/tmp" } ``` And this is equivalent to `:sftp,host='example.com':/tmp` ```json { "type": "sftp", "host": "example.com", "_root": "/tmp" } ``` And this is equivalent to `/tmp/dir` ```json { "type": "local", "_root": "/tmp/dir" } ``` ## Supported commands ### backend/command: Runs a backend command. {#backend-command} This takes the following parameters: - command - a string with the command name - fs - a remote name string e.g. "drive:" - arg - a list of arguments for the backend command - opt - a map of string to string of options Returns: - result - result from the backend command Example: rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2 Returns ``` { "result": { "arg": [ "path1", "path2" ], "name": "noop", "opt": { "blue": "", "echo": "yes" } } } ``` Note that this is the direct equivalent of using this "backend" command: rclone backend noop . -o echo=yes -o blue path1 path2 Note that arguments must be preceded by the "-a" flag See the [backend](https://rclone.org/commands/rclone_backend/) command for more information. ### cache/expire: Purge a remote from cache {#cache-expire} Purge a remote from the cache backend. Supports either a directory or a file. Params: - remote = path to remote (required) - withData = true/false to delete cached data (chunks) as well (optional) Eg rclone rc cache/expire remote=path/to/sub/folder/ rclone rc cache/expire remote=/ withData=true ### cache/fetch: Fetch file chunks {#cache-fetch} Ensure the specified file chunks are cached on disk. The chunks= parameter specifies the file chunks to check. It takes a comma separated list of array slice indices. The slice indices are similar to Python slices: start[:end] start is the 0 based chunk number from the beginning of the file to fetch inclusive. end is 0 based chunk number from the beginning of the file to fetch exclusive. Both values can be negative, in which case they count from the back of the file. The value "-5:" represents the last 5 chunks of a file. Some valid examples are: ":5,-5:" -> the first and last five chunks "0,-2" -> the first and the second last chunk "0:10" -> the first ten chunks Any parameter with a key that starts with "file" can be used to specify files to fetch, e.g. rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye File names will automatically be encrypted when the a crypt remote is used on top of the cache. ### cache/stats: Get cache stats {#cache-stats} Show statistics for the cache remote. **Authentication is not required for this call.** ### config/create: create the config for a remote. {#config-create} This takes the following parameters: - name - name of remote - parameters - a map of \{ "key": "value" \} pairs - type - type of the new remote - opt - a dictionary of options to control the configuration - obscure - declare passwords are plain and need obscuring - noObscure - declare passwords are already obscured and don't need obscuring - noOutput - don't print anything to stdout - nonInteractive - don't interact with a user, return questions - continue - continue the config process with an answer - all - ask all the config questions not just the post config ones - state - state to restart with - used with continue - result - result to restart with - used with continue See the [config create](https://rclone.org/commands/rclone_config_create/) command for more information on the above. ### config/delete: Delete a remote in the config file. {#config-delete} Parameters: - name - name of remote to delete See the [config delete](https://rclone.org/commands/rclone_config_delete/) command for more information on the above. ### config/dump: Dumps the config file. {#config-dump} Returns a JSON object: - key: value Where keys are remote names and values are the config parameters. See the [config dump](https://rclone.org/commands/rclone_config_dump/) command for more information on the above. ### config/get: Get a remote in the config file. {#config-get} Parameters: - name - name of remote to get See the [config dump](https://rclone.org/commands/rclone_config_dump/) command for more information on the above. ### config/listremotes: Lists the remotes in the config file and defined in environment variables. {#config-listremotes} Returns - remotes - array of remote names See the [listremotes](https://rclone.org/commands/rclone_listremotes/) command for more information on the above. ### config/oauthstatus: Get the status of the OAuth authentication server. {#config-oauthstatus} Returns the current status of the OAuth authentication server. Returns a JSON object: - status - "running" or "stopped" - authUrl - URL for the authorization (only if status is "running") Eg { "status": "running", "authUrl": "http://127.0.0.1:53682/auth?state=..." } ### config/oauthstop: Stop any running OAuth authentication server. {#config-oauthstop} Stops the OAuth authentication server if one is running. This can be used to recover from an interrupted OAuth flow without restarting rclone. If no OAuth authentication is in progress, an error is returned. ### config/password: password the config for a remote. {#config-password} This takes the following parameters: - name - name of remote - parameters - a map of \{ "key": "value" \} pairs See the [config password](https://rclone.org/commands/rclone_config_password/) command for more information on the above. ### config/paths: Reads the config file path and other important paths. {#config-paths} Returns a JSON object with the following keys: - config: path to config file - cache: path to root of cache directory - temp: path to root of temporary directory Eg { "cache": "/home/USER/.cache/rclone", "config": "/home/USER/.rclone.conf", "temp": "/tmp" } See the [config paths](https://rclone.org/commands/rclone_config_paths/) command for more information on the above. ### config/providers: Shows how providers are configured in the config file. {#config-providers} Returns a JSON object: - providers - array of objects See the [config providers](https://rclone.org/commands/rclone_config_providers/) command for more information on the above. Note that the Options blocks are in the same format as returned by "options/info". They are described in the [option blocks](#option-blocks) section. ### config/setpath: Set the path of the config file {#config-setpath} Parameters: - path - path to the config file to use ### config/unlock: Unlock the config file. {#config-unlock} Unlocks the config file if it is locked. Parameters: - 'configPassword' - password to unlock the config file A good idea is to disable AskPassword before making this call ### config/unset: Unset keys in a remote in the config file. {#config-unset} Parameters: - name - name of remote - keys - a list of key names to remove Returns: - removed - a list of the keys that were actually removed See the [config unset](https://rclone.org/commands/rclone_config_unset/) command for more information on the above. ### config/update: update the config for a remote. {#config-update} This takes the following parameters: - name - name of remote - parameters - a map of \{ "key": "value" \} pairs - opt - a dictionary of options to control the configuration - obscure - declare passwords are plain and need obscuring - noObscure - declare passwords are already obscured and don't need obscuring - noOutput - don't print anything to stdout - nonInteractive - don't interact with a user, return questions - continue - continue the config process with an answer - all - ask all the config questions not just the post config ones - state - state to restart with - used with continue - result - result to restart with - used with continue See the [config update](https://rclone.org/commands/rclone_config_update/) command for more information on the above. ### core/bwlimit: Set the bandwidth limit. {#core-bwlimit} This sets the bandwidth limit to the string passed in. This should be a single bandwidth limit entry or a pair of upload:download bandwidth. Eg rclone rc core/bwlimit rate=off { "bytesPerSecond": -1, "bytesPerSecondTx": -1, "bytesPerSecondRx": -1, "rate": "off" } rclone rc core/bwlimit rate=1M { "bytesPerSecond": 1048576, "bytesPerSecondTx": 1048576, "bytesPerSecondRx": 1048576, "rate": "1M" } rclone rc core/bwlimit rate=1M:100k { "bytesPerSecond": 1048576, "bytesPerSecondTx": 1048576, "bytesPerSecondRx": 131072, "rate": "1M" } If the rate parameter is not supplied then the bandwidth is queried rclone rc core/bwlimit { "bytesPerSecond": 1048576, "bytesPerSecondTx": 1048576, "bytesPerSecondRx": 1048576, "rate": "1M" } The format of the parameter is exactly the same as passed to --bwlimit except only one bandwidth may be specified. In either case "rate" is returned as a human-readable string, and "bytesPerSecond" is returned as a number. ### core/command: Run a rclone terminal command over rc. {#core-command} This takes the following parameters: - command - a string with the command name. - arg - a list of arguments for the backend command. - opt - a map of string to string of options. - returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR"). - Defaults to "COMBINED_OUTPUT" if not set. - The STREAM returnTypes will write the output to the body of the HTTP message. - The COMBINED_OUTPUT will write the output to the "result" parameter. Returns: - result - result from the backend command. - Only set when using returnType "COMBINED_OUTPUT". - error - set if rclone exits with an error code. - returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR"). Example: rclone rc core/command command=ls -a mydrive:/ -o max-depth=1 rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 Returns: ``` { "error": false, "result": "" } OR { "error": true, "result": "" } ``` ### core/disks: List the local disks {#core-disks} This does not take any parameters This call is for rclone GUI programs to enumerate local disks and important directories for doing transfers to and from. The list returned will include the root directory and the user's home directory and any mounted disks. The returned items should be usable directly as remotes. Returns: - disks - This is an array of strings of local disk names ### core/du: Returns disk usage of a locally attached disk. {#core-du} This returns the disk usage for the local directory passed in as dir. If the directory is not passed in, it defaults to the directory pointed to by --cache-dir. - dir - string (optional) Returns: ``` { "dir": "/", "info": { "Available": 361769115648, "Free": 361785892864, "Total": 982141468672 } } ``` **Authentication is not required for this call.** ### core/gc: Runs a garbage collection. {#core-gc} This tells the go runtime to do a garbage collection run. It isn't necessary to call this normally, but it can be useful for debugging memory problems. ### core/group-list: Returns list of stats. {#core-group-list} This returns list of stats groups currently in memory. Returns the following values: ``` { "groups": an array of group names: [ "group1", "group2", ... ] } ``` **Authentication is not required for this call.** ### core/memstats: Returns the memory statistics {#core-memstats} This returns the memory statistics of the running program. What the values mean are explained in the go docs: https://golang.org/pkg/runtime/#MemStats The most interesting values for most people are: - HeapAlloc - this is the amount of memory rclone is actually using - HeapSys - this is the amount of memory rclone has obtained from the OS - Sys - this is the total amount of memory requested from the OS - It is virtual memory so may include unused memory ### core/obscure: Obscures a string passed in. {#core-obscure} Pass a clear string and rclone will obscure it for the config file: - clear - string Returns: - obscured - string ### core/pid: Return PID of current process {#core-pid} This returns PID of current process. Useful for stopping rclone process. ### core/quit: Terminates the app. {#core-quit} (Optional) Pass an exit code to be used for terminating the app: - exitCode - int ### core/stats: Returns stats about current transfers. {#core-stats} This returns all available stats: rclone rc core/stats If group is not provided then summed up stats for all groups will be returned. Parameters - group - name of the stats group (string, optional) - short - if true will not return the transferring and checking arrays (boolean, optional) Returns the following values: ``` { "bytes": total transferred bytes since the start of the group, "checks": number of files checked, "deletedDirs": number of directories deleted, "deletes" : number of files deleted, "elapsedTime": time in floating point seconds since rclone was started, "errors": number of errors, "eta": estimated time in seconds until the group completes, "fatalError": boolean whether there has been at least one fatal error, "lastError": last error string, "renames" : number of files renamed, "listed" : number of directory entries listed, "retryError": boolean showing whether there has been at least one non-NoRetryError, "serverSideCopies": number of server side copies done, "serverSideCopyBytes": number bytes server side copied, "serverSideMoves": number of server side moves done, "serverSideMoveBytes": number bytes server side moved, "speed": average speed in bytes per second since start of the group, "totalBytes": total number of bytes in the group, "totalChecks": total number of checks in the group, "totalTransfers": total number of transfers in the group, "transferTime" : total time spent on running jobs, "transfers": number of transferred files, "transferring": an array of currently active file transfers: [ { "bytes": total transferred bytes for this file, "eta": estimated time in seconds until file transfer completion "name": name of the file, "percentage": progress of the file transfer in percent, "speed": average speed over the whole transfer in bytes per second, "speedAvg": current speed in bytes per second as an exponentially weighted moving average, "size": size of the file in bytes } ], "checking": an array of names of currently active file checks [] } ``` Values for "transferring", "checking" and "lastError" are only assigned if data is available. The value for "eta" is null if an eta cannot be determined. **Authentication is not required for this call.** ### core/stats-delete: Delete stats group. {#core-stats-delete} This deletes entire stats group. Parameters - group - name of the stats group (string) ### core/stats-reset: Reset stats. {#core-stats-reset} This clears counters, errors and finished transfers for all stats or specific stats group if group is provided. Parameters - group - name of the stats group (string) ### core/transferred: Returns stats about completed transfers. {#core-transferred} This returns stats about completed transfers: rclone rc core/transferred If group is not provided then completed transfers for all groups will be returned. Note only the last 100 completed transfers are returned. Parameters - group - name of the stats group (string) Returns the following values: ``` { "transferred": an array of completed transfers (including failed ones): [ { "name": name of the file, "size": size of the file in bytes, "bytes": total transferred bytes for this file, "checked": if the transfer is only checked (skipped, deleted), "what": the purpose of the transfer (transferring, deleting, checking, importing, hashing, merging, listing, moving, renaming), "timestamp": integer representing millisecond unix epoch, "error": string description of the error (empty if successful), "jobid": id of the job that this transfer belongs to } ] } ``` **Authentication is not required for this call.** ### core/version: Shows the current version of rclone, Go and the OS. {#core-version} This shows the current versions of rclone, Go and the OS: - version - rclone version, e.g. "v1.71.2" - decomposed - version number as [major, minor, patch] - isGit - boolean - true if this was compiled from the git version - isBeta - boolean - true if this is a beta version - os - OS in use as according to Go GOOS (e.g. "linux") - osKernel - OS Kernel version (e.g. "6.8.0-86-generic (x86_64)") - osVersion - OS Version (e.g. "ubuntu 24.04 (64 bit)") - osArch - cpu architecture in use (e.g. "arm64 (ARMv8 compatible)") - arch - cpu architecture in use according to Go GOARCH (e.g. "arm64") - goVersion - version of Go runtime in use (e.g. "go1.25.0") - linking - type of rclone executable (static or dynamic) - goTags - space separated build tags or "none" **Authentication is not required for this call.** ### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate} SetBlockProfileRate controls the fraction of goroutine blocking events that are reported in the blocking profile. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked. To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0. After calling this you can use this to see the blocking profile: go tool pprof http://localhost:5572/debug/pprof/block Parameters: - rate - int ### debug/set-gc-percent: Call runtime/debug.SetGCPercent for setting the garbage collection target percentage. {#debug-set-gc-percent} SetGCPercent sets the garbage collection target percentage: a collection is triggered when the ratio of freshly allocated data to live data remaining after the previous collection reaches this percentage. SetGCPercent returns the previous setting. The initial setting is the value of the GOGC environment variable at startup, or 100 if the variable is not set. This setting may be effectively reduced in order to maintain a memory limit. A negative percentage effectively disables garbage collection, unless the memory limit is reached. See https://pkg.go.dev/runtime/debug#SetMemoryLimit for more details. Parameters: - gc-percent - int ### debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug-set-mutex-profile-fraction} SetMutexProfileFraction controls the fraction of mutex contention events that are reported in the mutex profile. On average 1/rate events are reported. The previous rate is returned. To turn off profiling entirely, pass rate 0. To just read the current rate, pass rate < 0. (For n>1 the details of sampling may change.) Once this is set you can look use this to profile the mutex contention: go tool pprof http://localhost:5572/debug/pprof/mutex Parameters: - rate - int Results: - previousRate - int ### debug/set-soft-memory-limit: Call runtime/debug.SetMemoryLimit for setting a soft memory limit for the runtime. {#debug-set-soft-memory-limit} SetMemoryLimit provides the runtime with a soft memory limit. The runtime undertakes several processes to try to respect this memory limit, including adjustments to the frequency of garbage collections and returning memory to the underlying system more aggressively. This limit will be respected even if GOGC=off (or, if SetGCPercent(-1) is executed). The input limit is provided as bytes, and includes all memory mapped, managed, and not released by the Go runtime. Notably, it does not account for space used by the Go binary and memory external to Go, such as memory managed by the underlying system on behalf of the process, or memory managed by non-Go code inside the same process. Examples of excluded memory sources include: OS kernel memory held on behalf of the process, memory allocated by C code, and memory mapped by syscall.Mmap (because it is not managed by the Go runtime). A zero limit or a limit that's lower than the amount of memory used by the Go runtime may cause the garbage collector to run nearly continuously. However, the application may still make progress. The memory limit is always respected by the Go runtime, so to effectively disable this behavior, set the limit very high. math.MaxInt64 is the canonical value for disabling the limit, but values much greater than the available memory on the underlying system work just as well. See https://go.dev/doc/gc-guide for a detailed guide explaining the soft memory limit in more detail, as well as a variety of common use-cases and scenarios. SetMemoryLimit returns the previously set memory limit. A negative input does not adjust the limit, and allows for retrieval of the currently set memory limit. Parameters: - mem-limit - int ### fscache/clear: Clear the Fs cache. {#fscache-clear} This clears the fs cache. This is where remotes created from backends are cached for a short while to make repeated rc calls more efficient. If you change the parameters of a backend then you may want to call this to clear an existing remote out of the cache before re-creating it. ### fscache/entries: Returns the number of entries in the fs cache. {#fscache-entries} This returns the number of entries in the fs cache. Returns - entries - number of items in the cache ### job/batch: Run a batch of rclone rc commands concurrently. {#job-batch} This takes the following parameters: - concurrency - int - do this many commands concurrently. Defaults to `--transfers` if not set. - inputs - an list of inputs to the commands with an extra `_path` parameter ```json { "_path": "rc/path", "param1": "parameter for the path as documented", "param2": "parameter for the path as documented, etc", } ``` The inputs may use `_async`, `_group`, `_config` and `_filter` as normal when using the rc. Returns: - results - a list of results from the commands with one entry for each in inputs. For example: ```sh rclone rc job/batch --json '{ "inputs": [ { "_path": "rc/noop", "parameter": "OK" }, { "_path": "rc/error", "parameter": "BAD" } ] } ' ``` Gives the result: ```json { "results": [ { "parameter": "OK" }, { "error": "arbitrary error on input map[parameter:BAD]", "input": { "parameter": "BAD" }, "path": "rc/error", "status": 500 } ] } ``` ### job/list: Lists the IDs of the running jobs {#job-list} Parameters: None. Results: - executeId - string id of rclone executing (change after restart) - jobids - array of integer job ids (starting at 1 on each restart) - runningIds - array of integer job ids that are running - finishedIds - array of integer job ids that are finished **Authentication is not required for this call.** ### job/status: Reads the status of the job ID {#job-status} Parameters: - jobid - id of the job (integer). Results: - finished - boolean - duration - time in seconds that the job ran for - endTime - time the job finished (e.g. "2018-10-26T18:50:20.528746884+01:00") - error - error from the job or empty string for no error - finished - boolean whether the job has finished or not - id - as passed in above - executeId - rclone instance ID (changes after restart); combined with id uniquely identifies a job - startTime - time the job started (e.g. "2018-10-26T18:50:20.528336039+01:00") - success - boolean - true for success false otherwise - output - output of the job as would have been returned if called synchronously - progress - output of the progress related to the underlying job **Authentication is not required for this call.** ### job/stop: Stop the running job {#job-stop} Parameters: - jobid - id of the job (integer). ### job/stopgroup: Stop all running jobs in a group {#job-stopgroup} Parameters: - group - name of the group (string). ### mount/listmounts: Show current mount points {#mount-listmounts} This shows currently mounted points, which can be used for performing an unmount. This takes no parameters and returns - mountPoints: list of current mount points Eg rclone rc mount/listmounts ### mount/mount: Create a new mount point {#mount-mount} rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 This takes the following parameters: - fs - a remote path to be mounted (required) - mountPoint: valid path on the local machine (required) - mountType: one of the values (mount, cmount, mount2) specifies the mount implementation to use - mountOpt: a JSON object with Mount options in. - vfsOpt: a JSON object with VFS options in. Alternatively, you can pass VFS and Mount options flat at the top level of the parameter map. The option names are the same as their CLI flags without '--' and with '-' replaced by '_' (e.g. 'vfs_cache_mode' instead of 'CacheMode' inside 'vfsOpt', and 'volname' instead of 'VolName' inside 'mountOpt'). If both flat parameters and nested 'vfsOpt'/'mountOpt' blocks are supplied, the parameters in the nested blocks will take precedence. On Windows mountPoint may be set to "*" to assign the next available drive letter automatically, or a network share UNC path (e.g. "\\server\share") to mount as a network drive. In these cases the actual drive letter is chosen at mount time. This returns the following values: - mountPoint: the actual mount point that was used (this may differ from the input, e.g. on Windows when "*" is passed the allocated drive letter is returned) Example: ```console rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}' rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfs_cache_mode=writes volname=MyTestVolume rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount ``` The vfsOpt are as described in options/get and can be seen in the "vfs" section when running and the mountOpt can be seen in the "mount" section: ```console rclone rc options/get ``` ### mount/types: Show all possible mount types {#mount-types} This shows all possible mount types and returns them as a list. This takes no parameters and returns - mountTypes: list of mount types The mount types are strings like "mount", "mount2", "cmount" and can be passed to mount/mount as the mountType parameter. Eg rclone rc mount/types ### mount/unmount: Unmount selected active mount {#mount-unmount} rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. This takes the following parameters: - mountPoint: valid path on the local machine where the mount was created (required) Example: rclone rc mount/unmount mountPoint=/home//mountPoint ### mount/unmountall: Unmount all active mounts {#mount-unmountall} rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. This takes no parameters and returns error if unmount does not succeed. Eg rclone rc mount/unmountall ### operations/about: Return the space used on the remote {#operations-about} This takes the following parameters: - fs - a remote name string e.g. "drive:" The result is as returned from rclone about --json See the [about](https://rclone.org/commands/rclone_about/) command for more information on the above. ### operations/check: check the source and destination are the same {#operations-check} Checks the files in the source and destination match. It compares sizes and hashes and logs a report of files that don't match. It doesn't alter the source or destination. This takes the following parameters: - srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem - dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem - download - check by downloading rather than with hash - checkFileHash - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type - checkFileFs - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type - checkFileRemote - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type - oneWay - check one way only, source files must exist on remote - combined - make a combined report of changes (default false) - missingOnSrc - report all files missing from the source (default true) - missingOnDst - report all files missing from the destination (default true) - match - report all matching files (default false) - differ - report all non-matching files (default true) - error - report all files with errors (hashing or reading) (default true) If you supply the download flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data. If you supply the size-only global flag, it will only compare the sizes not the hashes as well. Use this for a quick check. If you supply the checkFileHash option with a valid hash name, the checkFileFs:checkFileRemote must point to a text file in the SUM format. This treats the checksum file as the source and dstFs as the destination. Note that srcFs is not used and should not be supplied in this case. Returns: - success - true if no error, false otherwise - status - textual summary of check, OK or text string - hashType - hash used in check, may be missing - combined - array of strings of combined report of changes - missingOnSrc - array of strings of all files missing from the source - missingOnDst - array of strings of all files missing from the destination - match - array of strings of all matching files - differ - array of strings of all non-matching files - error - array of strings of all files with errors (hashing or reading) ### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup} This takes the following parameters: - fs - a remote name string e.g. "drive:" See the [cleanup](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. ### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile} This takes the following parameters: - srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem - srcRemote - a path within that remote e.g. "file.txt" for the source - dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem - dstRemote - a path within that remote e.g. "file2.txt" for the destination ### operations/copyurl: Copy the URL to the object {#operations-copyurl} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - url - string, URL to read from - autoFilename - boolean, set to true to retrieve destination file name from url See the [copyurl](https://rclone.org/commands/rclone_copyurl/) command for more information on the above. ### operations/delete: Remove files in the path {#operations-delete} This takes the following parameters: - fs - a remote name string e.g. "drive:" See the [delete](https://rclone.org/commands/rclone_delete/) command for more information on the above. ### operations/deletefile: Remove the single file pointed to {#operations-deletefile} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" See the [deletefile](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. ### operations/fsinfo: Return information about the remote {#operations-fsinfo} This takes the following parameters: - fs - a remote name string e.g. "drive:" This returns info about the remote passed in; ``` { // optional features and whether they are available or not "Features": { "About": true, "BucketBased": false, "BucketBasedRootOK": false, "CanHaveEmptyDirectories": true, "CaseInsensitive": false, "ChangeNotify": false, "CleanUp": false, "Command": true, "Copy": false, "DirCacheFlush": false, "DirMove": true, "Disconnect": false, "DuplicateFiles": false, "GetTier": false, "IsLocal": true, "ListR": false, "MergeDirs": false, "MetadataInfo": true, "Move": true, "OpenWriterAt": true, "PublicLink": false, "Purge": true, "PutStream": true, "PutUnchecked": false, "ReadMetadata": true, "ReadMimeType": false, "ServerSideAcrossConfigs": false, "SetTier": false, "SetWrapper": false, "Shutdown": false, "SlowHash": true, "SlowModTime": false, "UnWrap": false, "UserInfo": false, "UserMetadata": true, "WrapFs": false, "WriteMetadata": true, "WriteMimeType": false }, // Names of hashes available "Hashes": [ "md5", "sha1", "whirlpool", "crc32", "sha256", "dropbox", "mailru", "quickxor" ], "Name": "local", // Name as created "Precision": 1, // Precision of timestamps in ns "Root": "/", // Path as created "String": "Local file system at /", // how the remote will appear in logs // Information about the system metadata for this backend "MetadataInfo": { "System": { "atime": { "Help": "Time of last access", "Type": "RFC 3339", "Example": "2006-01-02T15:04:05.999999999Z07:00" }, "btime": { "Help": "Time of file birth (creation)", "Type": "RFC 3339", "Example": "2006-01-02T15:04:05.999999999Z07:00" }, "gid": { "Help": "Group ID of owner", "Type": "decimal number", "Example": "500" }, "mode": { "Help": "File type and mode", "Type": "octal, unix style", "Example": "0100664" }, "mtime": { "Help": "Time of last modification", "Type": "RFC 3339", "Example": "2006-01-02T15:04:05.999999999Z07:00" }, "rdev": { "Help": "Device ID (if special file)", "Type": "hexadecimal", "Example": "1abc" }, "uid": { "Help": "User ID of owner", "Type": "decimal number", "Example": "500" } }, "Help": "Textual help string\n" } } ``` This command does not have a command line equivalent so use this instead: rclone rc --loopback operations/fsinfo fs=remote: ### operations/hashsum: Produces a hashsum file for all the objects in the path. {#operations-hashsum} Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. This takes the following parameters: - fs - a remote name string e.g. "drive:" for the source, "/" for local filesystem - this can point to a file and just that file will be returned in the listing. - hashType - type of hash to be used - download - check by downloading rather than with hash (boolean) - base64 - output the hashes in base64 rather than hex (boolean) If you supply the download flag, it will download the data from the remote and create the hash on the fly. This can be useful for remotes that don't support the given hash or if you really want to check all the data. Note that if you wish to supply a checkfile to check hashes against the current files then you should use operations/check instead of operations/hashsum. Returns: - hashsum - array of strings of the hashes - hashType - type of hash used Example: $ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true { "hashType": "md5", "hashsum": [ "WTSVLpuiXyJO_kGzJerRLg== backend-versions.sh", "v1b_OlWCJO9LtNq3EIKkNQ== bisect-go-rclone.sh", "VHbmHzHh4taXzgag8BAIKQ== bisect-rclone.sh", ] } See the [hashsum](https://rclone.org/commands/rclone_hashsum/) command for more information on the above. ### operations/hashsumfile: Produces a hash for a single file. {#operations-hashsumfile} Produces a hash for a single file using the hash named. This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "file.txt" - hashType - type of hash to be used - download - check by downloading rather than with hash (boolean) - base64 - output the hashes in base64 rather than hex (boolean) If you supply the download flag, it will download the data from the remote and create the hash on the fly. This can be useful for remotes that don't support the given hash or if you really want to read all the data. Returns: - hash - hash for the file - hashType - type of hash used Example: $ rclone rc --loopback operations/hashsumfile fs=/ remote=/bin/bash hashType=MD5 download=true base64=true { "hashType": "md5", "hash": "MDMw-fG2YXs7Uz5Nz-H68A==" } See the [hashsum](https://rclone.org/commands/rclone_hashsum/) command for more information on the above. ### operations/list: List the given remote and path in JSON format {#operations-list} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - opt - a dictionary of options to control the listing (optional) - recurse - If set recurse directories - noModTime - If set return modification time - showEncrypted - If set show decrypted names - showOrigIDs - If set show the IDs for each item if known - showHash - If set return a dictionary of hashes - noMimeType - If set don't show mime types - dirsOnly - If set only show directories - filesOnly - If set only show files - metadata - If set return metadata of objects also - hashTypes - array of strings of hash types to show if showHash set Returns: - list - This is an array of objects as described in the lsjson command See the [lsjson](https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples. ### operations/mkdir: Make a destination directory or container {#operations-mkdir} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" See the [mkdir](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. ### operations/movefile: Move a file from source remote to destination remote {#operations-movefile} This takes the following parameters: - srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem - srcRemote - a path within that remote e.g. "file.txt" for the source - dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem - dstRemote - a path within that remote e.g. "file2.txt" for the destination ### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - unlink - boolean - if set removes the link rather than adding it (optional) - expire - string - the expiry time of the link e.g. "1d" (optional) Returns: - url - URL of the resource See the [link](https://rclone.org/commands/rclone_link/) command for more information on the above. ### operations/purge: Remove a directory or container and all of its contents {#operations-purge} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" See the [purge](https://rclone.org/commands/rclone_purge/) command for more information on the above. ### operations/rmdir: Remove an empty directory or container {#operations-rmdir} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" See the [rmdir](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. ### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - leaveRoot - boolean, set to true not to delete the root See the [rmdirs](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. ### operations/settier: Changes storage tier or class on all files in the path {#operations-settier} This takes the following parameters: - fs - a remote name string e.g. "drive:" See the [settier](https://rclone.org/commands/rclone_settier/) command for more information on the above. ### operations/settierfile: Changes storage tier or class on the single file pointed to {#operations-settierfile} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" ### operations/size: Count the number of bytes and files in remote {#operations-size} This takes the following parameters: - fs - a remote name string e.g. "drive:path/to/dir" Returns: - count - number of files - bytes - number of bytes in those files See the [size](https://rclone.org/commands/rclone_size/) command for more information on the above. ### operations/stat: Give information about the supplied file or directory {#operations-stat} This takes the following parameters - fs - a remote name string eg "drive:" - remote - a path within that remote eg "dir" - opt - a dictionary of options to control the listing (optional) - see operations/list for the options The result is - item - an object as described in the lsjson command. Will be null if not found. Note that if you are only interested in files then it is much more efficient to set the filesOnly flag in the options. See the [lsjson](https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples. ### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile} This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - each part in body represents a file to be uploaded ### options/blocks: List all the option blocks {#options-blocks} Returns: - options - a list of the options block names ### options/get: Get all the global options {#options-get} Returns an object where keys are option block names and values are an object with the current option values in. Parameters: - blocks: optional string of comma separated blocks to include - all are included if this is missing or "" Note that these are the global options which are unaffected by use of the _config and _filter parameters. If you wish to read the parameters set in _config or _filter use options/local. This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. ### options/info: Get info about all the global options {#options-info} Returns an object where keys are option block names and values are an array of objects with info about each options. Parameters: - blocks: optional string of comma separated blocks to include - all are included if this is missing or "" These objects are in the same format as returned by "config/providers". They are described in the [option blocks](#option-blocks) section. ### options/local: Get the currently active config for this call {#options-local} Returns an object with the keys "config" and "filter". The "config" key contains the local config and the "filter" key contains the local filters. Note that these are the local options specific to this rc call. If _config was not supplied then they will be the global options. Likewise with "_filter". This call is mostly useful for seeing if _config and _filter passing is working. This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. ### options/set: Set an option {#options-set} Parameters: - option block name containing an object with - key: value Repeated as often as required. Only supply the options you wish to change. If an option is unknown it will be silently ignored. Not all options will have an effect when changed like this. For example: This sets DEBUG level logs (-vv) (these can be set by number or string) rclone rc options/set --json '{"main": {"LogLevel": "DEBUG"}}' rclone rc options/set --json '{"main": {"LogLevel": 8}}' And this sets INFO level logs (-v) rclone rc options/set --json '{"main": {"LogLevel": "INFO"}}' And this sets NOTICE level logs (normal without -v) rclone rc options/set --json '{"main": {"LogLevel": "NOTICE"}}' ### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin} Used for adding a plugin to the webgui. This takes the following parameters: - url - http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react). Example: rclone rc pluginsctl/addPlugin ### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType} This shows all possible plugins by a mime type. This takes the following parameters: - type - supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3). - pluginType - filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL). Returns: - loadedPlugins - list of current production plugins. - testPlugins - list of temporarily loaded development plugins, usually running on a different server. Example: rclone rc pluginsctl/getPluginsForType type=video/mp4 ### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins} This allows you to get the currently enabled plugins and their details. This takes no parameters and returns: - loadedPlugins - list of current production plugins. - testPlugins - list of temporarily loaded development plugins, usually running on a different server. E.g. rclone rc pluginsctl/listPlugins ### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins} Allows listing of test plugins with the rclone.test set to true in package.json of the plugin. This takes no parameters and returns: - loadedTestPlugins - list of currently available test plugins. E.g. rclone rc pluginsctl/listTestPlugins ### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin} This allows you to remove a plugin using it's name. This takes parameters: - name - name of the plugin in the format `author`/`plugin_name`. E.g. rclone rc pluginsctl/removePlugin name=rclone/video-plugin ### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin} This allows you to remove a plugin using it's name. This takes the following parameters: - name - name of the plugin in the format `author`/`plugin_name`. Example: rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react ### rc/error: This returns an error {#rc-error} This returns an error with the input as part of its error string. Useful for testing error handling. **Authentication is not required for this call.** ### rc/fatal: This returns an fatal error {#rc-fatal} This returns an error with the input as part of its error string. Useful for testing error handling. ### rc/list: List all the registered remote control commands {#rc-list} This lists all the registered remote control commands as a JSON map in the commands response. **Authentication is not required for this call.** ### rc/noop: Echo the input to the output parameters {#rc-noop} This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly. **Authentication is not required for this call.** ### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth} This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly. ### rc/panic: This returns an error by panicking {#rc-panic} This returns an error with the input as part of its error string. Useful for testing error handling. ### serve/list: Show running servers {#serve-list} Show running servers with IDs. This takes no parameters and returns - list: list of running serve commands Each list element will have - id: ID of the server - addr: address the server is running on - params: parameters used to start the server Eg rclone rc serve/list Returns ```json { "list": [ { "addr": "[::]:4321", "id": "nfs-ffc2a4e5", "params": { "fs": "remote:", "opt": { "ListenAddr": ":4321" }, "type": "nfs", "vfsOpt": { "CacheMode": "full" } } } ] } ``` ### serve/start: Create a new server {#serve-start} Create a new server with the specified parameters. This takes the following parameters: - `type` - type of server: `http`, `webdav`, `ftp`, `sftp`, `nfs`, etc. - `fs` - remote storage path to serve - `addr` - the ip:port to run the server on, eg ":1234" or "localhost:1234" Other parameters are as described in the documentation for the relevant [rclone serve](https://rclone.org/commands/rclone_serve/) command line options. To translate a command line option to an rc parameter, remove the leading `--` and replace `-` with `_`, so `--vfs-cache-mode` becomes `vfs_cache_mode`. Option parameters (such as VFS, proxy, and protocol-specific options) can be passed flat at the top level of the parameter map or inside nested JSON objects under the `vfsOpt`, `proxyOpt`, and `opt` keys (e.g. `vfsOpt='{"CacheMode": 2}'`, `proxyOpt='{"AuthProxy": "http://127.0.0.1:8080"}'`). If both flat parameters and nested blocks are supplied, the parameters in the nested blocks will take precedence. Note that global parameters must be set with `_config` and `_filter` as described above. Examples: rclone rc serve/start type=nfs fs=remote: addr=:4321 vfs_cache_mode=full rclone rc serve/start --json '{"type":"nfs","fs":"remote:","addr":":1234","vfs_cache_mode":"full"}' rclone rc serve/start type=webdav fs=remote: vfsOpt='{"CacheMode": 2}' proxyOpt='{"AuthProxy": "http://127.0.0.1:8080"}' This will give the reply ```json { "addr": "[::]:4321", // Address the server was started on "id": "nfs-ecfc6852" // Unique identifier for the server instance } ``` Or an error if it failed to start. Stop the server with `serve/stop` and list the running servers with `serve/list`. ### serve/stop: Unserve selected active serve {#serve-stop} Stops a running `serve` instance by ID. This takes the following parameters: - id: as returned by serve/start This will give an empty response if successful or an error if not. Example: rclone rc serve/stop id=12345 ### serve/stopall: Stop all active servers {#serve-stopall} Stop all active servers. This will stop all active servers. rclone rc serve/stopall ### serve/types: Show all possible serve types {#serve-types} This shows all possible serve types and returns them as a list. This takes no parameters and returns - types: list of serve types, eg "nfs", "sftp", etc The serve types are strings like "serve", "serve2", "cserve" and can be passed to serve/start as the serveType parameter. Eg rclone rc serve/types Returns ```json { "types": [ "http", "sftp", "nfs" ] } ``` ### sync/bisync: Perform bidirectional synchronization between two paths. {#sync-bisync} This takes the following parameters: - path1 (required) - (string) a remote directory string e.g. `drive:path1` - path2 (required) - (string) a remote directory string e.g. `drive:path2` - dryRun - (bool) dry-run mode - backupDir1 - (string) --backup-dir for Path1. Must be a non-overlapping path on the same remote. - backupDir2 - (string) --backup-dir for Path2. Must be a non-overlapping path on the same remote. - checkAccess - (bool) Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort. - checkFilename - (string) Filename for --check-access (default: RCLONE_TEST) - checkSync - (string) Controls comparison of final listings: true|false|only (default: true) - compare - (string) Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime') - conflictLoser - (ConflictLoserAction) Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num) - conflictResolve - (string) Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) - conflictSuffix - (string) Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict') - createEmptySrcDirs - (bool) Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) - downloadHash - (bool) Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!) - filtersFile - (string) Read filtering patterns from a file - force - (bool) Bypass --max-delete safety check and run the sync. Consider using with --verbose - ignoreListingChecksum - (bool) Do not use checksums for listings (add --ignore- checksum to additionally skip post-copy checksum checks) - maxLock - (Duration) Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) - noCleanup - (bool) Retain working files (useful for troubleshooting and testing). - noSlowHash - (bool) Ignore listing checksums only on backends where they are slow - recover - (bool) Automatically recover from interruptions without requiring -- resync. - removeEmptyDirs - (bool) Remove ALL empty directories at the final cleanup step. - resilient - (bool) Allow future runs to retry after certain less-serious errors, instead of requiring --resync. - resync - (bool) Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first. - resyncMode - (string) During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) - slowHashSyncOnly - (bool) Ignore slow checksums for listings and deltas, but still consider them during sync calls. - workdir - (string) Use custom working dir - useful for testing. (default: /home/ncw/.cache/rclone/bisync) See [bisync command help](https://rclone.org/commands/rclone_bisync/) and [full bisync description](https://rclone.org/bisync/) for more information. ### sync/copy: copy a directory from source remote to destination remote {#sync-copy} This takes the following parameters: - srcFs - a remote name string e.g. "drive:src" for the source - dstFs - a remote name string e.g. "drive:dst" for the destination - createEmptySrcDirs - create empty src directories on destination if set See the [copy](https://rclone.org/commands/rclone_copy/) command for more information on the above. ### sync/move: move a directory from source remote to destination remote {#sync-move} This takes the following parameters: - srcFs - a remote name string e.g. "drive:src" for the source - dstFs - a remote name string e.g. "drive:dst" for the destination - createEmptySrcDirs - create empty src directories on destination if set - deleteEmptySrcDirs - delete empty src directories if set See the [move](https://rclone.org/commands/rclone_move/) command for more information on the above. ### sync/sync: sync a directory from source remote to destination remote {#sync-sync} This takes the following parameters: - srcFs - a remote name string e.g. "drive:src" for the source - dstFs - a remote name string e.g. "drive:dst" for the destination - createEmptySrcDirs - create empty src directories on destination if set See the [sync](https://rclone.org/commands/rclone_sync/) command for more information on the above. ### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget} This forgets the paths in the directory cache causing them to be re-read from the remote when needed. If no paths are passed in then it will forget all the paths in the directory cache. rclone rc vfs/forget Otherwise pass files or dirs in as file=path or dir=path. Any parameter key starting with file will forget that file and any starting with dir will forget that dir, e.g. rclone rc vfs/forget file=hello file2=goodbye dir=home/junk This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. ### vfs/list: List active VFSes. {#vfs-list} This lists the active VFSes. It returns a list under the key "vfses" where the values are the VFS names that could be passed to the other VFS commands in the "fs" parameter. **Authentication is not required for this call.** ### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval} Without any parameter given this returns the current status of the poll-interval setting. When the interval=duration parameter is set, the poll-interval value is updated and the polling function is notified. Setting interval=0 disables poll-interval. rclone rc vfs/poll-interval interval=5m The timeout=duration parameter can be used to specify a time to wait for the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely. The new poll-interval value will only be active when the timeout is not reached. If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote. This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. ### vfs/queue: Queue info for a VFS. {#vfs-queue} This returns info about the upload queue for the selected VFS. This is only useful if `--vfs-cache-mode` > off. If you call it when the `--vfs-cache-mode` is off, it will return an empty result. { "queue": // an array of files queued for upload [ { "name": "file", // string: name (full path) of the file, "id": 123, // integer: id of this item in the queue, "size": 79, // integer: size of the file in bytes "expiry": 1.5 // float: time until file is eligible for transfer, lowest goes first "tries": 1, // integer: number of times we have tried to upload "delay": 5.0, // float: seconds between upload attempts "uploading": false, // boolean: true if item is being uploaded }, ], } The `expiry` time is the time until the file is eligible for being uploaded in floating point seconds. This may go negative. As rclone only transfers `--transfers` files at once, only the lowest `--transfers` expiry times will have `uploading` as `true`. So there may be files with negative expiry times for which `uploading` is `false`. This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. **Authentication is not required for this call.** ### vfs/queue-set-expiry: Set the expiry time for an item queued for upload. {#vfs-queue-set-expiry} Use this to adjust the `expiry` time for an item in the upload queue. You will need to read the `id` of the item using `vfs/queue` before using this call. You can then set `expiry` to a floating point number of seconds from now when the item is eligible for upload. If you want the item to be uploaded as soon as possible then set it to a large negative number (eg -1000000000). If you want the upload of the item to be delayed for a long time then set it to a large positive number. Setting the `expiry` of an item which has already has started uploading will have no effect - the item will carry on being uploaded. This will return an error if called with `--vfs-cache-mode` off or if the `id` passed is not found. This takes the following parameters - `fs` - select the VFS in use (optional) - `id` - a numeric ID as returned from `vfs/queue` - `expiry` - a new expiry time as floating point seconds - `relative` - if set, expiry is to be treated as relative to the current expiry (optional, boolean) This returns an empty result on success, or an error. This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. ### vfs/refresh: Refresh the directory cache. {#vfs-refresh} This reads the directories for the specified paths and freshens the directory cache. If no paths are passed in then it will refresh the root directory. rclone rc vfs/refresh Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, e.g. rclone rc vfs/refresh dir=home/junk dir2=data/misc If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled. This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. ### vfs/stats: Stats for a VFS. {#vfs-stats} This returns stats for the selected VFS. { // Status of the disk cache - only present if --vfs-cache-mode > off "diskCache": { "bytesUsed": 0, "erroredFiles": 0, "files": 0, "hashType": 1, "outOfSpace": false, "path": "/home/user/.cache/rclone/vfs/local/mnt/a", "pathMeta": "/home/user/.cache/rclone/vfsMeta/local/mnt/a", "uploadsInProgress": 0, "uploadsQueued": 0 }, "fs": "/mnt/a", "inUse": 1, // Status of the in memory metadata cache "metadataCache": { "dirs": 1, "files": 0 }, // Options as returned by options/get "opt": { "CacheMaxAge": 3600000000000, // ... "WriteWait": 1000000000 } } This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied. **Authentication is not required for this call.** ## Accessing the remote control via HTTP {#api-http} Rclone implements a simple HTTP based protocol. Each endpoint takes an JSON object and returns a JSON object or an error. The JSON objects are essentially a map of string names to values. All calls must made using POST. The input objects can be supplied using URL parameters, POST parameters or by supplying "Content-Type: application/json" and a JSON blob in the body. There are examples of these below using `curl`. The response will be a JSON blob in the body of the response. This is formatted to be reasonably human-readable. ### Error returns If an error occurs then there will be an HTTP error status (e.g. 500) and the body of the response will contain a JSON encoded error object, e.g. ```json { "error": "Expecting string value for key \"remote\" (was float64)", "input": { "fs": "/tmp", "remote": 3 }, "status": 400, "path": "operations/rmdir" } ``` The keys in the error response are: - error - error string - input - the input parameters to the call - status - the HTTP status code - path - the path of the call ### CORS The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back. ### Using POST with URL parameters only ```console curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' ``` Response ```json { "potato": "1", "sausage": "2" } ``` Here is what an error response looks like: ```console curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' ``` ```json { "error": "arbitrary error on input map[potato:1 sausage:2]", "input": { "potato": "1", "sausage": "2" } } ``` Note that curl doesn't return errors to the shell unless you use the `-f` option ```console $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' curl: (22) The requested URL returned error: 400 Bad Request $ echo $? 22 ``` ### Using POST with a form ```console curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop ``` Response ```json { "potato": "1", "sausage": "2" } ``` Note that you can combine these with URL parameters too with the POST parameters taking precedence. ```console curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4" ``` Response ```json { "potato": "1", "rutabaga": "3", "sausage": "4" } ``` ### Using POST with a JSON blob ```console curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop ``` response ```json { "password": "xyz", "username": "xyz" } ``` This can be combined with URL parameters too if required. The JSON blob takes precedence. ```console curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4' ``` ```json { "potato": 2, "rutabaga": "3", "sausage": 1 } ``` ## Debugging rclone with pprof If you use the `--rc` flag this will also enable the use of the go profiling tools on the same port. The profiling endpoints follow the same authentication rules as the rest of the rc: they are only served if authentication has been set up (`--rc-user`/`--rc-pass` or `--rc-htpasswd`) or the [`--rc-no-auth`](#--rc-no-auth) flag is in use. For debugging on the default localhost port the easiest thing is to use `--rc --rc-no-auth` (but see the warning about using `--rc-no-auth` on a non-loopback bind). To use these, first [install go](https://golang.org/doc/install). ### Debugging memory use To profile rclone's memory use you can run: ```console go tool pprof -web http://localhost:5572/debug/pprof/heap ``` This should open a page in your browser showing what is using what memory. You can also use the `-text` flag to produce a textual summary ```console $ go tool pprof -text http://localhost:5572/debug/pprof/heap Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% 100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest 0 0% 100% 513kB 33.38% net/http.(*conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main ``` ### Debugging go routine leaks Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected. See all active go routines using ```console curl http://localhost:5572/debug/pprof/goroutine?debug=1 ``` Or go to in your browser. ### Other profiles to look at You can see a summary of profiles available at Here is how to use some of them: - Memory: `go tool pprof http://localhost:5572/debug/pprof/heap` - Go routines: `curl http://localhost:5572/debug/pprof/goroutine?debug=1` - 30-second CPU profile: `go tool pprof http://localhost:5572/debug/pprof/profile` - 5-second execution trace: `wget http://localhost:5572/debug/pprof/trace?seconds=5` - Goroutine blocking profile - Enable first with: `rclone rc debug/set-block-profile-rate rate=1` ([docs](#debug-set-block-profile-rate)) - `go tool pprof http://localhost:5572/debug/pprof/block` - Contended mutexes: - Enable first with: `rclone rc debug/set-mutex-profile-fraction rate=1` ([docs](#debug-set-mutex-profile-fraction)) - `go tool pprof http://localhost:5572/debug/pprof/mutex` See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/) for more info on how to use the profiling and for a general overview see [the Go team's blog post on profiling go programs](https://blog.golang.org/profiling-go-programs). The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). # Overview of cloud storage systems Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through. ## Features Here is an overview of the major features of each cloud storage system. ### Hash The cloud storage system supports various hash types of the objects. The hashes are used when transferring data as an integrity check and can be specifically used with the `--checksum` flag in syncs and in the `check` command. To use the verify checksums when transferring between cloud storage systems they must support a common hash type. ### ModTime Almost all cloud storage systems store some sort of timestamp on objects, but several of them not something that is appropriate to use for syncing. E.g. some backends will only write a timestamp that represents the time of the upload. To be relevant for syncing it should be able to store the modification time of the source object. If this is not the case, rclone will only check the file size by default, though can be configured to check the file hash (with the `--checksum` flag). Ideally it should also be possible to change the timestamp of an existing file without having to re-upload it. | Key | Explanation | |-----|-------------| | `-` | ModTimes not supported - times likely the upload time | | `R` | ModTimes supported on files but can't be changed without re-upload | | `R/W` | Read and Write ModTimes fully supported on files | | `DR` | ModTimes supported on files and directories but can't be changed without re-upload | | `DR/W` | Read and Write ModTimes fully supported on files and directories | Storage systems with a `-` in the ModTime column, means the modification read on objects is not the modification time of the file when uploaded. It is most likely the time the file was uploaded, or possibly something else (like the time the picture was taken in Google Photos). Storage systems with a `R` (for read-only) in the ModTime column, means the it keeps modification times on objects, and updates them when uploading objects, but it does not support changing only the modification time (`SetModTime` operation) without re-uploading, possibly not even without deleting existing first. Some operations in rclone, such as `copy` and `sync` commands, will automatically check for `SetModTime` support and re-upload if necessary to keep the modification times in sync. Other commands will not work without `SetModTime` support, e.g. `touch` command on an existing file will fail, and changes to modification time only on a files in a `mount` will be silently ignored. Storage systems with `R/W` (for read/write) in the ModTime column, means they do also support modtime-only operations. Storage systems with `D` in the ModTime column means that the following symbols apply to directories as well as files. ### Case Insensitive If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, e.g. `file.txt` and `FILE.txt`. If a cloud storage system is case insensitive then that isn't possible. This can cause problems when syncing between a case insensitive system and a case sensitive system. The symptom of this is that no matter how many times you run the sync it never completes fully. The local filesystem and SFTP may or may not be case sensitive depending on OS. - Windows - usually case insensitive, though case is preserved - OSX - usually case insensitive, though it is possible to format case sensitive - Linux - usually case sensitive, but there are case insensitive file systems (e.g. FAT formatted USB keys) Most of the time this doesn't cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems. ### Duplicate files If a cloud storage system allows duplicate files then it can have two objects with the same name. This confuses rclone greatly when syncing - use the `rclone dedupe` command to rename or remove duplicates. ### Restricted filenames Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When `rclone` detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters. To handle the different sets of restricted characters for different backends, rclone uses something it calls [encoding](#encoding). This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently. The name shown by `rclone` to the user or during log output will only contain a minimal set of [replaced characters](#restricted-characters) to ensure correct formatting and not necessarily the actual name used on the cloud storage. This transformation is reversed when downloading a file or parsing `rclone` arguments. For example, when uploading a file named `my file?.txt` to Onedrive, it will be displayed as `my file?.txt` on the console, but stored as `my file？.txt` to Onedrive (the `?` gets replaced by the similar looking `？` character, the so-called "fullwidth question mark"). The reverse transformation allows to read a file `unusual/name.txt` from Google Drive, by passing the name `unusual／name.txt` on the command line (the `/` needs to be replaced by the similar looking `／` character). #### Caveats {#restricted-filenames-caveats} The filename encoding system works well in most cases, at least where file names are written in English or similar languages. You might not even notice it: It just works. In some cases it may lead to issues, though. E.g. when file names are written in Chinese, or Japanese, where it is always the Unicode fullwidth variants of the punctuation marks that are used. On Windows, the characters `:`, `*` and `?` are examples of restricted characters. If these are used in filenames on a remote that supports it, Rclone will transparently convert them to their fullwidth Unicode variants `＊`, `？` and `：` when downloading to Windows, and back again when uploading. This way files with names that are not allowed on Windows can still be stored. However, if you have files on your Windows system originally with these same Unicode characters in their names, they will be included in the same conversion process. E.g. if you create a file in your Windows filesystem with name `Test：1.jpg`, where `：` is the Unicode fullwidth colon symbol, and use rclone to upload it to Google Drive, which supports regular `:` (halfwidth question mark), rclone will replace the fullwidth `:` with the halfwidth `:` and store the file as `Test:1.jpg` in Google Drive. Since both Windows and Google Drive allows the name `Test：1.jpg`, it would probably be better if rclone just kept the name as is in this case. With the opposite situation; if you have a file named `Test:1.jpg`, in your Google Drive, e.g. uploaded from a Linux system where `:` is valid in file names. Then later use rclone to copy this file to your Windows computer you will notice that on your local disk it gets renamed to `Test：1.jpg`. The original filename is not legal on Windows, due to the `:`, and rclone therefore renames it to make the copy possible. That is all good. However, this can also lead to an issue: If you already had a *different* file named `Test：1.jpg` on Windows, and then use rclone to copy either way. Rclone will then treat the file originally named `Test:1.jpg` on Google Drive and the file originally named `Test：1.jpg` on Windows as the same file, and replace the contents from one with the other. Its virtually impossible to handle all cases like these correctly in all situations, but by customizing the [encoding option](#encoding), changing the set of characters that rclone should convert, you should be able to create a configuration that works well for your specific situation. See also the [example](https://rclone.org/overview/#encoding-example-windows) below. (Windows was used as an example of a file system with many restricted characters, and Google drive a storage system with few.) #### Default restricted characters {#restricted-characters} The table below shows the characters that are replaced by default. When a replacement character is found in a filename, this character will be escaped with the `‛` character to avoid ambiguous file names. (e.g. a file named `␀.txt` would shown as `‛␀.txt`) Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend. | Character | Value | Replacement | | --------- |:-----:|:-----------:| | NUL | 0x00 | ␀ | | SOH | 0x01 | ␁ | | STX | 0x02 | ␂ | | ETX | 0x03 | ␃ | | EOT | 0x04 | ␄ | | ENQ | 0x05 | ␅ | | ACK | 0x06 | ␆ | | BEL | 0x07 | ␇ | | BS | 0x08 | ␈ | | HT | 0x09 | ␉ | | LF | 0x0A | ␊ | | VT | 0x0B | ␋ | | FF | 0x0C | ␌ | | CR | 0x0D | ␍ | | SO | 0x0E | ␎ | | SI | 0x0F | ␏ | | DLE | 0x10 | ␐ | | DC1 | 0x11 | ␑ | | DC2 | 0x12 | ␒ | | DC3 | 0x13 | ␓ | | DC4 | 0x14 | ␔ | | NAK | 0x15 | ␕ | | SYN | 0x16 | ␖ | | ETB | 0x17 | ␗ | | CAN | 0x18 | ␘ | | EM | 0x19 | ␙ | | SUB | 0x1A | ␚ | | ESC | 0x1B | ␛ | | FS | 0x1C | ␜ | | GS | 0x1D | ␝ | | RS | 0x1E | ␞ | | US | 0x1F | ␟ | | / | 0x2F | ／ | | DEL | 0x7F | ␡ | The default encoding will also encode these file names as they are problematic with many cloud storage systems. | File name | Replacement | | --------- |:-----------:| | . | ． | | .. | ．． | #### Invalid UTF-8 bytes {#invalid-utf8} Some backends only support a sequence of well formed UTF-8 bytes as file or directory names. In this case all invalid UTF-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`. A common source of invalid UTF-8 bytes are local filesystems, that store names in a different encoding than UTF-8 or UTF-16, like latin1. See the [local filenames](https://rclone.org/local/#filenames) section for details. #### Encoding option {#encoding} Most backends have an encoding option, specified as a flag `--backend-encoding` where `backend` is the name of the backend, or as a config parameter `encoding` (you'll need to select the Advanced config in `rclone config` to see it). This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above). However this can be incorrect in some scenarios, for example if you have a Windows file system with Unicode fullwidth characters `＊`, `？` or `：`, that you want to remain as those characters on the remote rather than being translated to regular (halfwidth) `*`, `?` and `:`. The `--backend-encoding` flags allow you to change that. You can disable the encoding completely with `--backend-encoding Raw` or set `encoding = Raw` in the config file. Encoding takes a comma separated list of encodings. You can see the list of all possible values by passing an invalid value to this flag, e.g. `--local-encoding "help"`. The command `rclone help flags encoding` will show you the defaults for the backends. | Encoding | Characters | Encoded as | | --------- | ---------- | ---------- | | Asterisk | `*` | `＊` | | BackQuote | `` ` `` | `｀` | | BackSlash | `\` | `＼` | | Colon | `:` | `：` | | CrLf | CR 0x0D, LF 0x0A | `␍`, `␊` | | Ctl | All control characters 0x00-0x1F | `␀␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟` | | Del | DEL 0x7F | `␡` | | Dollar | `$` | `＄` | | Dot | `.` or `..` as entire string | `．`, `．．` | | DoubleQuote | `"` | `＂` | | Exclamation | `!` | `！` | | Hash | `#` | `＃` | | InvalidUtf8 | An invalid UTF-8 character (e.g. latin1) | `�` | | LeftCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the left of a string | `␍`, `␊`, `␉`, `␋` | | LeftPeriod | `.` on the left of a string | `.` | | LeftSpace | SPACE on the left of a string | `␠` | | LeftTilde | `~` on the left of a string | `～` | | LtGt | `<`, `>` | `＜`, `＞` | | None ¹ | NUL 0x00 | ␀ | | Percent | `%` | `％` | | Pipe | \| | `｜` | | Question | `?` | `？` | | RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | `␍`, `␊`, `␉`, `␋` | | RightPeriod | `.` on the right of a string | `.` | | RightSpace | SPACE on the right of a string | `␠` | | Semicolon | `;` | `；` | | SingleQuote | `'` | `＇` | | Slash | `/` | `／` | | SquareBracket | `[`, `]` | `［`, `］` | ¹ Encoding from NUL 0x00 to ␀ is always implicit except when using Raw. It was previously incorrectly documented as disabling encoding, and to maintain backward compatibility, its behavior has not been changed. ##### Encoding example: FTP To take a specific example, the FTP backend's default encoding is ```text --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" ``` However, let's say the FTP server is running on Windows and can't have any of the invalid Windows characters in file names. You are backing up Linux servers to this FTP server which do have those characters in file names. So you would add the Windows set which are ```text Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot ``` to the existing ones, giving: ```text Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace ``` This can be specified using the `--ftp-encoding` flag or using an `encoding` parameter in the config file. ##### Encoding example: Windows As another example, take a Windows system where there is a file with name `Test：1.jpg`, where `：` is the Unicode fullwidth colon symbol. When using rclone to copy this to a remote which supports `:`, the regular (halfwidth) colon (such as Google Drive), you will notice that the file gets renamed to `Test:1.jpg`. To avoid this you can change the set of characters rclone should convert for the local filesystem, using command-line argument `--local-encoding`. Rclone's default behavior on Windows corresponds to ```text --local-encoding "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot" ``` If you want to use fullwidth characters `：`, `＊` and `？` in your filenames without rclone changing them when uploading to a remote, then set the same as the default value but without `Colon,Question,Asterisk`: ```text --local-encoding "Slash,LtGt,DoubleQuote,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot" ``` Alternatively, you can disable the conversion of any characters with `--local-encoding Raw`. Instead of using command-line argument `--local-encoding`, you may also set it as [environment variable](https://rclone.org/docs/#environment-variables) `RCLONE_LOCAL_ENCODING`, or [configure](https://rclone.org/docs/#configure) a remote of type `local` in your config, and set the `encoding` option there. The risk by doing this is that if you have a filename with the regular (halfwidth) `:`, `*` and `?` in your cloud storage, and you try to download it to your Windows filesystem, this will fail. These characters are not valid in filenames on Windows, and you have told rclone not to work around this by converting them to valid fullwidth variants. ### MIME Type MIME types (also known as media types) classify types of documents using a simple text classification, e.g. `text/html` or `application/pdf`. Some cloud storage systems support reading (`R`) the MIME type of objects and some support writing (`W`) the MIME type of objects. The MIME type can be important if you are serving files directly to HTTP from the storage system. If you are copying from a remote which supports reading (`R`) to a remote which supports writing (`W`) then rclone will preserve the MIME types. Otherwise they will be guessed from the extension, or the remote itself may assign the MIME type. ### Metadata Backends may or may support reading or writing metadata. They may support reading and writing system metadata (metadata intrinsic to that backend) and/or user metadata (general purpose metadata). The levels of metadata support are | Key | Explanation | |-----|-------------| | `R` | Read only System Metadata on files only| | `RW` | Read and write System Metadata on files only| | `RWU` | Read and write System Metadata and read and write User Metadata on files only| | `DR` | Read only System Metadata on files and directories | | `DRW` | Read and write System Metadata on files and directories| | `DRWU` | Read and write System Metadata and read and write User Metadata on files and directories | See [the metadata docs](https://rclone.org/docs/#metadata) for more info. ## Optional Features All rclone remotes support a base command set. Other features depend upon backend-specific capabilities. ### Purge This deletes a directory quicker than just deleting all the files in the directory. ### Copy Used when copying an object to and from the same remote. This known as a server-side copy so you can copy a file without downloading it and uploading it again. It is used if you use `rclone copy` or `rclone move` if the remote doesn't support `Move` directly. If the server doesn't support `Copy` directly then for copy operations the file is downloaded then re-uploaded. ### Move Used when moving/renaming an object on the same remote. This is known as a server-side move of a file. This is used in `rclone move` if the server doesn't support `DirMove`. If the server isn't capable of `Move` then rclone simulates it with `Copy` then delete. If the server doesn't support `Copy` then rclone will download the file and re-upload it. ### DirMove This is used to implement `rclone move` to move a directory if possible. If it isn't then it will use `Move` on each file (which falls back to `Copy` then download and upload - see `Move` section). ### CleanUp This is used for emptying the trash for a remote by `rclone cleanup`. If the server can't do `CleanUp` then `rclone cleanup` will return an error. ‡‡ Note that while Box implements this it has to delete every file individually so it will be slower than emptying the trash via the WebUI ### ListR The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the `--fast-list` flag to work. See the [rclone docs](https://rclone.org/docs/#fast-list) for more details. ### StreamUpload Some remotes allow files to be uploaded without knowing the file size in advance. This allows certain operations to work without spooling the file to local disk first, e.g. `rclone rcat`. ### MultithreadUpload Some remotes allow transfers to the remote to be sent as chunks in parallel. If this is supported then rclone will use multi-thread copying to transfer files much faster. ### LinkSharing Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don't have an account on the particular cloud provider. ### About Rclone `about` prints quota information for a remote. Typical output includes bytes used, free, quota and in trash. If a remote lacks about capability `rclone about remote:`returns an error. Backends without about capability cannot determine free space for an rclone mount, or use policy `mfs` (most free space) as a member of an rclone union remote. See [rclone about command](https://rclone.org/commands/rclone_about/) ### EmptyDir The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations) for details. Most Object/Bucket-based remotes do not support this. # Tiers Rclone backends are divided into tiers to give users an idea of the stability of each backend. | Tier | Label | Intended meaning | |--------|---------------|------------------| | | Core | Production-grade, first-class | | | Stable | Well-supported, minor gaps | | | Supported | Works for many uses; known caveats | | | Experimental | Use with care; expect gaps/changes | | | Deprecated | No longer maintained or supported | ## Overview Here is a summary of all backends: ## Scoring Here is how the backends are scored. ### Features These are useful optional features a backend should have in rough order of importance. Each one of these scores a point for the Features column. - F1: Hash(es) - F2: Modtime - F3: Stream upload - F4: Copy/Move - F5: DirMove - F6: Metadata - F7: MultipartUpload ### Tier The tier is decided after determining these attributes. Some discretion is allowed in tiering as some of these attributes are more important than others. | Attr | T1: Core | T2: Stable | T3: Supported | T4: Experimental | T5: Incubator | |------|----------|------------|---------------|------------------|---------------| | Maintainers | >=2 | >=1 | >=1 | >=0 | >=0 | | API source | Official | Official | Either | Either | Either | | Features (F1-F7) | >=5/7 | >=4/7 | >=3/7 | >=2/7 | N/A | | Integration tests | All Green | All green | Nearly all green | Some Flaky | N/A | | Error handling | Pacer | Pacer | Retries | Retries | N/A | | Data integrity | Hashes, alt, modtime | Hashes or alt | Hash OR modtime | Best-effort | N/A | | Perf baseline | Bench within 2x S3 | Bench doc | Anecdotal OK | Optional | N/A | | Adoption | widely used | often used | some use | N/A | N/A | | Docs completeness | Full | Full | Basic | Minimal | Minimal | | Security | Principle-of-least-privilege | Reasonable scopes | Basic auth | Works | Works | # Global Flags This describes the global flags available to every rclone command split into groups. ## Copy Flags for anything which can copy a file. ``` --check-first Do all the checks before starting transfers -c, --checksum Check for changes with size & checksum (if available, or fallback to size only) --compare-dest stringArray Include additional server-side paths during comparison --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use modtime or checksum -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally --immutable Do not modify files, fail if existing files have been modified --inplace Download directly to destination file instead of atomic download to temp/rename -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --max-backlog int Maximum number of objects in sync or check backlog (default 10000) --max-duration Duration Maximum duration rclone will transfer data for (default 0s) --max-transfer SizeSuffix Maximum size of data to transfer (default off) -M, --metadata If set, preserve metadata when copying objects --modify-window Duration Max time diff to be considered the same (default 1ns) --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) --name-transform stringArray Transform paths during the copy process --no-check-dest Don't check the destination, copy regardless --no-traverse Don't traverse destination file system on copy --no-update-dir-modtime Don't update directory modification times --no-update-modtime Don't update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") --refresh-times Refresh the modtime of remote files --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs --size-only Skip based on size only, not modtime or checksum --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) -u, --update Skip files that are newer on the destination ``` ## Sync Flags used for sync commands. ``` --backup-dir string Make backups into hierarchy based in DIR --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring --delete-during When synchronizing, delete files during transfer --fix-case Force rename of case insensitive dest to match source --ignore-errors Delete even if there are I/O errors --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000) --max-delete int When synchronizing, limit the number of deletes (default -1) --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off) --suffix string Suffix to add to changed files --suffix-keep-extension Preserve the extension when using --suffix --track-renames When synchronizing, track file renames and do a server-side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") ``` ## Important Important flags useful for most commands. ``` -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) ``` ## Check Flags used for check commands. ``` --max-backlog int Maximum number of objects in sync or check backlog (default 10000) ``` ## Networking Flags for general networking and HTTP stuff. ``` --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name --bwlimit BwTimetable Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable --bwlimit-file BwTimetable Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable --ca-cert stringArray CA certificate used to verify servers --client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth --client-pass string Password for client SSL private key (PEM) for mutual TLS auth (obscured) (obscured) --contimeout Duration Connect timeout (default 1m0s) --disable-http-keep-alives Disable HTTP keep-alives and use each connection once --disable-http2 Disable HTTP/2 in the global transport --dscp string Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21 --expect-continue-timeout Duration Timeout when using expect / 100-continue in HTTP (default 1s) --header stringArray Set HTTP header for all transactions --header-download stringArray Set HTTP header for download transactions --header-upload stringArray Set HTTP header for upload transactions --http-proxy string HTTP proxy URL --max-connections int Maximum number of simultaneous backend API connections, 0 for unlimited --no-check-certificate Do not verify the server SSL certificate (insecure) --no-gzip-encoding Don't set Accept-Encoding: gzip --timeout Duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP transactions per second to this --tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --use-cookies Enable session cookiejar --user-agent string Set the user-agent to a specified string (default "rclone/v1.75.0") ``` ## Performance Flags helpful for increasing performance. ``` --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi) --checkers int Number of checkers to run in parallel (default 8) --transfers int Number of file transfers to run in parallel (default 4) ``` ## Config Flags for general configuration of rclone. ``` --ask-password Allow prompt for password for encrypted configuration (default true) --auto-confirm If enabled, do not request console confirmation --cache-dir string Directory rclone will use for caching (default "$HOME/.cache/rclone") --color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO) --config string Config file (default "$HOME/.config/rclone/rclone.conf") --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --disable string Disable a comma separated list of features (use --disable help to see a list) -n, --dry-run Do a trial run with no permanent changes --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts --fs-cache-expire-duration Duration Cache remotes for this long (0 to disable caching) (default 5m0s) --fs-cache-expire-interval Duration Interval to check for expired remotes (default 1m0s) --human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi -i, --interactive Enable interactive mode --kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s) --low-level-retries int Number of low level retries to do (default 10) --max-buffer-memory SizeSuffix If set, don't allocate more than this amount of memory as buffers (default off) --no-console Hide console window (supported on Windows only) --no-unicode-normalization Don't normalize unicode characters in filenames --password-command SpaceSepList Command for supplying password for encrypted configuration --retries int Retry operations this many times if they fail (default 3) --retries-sleep Duration Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s) --temp-dir string Directory rclone will use for temporary files (default "/tmp") --use-mmap Use mmap allocator (see docs) --use-server-modtime Use server modified time instead of object metadata ``` ## Debugging Flags for developers. ``` --cpuprofile string Write cpu profile to file --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl, errors, trace --dump-bodies Dump HTTP headers and bodies - may contain sensitive info --dump-headers Dump HTTP headers - may contain sensitive info --memprofile string Write memory profile to file ``` ## Filter Flags for filtering directory listings. ``` --delete-excluded Delete files on dest excluded from sync --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) --exclude-if-present stringArray Exclude directories if filename is present --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) --files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --hash-filter string Partition filenames by hash k/n or randomly @/n --ignore-case Ignore case in filters (case insensitive) --include stringArray Include files matching pattern --include-from stringArray Read file include patterns from file (use - to read from stdin) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-depth int If set limits the recursion depth to this (default -1) --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off) ``` ## Listing Flags for listing directories. ``` --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) --fast-list Use recursive list if available; uses more memory but fewer transactions ``` ## Logging Flags for logging and statistics. ``` --log-file string Log everything to this file --log-file-compress If set, compress rotated log files using gzip --log-file-max-age Duration Maximum duration to retain old log files (eg "7d") (default 0s) --log-file-max-backups int Maximum number of old log files to retain --log-file-max-size SizeSuffix Maximum size of the log file before it's rotated (eg "10M") (default off) --log-format Bits Comma separated list of log format options (default date,time) --log-level LogLevel Log level DEBUG|INFO|NOTICE|ERROR (default NOTICE) --log-systemd Activate systemd integration for the logger --max-stats-groups int Maximum number of stats groups to keep in memory, on max oldest is discarded (default 1000) -P, --progress Show progress during transfer --progress-terminal-title Show progress on the terminal title (requires -P/--progress) -q, --quiet Print as little stuff as possible --stats Duration Interval between printing stats, e.g. 500ms, 60s, 5m (0 to disable) (default 1m0s) --stats-file-name-length int Max file name length in stats (0 for no limit) (default 45) --stats-log-level LogLevel Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default INFO) --stats-one-line Make the stats fit on one line --stats-one-line-date Enable --stats-one-line and add current date/time prefix --stats-one-line-date-format string Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes ("), see https://golang.org/pkg/time/#Time.Format --stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes") --syslog Use Syslog for logging --syslog-facility string Facility for syslog, e.g. KERN,USER (default "DAEMON") --use-json-log Use json log format -v, --verbose count Print lots more stuff (repeat for more) ``` ## Metadata Flags to control metadata. ``` -M, --metadata If set, preserve metadata when copying objects --metadata-exclude stringArray Exclude metadatas matching pattern --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) --metadata-filter stringArray Add a metadata filtering rule --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) --metadata-include stringArray Include metadatas matching pattern --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) --metadata-mapper SpaceSepList Program to run to transforming metadata before upload --metadata-set stringArray Add metadata key=value when uploading ``` ## RC Flags to control the Remote Control API. ``` --rc Enable the remote control server --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572) --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from --rc-baseurl string Prefix for URLs - leave blank for root --rc-cert string TLS PEM key (concatenation of certificate and CA certificate) --rc-client-ca string Client certificate authority to verify clients with --rc-enable-metrics Enable the Prometheus metrics path at the remote control server --rc-files string Path to local files to serve on the HTTP server --rc-htpasswd string A htpasswd file - if not provided no authentication is done --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s) --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s) --rc-key string TLS PEM Private key --rc-max-header-bytes int Maximum size of request header (default 4096) --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --rc-no-auth Don't require auth for certain methods --rc-pass string Password for authentication --rc-realm string Realm for authentication --rc-response-header stringArray Set HTTP header for all responses, overriding existing values --rc-salt string Password hashing salt (default "dlPL2MqE") --rc-serve Enable the serving of remote objects --rc-serve-no-modtime Don't read the modification time (can speed things up) --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --rc-template string User-specified template --rc-user string User name for authentication --rc-user-from-header string User name from a defined HTTP header --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-no-open-browser Don't open the browser automatically --rc-web-gui-update Check and update to latest version of web gui ``` ## Metrics Flags to control the Metrics HTTP endpoint.. ``` --metrics-addr stringArray IPaddress:Port or :Port to bind server to --metrics-allow-origin string Origin which cross-domain request (CORS) can be executed from --metrics-baseurl string Prefix for URLs - leave blank for root --metrics-cert string TLS PEM key (concatenation of certificate and CA certificate) --metrics-client-ca string Client certificate authority to verify clients with --metrics-htpasswd string A htpasswd file - if not provided no authentication is done --metrics-key string TLS PEM Private key --metrics-max-header-bytes int Maximum size of request header (default 4096) --metrics-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") --metrics-pass string Password for authentication --metrics-realm string Realm for authentication --metrics-response-header stringArray Set HTTP header for all responses, overriding existing values --metrics-salt string Password hashing salt (default "dlPL2MqE") --metrics-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) --metrics-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) --metrics-template string User-specified template --metrics-user string User name for authentication --metrics-user-from-header string User name from a defined HTTP header --rc-enable-metrics Enable the Prometheus metrics path at the remote control server ``` ## Backend Backend-only flags (these can be set in the config file also). ``` --alias-description string Description of the remote --alias-remote string Remote or path to alias --archive-description string Description of the remote --archive-remote string Remote to wrap to read archives from --azureblob-access-tier string Access tier of blob: hot, cool, cold or archive --azureblob-account string Azure Storage Account Name --azureblob-archive-tier-delete Delete archive tier blobs before overwriting --azureblob-chunk-size SizeSuffix Upload chunk size (default 4Mi) --azureblob-client-certificate-password string Password for the certificate file (optional) (obscured) --azureblob-client-certificate-path string Path to a PEM or PKCS12 certificate file including the private key --azureblob-client-id string The ID of the client in use --azureblob-client-secret string One of the service principal's client secrets --azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth --azureblob-connection-string string Storage Connection String --azureblob-copy-concurrency int Concurrency for multipart copy (default 512) --azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi) --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks --azureblob-decompress If set this will decompress gzip encoded objects --azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion --azureblob-description string Description of the remote --azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created --azureblob-disable-checksum Don't store MD5 checksum with object metadata --azureblob-disable-instance-discovery Skip requesting Microsoft Entra instance metadata --azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) --azureblob-endpoint string Endpoint for the service --azureblob-env-auth Read credentials from runtime (environment variables, CLI or MSI) --azureblob-key string Storage Account Shared Key --azureblob-list-chunk int Size of blob list (default 5000) --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any --azureblob-no-check-container If set, don't attempt to check the container exists or create it --azureblob-no-head-object If set, do not do HEAD before GET when getting objects --azureblob-password string The user's password (obscured) --azureblob-public-access string Public access level of a container: blob or container --azureblob-sas-url string SAS URL for container level access only --azureblob-service-principal-file string Path to file containing credentials for use with a service principal --azureblob-tenant string ID of the service principal's tenant. Also called its directory ID --azureblob-upload-concurrency int Concurrency for multipart uploads (default 16) --azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256 MiB) (deprecated) --azureblob-use-az Use Azure CLI tool az for authentication --azureblob-use-copy-blob Whether to use the Copy Blob API when copying to the same storage account (default true) --azureblob-use-emulator Uses local storage emulator if provided as 'true' --azureblob-use-msi Use a managed service identity to authenticate (only works in Azure) --azureblob-username string User name (usually an email address) --azurefiles-account string Azure Storage Account Name --azurefiles-chunk-size SizeSuffix Upload chunk size (default 4Mi) --azurefiles-client-certificate-password string Password for the certificate file (optional) (obscured) --azurefiles-client-certificate-path string Path to a PEM or PKCS12 certificate file including the private key --azurefiles-client-id string The ID of the client in use --azurefiles-client-secret string One of the service principal's client secrets --azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth --azurefiles-connection-string string Storage Connection String --azurefiles-description string Description of the remote --azurefiles-disable-instance-discovery Skip requesting Microsoft Entra instance metadata --azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot) --azurefiles-endpoint string Endpoint for the service --azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI) --azurefiles-key string Storage Account Shared Key --azurefiles-max-stream-size SizeSuffix Max size for streamed files (default 10Gi) --azurefiles-msi-client-id string Object ID of the user-assigned MSI to use, if any --azurefiles-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any --azurefiles-msi-object-id string Object ID of the user-assigned MSI to use, if any --azurefiles-password string The user's password (obscured) --azurefiles-sas-url string SAS URL for container level access only --azurefiles-service-principal-file string Path to file containing credentials for use with a service principal --azurefiles-share-name string Azure Files Share Name --azurefiles-tenant string ID of the service principal's tenant. Also called its directory ID --azurefiles-upload-concurrency int Concurrency for multipart uploads (default 16) --azurefiles-use-az Use Azure CLI tool az for authentication --azurefiles-use-emulator Uses local storage emulator if provided as 'true' --azurefiles-use-msi Use a managed service identity to authenticate (only works in Azure) --azurefiles-username string User name (usually an email address) --b2-account string Account ID or Application Key ID --b2-chunk-size SizeSuffix Upload chunk size (default 96Mi) --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi) --b2-description string Description of the remote --b2-disable-checksum Disable checksums for large (> upload cutoff) files --b2-download-auth-duration Duration Time before the public link authorization token will expire in s or suffix ms|s|m|h|d (default 1w) --b2-download-url string Custom endpoint for downloads --b2-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --b2-endpoint string Endpoint for the service --b2-hard-delete Permanently delete files on remote removal, otherwise hide files --b2-key string Application Key --b2-lifecycle int Set the number of days deleted files should be kept when creating a bucket --b2-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in B2 --b2-sse-customer-key string To use SSE-C, you may provide the secret encryption key encoded in a UTF-8 compatible string to encrypt/decrypt your data --b2-sse-customer-key-base64 string To use SSE-C, you may provide the secret encryption key encoded in Base64 format to encrypt/decrypt your data --b2-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional) --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging --b2-upload-concurrency int Concurrency for multipart uploads (default 4) --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --b2-version-at Time Show file versions as they were at the specified time (default off) --b2-versions Include old versions in directory listings --box-access-token string Box App Primary Access Token --box-auth-url string Auth server URL --box-box-config-file string Box App config.json location --box-box-sub-type string (default "user") --box-client-credentials Use client credentials OAuth flow --box-client-id string OAuth Client Id --box-client-secret string OAuth Client Secret --box-commit-retries int Max number of times to try committing a multipart file (default 100) --box-description string Description of the remote --box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) --box-impersonate string Impersonate this user ID when using a service account --box-list-chunk int Size of listing chunk 1-1000 (default 1000) --box-owned-by string Only show items owned by the login (email address) passed in --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point --box-token string OAuth Access Token as a JSON blob --box-token-url string Token server url --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50 MiB) (default 50Mi) --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage (default 1m0s) --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming --cache-chunk-path string Directory to cache chunk files (default "$HOME/.cache/rclone/cache-backend") --cache-chunk-size SizeSuffix The size of a chunk (partial file data) (default 5Mi) --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk (default 10Gi) --cache-db-path string Directory to store file structure metadata DB (default "$HOME/.cache/rclone/cache-backend") --cache-db-purge Clear all the cached data for this remote on start --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) --cache-description string Description of the remote --cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s) --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server --cache-plex-password string The password of the Plex user (obscured) --cache-plex-url string The URL of the Plex server --cache-plex-username string The username of the Plex user --cache-read-retries int How many times to retry a read from a cache storage (default 10) --cache-remote string Remote to cache --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) --cache-workers int How many workers should run in parallel to download chunks (default 4) --cache-writes Cache file data on writes through the FS --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi) --chunker-description string Description of the remote --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks --chunker-hash-type string Choose how chunker handles hash sums (default "md5") --chunker-remote string Remote to chunk/unchunk --cloudinary-adjust-media-files-extensions Cloudinary handles media formats as a file attribute and strips it from the name, which is unlike most other file systems (default true) --cloudinary-api-key string Cloudinary API Key --cloudinary-api-secret string Cloudinary API Secret --cloudinary-cloud-name string Cloudinary Environment Name --cloudinary-description string Description of the remote --cloudinary-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) --cloudinary-eventually-consistent-delay Duration Wait N seconds for eventual consistency of the databases that support the backend operation (default 0s) --cloudinary-media-extensions stringArray Cloudinary supported media extensions (default 3ds,3g2,3gp,ai,arw,avi,avif,bmp,bw,cr2,cr3,djvu,dng,eps3,fbx,flif,flv,gif,glb,gltf,hdp,heic,heif,ico,indd,jp2,jpe,jpeg,jpg,jxl,jxr,m2ts,mov,mp4,mpeg,mts,mxf,obj,ogv,pdf,ply,png,psd,svg,tga,tif,tiff,ts,u3ma,usdz,wdp,webm,webp,wmv) --cloudinary-upload-prefix string Specify the API endpoint for environments out of the US --cloudinary-upload-preset string Upload Preset to select asset manipulation on upload --combine-description string Description of the remote --combine-upstreams SpaceSepList Upstreams for combining --compress-description string Description of the remote --compress-level string GZIP (levels -2 to 9): --compress-mode string Compression mode (default "gzip") --compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size (default 20Mi) --compress-remote string Remote to compress -L, --copy-links Follow symlinks and copy the pointed to item --crypt-description string Description of the remote --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true) --crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32") --crypt-filename-encryption string How to encrypt the filenames (default "standard") --crypt-no-data-encryption Option to either encrypt file data or leave it unencrypted --crypt-pass-bad-blocks If set this will pass bad blocks through as all 0 --crypt-password string Password or pass phrase for encryption (obscured) --crypt-password2 string Password or pass phrase for salt (obscured) --crypt-remote string Remote to encrypt/decrypt --crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead --crypt-show-mapping For all files listed show how the names encrypt --crypt-strict-names If set, this will raise an error when crypt comes across a filename that can't be decrypted --crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin") --doi-description string Description of the remote --doi-doi string The DOI or the doi.org URL --doi-doi-resolver-api-url string The URL of the DOI resolver API to use --doi-provider string DOI provider --drime-access-token string API Access token --drime-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi) --drime-description string Description of the remote --drime-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --drime-hard-delete Delete files permanently rather than putting them into the trash --drime-list-chunk int Number of items to list in each call (default 1000) --drime-root-folder-id string ID of the root folder --drime-upload-concurrency int Concurrency for multipart uploads and copies (default 4) --drime-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 5Mi) --drime-workspace-id string Account ID --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded --drive-allow-import-name-change Allow the filetype to change when uploading Google docs --drive-auth-owner-only Only consider files owned by the authenticated user --drive-auth-url string Auth server URL --drive-chunk-size SizeSuffix Upload chunk size (default 8Mi) --drive-client-credentials Use client credentials OAuth flow --drive-client-id string Google Application Client Id --drive-client-secret string Google Application Client Secret --drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut --drive-description string Description of the remote --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding Encoding The encoding for the backend (default InvalidUtf8) --drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars) --drive-export-formats string Comma separated list of preferred formats for downloading Google docs (default "docx,xlsx,pptx,svg") --drive-fast-list-bug-fix Work around a bug in Google Drive listing (default true) --drive-formats string Deprecated: See export_formats --drive-impersonate string Impersonate this user when using a service account --drive-import-formats string Comma separated list of preferred formats for uploading Google docs --drive-keep-revision-forever Keep new head revision of each file forever --drive-list-chunk int Size of listing chunk 100-1000, 0 to disable (default 1000) --drive-metadata-enforce-expansive-access Whether the request should enforce expansive access rules --drive-metadata-labels Bits Control whether labels should be read or written in metadata (default off) --drive-metadata-owner Bits Control whether owner should be read or written in metadata (default read) --drive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off) --drive-pacer-burst int Number of API calls to allow without sleeping (default 100) --drive-pacer-min-sleep Duration Minimum time to sleep between API calls (default 100ms) --drive-resource-key string Resource key for accessing a link-shared file --drive-root-folder-id string ID of the root folder --drive-scope string Comma separated list of scopes that rclone should use when requesting access from drive --drive-server-side-across-configs Deprecated: use --server-side-across-configs instead --drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-file string Service Account Credentials JSON file path --drive-shared-with-me Only show files that are shared with me --drive-show-all-gdocs Show all Google Docs including non-exportable ones in listings --drive-size-as-quota Show sizes as storage quota usage, not actual size --drive-skip-checksum-gphotos Skip checksums on Google photos and videos only --drive-skip-dangling-shortcuts If set skip dangling shortcut files --drive-skip-gdocs Skip google documents in all listings --drive-skip-shortcuts If set skip shortcut files --drive-starred-only Only show files that are starred --drive-stop-on-download-limit Make download limit errors be fatal --drive-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Shared Drive (Team Drive) --drive-token string OAuth Access Token as a JSON blob --drive-token-url string Token server url --drive-trashed-only Only show files that are in the trash --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8Mi) --drive-use-created-date Use file created date instead of modified date --drive-use-shared-date Use date file was shared instead of modified date --drive-use-trash Send files to the trash instead of deleting permanently (default true) --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download (default off) --dropbox-auth-url string Auth server URL --dropbox-batch-mode string Upload file batching sync|async|off (default "sync") --dropbox-batch-size int Max number of files in upload batch --dropbox-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s) --dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi) --dropbox-client-credentials Use client credentials OAuth flow --dropbox-client-id string OAuth Client Id --dropbox-client-secret string OAuth Client Secret --dropbox-description string Description of the remote --dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-export-formats CommaSepList Comma separated list of preferred formats for exporting files (default html,md) --dropbox-impersonate string Impersonate this user when using a business account --dropbox-impersonate-admin string Team admin ID to use when performing actions as a team administrator --dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms) --dropbox-root-namespace string Specify a different Dropbox namespace ID to use as the root for all paths --dropbox-shared-files Instructs rclone to work on individual shared files --dropbox-shared-folders Instructs rclone to work on shared folders --dropbox-show-all-exports Show all exportable files in listings --dropbox-skip-exports Skip exportable files in all listings --dropbox-skip-shared-folders Instructs rclone to skip all shared folders --dropbox-skip-unowned-folders Instructs rclone to skip shared folders not owned by the current user --dropbox-token string OAuth Access Token as a JSON blob --dropbox-token-url string Token server url --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-cdn Set if you wish to use CDN download links --fichier-description string Description of the remote --fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured) --fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured) --fichier-shared-folder string If you want to download a shared folder, add this parameter --filefabric-description string Description of the remote --filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot) --filefabric-permanent-token string Permanent Authentication Token --filefabric-root-folder-id string ID of the root folder --filefabric-token string Session Token --filefabric-token-expiry string Token expiry time --filefabric-url string URL of the Enterprise File Fabric to connect to --filefabric-version string Version read from the file fabric --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi) --filelu-description string Description of the remote --filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation) --filelu-key string Your FileLu Rclone key from My Account --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi) --filen-api-key string API Key for your Filen account (obscured) --filen-auth-version string Authentication Version (internal use only) --filen-base-folder-uuid string UUID of Account Root Directory (internal use only) --filen-description string Description of the remote --filen-email string Email of your Filen account --filen-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot) --filen-master-keys string Master Keys (internal use only) --filen-password string Password of your Filen account (obscured) --filen-private-key string Private RSA Key (internal use only) --filen-public-key string Public RSA Key (internal use only) --filen-upload-concurrency int Concurrency for chunked uploads (default 16) --filescom-api-key string The API key used to authenticate with Files.com --filescom-description string Description of the remote --filescom-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) --filescom-password string The password used to authenticate with Files.com (obscured) --filescom-site string Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com) --filescom-username string The username used to authenticate with Files.com --ftp-allow-insecure-tls-ciphers Allow insecure TLS ciphers --ftp-ask-password Allow asking for FTP password when needed --ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s) --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-description string Description of the remote --ftp-disable-epsv Disable using EPSV even if server advertises support --ftp-disable-mlsd Disable using MLSD even if server advertises support --ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS) --ftp-disable-utf8 Disable using UTF-8 even if server advertises support --ftp-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,RightSpace,Dot) --ftp-explicit-tls Use Explicit FTPS (FTP over TLS) --ftp-force-list-hidden Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD --ftp-host string FTP host to connect to --ftp-http-proxy string URL for HTTP CONNECT proxy --ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s) --ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-no-check-upload Don't check the upload is OK --ftp-pass string FTP password (obscured) --ftp-port int FTP port number (default 21) --ftp-shut-timeout Duration Maximum time to wait for data connection closing status (default 1m0s) --ftp-socks-proxy string Socks 5 proxy host --ftp-tls Use Implicit FTPS (FTP over TLS) --ftp-tls-cache-size int Size of TLS session cache for all control and data connections (default 32) --ftp-user string FTP username (default "$USER") --ftp-writing-mdtm Use MDTM to set modification time (VsFtpd quirk) --gcs-access-token string Short-lived access token --gcs-anonymous Access public buckets and objects without credentials --gcs-auth-url string Auth server URL --gcs-bucket-acl string Access Control List for new buckets --gcs-bucket-policy-only Access checks should use bucket-level IAM policies --gcs-client-credentials Use client credentials OAuth flow --gcs-client-id string OAuth Client Id --gcs-client-secret string OAuth Client Secret --gcs-decompress If set this will decompress gzip encoded objects --gcs-description string Description of the remote --gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created --gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot) --gcs-endpoint string Custom endpoint for the storage API. Leave blank to use the provider default --gcs-env-auth Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars) --gcs-location string Location for the newly created buckets --gcs-no-check-bucket If set, don't attempt to check the bucket exists or create it --gcs-object-acl string Access Control List for new objects --gcs-project-number string Project number --gcs-service-account-file string Service Account Credentials JSON file path --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage --gcs-token string OAuth Access Token as a JSON blob --gcs-token-url string Token server url --gcs-user-project string User project --gofile-access-token string API Access token --gofile-account-id string Account ID --gofile-description string Description of the remote --gofile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation) --gofile-list-chunk int Number of items to list in each call (default 1000) --gofile-root-folder-id string ID of the root folder --gphotos-auth-url string Auth server URL --gphotos-batch-mode string Upload file batching sync|async|off (default "sync") --gphotos-batch-size int Max number of files in upload batch --gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s) --gphotos-client-credentials Use client credentials OAuth flow --gphotos-client-id string OAuth Client Id --gphotos-client-secret string OAuth Client Secret --gphotos-description string Description of the remote --gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot) --gphotos-include-archived Also view and download archived media --gphotos-proxy string Use the gphotosdl proxy for downloading the full resolution images --gphotos-read-only Set to make the Google Photos backend read only --gphotos-read-size Set to read the size of media items --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) --gphotos-token string OAuth Access Token as a JSON blob --gphotos-token-url string Token server url --hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default) --hasher-description string Description of the remote --hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1) --hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off) --hasher-remote string Remote to cache checksums for (e.g. myRemote:path) --hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy --hdfs-description string Description of the remote --hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) --hdfs-namenode CommaSepList Hadoop name nodes and ports --hdfs-service-principal-name string Kerberos service principal name for the namenode --hdfs-username string Hadoop user name --hidrive-auth-url string Auth server URL --hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi) --hidrive-client-credentials Use client credentials OAuth flow --hidrive-client-id string OAuth Client Id --hidrive-client-secret string OAuth Client Secret --hidrive-description string Description of the remote --hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary --hidrive-encoding Encoding The encoding for the backend (default Slash,Dot) --hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1") --hidrive-root-prefix string The root/parent folder for all paths (default "/") --hidrive-scope-access string Access permissions that rclone should use when requesting access from HiDrive (default "rw") --hidrive-scope-role string User-level that rclone should use when requesting access from HiDrive (default "user") --hidrive-token string OAuth Access Token as a JSON blob --hidrive-token-url string Token server url --hidrive-upload-concurrency int Concurrency for chunked uploads (default 4) --hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi) --http-description string Description of the remote --http-headers CommaSepList Set HTTP headers for all transactions --http-no-escape Do not escape URL metacharacters in path names --http-no-head Don't use HEAD requests --http-no-slash Set this if the site doesn't end directories with / --http-url string URL of HTTP host to connect to --huaweidrive-auth-url string Auth server URL --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi) --huaweidrive-client-credentials Use client credentials OAuth flow --huaweidrive-client-id string OAuth Client Id --huaweidrive-client-secret string OAuth Client Secret --huaweidrive-description string Description of the remote --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000) --huaweidrive-root-folder-id string ID of the root folder --huaweidrive-token string OAuth Access Token as a JSON blob --huaweidrive-token-url string Token server url --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi) --iclouddrive-apple-id string Apple ID --iclouddrive-client-id string Client ID for iCloud API access (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d") --iclouddrive-description string Description of the remote --iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --iclouddrive-password string Password (obscured) --iclouddrive-service string iCloud service to use (default "drive") --imagekit-description string Description of the remote --imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket) --imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) --imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true --imagekit-private-key string You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) --imagekit-public-key string You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) --imagekit-upload-tags string Tags to add to the uploaded files, e.g. "tag1,tag2" --imagekit-versions Include old versions in directory listings --internetarchive-access-key-id string IAS3 Access Key --internetarchive-description string Description of the remote --internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true) --internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot) --internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org") --internetarchive-front-endpoint string Host of InternetArchive Frontend (default "https://archive.org") --internetarchive-item-derive Whether to trigger derive on the IA item or not. If set to false, the item will not be derived by IA upon upload (default true) --internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set --internetarchive-secret-access-key string IAS3 Secret Key (password) --internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s) --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi) --internxt-description string Description of the remote --internxt-email string Email of your Internxt account --internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot) --internxt-pass string Password (obscured) --internxt-skip-hash-validation Skip hash validation when downloading files (default true) --internxt-upload-concurrency int Concurrency for multipart uploads (default 4) --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi) --jottacloud-auth-url string Auth server URL --jottacloud-client-credentials Use client credentials OAuth flow --jottacloud-client-id string OAuth Client Id --jottacloud-client-secret string OAuth Client Secret --jottacloud-description string Description of the remote --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot) --jottacloud-hard-delete Delete files permanently rather than putting them into the trash --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi) --jottacloud-no-versions Avoid server side versioning by deleting files and recreating files instead of overwriting them --jottacloud-token string OAuth Access Token as a JSON blob --jottacloud-token-url string Token server url --jottacloud-trashed-only Only show files that are in the trash --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's (default 10Mi) --koofr-description string Description of the remote --koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --koofr-endpoint string The Koofr API endpoint to use --koofr-mountid string Mount ID of the mount to use --koofr-password string Your password for rclone generate one at https://app.koofr.net/app/admin/preferences/password (obscured) --koofr-provider string Choose your storage provider --koofr-setmtime Does the backend support setting modification time (default true) --koofr-user string Your user name --linkbox-description string Description of the remote --linkbox-email string Email for login --linkbox-password string Password for login (obscured) --linkbox-token string Token from https://www.linkbox.to/admin/account --local-case-insensitive Force the filesystem to report itself as case insensitive --local-case-sensitive Force the filesystem to report itself as case sensitive --local-description string Description of the remote --local-encoding Encoding The encoding for the backend (default Slash,Dot) --local-fatal-if-no-space Make out-of-space errors fatal during transfers --local-hashes CommaSepList Comma separated list of supported checksum types --local-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend --local-metadata-restore-special-bits Restore the setuid, setgid and sticky bits from metadata --local-no-check-updated Don't check to see if the files change during upload --local-no-clone Disable reflink cloning for server-side copies --local-no-preallocate Disable preallocation of disk space for transferred files --local-no-set-modtime Disable setting modtime --local-no-sparse Disable sparse files for multi-thread downloads --local-nounc Disable UNC (long path names) conversion on Windows --local-time-type mtime|atime|btime|ctime Set what kind of time is returned (default mtime) --local-unicode-normalization Apply unicode NFC normalization to paths and filenames --local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated) --mailru-auth-url string Auth server URL --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-client-credentials Use client credentials OAuth flow --mailru-client-id string OAuth Client Id --mailru-client-secret string OAuth Client Secret --mailru-description string Description of the remote --mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) --mailru-pass string Password (obscured) --mailru-speedup-enable Skip full upload if there is another file with same data hash (default true) --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash) (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf") --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3Gi) --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk (default 32Mi) --mailru-token string OAuth Access Token as a JSON blob --mailru-token-url string Token server url --mailru-user string User name (usually email) --mega-2fa string The 2FA code of your MEGA account if the account is set up with one --mega-debug Output more debug from Mega --mega-description string Description of the remote --mega-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) --mega-hard-delete Delete files permanently rather than putting them into the trash --mega-pass string Password (obscured) --mega-use-https Use HTTPS for transfers --mega-user string User name --memory-description string Description of the remote --memory-discard If set all writes will be discarded and reads will return an error --netstorage-account string Set the NetStorage account name --netstorage-description string Description of the remote --netstorage-host string Domain+path of NetStorage host to connect to --netstorage-protocol string Select between HTTP or HTTPS protocol (default "https") --netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured) -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only) --onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access) --onedrive-auth-url string Auth server URL --onedrive-av-override Allows download of files the server thinks has a virus --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi) --onedrive-client-credentials Use client credentials OAuth flow --onedrive-client-id string OAuth Client Id --onedrive-client-secret string OAuth Client Secret --onedrive-delta If set rclone will use delta listing to implement recursive listings --onedrive-description string Description of the remote --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive (personal | business | documentLibrary) --onedrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings --onedrive-hard-delete Permanently delete files on removal --onedrive-hash-type string Specify the hash in use for the backend (default "auto") --onedrive-link-password string Set the password for links created by the link command --onedrive-link-scope string Set the scope of the links created by the link command (default "anonymous") --onedrive-link-type string Set the type of the links created by the link command (default "view") --onedrive-list-chunk int Size of listing chunk (default 1000) --onedrive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off) --onedrive-no-versions Remove all versions on modifying operations --onedrive-region string Choose national cloud region for OneDrive (default "global") --onedrive-root-folder-id string ID of the root folder --onedrive-server-side-across-configs Deprecated: use --server-side-across-configs instead --onedrive-tenant string ID of the service principal's tenant. Also called its directory ID --onedrive-tenant-url string The tenant URL for non-admin OneDrive access --onedrive-token string OAuth Access Token as a JSON blob --onedrive-token-url string Token server url --onedrive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default off) --oos-attempt-resume-upload If true attempt to resume previously started multipart upload for the object --oos-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi) --oos-compartment string Specify compartment OCID, if you need to list buckets --oos-config-file string Path to OCI config file (default "~/.oci/config") --oos-config-profile string Profile name inside the oci config file (default "Default") --oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi) --oos-copy-timeout Duration Timeout for copy (default 1m0s) --oos-decompress If set this will decompress gzip encoded objects --oos-description string Description of the remote --oos-disable-checksum Don't store MD5 checksum with object metadata --oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) --oos-endpoint string Endpoint for Object storage API --oos-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery --oos-max-upload-parts int Maximum number of parts in a multipart upload (default 10000) --oos-namespace string Object storage namespace --oos-no-check-bucket If set, don't attempt to check the bucket exists or create it --oos-provider string Choose your Auth Provider (default "env_auth") --oos-region string Object storage Region --oos-sse-customer-algorithm string If using SSE-C, the optional header that specifies "AES256" as the encryption algorithm --oos-sse-customer-key string To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to --oos-sse-customer-key-file string To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated --oos-sse-customer-key-sha256 string If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption --oos-sse-kms-key-id string if using your own master key in vault, this header specifies the --oos-storage-tier string The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm (default "Standard") --oos-upload-concurrency int Concurrency for multipart uploads (default 10) --oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --opendrive-access string Files and folders will be uploaded with this access permission (default private) (default "private") --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi) --opendrive-description string Description of the remote --opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) --opendrive-password string Password (obscured) --opendrive-username string Username --pcloud-auth-url string Auth server URL --pcloud-client-credentials Use client credentials OAuth flow --pcloud-client-id string OAuth Client Id --pcloud-client-secret string OAuth Client Secret --pcloud-description string Description of the remote --pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --pcloud-hostname string Hostname to connect to (default "api.pcloud.com") --pcloud-password string Your pcloud password (obscured) --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point (default "d0") --pcloud-token string OAuth Access Token as a JSON blob --pcloud-token-url string Token server url --pcloud-username string Your pcloud username --pikpak-chunk-size SizeSuffix Chunk size for multipart uploads (default 5Mi) --pikpak-description string Description of the remote --pikpak-device-id string Device ID used for authorization --pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot) --pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi) --pikpak-no-media-link Use original file links instead of media links --pikpak-pass string Pikpak password (obscured) --pikpak-root-folder-id string ID of the root folder --pikpak-trashed-only Only show files that are in the trash --pikpak-upload-concurrency int Concurrency for multipart uploads (default 4) --pikpak-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --pikpak-use-trash Send files to the trash instead of deleting permanently (default true) --pikpak-user string Pikpak username --pikpak-user-agent string HTTP user agent for pikpak (default "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0") --pixeldrain-api-key string API key for your pixeldrain account --pixeldrain-api-url string The API endpoint to connect to. In the vast majority of cases it's fine to leave (default "https://pixeldrain.com/api") --pixeldrain-description string Description of the remote --pixeldrain-root-folder-id string Root of the filesystem to use (default "me") --premiumizeme-auth-url string Auth server URL --premiumizeme-client-credentials Use client credentials OAuth flow --premiumizeme-client-id string OAuth Client Id --premiumizeme-client-secret string OAuth Client Secret --premiumizeme-description string Description of the remote --premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) --premiumizeme-token string OAuth Access Token as a JSON blob --premiumizeme-token-url string Token server url --protondrive-2fa string The 2FA code --protondrive-app-version string The app version string --protondrive-description string Description of the remote --protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true) --protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot) --protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured) --protondrive-original-file-size Return the file size before encryption (default true) --protondrive-otp-secret-key string The OTP secret key (obscured) --protondrive-password string The password of your proton account (obscured) --protondrive-replace-existing-draft Create a new revision when filename conflict is detected --protondrive-username string The username of your proton account --putio-auth-url string Auth server URL --putio-client-credentials Use client credentials OAuth flow --putio-client-id string OAuth Client Id --putio-client-secret string OAuth Client Secret --putio-description string Description of the remote --putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --putio-token string OAuth Access Token as a JSON blob --putio-token-url string Token server url --qingstor-access-key-id string QingStor Access Key ID --qingstor-chunk-size SizeSuffix Chunk size to use for uploading (default 4Mi) --qingstor-connection-retries int Number of connection retries (default 3) --qingstor-description string Description of the remote --qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8) --qingstor-endpoint string Enter an endpoint URL to connection QingStor API --qingstor-env-auth Get QingStor credentials from runtime --qingstor-secret-access-key string QingStor Secret Access Key (password) --qingstor-upload-concurrency int Concurrency for multipart uploads (default 1) --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --qingstor-zone string Zone to connect to --quatrix-api-key string API key for accessing Quatrix account --quatrix-description string Description of the remote --quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s") --quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --quatrix-hard-delete Delete files permanently rather than putting them into the trash --quatrix-host string Host name of Quatrix account --quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi) --quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi) --quatrix-skip-project-folders Skip project folders in operations --s3-access-key-id string AWS Access Key ID --s3-acl string Canned ACL used when creating buckets and storing or copying objects --s3-bucket-acl string Canned ACL used when creating buckets --s3-bucket-object-lock-enabled Enable Object Lock when creating new buckets --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode --s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi) --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi) --s3-decompress If set this will decompress gzip encoded objects --s3-description string Description of the remote --s3-directory-bucket Set to use AWS Directory Buckets --s3-directory-markers Upload an empty object with a trailing slash when a new directory is created --s3-disable-checksum Don't store MD5 checksum with object metadata --s3-disable-http2 Disable usage of http2 for S3 backends --s3-download-url string Custom endpoint for downloads --s3-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) --s3-endpoint string Endpoint for S3 API --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars) --s3-force-path-style If true use path style access if false use virtual hosted style (default true) --s3-ibm-api-key string IBM API Key to be used to obtain IAM token --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication --s3-ibm-resource-instance-id string IBM service instance id --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request) (default 1000) --s3-list-url-encode Tristate Whether to url encode listings: true/false/unset (default unset) --s3-list-version int Version of ListObjects to use: 1,2 or 0 for auto --s3-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset) --s3-location-constraint string Location constraint - must be set to match the Region --s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000) --s3-might-gzip Tristate Set this if the backend might gzip objects (default unset) --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it --s3-no-head If set, don't HEAD uploaded objects to check integrity --s3-no-head-object If set, do not do HEAD before GET when getting objects --s3-no-system-metadata Suppress setting and reading of system metadata --s3-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset) --s3-profile string Profile to use in the shared credentials file --s3-provider string Choose your S3 provider --s3-region string Region to connect to --s3-requester-pays Enables requester pays option when interacting with S3 bucket --s3-role-arn string ARN of the IAM role to assume --s3-role-external-id string External ID for assumed role --s3-role-session-duration string Session duration for assumed role --s3-role-session-name string Session name for assumed role --s3-sdk-log-mode Bits Set to debug the SDK (default Off) --s3-secret-access-key string AWS Secret Access Key (password) --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3 --s3-session-token string An AWS session token --s3-shared-credentials-file string Path to the shared credentials file --s3-sign-accept-encoding Tristate Set if rclone should include Accept-Encoding as part of the signature (default unset) --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3 --s3-sse-customer-key string To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data --s3-sse-customer-key-base64 string If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data --s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional) --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key --s3-storage-class string The storage class to use when storing new objects in S3 --s3-upload-concurrency int Concurrency for multipart uploads and copies (default 4) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint --s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset) --s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset) --s3-use-arn-region If true, enables arn region support for the service --s3-use-data-integrity-protections Tristate If true use AWS S3 data integrity protections (default unset) --s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support) --s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset) --s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset) --s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads --s3-use-unsigned-payload Tristate Whether to use an unsigned payload in PutObject (default unset) --s3-use-x-id Tristate Set if rclone should add x-id URL parameters (default unset) --s3-v2-auth If true use v2 authentication --s3-version-at Time Show file versions as they were at the specified time (default off) --s3-version-deleted Show deleted file markers when using versions --s3-versions Include old versions in directory listings --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) --seafile-create-library Should rclone create a library if it doesn't exist --seafile-description string Description of the remote --seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8,Dot) --seafile-library string Name of the library --seafile-library-key string Library password (for encrypted libraries only) (obscured) --seafile-pass string Password (obscured) --seafile-url string URL of seafile host to connect to --seafile-user string User name (usually email address) --sftp-ask-password Allow asking for SFTP password when needed --sftp-blake3sum-command string The command used to read BLAKE3 hashes --sftp-chunk-size SizeSuffix Upload and download chunk size (default 32Ki) --sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference --sftp-concurrency int The maximum number of outstanding requests for one file (default 64) --sftp-connections int Maximum number of SFTP simultaneous connections, 0 for unlimited --sftp-copy-is-hardlink Set to enable server side copies using hardlinks --sftp-crc32sum-command string The command used to read CRC-32 hashes --sftp-description string Description of the remote --sftp-disable-concurrent-reads If set don't use concurrent reads --sftp-disable-concurrent-writes If set don't use concurrent writes --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available --sftp-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,Dot) --sftp-hashes CommaSepList Comma separated list of supported checksum types --sftp-host string SSH host to connect to --sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference --sftp-host-keys CommaSepList Pinned host keys for this remote, used to verify the server --sftp-http-proxy string URL for HTTP CONNECT proxy --sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s) --sftp-key-exchange SpaceSepList Space separated list of key exchange algorithms, ordered by preference --sftp-key-file string Path to PEM-encoded private key file --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file (obscured) --sftp-key-pem string Raw PEM-encoded private key --sftp-key-use-agent When set forces the usage of the ssh-agent --sftp-known-hosts-file string Optional path to known_hosts file --sftp-macs SpaceSepList Space separated list of MACs (message authentication code) algorithms, ordered by preference --sftp-md5sum-command string The command used to read MD5 hashes --sftp-pass string SSH password, leave blank to use ssh-agent (obscured) --sftp-path-override string Override path used by SSH shell commands --sftp-pin-host-key Pin the server host key on first connection (Trust On First Use) --sftp-port int SSH port number (default 22) --sftp-pubkey string SSH public certificate for public certificate based authentication --sftp-pubkey-file string Optional path to public key file --sftp-server-command string Specifies the path or command to run a sftp server on the remote host --sftp-set-env SpaceSepList Environment variables to pass to sftp and commands --sftp-set-modtime Set the modified time on the remote if set (default true) --sftp-sha1sum-command string The command used to read SHA-1 hashes --sftp-sha256sum-command string The command used to read SHA-256 hashes --sftp-shell-type string The type of SSH shell on remote server, if any --sftp-skip-links Set to skip any symlinks and any other non regular files --sftp-socks-proxy string Socks 5 proxy host --sftp-ssh SpaceSepList Path and arguments to external ssh binary --sftp-subsystem string Specifies the SSH2 subsystem on the remote host (default "sftp") --sftp-use-fstat If set use fstat instead of stat --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods --sftp-user string SSH username (default "$USER") --sftp-xxh128sum-command string The command used to read XXH128 hashes --sftp-xxh3sum-command string The command used to read XXH3 hashes --shade-api-key string An API key for your account --shade-chunk-size SizeSuffix Chunk size to use for uploading (default 64Mi) --shade-description string Description of the remote --shade-drive-id string The ID of your drive, see this in the drive settings. Individual rclone configs must be made per drive --shade-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --shade-endpoint string Endpoint for the service --shade-max-upload-parts int Maximum amount of parts in a multipart upload (default 10000) --shade-token string JWT Token for performing Shade FS operations. Don't set this value - rclone will set it automatically --shade-token-expiry string JWT Token Expiration time. Don't set this value - rclone will set it automatically --shade-upload-concurrency int Concurrency for multipart uploads and copies. This is the number of chunks of the same file that are uploaded concurrently for multipart uploads and copies (default 4) --sharefile-auth-url string Auth server URL --sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi) --sharefile-client-credentials Use client credentials OAuth flow --sharefile-client-id string OAuth Client Id --sharefile-client-secret string OAuth Client Secret --sharefile-description string Description of the remote --sharefile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) --sharefile-endpoint string Endpoint for API calls --sharefile-root-folder-id string ID of the root folder --sharefile-token string OAuth Access Token as a JSON blob --sharefile-token-url string Token server url --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi) --sia-api-password string Sia Daemon API Password (obscured) --sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980") --sia-description string Description of the remote --sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot) --sia-user-agent string Siad User Agent (default "Sia-Agent") --skip-links Don't warn about skipped symlinks --skip-specials Don't warn about skipped pipes, sockets and device objects --smb-case-insensitive Whether the server is configured to be case-insensitive (default true) --smb-description string Description of the remote --smb-domain string Domain name for NTLM authentication (default "WORKGROUP") --smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot) --smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true) --smb-host string SMB server hostname to connect to --smb-idle-timeout Duration Max time before closing idle connections (default 1m0s) --smb-kerberos-ccache string Path to the Kerberos credential cache (krb5cc) --smb-pass string SMB password (obscured) --smb-port int SMB port number (default 445) --smb-spn string Service principal name --smb-use-kerberos Use Kerberos authentication --smb-user string SMB username (default "$USER") --storj-access-grant string Access grant --storj-api-key string API key --storj-description string Description of the remote --storj-passphrase string Encryption passphrase --storj-provider string Choose an authentication method (default "existing") --storj-satellite-address string Satellite address (default "us1.storj.io") --sugarsync-access-key-id string Sugarsync Access Key ID --sugarsync-app-id string Sugarsync App ID --sugarsync-authorization string Sugarsync authorization --sugarsync-authorization-expiry string Sugarsync authorization expiry --sugarsync-deleted-id string Sugarsync deleted folder id --sugarsync-description string Description of the remote --sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot) --sugarsync-hard-delete Permanently delete files if true --sugarsync-private-access-key string Sugarsync Private Access Key --sugarsync-refresh-token string Sugarsync refresh token --sugarsync-root-id string Sugarsync root id --sugarsync-user string Sugarsync user --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) --swift-auth string Authentication URL for server (OS_AUTH_URL) --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) --swift-chunk-size SizeSuffix Above this size files will be chunked (default 5Gi) --swift-description string Description of the remote --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) --swift-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8) --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") --swift-env-auth Get swift credentials from environment variables in standard OpenStack form --swift-fetch-until-empty-page When paginating, always fetch unless we received an empty page --swift-key string API key or password (OS_PASSWORD) --swift-leave-parts-on-error If true avoid calling abort upload on a failure --swift-no-chunk Don't chunk files during streaming upload --swift-no-large-objects Disable support for static and dynamic large objects --swift-partial-page-fetch-threshold int When paginating, fetch if the current page is within this percentage of the limit --swift-region string Region name - optional (OS_REGION_NAME) --swift-storage-policy string The storage policy to use when creating a new container --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) --swift-use-segments-container Tristate Choose destination for large object segments (default unset) --swift-user string User name to log in (OS_USERNAME) --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID) --ulozto-app-token string The application token identifying the app. An app API key can be either found in the API --ulozto-description string Description of the remote --ulozto-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --ulozto-list-page-size int The size of a single page for list commands. 1-500 (default 500) --ulozto-password string The password for the user (obscured) --ulozto-root-folder-slug string If set, rclone will use this folder as the root folder for all operations. For example, --ulozto-username string The username of the principal to operate as --union-action-policy string Policy to choose upstream on ACTION category (default "epall") --union-cache-time int Cache time of usage and free space (in seconds) (default 120) --union-create-policy string Policy to choose upstream on CREATE category (default "epmfs") --union-description string Description of the remote --union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi) --union-search-policy string Policy to choose upstream on SEARCH category (default "ff") --union-upstreams string List of space separated upstreams --webdav-auth-redirect Preserve authentication on redirect --webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon) --webdav-bearer-token-command string Command to run to get a bearer token --webdav-description string Description of the remote --webdav-encoding string The encoding for the backend --webdav-headers CommaSepList Set HTTP headers for all transactions --webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi) --webdav-owncloud-exclude-mounts Exclude ownCloud mounted storages --webdav-owncloud-exclude-shares Exclude ownCloud shares --webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms) --webdav-pass string Password (obscured) --webdav-unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly --webdav-url string URL of http host to connect to --webdav-user string User name --webdav-vendor string Name of the WebDAV site/service/software you are using --yandex-auth-url string Auth server URL --yandex-client-credentials Use client credentials OAuth flow --yandex-client-id string OAuth Client Id --yandex-client-secret string OAuth Client Secret --yandex-description string Description of the remote --yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-hard-delete Delete files permanently rather than putting them into the trash --yandex-spoof-ua Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true) --yandex-token string OAuth Access Token as a JSON blob --yandex-token-url string Token server url --yandex-upload-wait Duration Wait this long after an upload before setting the modification time (default 0s) --zoho-auth-url string Auth server URL --zoho-client-credentials Use client credentials OAuth flow --zoho-client-id string OAuth Client Id --zoho-client-secret string OAuth Client Secret --zoho-description string Description of the remote --zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8) --zoho-list-folder-burst int Same-folder listings allowed back-to-back before --zoho-list-folder-limit paces them (default 6) --zoho-list-folder-limit int Max listings of the SAME folder allowed per --zoho-list-folder-window (default 19) --zoho-list-folder-window Duration The window for --zoho-list-folder-limit (default 1m0s) --zoho-region string Zoho region to connect to --zoho-root-folder-id string ID of the root folder --zoho-token string OAuth Access Token as a JSON blob --zoho-token-url string Token server url --zoho-tpslimit float Max number of API transactions per second (default 6) --zoho-tpslimit-burst int Number of API calls to allow back-to-back without sleeping, for --zoho-tpslimit (default 1) --zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi) ``` # Docker Volume Plugin ## Introduction Docker 1.9 has added support for creating [named volumes](https://docs.docker.com/storage/volumes/) via [command-line interface](https://docs.docker.com/engine/reference/commandline/volume_create/) and mounting them in containers as a way to share data between them. Since Docker 1.10 you can create named volumes with [Docker Compose](https://docs.docker.com/compose/) by descriptions in [docker-compose.yml](https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference) files for use by container groups on a single host. As of Docker 1.12 volumes are supported by [Docker Swarm](https://docs.docker.com/engine/swarm/key-concepts/) included with Docker Engine and created from descriptions in [swarm compose v3](https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference) files for use with *swarm stacks* across multiple cluster nodes. [Docker Volume Plugins](https://docs.docker.com/engine/extend/plugins_volume/) augment the default `local` volume driver included in Docker with stateful volumes shared across containers and hosts. Unlike local volumes, your data will *not* be deleted when such volume is removed. Plugins can run managed by the docker daemon, as a native system service (under systemd, *sysv* or *upstart*) or as a standalone executable. Rclone can run as docker volume plugin in all these modes. It interacts with the local docker daemon via [plugin API](https://docs.docker.com/engine/extend/plugin_api/) and handles mounting of remote file systems into docker containers so it must run on the same host as the docker daemon or on every Swarm node. ## Getting started In the first example we will use the [SFTP](https://rclone.org/sftp/) rclone volume with Docker engine on a standalone Ubuntu machine. Start from [installing Docker](https://docs.docker.com/engine/install/) on the host. The *FUSE* driver is a prerequisite for rclone mounting and should be installed on host: ```console sudo apt-get -y install fuse3 ``` Create two directories required by rclone docker plugin: ```console sudo mkdir -p /var/lib/docker-plugins/rclone/config sudo mkdir -p /var/lib/docker-plugins/rclone/cache ``` Install the managed rclone docker plugin for your architecture (here `amd64`): ```console docker plugin install rclone/docker-volume-rclone:amd64 args="-v" --alias rclone --grant-all-permissions docker plugin list ``` Create your [SFTP volume](https://rclone.org/sftp/#standard-options): ```console docker volume create firstvolume -d rclone -o type=sftp -o sftp-host=_hostname_ -o sftp-user=_username_ -o sftp-pass=_password_ -o allow-other=true ``` Note that since all options are static, you don't even have to run `rclone config` or create the `rclone.conf` file (but the `config` directory should still be present). In the simplest case you can use `localhost` as *hostname* and your SSH credentials as *username* and *password*. You can also change the remote path to your home directory on the host, for example `-o path=/home/username`. Time to create a test container and mount the volume into it: ```console docker run --rm -it -v firstvolume:/mnt --workdir /mnt ubuntu:latest bash ``` If all goes well, you will enter the new container and change right to the mounted SFTP remote. You can type `ls` to list the mounted directory or otherwise play with it. Type `exit` when you are done. The container will stop but the volume will stay, ready to be reused. When it's not needed anymore, remove it: ```console docker volume list docker volume remove firstvolume ``` Now let us try **something more elaborate**: [Google Drive](https://rclone.org/drive/) volume on multi-node Docker Swarm. You should start from installing Docker and FUSE, creating plugin directories and installing rclone plugin on *every* swarm node. Then [setup the Swarm](https://docs.docker.com/engine/swarm/swarm-mode/). Google Drive volumes need an access token which can be setup via web browser and will be periodically renewed by rclone. The managed plugin cannot run a browser so we will use a technique similar to the [rclone setup on a headless box](https://rclone.org/remote_setup/). Run [rclone config](https://rclone.org/commands/rclone_config_create/) on *another* machine equipped with *web browser* and graphical user interface. Create the [Google Drive remote](https://rclone.org/drive/#standard-options). When done, transfer the resulting `rclone.conf` to the Swarm cluster and save as `/var/lib/docker-plugins/rclone/config/rclone.conf` on *every* node. By default this location is accessible only to the root user so you will need appropriate privileges. The resulting config will look like this: ```ini [gdrive] type = drive scope = drive drive_id = 1234567... root_folder_id = 0Abcd... token = {"access_token":...} ``` Now create the file named `example.yml` with a swarm stack description like this: ```yaml version: '3' services: heimdall: image: linuxserver/heimdall:latest ports: [8080:80] volumes: [configdata:/config] volumes: configdata: driver: rclone driver_opts: remote: 'gdrive:heimdall' allow_other: 'true' vfs_cache_mode: full poll_interval: 0 ``` and run the stack: ```console docker stack deploy example -c ./example.yml ``` After a few seconds docker will spread the parsed stack description over cluster, create the `example_heimdall` service on port *8080*, run service containers on one or more cluster nodes and request the `example_configdata` volume from rclone plugins on the node hosts. You can use the following commands to confirm results: ```console docker service ls docker service ps example_heimdall docker volume ls ``` Point your browser to `http://cluster.host.address:8080` and play with the service. Stop it with `docker stack remove example` when you are done. Note that the `example_configdata` volume(s) created on demand at the cluster nodes will not be automatically removed together with the stack but stay for future reuse. You can remove them manually by invoking the `docker volume remove example_configdata` command on every node. ## Creating Volumes via CLI Volumes can be created with [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/). Here are a few examples: ```console docker volume create vol1 -d rclone -o remote=storj: -o vfs-cache-mode=full docker volume create vol2 -d rclone -o remote=:storj,access_grant=xxx:heimdall docker volume create vol3 -d rclone -o type=storj -o path=heimdall -o storj-access-grant=xxx -o poll-interval=0 ``` Note the `-d rclone` flag that tells docker to request volume from the rclone driver. This works even if you installed managed driver by its full name `rclone/docker-volume-rclone` because you provided the `--alias rclone` option. Volumes can be inspected as follows: ```console docker volume list docker volume inspect vol1 ``` ## Volume Configuration Rclone flags and volume options are set via the `-o` flag to the `docker volume create` command. They include backend-specific parameters as well as mount and *VFS* options. Also there are a few special `-o` options: `remote`, `fs`, `type`, `path`, `mount-type` and `persist`. `remote` determines an existing remote name from the config file, with trailing colon and optionally with a remote path. See the full syntax in the [rclone documentation](https://rclone.org/docs/#syntax-of-remote-paths). This option can be aliased as `fs` to prevent confusion with the *remote* parameter of such backends as *crypt* or *alias*. The `remote=:backend:dir/subdir` syntax can be used to create [on-the-fly (config-less) remotes](https://rclone.org/docs/#backend-path-to-dir), while the `type` and `path` options provide a simpler alternative for this. Using two split options ```text -o type=backend -o path=dir/subdir ``` is equivalent to the combined syntax ```text -o remote=:backend:dir/subdir ``` but is arguably easier to parameterize in scripts. The `path` part is optional. [Mount and VFS options](https://rclone.org/commands/rclone_serve_docker/#options) as well as [backend parameters](https://rclone.org/flags/#backend) are named like their twin command-line flags without the `--` CLI prefix. Optionally you can use underscores instead of dashes in option names. For example, `--vfs-cache-mode full` becomes `-o vfs-cache-mode=full` or `-o vfs_cache_mode=full`. Boolean CLI flags without value will gain the `true` value, e.g. `--allow-other` becomes `-o allow-other=true` or `-o allow_other=true`. Please note that you can provide parameters only for the backend immediately referenced by the backend type of mounted `remote`. If this is a wrapping backend like *alias, chunker or crypt*, you cannot provide options for the referred to remote or backend. This limitation is imposed by the rclone connection string parser. The only workaround is to feed plugin with `rclone.conf` or configure plugin arguments (see below). ## Special Volume Options `mount-type` determines the mount method and in general can be one of: `mount`, `cmount`, or `mount2`. This can be aliased as `mount_type`. It should be noted that the managed rclone docker plugin currently does not support the `cmount` method and `mount2` is rarely needed. This option defaults to the first found method, which is usually `mount` so you generally won't need it. `persist` is a reserved boolean (true/false) option. In future it will allow to persist on-the-fly remotes in the plugin `rclone.conf` file. ## Connection Strings The `remote` value can be extended with [connection strings](https://rclone.org/docs/#connection-strings) as an alternative way to supply backend parameters. This is equivalent to the `-o` backend options with one *syntactic difference*. Inside connection string the backend prefix must be dropped from parameter names but in the `-o param=value` array it must be present. For instance, compare the following option array ```text -o remote=:sftp:/home -o sftp-host=localhost ``` with equivalent connection string: ```text -o remote=:sftp,host=localhost:/home ``` This difference exists because flag options `-o key=val` include not only backend parameters but also mount/VFS flags and possibly other settings. Also it allows to discriminate the `remote` option from the `crypt-remote` (or similarly named backend parameters) and arguably simplifies scripting due to clearer value substitution. ## Using with Swarm or Compose Both *Docker Swarm* and *Docker Compose* use [YAML](http://yaml.org/spec/1.2/spec.html)-formatted text files to describe groups (stacks) of containers, their properties, networks and volumes. *Compose* uses the [compose v2](https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference) format, *Swarm* uses the [compose v3](https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference) format. They are mostly similar, differences are explained in the [docker documentation](https://docs.docker.com/compose/compose-file/compose-versioning/#upgrading). Volumes are described by the children of the top-level `volumes:` node. Each of them should be named after its volume and have at least two elements, the self-explanatory `driver: rclone` value and the `driver_opts:` structure playing the same role as `-o key=val` CLI flags: ```yaml volumes: volume_name_1: driver: rclone driver_opts: remote: 'gdrive:' allow_other: 'true' vfs_cache_mode: full token: '{"type": "borrower", "expires": "2021-12-31"}' poll_interval: 0 ``` Notice a few important details: - YAML prefers `_` in option names instead of `-`. - YAML treats single and double quotes interchangeably. Simple strings and integers can be left unquoted. - Boolean values must be quoted like `'true'` or `"false"` because these two words are reserved by YAML. - The filesystem string is keyed with `remote` (or with `fs`). Normally you can omit quotes here, but if the string ends with colon, you **must** quote it like `remote: "storage_box:"`. - YAML is picky about surrounding braces in values as this is in fact another [syntax for key/value mappings](http://yaml.org/spec/1.2/spec.html#id2790832). For example, JSON access tokens usually contain double quotes and surrounding braces, so you must put them in single quotes. ## Installing as Managed Plugin Docker daemon can install plugins from an image registry and run them managed. We maintain the [docker-volume-rclone](https://hub.docker.com/p/rclone/docker-volume-rclone/) plugin image on [Docker Hub](https://hub.docker.com). Rclone volume plugin requires **Docker Engine >= 19.03.15** The plugin requires presence of two directories on the host before it can be installed. Note that plugin will **not** create them automatically. By default they must exist on host at the following locations (though you can tweak the paths): - `/var/lib/docker-plugins/rclone/config` is reserved for the `rclone.conf` config file and **must** exist even if it's empty and the config file is not present. - `/var/lib/docker-plugins/rclone/cache` holds the plugin state file as well as optional VFS caches. You can [install managed plugin](https://docs.docker.com/engine/reference/commandline/plugin_install/) with default settings as follows: ```console docker plugin install rclone/docker-volume-rclone:amd64 --grant-all-permissions --alias rclone ``` The `:amd64` part of the image specification after colon is called a *tag*. Usually you will want to install the latest plugin for your architecture. In this case the tag will just name it, like `amd64` above. The following plugin architectures are currently available: - `amd64` - `arm64` - `arm-v7` Sometimes you might want a concrete plugin version, not the latest one. Then you should use image tag in the form `:ARCHITECTURE-VERSION`. For example, to install plugin version `v1.56.2` on architecture `arm64` you will use tag `arm64-1.56.2` (note the removed `v`) so the full image specification becomes `rclone/docker-volume-rclone:arm64-1.56.2`. We also provide the `latest` plugin tag, but since docker does not support multi-architecture plugins as of the time of this writing, this tag is currently an **alias for `amd64`**. By convention the `latest` tag is the default one and can be omitted, thus both `rclone/docker-volume-rclone:latest` and just `rclone/docker-volume-rclone` will refer to the latest plugin release for the `amd64` platform. Also the `amd64` part can be omitted from the versioned rclone plugin tags. For example, rclone image reference `rclone/docker-volume-rclone:amd64-1.56.2` can be abbreviated as `rclone/docker-volume-rclone:1.56.2` for convenience. However, for non-intel architectures you still have to use the full tag as `amd64` or `latest` will fail to start. Managed plugin is in fact a special container running in a namespace separate from normal docker containers. Inside it runs the `rclone serve docker` command. The config and cache directories are bind-mounted into the container at start. The docker daemon connects to a unix socket created by the command inside the container. The command creates on-demand remote mounts right inside, then docker machinery propagates them through kernel mount namespaces and bind-mounts into requesting user containers. You can tweak a few plugin settings after installation when it's disabled (not in use), for instance: ```console docker plugin disable rclone docker plugin set rclone RCLONE_VERBOSE=2 config=/etc/rclone args="--vfs-cache-mode=writes --allow-other" docker plugin enable rclone docker plugin inspect rclone ``` Note that if docker refuses to disable the plugin, you should find and remove all active volumes connected with it as well as containers and swarm services that use them. This is rather tedious so please carefully plan in advance. You can tweak the following settings: `args`, `config`, `cache`, `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` and `RCLONE_VERBOSE`. It's *your* task to keep plugin settings in sync across swarm cluster nodes. `args` sets command-line arguments for the `rclone serve docker` command (*none* by default). Arguments should be separated by space so you will normally want to put them in quotes on the [docker plugin set](https://docs.docker.com/engine/reference/commandline/plugin_set/) command line. Both [serve docker flags](https://rclone.org/commands/rclone_serve_docker/#options) and [generic rclone flags](https://rclone.org/flags/) are supported, including backend parameters that will be used as defaults for volume creation. Note that plugin will fail (due to [this docker bug](https://github.com/moby/moby/blob/v20.10.7/plugin/v2/plugin.go#L195)) if the `args` value is empty. Use e.g. `args="-v"` as a workaround. `config=/host/dir` sets alternative host location for the config directory. Plugin will look for `rclone.conf` here. It's not an error if the config file is not present but the directory must exist. Please note that plugin can periodically rewrite the config file, for example when it renews storage access tokens. Keep this in mind and try to avoid races between the plugin and other instances of rclone on the host that might try to change the config simultaneously resulting in corrupted `rclone.conf`. You can also put stuff like private key files for SFTP remotes in this directory. Just note that it's bind-mounted inside the plugin container at the predefined path `/data/config`. For example, if your key file is named `sftp-box1.key` on the host, the corresponding volume config option should read `-o sftp-key-file=/data/config/sftp-box1.key`. `cache=/host/dir` sets alternative host location for the *cache* directory. The plugin will keep VFS caches here. Also it will create and maintain the `docker-plugin.state` file in this directory. When the plugin is restarted or reinstalled, it will look in this file to recreate any volumes that existed previously. However, they will not be re-mounted into consuming containers after restart. Usually this is not a problem as the docker daemon normally will restart affected user containers after failures, daemon restarts or host reboots. `RCLONE_VERBOSE` sets plugin verbosity from `0` (errors only, by default) to `2` (debugging). Verbosity can be also tweaked via `args="-v [-v] ..."`. Since arguments are more generic, you will rarely need this setting. The plugin output by default feeds the docker daemon log on local host. Log entries are reflected as *errors* in the docker log but retain their actual level assigned by rclone in the encapsulated message string. `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` customize the plugin proxy settings. You can set custom plugin options right when you install it, *in one go*: ```console docker plugin remove rclone docker plugin install rclone/docker-volume-rclone:amd64 \ --alias rclone --grant-all-permissions \ args="-v --allow-other" config=/etc/rclone docker plugin inspect rclone ``` ## Healthchecks The docker plugin volume protocol doesn't provide a way for plugins to inform the docker daemon that a volume is (un-)available. As a workaround you can setup a healthcheck to verify that the mount is responding, for example: ```yaml services: my_service: image: my_image healthcheck: test: ls /path/to/rclone/mount || exit 1 interval: 1m timeout: 15s retries: 3 start_period: 15s ``` ## Running Plugin under Systemd In most cases you should prefer managed mode. Moreover, MacOS and Windows do not support native Docker plugins. Please use managed mode on these systems. Proceed further only if you are on Linux. First, [install rclone](https://rclone.org/install/). You can just run it (type `rclone serve docker` and hit enter) for the test. Install *FUSE*: ```console sudo apt-get -y install fuse ``` Download two systemd configuration files: [docker-volume-rclone.service](https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.service) and [docker-volume-rclone.socket](https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.socket). Put them to the `/etc/systemd/system/` directory: ```console cp docker-volume-plugin.service /etc/systemd/system/ cp docker-volume-plugin.socket /etc/systemd/system/ ``` Please note that all commands in this section must be run as *root* but we omit `sudo` prefix for brevity. Now create directories required by the service: ```console mkdir -p /var/lib/docker-volumes/rclone mkdir -p /var/lib/docker-plugins/rclone/config mkdir -p /var/lib/docker-plugins/rclone/cache ``` Run the docker plugin service in the socket activated mode: ```console systemctl daemon-reload systemctl start docker-volume-rclone.service systemctl enable docker-volume-rclone.socket systemctl start docker-volume-rclone.socket systemctl restart docker ``` Or run the service directly: - run `systemctl daemon-reload` to let systemd pick up new config - run `systemctl enable docker-volume-rclone.service` to make the new service start automatically when you power on your machine. - run `systemctl start docker-volume-rclone.service` to start the service now. - run `systemctl restart docker` to restart docker daemon and let it detect the new plugin socket. Note that this step is not needed in managed mode where docker knows about plugin state changes. The two methods are equivalent from the user perspective, but I personally prefer socket activation. ## Troubleshooting You can [see managed plugin settings](https://docs.docker.com/engine/extend/#debugging-plugins) with ```console docker plugin list docker plugin inspect rclone ``` Note that docker (including latest 20.10.7) will not show actual values of `args`, just the defaults. Use `journalctl --unit docker` to see managed plugin output as part of the docker daemon log. Note that docker reflects plugin lines as *errors* but their actual level can be seen from encapsulated message string. You will usually install the latest version of managed plugin for your platform. Use the following commands to print the actual installed version: ```console PLUGID=$(docker plugin list --no-trunc | awk '/rclone/{print$1}') sudo runc --root /run/docker/runtime-runc/plugins.moby exec $PLUGID rclone version ``` You can even use `runc` to run shell inside the plugin container: ```console sudo runc --root /run/docker/runtime-runc/plugins.moby exec --tty $PLUGID bash ``` Also you can use curl to check the plugin socket connectivity: ```console docker plugin list --no-trunc PLUGID=123abc... sudo curl -H Content-Type:application/json -XPOST -d {} --unix-socket /run/docker/plugins/$PLUGID/rclone.sock http://localhost/Plugin.Activate ``` though this is rarely needed. If the plugin fails to work properly, and only as a last resort after you tried diagnosing with the above methods, you can try clearing the state of the plugin. **Note that all existing rclone docker volumes will probably have to be recreated.** This might be needed because a reinstall don't cleanup existing state files to allow for easy restoration, as stated above. ```console docker plugin disable rclone # disable the plugin to ensure no interference sudo rm /var/lib/docker-plugins/rclone/cache/docker-plugin.state # removing the plugin state docker plugin enable rclone # re-enable the plugin afterward ``` ## Caveats Finally I'd like to mention a *caveat with updating volume settings*. Docker CLI does not have a dedicated command like `docker volume update`. It may be tempting to invoke `docker volume create` with updated options on existing volume, but there is a gotcha. The command will do nothing, it won't even return an error. I hope that docker maintainers will fix this some day. In the meantime be aware that you must remove your volume before recreating it with new settings: ```console docker volume remove my_vol docker volume create my_vol -d rclone -o opt1=new_val1 ... ``` and verify that settings did update: ```console docker volume list docker volume inspect my_vol ``` If docker refuses to remove the volume, you should find containers or swarm services that use it and stop them first. ## Bisync `bisync` is considered an **advanced command**, so use with care. Make sure you have read and understood the entire [manual](https://rclone.org/bisync) (especially the [Limitations](#limitations) section) before using, or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/). ## Getting started {#getting-started} - [Install rclone](https://rclone.org/install/) and setup your remotes. - Bisync will create its working directory at `~/.cache/rclone/bisync` on Linux, `/Users/yourusername/Library/Caches/rclone/bisync` on Mac, or `C:\Users\MyLogin\AppData\Local\rclone\bisync` on Windows. Make sure that this location is writable. - Run bisync with the `--resync` flag, specifying the paths to the local and remote sync directory roots. - For successive sync runs, leave off the `--resync` flag. (**Important!**) - Consider using a [filters file](#filtering) for excluding unnecessary files and directories from the sync. - Consider setting up the [--check-access](#check-access) feature for safety. - On Linux or Mac, consider setting up a [crontab entry](#cron). bisync can safely run in concurrent cron jobs thanks to lock files it maintains. For example, your first command might look like this: ```console rclone bisync remote1:path1 remote2:path2 --create-empty-src-dirs --compare size,modtime,checksum --slow-hash-sync-only --resilient -MvP --drive-skip-gdocs --fix-case --resync --dry-run ``` If all looks good, run it again without `--dry-run`. After that, remove `--resync` as well. Here is a typical run log (with timestamps removed for clarity): ```console rclone bisync /testdir/path1/ /testdir/path2/ --verbose INFO : Synching Path1 "/testdir/path1/" with Path2 "/testdir/path2/" INFO : Path1 checking for diffs INFO : - Path1 File is new - file11.txt INFO : - Path1 File is newer - file2.txt INFO : - Path1 File is newer - file5.txt INFO : - Path1 File is newer - file7.txt INFO : - Path1 File was deleted - file4.txt INFO : - Path1 File was deleted - file6.txt INFO : - Path1 File was deleted - file8.txt INFO : Path1: 7 changes: 1 new, 3 newer, 0 older, 3 deleted INFO : Path2 checking for diffs INFO : - Path2 File is new - file10.txt INFO : - Path2 File is newer - file1.txt INFO : - Path2 File is newer - file5.txt INFO : - Path2 File is newer - file6.txt INFO : - Path2 File was deleted - file3.txt INFO : - Path2 File was deleted - file7.txt INFO : - Path2 File was deleted - file8.txt INFO : Path2: 7 changes: 1 new, 3 newer, 0 older, 3 deleted INFO : Applying changes INFO : - Path1 Queue copy to Path2 - /testdir/path2/file11.txt INFO : - Path1 Queue copy to Path2 - /testdir/path2/file2.txt INFO : - Path2 Queue delete - /testdir/path2/file4.txt NOTICE: - WARNING New or changed in both paths - file5.txt NOTICE: - Path1 Renaming Path1 copy - /testdir/path1/file5.txt..path1 NOTICE: - Path1 Queue copy to Path2 - /testdir/path2/file5.txt..path1 NOTICE: - Path2 Renaming Path2 copy - /testdir/path2/file5.txt..path2 NOTICE: - Path2 Queue copy to Path1 - /testdir/path1/file5.txt..path2 INFO : - Path2 Queue copy to Path1 - /testdir/path1/file6.txt INFO : - Path1 Queue copy to Path2 - /testdir/path2/file7.txt INFO : - Path2 Queue copy to Path1 - /testdir/path1/file1.txt INFO : - Path2 Queue copy to Path1 - /testdir/path1/file10.txt INFO : - Path1 Queue delete - /testdir/path1/file3.txt INFO : - Path2 Do queued copies to - Path1 INFO : - Path1 Do queued copies to - Path2 INFO : - Do queued deletes on - Path1 INFO : - Do queued deletes on - Path2 INFO : Updating listings INFO : Validating listings for Path1 "/testdir/path1/" vs Path2 "/testdir/path2/" INFO : Bisync successful ``` ## Command line syntax ```console $ rclone bisync --help Usage: rclone bisync remote1:path1 remote2:path2 [flags] Positional arguments: Path1, Path2 Local path, or remote storage with ':' plus optional path. Type 'rclone listremotes' for list of configured remotes. Optional Flags: --backup-dir1 string --backup-dir for Path1. Must be a non-overlapping path on the same remote. --backup-dir2 string --backup-dir for Path2. Must be a non-overlapping path on the same remote. --check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort. --check-filename string Filename for --check-access (default: RCLONE_TEST) --check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true") --compare string Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime') --conflict-loser ConflictLoserAction Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num) --conflict-resolve string Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none") --conflict-suffix string Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict') --create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) --download-hash Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!) --filters-file string Read filtering patterns from a file --force Bypass --max-delete safety check and run the sync. Consider using with --verbose -h, --help help for bisync --ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks) --max-lock Duration Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s) --no-cleanup Retain working files (useful for troubleshooting and testing). --no-slow-hash Ignore listing checksums only on backends where they are slow --recover Automatically recover from interruptions without requiring --resync. --remove-empty-dirs Remove ALL empty directories at the final cleanup step. --resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. -1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first. --resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none") --retries int Retry operations this many times if they fail (requires --resilient). (default 3) --retries-sleep Duration Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s) --slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls. --workdir string Use custom working dir - useful for testing. (default: {WORKDIR}) --max-delete PERCENT Safety check on maximum percentage of deleted files allowed. If exceeded, the bisync run will abort. (default: 50%) -n, --dry-run Go through the motions - No files are copied/deleted. -v, --verbose Increases logging verbosity. May be specified more than once for more details. ``` Arbitrary rclone flags may be specified on the [bisync command line](https://rclone.org/commands/rclone_bisync/), for example `rclone bisync ./testdir/path1/ gdrive:testdir/path2/ --drive-skip-gdocs -v -v --timeout 10s` Note that interactions of various rclone flags with bisync process flow has not been fully tested yet. ### Paths Path1 and Path2 arguments may be references to any mix of local directory paths (absolute or relative), UNC paths (`//server/share/path`), Windows drive paths (with a drive letter and `:`) or configured [remotes](https://rclone.org/docs/#syntax-of-remote-paths) with optional subdirectory paths. Cloud references are distinguished by having a `:` in the argument (see [Windows support](#windows) below). Path1 and Path2 are treated equally, in that neither has priority for file changes (except during [`--resync`](#resync)), and access efficiency does not change whether a remote is on Path1 or Path2. The listings in bisync working directory (default: `~/.cache/rclone/bisync`) are named based on the Path1 and Path2 arguments so that separate syncs to individual directories within the tree may be set up, e.g.: `path_to_local_tree..dropbox_subdir.lst`. Any empty directories after the sync on both the Path1 and Path2 filesystems are not deleted by default, unless `--create-empty-src-dirs` is specified. If the `--remove-empty-dirs` flag is specified, then both paths will have ALL empty directories purged as the last step in the process. ## Command-line flags ### --resync This will effectively make both Path1 and Path2 filesystems contain a matching superset of all files. By default, Path2 files that do not exist in Path1 will be copied to Path1, and the process will then copy the Path1 tree to Path2. The `--resync` sequence is roughly equivalent to the following (but see [`--resync-mode`](#resync-mode) for other options): ```console rclone copy Path2 Path1 --ignore-existing [--create-empty-src-dirs] rclone copy Path1 Path2 [--create-empty-src-dirs] ``` The base directories on both Path1 and Path2 filesystems must exist or bisync will fail. This is required for safety - that bisync can verify that both paths are valid. When using `--resync`, a newer version of a file on the Path2 filesystem will (by default) be overwritten by the Path1 filesystem version. (Note that this is [NOT entirely symmetrical](https://github.com/rclone/rclone/issues/5681#issuecomment-938761815), and more symmetrical options can be specified with the [`--resync-mode`](#resync-mode) flag.) Carefully evaluate deltas using [--dry-run](https://rclone.org/flags/#non-backend-flags). For a resync run, one of the paths may be empty (no files in the path tree). The resync run should result in files on both paths, else a normal non-resync run will fail. For a non-resync run, either path being empty (no files in the tree) fails with `Empty current PathN listing. Cannot sync to an empty directory: X.pathN.lst` This is a safety check that an unexpected empty path does not result in deleting **everything** in the other path. Note that `--resync` implies `--resync-mode path1` unless a different [`--resync-mode`](#resync-mode) is explicitly specified. It is not necessary to use both the `--resync` and `--resync-mode` flags -- either one is sufficient without the other. **Note:** `--resync` (including `--resync-mode`) should only be used under three specific (rare) circumstances: 1. It is your *first* bisync run (between these two paths) 2. You've just made changes to your bisync settings (such as editing the contents of your `--filters-file`) 3. There was an error on the prior run, and as a result, bisync now requires `--resync` to recover The rest of the time, you should *omit* `--resync`. The reason is because `--resync` will only *copy* (not *sync*) each side to the other. Therefore, if you included `--resync` for every bisync run, it would never be possible to delete a file -- the deleted file would always keep reappearing at the end of every run (because it's being copied from the other side where it still exists). Similarly, renaming a file would always result in a duplicate copy (both old and new name) on both sides. If you find that frequent interruptions from #3 are an issue, rather than automatically running `--resync`, the recommended alternative is to use the [`--resilient`](#resilient), [`--recover`](#recover), and [`--conflict-resolve`](#conflict-resolve) flags, (along with [Graceful Shutdown](#graceful-shutdown) mode, when needed) for a very robust "set-it-and-forget-it" bisync setup that can automatically bounce back from almost any interruption it might encounter. Consider adding something like the following: ```text --resilient --recover --max-lock 2m --conflict-resolve newer ``` ### --resync-mode CHOICE {#resync-mode} In the event that a file differs on both sides during a `--resync`, `--resync-mode` controls which version will overwrite the other. The supported options are similar to [`--conflict-resolve`](#conflict-resolve). For all of the following options, the version that is kept is referred to as the "winner", and the version that is overwritten (deleted) is referred to as the "loser". The options are named after the "winner": - `path1` - (the default) - the version from Path1 is unconditionally considered the winner (regardless of `modtime` and `size`, if any). This can be useful if one side is more trusted or up-to-date than the other, at the time of the `--resync`. - `path2` - same as `path1`, except the path2 version is considered the winner. - `newer` - the newer file (by `modtime`) is considered the winner, regardless of which side it came from. This may result in having a mix of some winners from Path1, and some winners from Path2. (The implementation is analogous to running `rclone copy --update` in both directions.) - `older` - same as `newer`, except the older file is considered the winner, and the newer file is considered the loser. - `larger` - the larger file (by `size`) is considered the winner (regardless of `modtime`, if any). This can be a useful option for remotes without `modtime` support, or with the kinds of files (such as logs) that tend to grow but not shrink, over time. - `smaller` - the smaller file (by `size`) is considered the winner (regardless of `modtime`, if any). For all of the above options, note the following: - If either of the underlying remotes lacks support for the chosen method, it will be ignored and will fall back to the default of `path1`. (For example, if `--resync-mode newer` is set, but one of the paths uses a remote that doesn't support `modtime`.) - If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored, and bisync will instead try to determine whether the files differ by looking at the other `--compare` methods in effect. (For example, if `--resync-mode newer` is set, but the Path1 and Path2 modtimes are identical, bisync will compare the sizes.) If bisync concludes that they differ, preference is given to whichever is the "source" at that moment. (In practice, this gives a slight advantage to Path2, as the 2to1 copy comes before the 1to2 copy.) If the files *do not* differ, nothing is copied (as both sides are already correct). - These options apply only to files that exist on both sides (with the same name and relative path). Files that exist *only* on one side and not the other are *always* copied to the other, during `--resync` (this is one of the main differences between resync and non-resync runs.). - `--conflict-resolve`, `--conflict-loser`, and `--conflict-suffix` do not apply during `--resync`, and unlike these flags, nothing is renamed during `--resync`. When a file differs on both sides during `--resync`, one version always overwrites the other (much like in `rclone copy`.) (Consider using [`--backup-dir`](#backup-dir1-and-backup-dir2) to retain a backup of the losing version.) - Unlike for `--conflict-resolve`, `--resync-mode none` is not a valid option (or rather, it will be interpreted as "no resync", unless `--resync` has also been specified, in which case it will be ignored.) - Winners and losers are decided at the individual file-level only (there is not currently an option to pick an entire winning directory atomically, although the `path1` and `path2` options typically produce a similar result.) - To maintain backward-compatibility, the `--resync` flag implies `--resync-mode path1` unless a different `--resync-mode` is explicitly specified. Similarly, all `--resync-mode` options (except `none`) imply `--resync`, so it is not necessary to use both the `--resync` and `--resync-mode` flags simultaneously -- either one is sufficient without the other. ### --check-access Access check files are an additional safety measure against data loss. bisync will ensure it can find matching `RCLONE_TEST` files in the same places in the Path1 and Path2 filesystems. `RCLONE_TEST` files are not generated automatically. For `--check-access` to succeed, you must first either: **A)** Place one or more `RCLONE_TEST` files in both systems, or **B)** Set `--check-filename` to a filename already in use in various locations throughout your sync'd fileset. Recommended methods for **A)** include: - `rclone touch Path1/RCLONE_TEST` (create a new file) - `rclone copyto Path1/RCLONE_TEST Path2/RCLONE_TEST` (copy an existing file) - `rclone copy Path1/RCLONE_TEST Path2/RCLONE_TEST --include "RCLONE_TEST"` (copy multiple files at once, recursively) - create the files manually (outside of rclone) - run `bisync` once *without* `--check-access` to set matching files on both filesystems will also work, but is not preferred, due to potential for user error (you are temporarily disabling the safety feature). Note that `--check-access` is still enforced on `--resync`, so `bisync --resync --check-access` will not work as a method of initially setting the files (this is to ensure that bisync can't [inadvertently circumvent its own safety switch](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should).) Time stamps and file contents for `RCLONE_TEST` files are not important, just the names and locations. If you have symbolic links in your sync tree it is recommended to place `RCLONE_TEST` files in the linked-to directory tree to protect against bisync assuming a bunch of deleted files if the linked-to tree should not be accessible. See also the [--check-filename](--check-filename) flag. ### --check-filename Name of the file(s) used in access health validation. The default `--check-filename` is `RCLONE_TEST`. One or more files having this filename must exist, synchronized between your source and destination filesets, in order for `--check-access` to succeed. See [--check-access](#check-access) for additional details. ### --compare As of `v1.66`, bisync fully supports comparing based on any combination of size, modtime, and checksum (lifting the prior restriction on backends without modtime support.) By default (without the `--compare` flag), bisync inherits the same comparison options as `sync` (that is: `size` and `modtime` by default, unless modified with flags such as [`--checksum`](https://rclone.org/docs/#c-checksum) or [`--size-only`](/docs/#size-only).) If the `--compare` flag is set, it will override these defaults. This can be useful if you wish to compare based on combinations not currently supported in `sync`, such as comparing all three of `size` AND `modtime` AND `checksum` simultaneously (or just `modtime` AND `checksum`). `--compare` takes a comma-separated list, with the currently supported values being `size`, `modtime`, and `checksum`. For example, if you want to compare size and checksum, but not modtime, you would do: ```text --compare size,checksum ``` Or if you want to compare all three: ```text --compare size,modtime,checksum ``` `--compare` overrides any conflicting flags. For example, if you set the conflicting flags `--compare checksum --size-only`, `--size-only` will be ignored, and bisync will compare checksum and not size. To avoid confusion, it is recommended to use *either* `--compare` or the normal `sync` flags, but not both. If `--compare` includes `checksum` and both remotes support checksums but have no hash types in common with each other, checksums will be considered *only* for comparisons within the same side (to determine what has changed since the prior sync), but not for comparisons against the opposite side. If one side supports checksums and the other does not, checksums will only be considered on the side that supports them. When comparing with `checksum` and/or `size` without `modtime`, bisync cannot determine whether a file is `newer` or `older` -- only whether it is `changed` or `unchanged`. (If it is `changed` on both sides, bisync still does the standard equality-check to avoid declaring a sync conflict unless it absolutely has to.) It is recommended to do a `--resync` when changing `--compare` settings, as otherwise your prior listing files may not contain the attributes you wish to compare (for example, they will not have stored checksums if you were not previously comparing checksums.) ### --ignore-listing-checksum When `--checksum` or `--compare checksum` is set, bisync will retrieve (or generate) checksums (for backends that support them) when creating the listings for both paths, and store the checksums in the listing files. `--ignore-listing-checksum` will disable this behavior, which may speed things up considerably, especially on backends (such as [local](https://rclone.org/local/)) where hashes must be computed on the fly instead of retrieved. Please note the following: - As of `v1.66`, `--ignore-listing-checksum` is now automatically set when neither `--checksum` nor `--compare checksum` are in use (as the checksums would not be used for anything.) - `--ignore-listing-checksum` is NOT the same as [`--ignore-checksum`](https://rclone.org/docs/#ignore-checksum), and you may wish to use one or the other, or both. In a nutshell: `--ignore-listing-checksum` controls whether checksums are considered when scanning for diffs, while `--ignore-checksum` controls whether checksums are considered during the copy/sync operations that follow, if there ARE diffs. - Unless `--ignore-listing-checksum` is passed, bisync currently computes hashes for one path *even when there's no common hash with the other path* (for example, a [crypt](https://rclone.org/crypt/#modification-times-and-hashes) remote.) This can still be beneficial, as the hashes will still be used to detect changes within the same side (if `--checksum` or `--compare checksum` is set), even if they can't be used to compare against the opposite side. - If you wish to ignore listing checksums *only* on remotes where they are slow to compute, consider using [`--no-slow-hash`](#no-slow-hash) (or [`--slow-hash-sync-only`](#slow-hash-sync-only)) instead of `--ignore-listing-checksum`. - If `--ignore-listing-checksum` is used simultaneously with `--compare checksum` (or `--checksum`), checksums will be ignored for bisync deltas, but still considered during the sync operations that follow (if deltas are detected based on modtime and/or size.) ### --no-slow-hash On some remotes (notably `local`), checksums can dramatically slow down a bisync run, because hashes cannot be stored and need to be computed in real-time when they are requested. On other remotes (such as `drive`), they add practically no time at all. The `--no-slow-hash` flag will automatically skip checksums on remotes where they are slow, while still comparing them on others (assuming [`--compare`](#compare) includes `checksum`.) This can be useful when one of your bisync paths is slow but you still want to check checksums on the other, for a more robust sync. ### --slow-hash-sync-only Same as [`--no-slow-hash`](#no-slow-hash), except slow hashes are still considered during sync calls. They are still NOT considered for determining deltas, nor or they included in listings. They are also skipped during `--resync`. The main use case for this flag is when you have a large number of files, but relatively few of them change from run to run -- so you don't want to check your entire tree every time (it would take too long), but you still want to consider checksums for the smaller group of files for which a `modtime` or `size` change was detected. Keep in mind that this speed savings comes with a safety trade-off: if a file's content were to change without a change to its `modtime` or `size`, bisync would not detect it, and it would not be synced. `--slow-hash-sync-only` is only useful if both remotes share a common hash type (if they don't, bisync will automatically fall back to `--no-slow-hash`.) Both `--no-slow-hash` and `--slow-hash-sync-only` have no effect without `--compare checksum` (or `--checksum`). ### --download-hash If `--download-hash` is set, bisync will use best efforts to obtain an MD5 checksum by downloading and computing on-the-fly, when checksums are not otherwise available (for example, a remote that doesn't support them.) Note that since rclone has to download the entire file, this may dramatically slow down your bisync runs, and is also likely to use a lot of data, so it is probably not practical for bisync paths with a large total file size. However, it can be a good option for syncing small-but-important files with maximum accuracy (for example, a source code repo on a `crypt` remote.) An additional advantage over methods like [`cryptcheck`](https://rclone.org/commands/rclone_cryptcheck/) is that the original file is not required for comparison (for example, `--download-hash` can be used to bisync two different crypt remotes with different passwords.) When `--download-hash` is set, bisync still looks for more efficient checksums first, and falls back to downloading only when none are found. It takes priority over conflicting flags such as `--no-slow-hash`. `--download-hash` is not suitable for [Google Docs](#gdocs) and other files of unknown size, as their checksums would change from run to run (due to small variances in the internals of the generated export file.) Therefore, bisync automatically skips `--download-hash` for files with a size less than 0. See also: [`Hasher`](https://rclone.org/hasher/) backend, [`cryptcheck`](https://rclone.org/commands/rclone_cryptcheck/) command, [`rclone check --download`](https://rclone.org/commands/rclone_check/) option, [`md5sum`](https://rclone.org/commands/rclone_md5sum/) command ### --max-delete As a safety check, if greater than the `--max-delete` percent of files were deleted on either the Path1 or Path2 filesystem, then bisync will abort with a warning message, without making any changes. The default `--max-delete` is `50%`. One way to trigger this limit is to rename a directory that contains more than half of your files. This will appear to bisync as a bunch of deleted files and a bunch of new files. This safety check is intended to block bisync from deleting all of the files on both filesystems due to a temporary network access issue, or if the user had inadvertently deleted the files on one side or the other. To force the sync, either set a different delete percentage limit, e.g. `--max-delete 75` (allows up to 75% deletion), or use `--force` to bypass the check. Also see the [all files changed](#all-files-changed) check. ### --filters-file {#filters-file} By using rclone filter features you can exclude file types or directory sub-trees from the sync. See the [bisync filters](#filtering) section and generic [--filter-from](https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file) documentation. An [example filters file](#example-filters-file) contains filters for non-allowed files for syncing with Dropbox. If you make changes to your filters file then bisync requires a run with `--resync`. This is a safety feature, which prevents existing files on the Path1 and/or Path2 side from seeming to disappear from view (since they are excluded in the new listings), which would fool bisync into seeing them as deleted (as compared to the prior run listings), and then bisync would proceed to delete them for real. To block this from happening, bisync calculates an MD5 hash of the filters file and stores the hash in a `.md5` file in the same place as your filters file. On the next run with `--filters-file` set, bisync re-calculates the MD5 hash of the current filters file and compares it to the hash stored in the `.md5` file. If they don't match, the run aborts with a critical error and thus forces you to do a `--resync`, likely avoiding a disaster. ### --conflict-resolve CHOICE {#conflict-resolve} In bisync, a "conflict" is a file that is *new* or *changed* on *both sides* (relative to the prior run) AND is *not currently identical* on both sides. `--conflict-resolve` controls how bisync handles such a scenario. The currently supported options are: - `none` - (the default) - do not attempt to pick a winner, keep and rename both files according to [`--conflict-loser`](#conflict-loser) and [`--conflict-suffix`](#conflict-suffix) settings. For example, with the default settings, `file.txt` on Path1 is renamed `file.txt.conflict1` and `file.txt` on Path2 is renamed `file.txt.conflict2`. Both are copied to the opposite path during the run, so both sides end up with a copy of both files. (As `none` is the default, it is not necessary to specify `--conflict-resolve none` -- you can just omit the flag.) - `newer` - the newer file (by `modtime`) is considered the winner and is copied without renaming. The older file (the "loser") is handled according to `--conflict-loser` and `--conflict-suffix` settings (either renamed or deleted.) For example, if `file.txt` on Path1 is newer than `file.txt` on Path2, the result on both sides (with other default settings) will be `file.txt` (winner from Path1) and `file.txt.conflict1` (loser from Path2). - `older` - same as `newer`, except the older file is considered the winner, and the newer file is considered the loser. - `larger` - the larger file (by `size`) is considered the winner (regardless of `modtime`, if any). - `smaller` - the smaller file (by `size`) is considered the winner (regardless of `modtime`, if any). - `path1` - the version from Path1 is unconditionally considered the winner (regardless of `modtime` and `size`, if any). This can be useful if one side is usually more trusted or up-to-date than the other. - `path2` - same as `path1`, except the path2 version is considered the winner. For all of the above options, note the following: - If either of the underlying remotes lacks support for the chosen method, it will be ignored and fall back to `none`. (For example, if `--conflict-resolve newer` is set, but one of the paths uses a remote that doesn't support `modtime`.) - If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored and fall back to `none`. (For example, if `--conflict-resolve newer` is set, but the Path1 and Path2 modtimes are identical, even if the sizes may differ.) - If the file's content is currently identical on both sides, it is not considered a "conflict", even if new or changed on both sides since the prior sync. (For example, if you made a change on one side and then synced it to the other side by other means.) Therefore, none of the conflict resolution flags apply in this scenario. - The conflict resolution flags do not apply during a `--resync`, as there is no "prior run" to speak of (but see [`--resync-mode`](#resync-mode) for similar options.) ### --conflict-loser CHOICE {#conflict-loser} `--conflict-loser` determines what happens to the "loser" of a sync conflict (when [`--conflict-resolve`](#conflict-resolve) determines a winner) or to both files (when there is no winner.) The currently supported options are: - `num` - (the default) - auto-number the conflicts by automatically appending the next available number to the `--conflict-suffix`, in chronological order. For example, with the default settings, the first conflict for `file.txt` will be renamed `file.txt.conflict1`. If `file.txt.conflict1` already exists, `file.txt.conflict2` will be used instead (etc., up to a maximum of 9223372036854775807 conflicts.) - `pathname` - rename the conflicts according to which side they came from, which was the default behavior prior to `v1.66`. For example, with `--conflict-suffix path`, `file.txt` from Path1 will be renamed `file.txt.path1`, and `file.txt` from Path2 will be renamed `file.txt.path2`. If two non-identical suffixes are provided (ex. `--conflict-suffix cloud,local`), the trailing digit is omitted. Importantly, note that with `pathname`, there is no auto-numbering beyond `2`, so if `file.txt.path2` somehow already exists, it will be overwritten. Using a dynamic date variable in your `--conflict-suffix` (see below) is one possible way to avoid this. Note also that conflicts-of-conflicts are possible, if the original conflict is not manually resolved -- for example, if for some reason you edited `file.txt.path1` on both sides, and those edits were different, the result would be `file.txt.path1.path1` and `file.txt.path1.path2` (in addition to `file.txt.path2`.) - `delete` - keep the winner only and delete the loser, instead of renaming it. If a winner cannot be determined (see `--conflict-resolve` for details on how this could happen), `delete` is ignored and the default `num` is used instead (i.e. both versions are kept and renamed, and neither is deleted.) `delete` is inherently the most destructive option, so use it only with care. For all of the above options, note that if a winner cannot be determined (see `--conflict-resolve` for details on how this could happen), or if `--conflict-resolve` is not in use, *both* files will be renamed. ### --conflict-suffix STRING[,STRING] {#conflict-suffix} `--conflict-suffix` controls the suffix that is appended when bisync renames a [`--conflict-loser`](#conflict-loser) (default: `conflict`). `--conflict-suffix` will accept either one string or two comma-separated strings to assign different suffixes to Path1 vs. Path2. This may be helpful later in identifying the source of the conflict. (For example, `--conflict-suffix dropboxconflict,laptopconflict`) With `--conflict-loser num`, a number is always appended to the suffix. With `--conflict-loser pathname`, a number is appended only when one suffix is specified (or when two identical suffixes are specified.) i.e. with `--conflict-loser pathname`, all of the following would produce exactly the same result: ```text --conflict-suffix path --conflict-suffix path,path --conflict-suffix path1,path2 ``` Suffixes may be as short as 1 character. By default, the suffix is appended after any other extensions (ex. `file.jpg.conflict1`), however, this can be changed with the [`--suffix-keep-extension`](https://rclone.org/docs/#suffix-keep-extension) flag (i.e. to instead result in `file.conflict1.jpg`). `--conflict-suffix` supports several *dynamic date variables* when enclosed in curly braces as globs. This can be helpful to track the date and/or time that each conflict was handled by bisync. For example: ```text --conflict-suffix {DateOnly}-conflict // result: myfile.txt.2006-01-02-conflict1 ``` All of the formats described [here (go Time.Layout constants)](https://pkg.go.dev/time#pkg-constants) and [here (go Time.Format examples)](https://pkg.go.dev/time#example-Time.Format) are supported, but take care to ensure that your chosen format does not use any characters that are illegal on your remotes (for example, macOS does not allow colons in filenames, and slashes are also best avoided as they are often interpreted as directory separators.) To address this particular issue, an additional `{MacFriendlyTime}` (or just `{mac}`) option is supported, which results in `2006-01-02 0304PM`. Note that `--conflict-suffix` is entirely separate from rclone's main [`--sufix`](https://rclone.org/docs/#suffix-string) flag. This is intentional, as users may wish to use both flags simultaneously, if also using [`--backup-dir`](#backup-dir1-and-backup-dir2). Finally, note that the default in bisync prior to `v1.66` was to rename conflicts with `..path1` and `..path2` (with two periods, and `path` instead of `conflict`.) Bisync now defaults to a single dot instead of a double dot, but additional dots can be added by including them in the specified suffix string. For example, for behavior equivalent to the previous default, use: ```text [--conflict-resolve none] --conflict-loser pathname --conflict-suffix .path ``` ### --check-sync Enabled by default, the check-sync function checks that all of the same files exist in both the Path1 and Path2 history listings. This *check-sync* integrity check is performed at the end of the sync run by default. Any untrapped failing copy/deletes between the two paths might result in differences between the two listings and in the untracked file content differences between the two paths. A resync run would correct the error. Note that the default-enabled integrity check locally executes a load of both the final Path1 and Path2 listings, and thus adds to the run time of a sync. Using `--check-sync=false` will disable it and may significantly reduce the sync run times for very large numbers of files. The check may be run manually with `--check-sync=only`. It runs only the integrity check and terminates without actually syncing. Note that currently, `--check-sync` **only checks listing snapshots and NOT the actual files on the remotes.** Note also that the listing snapshots will not know about any changes that happened during or after the latest bisync run, as those will be discovered on the next run. Therefore, while listings should always match *each other* at the end of a bisync run, it is *expected* that they will not match the underlying remotes, nor will the remotes match each other, if there were changes during or after the run. This is normal, and any differences will be detected and synced on the next run. For a robust integrity check of the current state of the remotes (as opposed to just their listing snapshots), consider using [`check`](commands/rclone_check/) (or [`cryptcheck`](https://rclone.org/commands/rclone_cryptcheck/), if at least one path is a `crypt` remote) instead of `--check-sync`, keeping in mind that differences are expected if files changed during or after your last bisync run. For example, a possible sequence could look like this: 1. Normally scheduled bisync run: ```console rclone bisync Path1 Path2 -MPc --check-access --max-delete 10 --filters-file /path/to/filters.txt -v --no-cleanup --ignore-listing-checksum --disable ListR --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient ``` 2. Periodic independent integrity check (perhaps scheduled nightly or weekly): ```console rclone check -MvPc Path1 Path2 --filter-from /path/to/filters.txt ``` 3. If diffs are found, you have some choices to correct them. If one side is more up-to-date and you want to make the other side match it, you could run: ```console rclone sync Path1 Path2 --filter-from /path/to/filters.txt --create-empty-src-dirs -MPc -v ``` (or switch Path1 and Path2 to make Path2 the source-of-truth) Or, if neither side is totally up-to-date, you could run a `--resync` to bring them back into agreement (but remember that this could cause deleted files to re-appear.) *Note also that `rclone check` does not currently include empty directories, so if you want to know if any empty directories are out of sync, consider alternatively running the above `rclone sync` command with `--dry-run` added. See also: [Concurrent modifications](#concurrent-modifications), [`--resilient`](#resilient) ### --resilient By default, most errors or interruptions will cause bisync to abort and require [`--resync`](#resync) to recover. This is a safety feature, to prevent bisync from running again until a user checks things out. However, in some cases, bisync can go too far and enforce a lockout when one isn't actually necessary, like for certain less-serious errors that might resolve themselves on the next run. When `--resilient` is specified, bisync tries its best to recover and self-correct, and only requires `--resync` as a last resort when a human's involvement is absolutely necessary. The intended use case is for running bisync as a background process (such as via scheduled [cron](#cron)). When using `--resilient` mode, bisync will still report the error and abort, however it will not lock out future runs -- allowing the possibility of retrying at the next normally scheduled time, without requiring a `--resync` first. Examples of such retryable errors include access test failures, missing listing files, and filter change detections. These safety features will still prevent the *current* run from proceeding -- the difference is that if conditions have improved by the time of the *next* run, that next run will be allowed to proceed. Certain more serious errors will still enforce a `--resync` lockout, even in `--resilient` mode, to prevent data loss. Behavior of `--resilient` may change in a future version. (See also: [`--recover`](#recover), [`--max-lock`](#max-lock), [Graceful Shutdown](#graceful-shutdown)) ### --recover If `--recover` is set, in the event of a sudden interruption or other un-graceful shutdown, bisync will attempt to automatically recover on the next run, instead of requiring `--resync`. Bisync is able to recover robustly by keeping one "backup" listing at all times, representing the state of both paths after the last known successful sync. Bisync can then compare the current state with this snapshot to determine which changes it needs to retry. Changes that were synced after this snapshot (during the run that was later interrupted) will appear to bisync as if they are "new or changed on both sides", but in most cases this is not a problem, as bisync will simply do its usual "equality check" and learn that no action needs to be taken on these files, since they are already identical on both sides. In the rare event that a file is synced successfully during a run that later aborts, and then that same file changes AGAIN before the next run, bisync will think it is a sync conflict, and handle it accordingly. (From bisync's perspective, the file has changed on both sides since the last trusted sync, and the files on either side are not currently identical.) Therefore, `--recover` carries with it a slightly increased chance of having conflicts -- though in practice this is pretty rare, as the conditions required to cause it are quite specific. This risk can be reduced by using bisync's ["Graceful Shutdown"](#graceful-shutdown) mode (triggered by sending `SIGINT` or `Ctrl+C`), when you have the choice, instead of forcing a sudden termination. `--recover` and `--resilient` are similar, but distinct -- the main difference is that `--resilient` is about *retrying*, while `--recover` is about *recovering*. Most users will probably want both. `--resilient` allows retrying when bisync has chosen to abort itself due to safety features such as failing `--check-access` or detecting a filter change. `--resilient` does not cover external interruptions such as a user shutting down their computer in the middle of a sync -- that is what `--recover` is for. ### --max-lock Bisync uses [lock files](#lock-file) as a safety feature to prevent interference from other bisync runs while it is running. Bisync normally removes these lock files at the end of a run, but if bisync is abruptly interrupted, these files will be left behind. By default, they will lock out all future runs, until the user has a chance to manually check things out and remove the lock. As an alternative, `--max-lock` can be used to make them automatically expire after a certain period of time, so that future runs are not locked out forever, and auto-recovery is possible. `--max-lock` can be any duration `2m` or greater (or `0` to disable). If set, lock files older than this will be considered "expired", and future runs will be allowed to disregard them and proceed. (Note that the `--max-lock` duration must be set by the process that left the lock file -- not the later one interpreting it.) If set, bisync will also "renew" these lock files every `--max-lock minus one minute` throughout a run, for extra safety. (For example, with `--max-lock 5m`, bisync would renew the lock file (for another 5 minutes) every 4 minutes until the run has completed.) In other words, it should not be possible for a lock file to pass its expiration time while the process that created it is still running -- and you can therefore be reasonably sure that any *expired* lock file you may find was left there by an interrupted run, not one that is still running and just taking awhile. If a lock file exists but its contents are unreadable (for example, due to an incomplete write or disk error), it is treated as expired when `--max-lock` is set to a value greater than `0`. If `--max-lock` is `0` or not set, an unreadable lock file will produce an error and block future runs until removed manually. If `--max-lock` is `0` or not set, the default is that lock files will never expire, and will block future runs (of these same two bisync paths) indefinitely. For maximum resilience from disruptions, consider setting a relatively short duration like `--max-lock 2m` along with [`--resilient`](#resilient) and [`--recover`](#recover), and a relatively frequent [cron schedule](#cron). The result will be a very robust "set-it-and-forget-it" bisync run that can automatically bounce back from almost any interruption it might encounter, without requiring the user to get involved and run a `--resync`. (See also: [Graceful Shutdown](#graceful-shutdown) mode) ### --backup-dir1 and --backup-dir2 As of `v1.66`, [`--backup-dir`](https://rclone.org/docs/#backup-dir-string) is supported in bisync. Because `--backup-dir` must be a non-overlapping path on the same remote, Bisync has introduced new `--backup-dir1` and `--backup-dir2` flags to support separate backup-dirs for `Path1` and `Path2` (bisyncing between different remotes with `--backup-dir` would not otherwise be possible.) `--backup-dir1` and `--backup-dir2` can use different remotes from each other, but `--backup-dir1` must use the same remote as `Path1`, and `--backup-dir2` must use the same remote as `Path2`. Each backup directory must not overlap its respective bisync Path without being excluded by a filter rule. The standard `--backup-dir` will also work, if both paths use the same remote (but note that deleted files from both paths would be mixed together in the same dir). If either `--backup-dir1` and `--backup-dir2` are set, they will override `--backup-dir`. Example: ```console rclone bisync /Users/someuser/some/local/path/Bisync gdrive:Bisync --backup-dir1 /Users/someuser/some/local/path/BackupDir --backup-dir2 gdrive:BackupDir --suffix -2023-08-26 --suffix-keep-extension --check-access --max-delete 10 --filters-file /Users/someuser/some/local/path/bisync_filters.txt --no-cleanup --ignore-listing-checksum --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient -MvP --drive-skip-gdocs --fix-case ``` In this example, if the user deletes a file in `/Users/someuser/some/local/path/Bisync`, bisync will propagate the delete to the other side by moving the corresponding file from `gdrive:Bisync` to `gdrive:BackupDir`. If the user deletes a file from `gdrive:Bisync`, bisync moves it from `/Users/someuser/some/local/path/Bisync` to `/Users/someuser/some/local/path/BackupDir`. In the event of a [rename due to a sync conflict](#conflict-loser), the rename is not considered a delete, unless a previous conflict with the same name already exists and would get overwritten. See also: [`--suffix`](https://rclone.org/docs/#suffix-string), [`--suffix-keep-extension`](https://rclone.org/docs/#suffix-keep-extension) ## Operation ### Runtime flow details bisync retains the listings of the `Path1` and `Path2` filesystems from the prior run. On each successive run it will: - list files on `path1` and `path2`, and check for changes on each side. Changes include `New`, `Newer`, `Older`, and `Deleted` files. - Propagate changes on `path1` to `path2`, and vice-versa. ### Safety measures - Lock file prevents multiple simultaneous runs when taking a while. This can be particularly useful if bisync is run by cron scheduler. - Handle change conflicts non-destructively by creating `.conflict1`, `.conflict2`, etc. file versions, according to [`--conflict-resolve`](#conflict-resolve), [`--conflict-loser`](#conflict-loser), and [`--conflict-suffix`](#conflict-suffix) settings. - File system access health check using `RCLONE_TEST` files (see the `--check-access` flag). - Abort on excessive deletes - protects against a failed listing being interpreted as all the files were deleted. See the `--max-delete` and `--force` flags. - If something evil happens, bisync goes into a safe state to block damage by later runs. (See [Error Handling](#error-handling)) ### Normal sync checks Type | Description | Result | Implementation --------------|-----------------------------------------------|--------------------------|----------------------------- Path2 new | File is new on Path2, does not exist on Path1 | Path2 version survives | `rclone copy` Path2 to Path1 Path2 newer | File is newer on Path2, unchanged on Path1 | Path2 version survives | `rclone copy` Path2 to Path1 Path2 deleted | File is deleted on Path2, unchanged on Path1 | File is deleted | `rclone delete` Path1 Path1 new | File is new on Path1, does not exist on Path2 | Path1 version survives | `rclone copy` Path1 to Path2 Path1 newer | File is newer on Path1, unchanged on Path2 | Path1 version survives | `rclone copy` Path1 to Path2 Path1 older | File is older on Path1, unchanged on Path2 | *Path1 version survives* | `rclone copy` Path1 to Path2 Path2 older | File is older on Path2, unchanged on Path1 | *Path2 version survives* | `rclone copy` Path2 to Path1 Path1 deleted | File no longer exists on Path1 | File is deleted | `rclone delete` Path2 ### Unusual sync checks Type | Description | Result | Implementation --------------------------------|---------------------------------------|------------------------------------|----------------------- Path1 new/changed AND Path2 new/changed AND Path1 == Path2 | File is new/changed on Path1 AND new/changed on Path2 AND Path1 version is currently identical to Path2 | No change | None Path1 new AND Path2 new | File is new on Path1 AND new on Path2 (and Path1 version is NOT identical to Path2) | Conflicts handled according to [`--conflict-resolve`](#conflict-resolve) & [`--conflict-loser`](#conflict-loser) settings | default: `rclone copy` renamed `Path2.conflict2` file to Path1, `rclone copy` renamed `Path1.conflict1` file to Path2 Path2 newer AND Path1 changed | File is newer on Path2 AND also changed (newer/older/size) on Path1 (and Path1 version is NOT identical to Path2) | Conflicts handled according to [`--conflict-resolve`](#conflict-resolve) & [`--conflict-loser`](#conflict-loser) settings | default: `rclone copy` renamed `Path2.conflict2` file to Path1, `rclone copy` renamed `Path1.conflict1` file to Path2 Path2 newer AND Path1 deleted | File is newer on Path2 AND also deleted on Path1 | Path2 version survives | `rclone copy` Path2 to Path1 Path2 deleted AND Path1 changed | File is deleted on Path2 AND changed (newer/older/size) on Path1 | Path1 version survives |`rclone copy` Path1 to Path2 Path1 deleted AND Path2 changed | File is deleted on Path1 AND changed (newer/older/size) on Path2 | Path2 version survives | `rclone copy` Path2 to Path1 As of `rclone v1.64`, bisync is now better at detecting *false positive* sync conflicts, which would previously have resulted in unnecessary renames and duplicates. Now, when bisync comes to a file that it wants to rename (because it is new/changed on both sides), it first checks whether the Path1 and Path2 versions are currently *identical* (using the same underlying function as [`check`](commands/rclone_check/).) If bisync concludes that the files are identical, it will skip them and move on. Otherwise, it will create renamed duplicates, as before. This behavior also [improves the experience of renaming directories](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=Renamed%20directories), as a `--resync` is no longer required, so long as the same change has been made on both sides. ### All files changed check {#all-files-changed} If *all* prior existing files on either of the filesystems have changed (e.g. timestamps have changed due to changing the system's timezone) then bisync will abort without making any changes. Any new files are not considered for this check. You could use `--force` to force the sync (whichever side has the changed timestamp files wins). Alternately, a `--resync` may be used (Path1 versions will be pushed to Path2). Consider the situation carefully and perhaps use `--dry-run` before you commit to the changes. ### Modification times By default, bisync compares files by modification time and size. If you or your application should change the content of a file without changing the modification time and size, then bisync will *not* notice the change, and thus will not copy it to the other side. As an alternative, consider comparing by checksum (if your remotes support it). See [`--compare`](#compare) for details. ### Error handling {#error-handling} Certain bisync critical errors, such as file copy/move failing, will result in a bisync lockout of following runs. The lockout is asserted because the sync status and history of the Path1 and Path2 filesystems cannot be trusted, so it is safer to block any further changes until someone checks things out. The recovery is to do a `--resync` again. It is recommended to use `--resync --dry-run --verbose` initially and *carefully* review what changes will be made before running the `--resync` without `--dry-run`. Most of these events come up due to an error status from an internal call. On such a critical error the `{...}.path1.lst` and `{...}.path2.lst` listing files are renamed to extension `.lst-err`, which blocks any future bisync runs (since the normal `.lst` files are not found). Bisync keeps them under `bisync` subdirectory of the rclone cache directory, typically at `${HOME}/.cache/rclone/bisync/` on Linux. Some errors are considered temporary and re-running the bisync is not blocked. The *critical return* blocks further bisync runs. See also: [`--resilient`](#resilient), [`--recover`](#recover), [`--max-lock`](#max-lock), [Graceful Shutdown](#graceful-shutdown) ### Lock file When bisync is running, a lock file is created in the bisync working directory, typically at `~/.cache/rclone/bisync/PATH1..PATH2.lck` on Linux. If bisync should crash or hang, the lock file will remain in place and block any further runs of bisync *for the same paths*. Delete the lock file as part of debugging the situation. The lock file effectively blocks follow-on (e.g., scheduled by *cron*) runs when the prior invocation is taking a long time. The lock file contains *PID* of the blocking process, which may help in debug. Lock files can be set to automatically expire after a certain amount of time, using the [`--max-lock`](#max-lock) flag. **Note** that while concurrent bisync runs are allowed, *be very cautious* that there is no overlap in the trees being synched between concurrent runs, lest there be replicated files, deleted files and general mayhem. ### Exit codes `rclone bisync` returns the following codes to calling program: - `0` on a successful run, - `1` for a non-critical failing run (a rerun may be successful), - `2` on syntax or usage error, - `7` for a critically aborted run (requires a `--resync` to recover). See also the section about [exit codes](https://rclone.org/docs/#exit-code) in main docs. ### Graceful Shutdown Bisync has a "Graceful Shutdown" mode which is activated by sending `SIGINT` or pressing `Ctrl+C` during a run. Once triggered, bisync will use best efforts to exit cleanly before the timer runs out. If bisync is in the middle of transferring files, it will attempt to cleanly empty its queue by finishing what it has started but not taking more. If it cannot do so within 30 seconds, it will cancel the in-progress transfers at that point and then give itself a maximum of 60 seconds to wrap up, save its state for next time, and exit. With the `-vP` flags you will see constant status updates and a final confirmation of whether or not the graceful shutdown was successful. At any point during the "Graceful Shutdown" sequence, a second `SIGINT` or `Ctrl+C` will trigger an immediate, un-graceful exit, which will leave things in a messier state. Usually a robust recovery will still be possible if using [`--recover`](#recover) mode, otherwise you will need to do a `--resync`. If you plan to use Graceful Shutdown mode, it is recommended to use [`--resilient`](#resilient) and [`--recover`](#recover), and it is important to NOT use [`--inplace`](https://rclone.org/docs/#inplace), otherwise you risk leaving partially-written files on one side, which may be confused for real files on the next run. Note also that in the event of an abrupt interruption, a [lock file](#lock-file) will be left behind to block concurrent runs. You will need to delete it before you can proceed with the next run (or wait for it to expire on its own, if using `--max-lock`.) ## Limitations ### Supported backends Bisync is integration-tested against all rclone backends to verify compatibility. Most backends (including all backends not listed below) are deemed fully supported with no known issues. Occasionally, however, these tests reveal issues with particular backends, usually related to a provider-specific limitation beyond rclone's control (for example, disallowed special characters and filename encodings.) The following backends have known issues that need more investigation: - `TestHuaweiDrive` (`huaweidrive`) - [`TestBisyncRemoteLocal/ext_paths`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt) - [`TestBisyncRemoteLocal/extended_filenames`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt) - [`TestBisyncRemoteLocal/normalization`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt) - [`TestBisyncLocalRemote/ext_paths`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt) - [`TestBisyncLocalRemote/extended_filenames`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt) - [4 more](https://pub.rclone.org/integration-tests/current/) - `TestPcloud` (`pcloud`) - [`TestBisyncRemoteRemote/check_access`](https://pub.rclone.org/integration-tests/current/pcloud-cmd.bisync-TestPcloud-1.txt) - [`TestBisyncRemoteRemote/rmdirs`](https://pub.rclone.org/integration-tests/current/pcloud-cmd.bisync-TestPcloud-1.txt) - Updated: 2026-07-31-010017 The following backends either have not been tested recently or have known issues that are deemed unfixable for the time being: - `TestArchive` (`archive`) - `TestCache` (`cache`) - `TestDrime` (`drime`) - `TestDropbox` (`dropbox`) - `TestBisyncRemoteLocal/normalization` - `TestBisyncLocalRemote/normalization` - `TestBisyncRemoteRemote/normalization` - `TestFileLu` (`filelu`) - `TestFilesCom` (`filescom`) - `TestImageKit` (`imagekit`) - `TestJottacloud` (`jottacloud`) - `TestLinkbox` (`linkbox`) - `TestMailru` (`mailru`) - `TestMega` (`mega`) - `TestOpenDrive` (`opendrive`) - `TestOracleObjectStorage` (`oracleobjectstorage`) - `TestPikPak` (`pikpak`) - `TestPixeldrain` (`pixeldrain`) - `TestProtonDrive` (`protondrive`) - `TestPutio` (`putio`) - `TestQuatrix` (`quatrix`) - `TestS3GCS` (`s3`) - `TestBisyncRemoteRemote/extended_filenames` - `TestS3Rclone` (`s3`) - `TestSFTPRsyncNet` (`sftp`) - `TestStorj` (`storj`) - `TestWebdavNextcloud` (`webdav`) - `TestWebdavOwncloud` (`webdav`) - `TestnStorage` (`netstorage`) ([more info](https://github.com/rclone/rclone/blob/master/fstest/test_all/config.yaml)) The above lists are updated for each stable release of rclone. For test results updated nightly based on the latest beta, visit rclone's [integration test status page](https://pub.rclone.org/integration-tests/current/). Early beta versions of `rclone bisync` required both underlying backends to support modification times, and refused to run otherwise. This limitation has been lifted as of `v1.66`, as bisync now supports comparing checksum and/or size instead of (or in addition to) modtime. See [`--compare`](#compare) for details. ### Concurrent modifications When using **Local, FTP or SFTP** remotes with [`--inplace`](https://rclone.org/docs/#inplace), rclone does not create *temporary* files at the destination when copying, and thus if the connection is lost the created file may be corrupt, which will likely propagate back to the original path on the next sync, resulting in data loss. It is therefore recommended to *omit* `--inplace`. Files that **change during** a bisync run may result in data loss. Prior to `rclone v1.66`, this was commonly seen in highly dynamic environments, where the filesystem was getting hammered by running processes during the sync. As of `rclone v1.66`, bisync was redesigned to use a "snapshot" model, greatly reducing the risks from changes during a sync. Changes that are not detected during the current sync will now be detected during the following sync, and will no longer cause the entire run to throw a critical error. There is additionally a mechanism to mark files as needing to be internally rechecked next time, for added safety. It should therefore no longer be necessary to sync only at quiet times -- however, note that an error can still occur if a file happens to change at the exact moment it's being read/written by bisync (same as would happen in `rclone sync`.) (See also: [`--ignore-checksum`](https://rclone.org/docs/#ignore-checksum), [`--local-no-check-updated`](https://rclone.org/local/#local-no-check-updated)) ### Empty directories By default, new/deleted empty directories on one path are *not* propagated to the other side. This is because bisync (and rclone) natively works on files, not directories. However, this can be changed with the `--create-empty-src-dirs` flag, which works in much the same way as in [`sync`](https://rclone.org/commands/rclone_sync/) and [`copy`](https://rclone.org/commands/rclone_copy/). When used, empty directories created or deleted on one side will also be created or deleted on the other side. The following should be noted: - `--create-empty-src-dirs` is not compatible with `--remove-empty-dirs`. Use only one or the other (or neither). - It is not recommended to switch back and forth between `--create-empty-src-dirs` and the default (no `--create-empty-src-dirs`) without running `-- resync`. This is because it may appear as though all directories (not just the empty ones) were created/deleted, when actually you've just toggled between making them visible/invisible to bisync. It looks scarier than it is, but it's still probably best to stick to one or the other, and use `--resync` when you need to switch. ### Renamed directories By default, renaming a folder on the Path1 side results in deleting all files on the Path2 side and then copying all files again from Path1 to Path2. Bisync sees this as all files in the old directory name as deleted and all files in the new directory name as new. A recommended solution is to use [`--track-renames`](https://rclone.org/docs/#track-renames), which is now supported in bisync as of `rclone v1.66`. Note that `--track-renames` is not available during `--resync`, as `--resync` does not delete anything (`--track-renames` only supports `sync`, not `copy`.) Otherwise, the most effective and efficient method of renaming a directory is to rename it to the same name on both sides. (As of `rclone v1.64`, a `--resync` is no longer required after doing so, as bisync will automatically detect that Path1 and Path2 are in agreement.) Note that although the flag --track-renames ensures that renamed/moved files won't be deleted and uploaded again, they are still counted as deleted files for purposes of the --max-delete flag (as this check happens before the rename detection operation). See [this issue](https://github.com/rclone/rclone/issues/8685). ### `--fast-list` used by default Unlike most other rclone commands, bisync uses [`--fast-list`](https://rclone.org/docs/#fast-list) by default, for backends that support it. In many cases this is desirable, however, there are some scenarios in which bisync could be faster *without* `--fast-list`, and there is also a [known issue concerning Google Drive users with many empty directories](https://github.com/rclone/rclone/commit/cbf3d4356135814921382dd3285d859d15d0aa77). For now, the recommended way to avoid using `--fast-list` is to add `--disable ListR` to all bisync commands. The default behavior may change in a future version. ### Case (and unicode) sensitivity {#case-sensitivity} As of `v1.66`, case and unicode form differences no longer cause critical errors, and normalization (when comparing between filesystems) is handled according to the same flags and defaults as `rclone sync`. See the following options (all of which are supported by bisync) to control this behavior more granularly: - [`--fix-case`](https://rclone.org/docs/#fix-case) - [`--ignore-case-sync`](https://rclone.org/docs/#ignore-case-sync) - [`--no-unicode-normalization`](https://rclone.org/docs/#no-unicode-normalization) - [`--local-unicode-normalization`](https://rclone.org/local/#local-unicode-normalization) and [`--local-case-sensitive`](https://rclone.org/local/#local-case-sensitive) (caution: these are normally not what you want.) Note that in the (probably rare) event that `--fix-case` is used AND a file is new/changed on both sides AND the checksums match AND the filename case does not match, the Path1 filename is considered the winner, for the purposes of `--fix-case` (Path2 will be renamed to match it). ## Windows support {#windows} Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on Windows GitHub runners. Drive letters are allowed, including drive letters mapped to network drives (`rclone bisync J:\localsync GDrive:`). If a drive letter is omitted, the shell current drive is the default. Drive letters are a single character follows by `:`, so cloud names must be more than one character long. Absolute paths (with or without a drive letter), and relative paths (with or without a drive letter) are supported. Working directory is created at `C:\Users\MyLogin\AppData\Local\rclone\bisync`. Note that bisync output may show a mix of forward `/` and back `\` slashes. Be careful of case independent directory and file naming on Windows vs. case dependent Linux ## Filtering {#filtering} See [filtering documentation](https://rclone.org/filtering/) for how filter rules are written and interpreted. Bisync's [`--filters-file`](#filters-file) flag slightly extends the rclone's [--filter-from](https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file) filtering mechanism. For a given bisync run you may provide *only one* `--filters-file`. The `--include*`, `--exclude*`, and `--filter` flags are also supported. ### How to filter directories Filtering portions of the directory tree is a critical feature for syncing. Examples of directory trees (always beneath the Path1/Path2 root level) you may want to exclude from your sync: - Directory trees containing only software build intermediate files. - Directory trees containing application temporary files and data such as the Windows `C:\Users\MyLogin\AppData\` tree. - Directory trees containing files that are large, less important, or are getting thrashed continuously by ongoing processes. On the other hand, there may be only select directories that you actually want to sync, and exclude all others. See the [Example include-style filters for Windows user directories](#include-filters) below. ### Filters file writing guidelines 1. Begin with excluding directory trees: - e.g. `- /AppData/` - `**` on the end is not necessary. Once a given directory level is excluded then everything beneath it won't be looked at by rclone. - Exclude such directories that are unneeded, are big, dynamically thrashed, or where there may be access permission issues. - Excluding such dirs first will make rclone operations (much) faster. - Specific files may also be excluded, as with the Dropbox exclusions example below. 2. Decide if it's easier (or cleaner) to: - Include select directories and therefore *exclude everything else* -- or -- - Exclude select directories and therefore *include everything else* 3. Include select directories: - Add lines like: `+ /Documents/PersonalFiles/**` to select which directories to include in the sync. - `**` on the end specifies to include the full depth of the specified tree. - With Include-style filters, files at the Path1/Path2 root are not included. They may be included with `+ /*`. - Place RCLONE_TEST files within these included directory trees. They will only be looked for in these directory trees. - Finish by excluding everything else by adding `- **` at the end of the filters file. - Disregard step 4. 4. Exclude select directories: - Add more lines like in step 1. For example: `-/Desktop/tempfiles/`, or `- /testdir/`. Again, a `**` on the end is not necessary. - Do *not* add a `- **` in the file. Without this line, everything will be included that has not been explicitly excluded. - Disregard step 3. A few rules for the syntax of a filter file expanding on [filtering documentation](https://rclone.org/filtering/): - Lines may start with spaces and tabs - rclone strips leading whitespace. - If the first non-whitespace character is a `#` then the line is a comment and will be ignored. - Blank lines are ignored. - The first non-whitespace character on a filter line must be a `+` or `-`. - Exactly 1 space is allowed between the `+/-` and the path term. - Only forward slashes (`/`) are used in path terms, even on Windows. - The rest of the line is taken as the path term. Trailing whitespace is taken literally, and probably is an error. ### Example include-style filters for Windows user directories {#include-filters} This Windows *include-style* example is based on the sync root (Path1) set to `C:\Users\MyLogin`. The strategy is to select specific directories to be synched with a network drive (Path2). - `- /AppData/` excludes an entire tree of Windows stored stuff that need not be synched. In my case, AppData has >11 GB of stuff I don't care about, and there are some subdirectories beneath AppData that are not accessible to my user login, resulting in bisync critical aborts. - Windows creates cache files starting with both upper and lowercase `NTUSER` at `C:\Users\MyLogin`. These files may be dynamic, locked, and are generally *don't care*. - There are just a few directories with *my* data that I do want synched, in the form of `+ /`. By selecting only the directory trees I want to avoid the dozen plus directories that various apps make at `C:\Users\MyLogin\Documents`. - Include files in the root of the sync point, `C:\Users\MyLogin`, by adding the `+ /*` line. - This is an Include-style filters file, therefore it ends with `- **` which excludes everything not explicitly included. ```text - /AppData/ - NTUSER* - ntuser* + /Documents/Family/** + /Documents/Sketchup/** + /Documents/Microcapture_Photo/** + /Documents/Microcapture_Video/** + /Desktop/** + /Pictures/** + /* - ** ``` Note also that Windows implements several "library" links such as `C:\Users\MyLogin\My Documents\My Music` pointing to `C:\Users\MyLogin\Music`. rclone sees these as links, so you must add `--links` to the bisync command line if you which to follow these links. I find that I get permission errors in trying to follow the links, so I don't include the rclone `--links` flag, but then you get lots of `Can't follow symlink…` noise from rclone about not following the links. This noise can be quashed by adding `--quiet` to the bisync command line. ## Example exclude-style filters files for use with Dropbox {#exclude-filters} - Dropbox disallows syncing the listed temporary and configuration/data files. The `- ` filters exclude these files where ever they may occur in the sync tree. Consider adding similar exclusions for file types you don't need to sync, such as core dump and software build files. - bisync testing creates `/testdir/` at the top level of the sync tree, and usually deletes the tree after the test. If a normal sync should run while the `/testdir/` tree exists the `--check-access` phase may fail due to unbalanced RCLONE_TEST files. The `- /testdir/` filter blocks this tree from being synched. You don't need this exclusion if you are not doing bisync development testing. - Everything else beneath the Path1/Path2 root will be synched. - RCLONE_TEST files may be placed anywhere within the tree, including the root. ### Example filters file for Dropbox {#example-filters-file} ```text # Filter file for use with bisync # See https://rclone.org/filtering/ for filtering rules # NOTICE: If you make changes to this file you MUST do a --resync run. # Run with --dry-run to see what changes will be made. # Dropbox won't sync some files so filter them away here. # See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing - .dropbox.attr - ~*.tmp - ~$* - .~* - desktop.ini - .dropbox # Used for bisync testing, so excluded from normal runs - /testdir/ # Other example filters #- /TiBU/ #- /Photos/ ``` ### How --check-access handles filters At the start of a bisync run, listings are gathered for Path1 and Path2 while using the user's `--filters-file`. During the check access phase, bisync scans these listings for `RCLONE_TEST` files. Any `RCLONE_TEST` files hidden by the `--filters-file` are *not* in the listings and thus not checked during the check access phase. ## Troubleshooting {#troubleshooting} ### Reading bisync logs Here are two normal runs. The first one has a newer file on the remote. The second has no deltas between local and remote. ```text 2021/05/16 00:24:38 INFO : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/" 2021/05/16 00:24:38 INFO : Path1 checking for diffs 2021/05/16 00:24:38 INFO : - Path1 File is new - file.txt 2021/05/16 00:24:38 INFO : Path1: 1 changes: 1 new, 0 newer, 0 older, 0 deleted 2021/05/16 00:24:38 INFO : Path2 checking for diffs 2021/05/16 00:24:38 INFO : Applying changes 2021/05/16 00:24:38 INFO : - Path1 Queue copy to Path2 - dropbox:/file.txt 2021/05/16 00:24:38 INFO : - Path1 Do queued copies to - Path2 2021/05/16 00:24:38 INFO : Updating listings 2021/05/16 00:24:38 INFO : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/" 2021/05/16 00:24:38 INFO : Bisync successful 2021/05/16 00:36:52 INFO : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/" 2021/05/16 00:36:52 INFO : Path1 checking for diffs 2021/05/16 00:36:52 INFO : Path2 checking for diffs 2021/05/16 00:36:52 INFO : No changes found 2021/05/16 00:36:52 INFO : Updating listings 2021/05/16 00:36:52 INFO : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/" 2021/05/16 00:36:52 INFO : Bisync successful ``` ### Dry run oddity The `--dry-run` messages may indicate that it would try to delete some files. For example, if a file is new on Path2 and does not exist on Path1 then it would normally be copied to Path1, but with `--dry-run` enabled those copies don't happen, which leads to the attempted delete on Path2, blocked again by --dry-run: `... Not deleting as --dry-run`. This whole confusing situation is an artifact of the `--dry-run` flag. Scrutinize the proposed deletes carefully, and if the files would have been copied to Path1 then the threatened deletes on Path2 may be disregarded. ### Retries Rclone has built-in retries. If you run with `--verbose` you'll see error and retry messages such as shown below. This is usually not a bug. If at the end of the run, you see `Bisync successful` and not `Bisync critical error` or `Bisync aborted` then the run was successful, and you can ignore the error messages. The following run shows an intermittent fail. Lines *5* and *6* are low-level messages. Line *6* is a bubbled-up *warning* message, conveying the error. Rclone normally retries failing commands, so there may be numerous such messages in the log. Since there are no final error/warning messages on line *7*, rclone has recovered from failure after a retry, and the overall sync was successful. ```text 1: 2021/05/14 00:44:12 INFO : Synching Path1 "/path/to/local/tree" with Path2 "dropbox:" 2: 2021/05/14 00:44:12 INFO : Path1 checking for diffs 3: 2021/05/14 00:44:12 INFO : Path2 checking for diffs 4: 2021/05/14 00:44:12 INFO : Path2: 113 changes: 22 new, 0 newer, 0 older, 91 deleted 5: 2021/05/14 00:44:12 ERROR : /path/to/local/tree/objects/af: error listing: unexpected end of JSON input 6: 2021/05/14 00:44:12 NOTICE: WARNING listing try 1 failed. - dropbox: 7: 2021/05/14 00:44:12 INFO : Bisync successful ``` This log shows a *Critical failure* which requires a `--resync` to recover from. See the [Runtime Error Handling](#error-handling) section. ```text 2021/05/12 00:49:40 INFO : Google drive root '': Waiting for checks to finish 2021/05/12 00:49:40 INFO : Google drive root '': Waiting for transfers to finish 2021/05/12 00:49:40 INFO : Google drive root '': not deleting files as there were IO errors 2021/05/12 00:49:40 ERROR : Attempt 3/3 failed with 3 errors and: not deleting files as there were IO errors 2021/05/12 00:49:40 ERROR : Failed to sync: not deleting files as there were IO errors 2021/05/12 00:49:40 NOTICE: WARNING rclone sync try 3 failed. - /path/to/local/tree/ 2021/05/12 00:49:40 ERROR : Bisync aborted. Must run --resync to recover. ``` ### Denied downloads of "infected" or "abusive" files Google Drive has a filter for certain file types (`.exe`, `.apk`, et cetera) that by default cannot be copied from Google Drive to the local filesystem. If you are having problems, run with `--verbose` to see specifically which files are generating complaints. If the error is `This file has been identified as malware or spam and cannot be downloaded`, consider using the flag [--drive-acknowledge-abuse](https://rclone.org/drive/#drive-acknowledge-abuse). ### Google Docs (and other files of unknown size) {#gdocs} As of `v1.66`, [Google Docs](https://rclone.org/drive/#import-export-of-google-documents) (including Google Sheets, Slides, etc.) are now supported in bisync, subject to the same options, defaults, and limitations as in `rclone sync`. When bisyncing drive with non-drive backends, the drive -> non-drive direction is controlled by [`--drive-export-formats`](https://rclone.org/drive/#drive-export-formats) (default `"docx,xlsx,pptx,svg"`) and the non-drive -> drive direction is controlled by [`--drive-import-formats`](https://rclone.org/drive/#drive-import-formats) (default none.) For example, with the default export/import formats, a Google Sheet on the drive side will be synced to an `.xlsx` file on the non-drive side. In the reverse direction, `.xlsx` files with filenames that match an existing Google Sheet will be synced to that Google Sheet, while `.xlsx` files that do NOT match an existing Google Sheet will be copied to drive as normal `.xlsx` files (without conversion to Sheets, although the Google Drive web browser UI may still give you the option to open it as one.) If `--drive-import-formats` is set (it's not, by default), then all of the specified formats will be converted to Google Docs, if there is no existing Google Doc with a matching name. Caution: such conversion can be quite lossy, and in most cases it's probably not what you want! To bisync Google Docs as URL shortcut links (in a manner similar to "Drive for Desktop"), use: `--drive-export-formats url` (or [alternatives](https://rclone.org/drive/#exportformats:~:text=available%20Google%20Documents.-,Extension,macOS,-Standard%20options).) Note that these link files cannot be edited on the non-drive side -- you will get errors if you try to sync an edited link file back to drive. They CAN be deleted (it will result in deleting the corresponding Google Doc.) If you create a `.url` file on the non-drive side that does not match an existing Google Doc, bisyncing it will just result in copying the literal `.url` file over to drive (no Google Doc will be created.) So, as a general rule of thumb, think of them as read-only placeholders on the non-drive side, and make all your changes on the drive side. Likewise, even with other export-formats, it is best to only move/rename Google Docs on the drive side. This is because otherwise, bisync will interpret this as a file deleted and another created, and accordingly, it will delete the Google Doc and create a new file at the new path. (Whether or not that new file is a Google Doc depends on `--drive-import-formats`.) Lastly, take note that all Google Docs on the drive side have a size of `-1` and no checksum. Therefore, they cannot be reliably synced with the `--checksum` or `--size-only` flags. (To be exact: they will still get created/deleted, and bisync's delta engine will notice changes and queue them for syncing, but the underlying sync function will consider them identical and skip them.) To work around this, use the default (modtime and size) instead of `--checksum` or `--size-only`. To ignore Google Docs entirely, use [`--drive-skip-gdocs`](https://rclone.org/drive/#drive-skip-gdocs). ## Usage examples ### Cron {#cron} Rclone does not yet have a built-in capability to monitor the local file system for changes and must be blindly run periodically. On Windows this can be done using a *Task Scheduler*, on Linux you can use *Cron* which is described below. The 1st example runs a sync every 5 minutes between a local directory and an OwnCloud server, with output logged to a runlog file: ```text # Minute (0-59) # Hour (0-23) # Day of Month (1-31) # Month (1-12 or Jan-Dec) # Day of Week (0-6 or Sun-Sat) # Command */5 * * * * /path/to/rclone bisync /local/files MyCloud: --check-access --filters-file /path/to/bysync-filters.txt --log-file /path/to//bisync.log ``` See [crontab syntax](https://www.man7.org/linux/man-pages/man1/crontab.1p.html#INPUT_FILES) for the details of crontab time interval expressions. If you run `rclone bisync` as a cron job, redirect stdout/stderr to a file. The 2nd example runs a sync to Dropbox every hour and logs all stdout (via the `>>`) and stderr (via `2>&1`) to a log file. ```text 0 * * * * /path/to/rclone bisync /path/to/local/dropbox Dropbox: --check-access --filters-file /home/user/filters.txt >> /path/to/logs/dropbox-run.log 2>&1 ``` ### Sharing an encrypted folder tree between hosts bisync can keep a local folder in sync with a cloud service, but what if you have some highly sensitive files to be synched? Usage of a cloud service is for exchanging both routine and sensitive personal files between one's home network, one's personal notebook when on the road, and with one's work computer. The routine data is not sensitive. For the sensitive data, configure an rclone [crypt remote](https://rclone.org/crypt/) to point to a subdirectory within the local disk tree that is bisync'd to Dropbox, and then set up an bisync for this local crypt directory to a directory outside of the main sync tree. ### Linux server setup - `/path/to/DBoxroot` is the root of my local sync tree. There are numerous subdirectories. - `/path/to/DBoxroot/crypt` is the root subdirectory for files that are encrypted. This local directory target is setup as an rclone crypt remote named `Dropcrypt:`. See [rclone.conf](#rclone-conf-snippet) snippet below. - `/path/to/my/unencrypted/files` is the root of my sensitive files - not encrypted, not within the tree synched to Dropbox. - To sync my local unencrypted files with the encrypted Dropbox versions I manually run `bisync /path/to/my/unencrypted/files DropCrypt:`. This step could be bundled into a script to run before and after the full Dropbox tree sync in the last step, thus actively keeping the sensitive files in sync. - `bisync /path/to/DBoxroot Dropbox:` runs periodically via cron, keeping my full local sync tree in sync with Dropbox. ### Windows notebook setup - The Dropbox client runs keeping the local tree `C:\Users\MyLogin\Dropbox` always in sync with Dropbox. I could have used `rclone bisync` instead. - A separate directory tree at `C:\Users\MyLogin\Documents\DropLocal` hosts the tree of unencrypted files/folders. - To sync my local unencrypted files with the encrypted Dropbox versions I manually run the following command: `rclone bisync C:\Users\MyLogin\Documents\DropLocal Dropcrypt:`. - The Dropbox client then syncs the changes with Dropbox. ### rclone.conf snippet {#rclone-conf-snippet} ```ini [Dropbox] type = dropbox ... [Dropcrypt] type = crypt remote = /path/to/DBoxroot/crypt # on the Linux server remote = C:\Users\MyLogin\Dropbox\crypt # on the Windows notebook filename_encryption = standard directory_name_encryption = true password = ... ... ``` ## Testing {#testing} You should read this section only if you are developing for rclone. You need to have rclone source code locally to work with bisync tests. Bisync has a dedicated test framework implemented in the `bisync_test.go` file located in the rclone source tree. The test suite is based on the `go test` command. Series of tests are stored in subdirectories below the `cmd/bisync/testdata` directory. Individual tests can be invoked by their directory name, e.g. `go test . -case basic -remote local -remote2 gdrive: -v` Tests will make a temporary folder on remote and purge it afterwards. If during test run there are intermittent errors and rclone retries, these errors will be captured and flagged as invalid MISCOMPAREs. Rerunning the test will let it pass. Consider such failures as noise. ### Test command syntax ```text usage: go test ./cmd/bisync [options...] Options: -case NAME Name(s) of the test case(s) to run. Multiple names should be separated by commas. You can remove the `test_` prefix and replace `_` by `-` in test name for convenience. If not `all`, the name(s) should map to a directory under `./cmd/bisync/testdata`. Use `all` to run all tests (default: all) -remote PATH1 `local` or name of cloud service with `:` (default: local) -remote2 PATH2 `local` or name of cloud service with `:` (default: local) -no-compare Disable comparing test results with the golden directory (default: compare) -no-cleanup Disable cleanup of Path1 and Path2 testdirs. Useful for troubleshooting. (default: cleanup) -golden Store results in the golden directory (default: false) This flag can be used with multiple tests. -debug Print debug messages -stop-at NUM Stop test after given step number. (default: run to the end) Implies `-no-compare` and `-no-cleanup`, if the test really ends prematurely. Only meaningful for a single test case. -refresh-times Force refreshing the target modtime, useful for Dropbox (default: false) -verbose Run tests verbosely ``` Note: unlike rclone flags which must be prefixed by double dash (`--`), the test command flags can be equally prefixed by a single `-` or double dash. ### Running tests - `go test . -case basic -remote local -remote2 local` runs the `test_basic` test case using only the local filesystem, syncing one local directory with another local directory. Test script output is to the console, while commands within scenario.txt have their output sent to the `.../workdir/test.log` file, which is finally compared to the golden copy. - The first argument after `go test` should be a relative name of the directory containing bisync source code. If you run tests right from there, the argument will be `.` (current directory) as in most examples below. If you run bisync tests from the rclone source directory, the command should be `go test ./cmd/bisync ...`. - The test engine will mangle rclone output to ensure comparability with golden listings and logs. - Test scenarios are located in `./cmd/bisync/testdata`. The test `-case` argument should match the full name of a subdirectory under that directory. Every test subdirectory name on disk must start with `test_`, this prefix can be omitted on command line for brevity. Also, underscores in the name can be replaced by dashes for convenience. - `go test . -remote local -remote2 local -case all` runs all tests. - Path1 and Path2 may either be the keyword `local` or may be names of configured cloud services. `go test . -remote gdrive: -remote2 dropbox: -case basic` will run the test between these two services, without transferring any files to the local filesystem. - Test run stdout and stderr console output may be directed to a file, e.g. `go test . -remote gdrive: -remote2 local -case all > runlog.txt 2>&1` ### Test execution flow 1. The base setup in the `initial` directory of the testcase is applied on the Path1 and Path2 filesystems (via rclone copy the initial directory to Path1, then rclone sync Path1 to Path2). 2. The commands in the scenario.txt file are applied, with output directed to the `test.log` file in the test working directory. Typically, the first actual command in the `scenario.txt` file is to do a `--resync`, which establishes the baseline `{...}.path1.lst` and `{...}.path2.lst` files in the test working directory (`.../workdir/` relative to the temporary test directory). Various commands and listing snapshots are done within the test. 3. Finally, the contents of the test working directory are compared to the contents of the testcase's golden directory. ### Notes about testing - Test cases are in individual directories beneath `./cmd/bisync/testdata`. A command line reference to a test is understood to reference a directory beneath `testdata`. For example, `go test ./cmd/bisync -case dry-run -remote gdrive: -remote2 local` refers to the test case in `./cmd/bisync/testdata/test_dry_run`. - The test working directory is located at `.../workdir` relative to a temporary test directory, usually under `/tmp` on Linux. - The local test sync tree is created at a temporary directory named like `bisync.XXX` under system temporary directory. - The remote test sync tree is located at a temporary directory under `/bisync.XXX/`. - `path1` and/or `path2` subdirectories are created in a temporary directory under the respective local or cloud test remote. - By default, the Path1 and Path2 test dirs and workdir will be deleted after each test run. The `-no-cleanup` flag disables purging these directories when validating and debugging a given test. These directories will be flushed before running another test, independent of the `-no-cleanup` usage. - You will likely want to add `- /testdir/` to your normal bisync `--filters-file` so that normal syncs do not attempt to sync the test temporary directories, which may have `RCLONE_TEST` miscompares in some testcases which would otherwise trip the `--check-access` system. The `--check-access` mechanism is hard-coded to ignore `RCLONE_TEST` files beneath `bisync/testdata`, so the test cases may reside on the synched tree even if there are check file mismatches in the test tree. - Some Dropbox tests can fail, notably printing the following message: `src and dst identical but can't set mod time without deleting and re-uploading` This is expected and happens due to the way Dropbox handles modification times. You should use the `-refresh-times` test flag to make up for this. - If Dropbox tests hit request limit for you and print error message `too_many_requests/...: Too many requests or write operations.` then follow the [Dropbox App ID instructions](https://rclone.org/dropbox/#get-your-own-dropbox-app-id). ### Updating golden results Sometimes even a slight change in the bisync source can cause little changes spread around many log files. Updating them manually would be a nightmare. The `-golden` flag will store the `test.log` and `*.lst` listings from each test case into respective golden directories. Golden results will automatically contain generic strings instead of local or cloud paths which means that they should match when run with a different cloud service. Your normal workflow might be as follows: 1. Git-clone the rclone sources locally 2. Modify bisync source and check that it builds 3. Run the whole test suite `go test ./cmd/bisync -remote local` 4. If some tests show log difference, recheck them individually, e.g.: `go test ./cmd/bisync -remote local -case basic` 5. If you are convinced with the difference, goldenize all tests at once: `go test ./cmd/bisync -remote local -golden` 6. Use word diff: `git diff --word-diff ./cmd/bisync/testdata/`. Please note that normal line-level diff is generally useless here. 7. Check the difference *carefully*! 8. Commit the change (`git commit`) *only* if you are sure. If unsure, save your code changes then wipe the log diffs from git: `git reset [--hard]`. ### Structure of test scenarios - `/initial/` contains a tree of files that will be set as the initial condition on both Path1 and Path2 testdirs. - `/modfiles/` contains files that will be used to modify the Path1 and/or Path2 filesystems. - `/golden/` contains the expected content of the test working directory (`workdir`) at the completion of the testcase. - `/scenario.txt` contains the body of the test, in the form of various commands to modify files, run bisync, and snapshot listings. Output from these commands is captured to `.../workdir/test.log` for comparison to the golden files. ### Supported test commands - `test ` Print the line to the console and to the `test.log`: `test sync is working correctly with options x, y, z` - `copy-listings ` Save a copy of all `.lst` listings in the test working directory with the specified prefix: `save-listings exclude-pass-run` - `move-listings ` Similar to `copy-listings` but removes the source - `purge-children ` This will delete all child files and purge all child subdirs under given directory but keep the parent intact. This behavior is important for tests with Google Drive because removing and re-creating the parent would change its ID. - `delete-file ` Delete a single file. - `delete-glob ` Delete a group of files located one level deep in the given directory with names matching a given glob pattern. - `touch-glob YYYY-MM-DD ` Change modification time on a group of files. - `touch-copy YYYY-MM-DD

` Change file modification time then copy it to destination. - `copy-file

` Copy a single file to given directory. - `copy-as

` Similar to above but destination must include both directory and the new file name at destination. - `copy-dir ` and `sync-dir ` Copy/sync a directory. Equivalent of `rclone copy` and `rclone sync`. - `list-dirs ` Equivalent to `rclone lsf -R --dirs-only ` - `bisync [options]` Runs bisync against `-remote` and `-remote2`. ### Supported substitution terms - `{testdir/}` - the root dir of the testcase - `{datadir/}` - the `modfiles` dir under the testcase root - `{workdir/}` - the temporary test working directory - `{path1/}` - the root of the Path1 test directory tree - `{path2/}` - the root of the Path2 test directory tree - `{session}` - base name of the test listings - `{/}` - OS-specific path separator - `{spc}`, `{tab}`, `{eol}` - whitespace - `{chr:HH}` - raw byte with given hexadecimal code Substitution results of the terms named like `{dir/}` will end with `/` (or backslash on Windows), so it is not necessary to include slash in the usage, for example `delete-file {path1/}file1.txt`. ## Benchmarks *This section is work in progress.* Here are a few data points for scale, execution times, and memory usage. The first set of data was taken between a local disk to Dropbox. The [speedtest.net](https://speedtest.net) download speed was ~170 Mbps, and upload speed was ~10 Mbps. 500 files (~9.5 MB each) had been already synched. 50 files were added in a new directory, each ~9.5 MB, ~475 MB total. Change | Operations and times | Overall run time --------------------------------------|--------------------------------------------------------|------------------ 500 files synched (nothing to move) | 1x listings for Path1 & Path2 | 1.5 sec 500 files synched with --check-access | 1x listings for Path1 & Path2 | 1.5 sec 50 new files on remote | Queued 50 copies down: 27 sec | 29 sec Moved local dir | Queued 50 copies up: 410 sec, 50 deletes up: 9 sec | 421 sec Moved remote dir | Queued 50 copies down: 31 sec, 50 deletes down: <1 sec | 33 sec Delete local dir | Queued 50 deletes up: 9 sec | 13 sec This next data is from a user's application. They had ~400GB of data over 1.96 million files being sync'ed between a Windows local disk and some remote cloud. The file full path length was on average 35 characters (which factors into load time and RAM required). - Loading the prior listing into memory (1.96 million files, listing file size 140 MB) took ~30 sec and occupied about 1 GB of RAM. - Getting a fresh listing of the local file system (producing the 140 MB output file) took about XXX sec. - Getting a fresh listing of the remote file system (producing the 140 MB output file) took about XXX sec. The network download speed was measured at XXX Mb/s. - Once the prior and current Path1 and Path2 listings were loaded (a total of four to be loaded, two at a time), determining the deltas was pretty quick (a few seconds for this test case), and the transfer time for any files to be copied was dominated by the network bandwidth. ## References rclone's bisync implementation was derived from the [rclonesync-V2](https://github.com/cjnaz/rclonesync-V2) project, including documentation and test mechanisms, with [@cjnaz](https://github.com/cjnaz)'s full support and encouragement. `rclone bisync` is similar in nature to a range of other projects: - [unison](https://github.com/bcpierce00/unison) - [syncthing](https://github.com/syncthing/syncthing) - [cjnaz/rclonesync](https://github.com/cjnaz/rclonesync-V2) - [ConorWilliams/rsinc](https://github.com/ConorWilliams/rsinc) - [jwink3101/syncrclone](https://github.com/Jwink3101/syncrclone) - [DavideRossi/upback](https://github.com/DavideRossi/upback) Bisync adopts the differential synchronization technique, which is based on keeping history of changes performed by both synchronizing sides. See the *Dual Shadow Method* section in [Neil Fraser's article](https://neil.fraser.name/writing/sync/). Also note a number of academic publications by [Benjamin Pierce](http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization) about *Unison* and synchronization in general. ## Changelog ### `v1.74.2` - Fixed an issue causing `--conflict-loser pathname` to produce unexpected behavior if using a non-default `--conflict-resolve` value. ### `v1.74` - Added several missing `rc` parameters. - Optional `rc` parameters are now truly optional. - `rc` output now provides more structured information. ### `v1.71` - `bisync` is now officially released from beta. - Fixed an issue causing hash type to be set incorrectly if `path2` had slow hashes and `--no-slow-hash` or `--slow-hash-sync-only` was in use. - Fixed an issue causing errors when running concurrent bisync runs through the `rc`. ### `v1.69.1` - Fixed an issue causing listings to not capture concurrent modifications under certain conditions ### `v1.68` - Fixed an issue affecting backends that round modtimes to a lower precision. ### `v1.67` - Added integration tests against all backends. ### `v1.66` - Copies and deletes are now handled in one operation instead of two - `--track-renames` and `--backup-dir` are now supported - Partial uploads known issue on `local`/`ftp`/`sftp` has been resolved (unless using `--inplace`) - Final listings are now generated from sync results, to avoid needing to re-list - Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes - Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time. - A few basic terminal colors are now supported, controllable with [`--color`](https://rclone.org/docs/#color) (`AUTO`|`NEVER`|`ALWAYS`) - Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as `check` and `sync`, for performance improvements and less [risk of error](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=4.%20Listings%20should%20alternate%20between%20paths%20to%20minimize%20errors). - Fixed handling of unicode normalization and case insensitivity, support for [`--fix-case`](https://rclone.org/docs/#fix-case), [`--ignore-case-sync`](/docs/#ignore-case-sync), [`--no-unicode-normalization`](https://rclone.org/docs/#no-unicode-normalization) - `--resync` is now much more efficient (especially for users of `--create-empty-src-dirs`) - Google Docs (and other files of unknown size) are now supported (with the same options as in `sync`) - Equality checks before a sync conflict rename now fall back to `cryptcheck` (when possible) or `--download`, instead of of `--size-only`, when `check` is not available. - Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags. - Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support. - Bisync now supports a "Graceful Shutdown" mode to cleanly cancel a run early without requiring `--resync`. - New `--recover` flag allows robust recovery in the event of interruptions, without requiring `--resync`. - A new `--max-lock` setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted. - Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new [`--conflict-resolve`](#conflict-resolve), [`--conflict-loser`](#conflict-loser), and [`--conflict-suffix`](#conflict-suffix) flags. - A new [`--resync-mode`](#resync-mode) flag allows more control over which version of a file gets kept during a `--resync`. - Bisync now supports [`--retries`](https://rclone.org/docs/#retries-int) and [`--retries-sleep`](/docs/#retries-sleep-time) (when [`--resilient`](#resilient) is set.) ### `v1.64` - Fixed an [issue](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Dry%20runs%20are%20not%20completely%20dry) causing dry runs to inadvertently commit filter changes - Fixed an [issue](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20%2D%2Dresync%20deletes%20data%2C%20contrary%20to%20docs) causing `--resync` to erroneously delete empty folders and duplicate files unique to Path2 - `--check-access` is now enforced during `--resync`, preventing data loss in [certain user error scenarios](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should) - Fixed an [issue](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=5.%20Bisync%20reads%20files%20in%20excluded%20directories%20during%20delete%20operations) causing bisync to consider more files than necessary due to overbroad filters during delete operations - [Improved detection of false positive change conflicts](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Identical%20files%20should%20be%20left%20alone%2C%20even%20if%20new/newer/changed%20on%20both%20sides) (identical files are now left alone instead of renamed) - Added [support for `--create-empty-src-dirs`](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20Bisync%20should%20create/delete%20empty%20directories%20as%20sync%20does%2C%20when%20%2D%2Dcreate%2Dempty%2Dsrc%2Ddirs%20is%20passed) - Added experimental `--resilient` mode to allow [recovery from self-correctable errors](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20Bisync%20should%20be%20more%20resilient%20to%20self%2Dcorrectable%20errors) - Added [new `--ignore-listing-checksum` flag](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20%2D%2Dignore%2Dchecksum%20should%20be%20split%20into%20two%20flags%20for%20separate%20purposes) to distinguish from `--ignore-checksum` - [Performance improvements](https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20Deletes%20take%20several%20times%20longer%20than%20copies) for large remotes - Documentation and testing improvements # Release signing The hashes of the binary artefacts of the rclone release are signed with a public PGP/GPG key. This can be verified manually as described below. The same mechanism is also used by [rclone selfupdate](https://rclone.org/commands/rclone_selfupdate/) to verify that the release has not been tampered with before the new update is installed. This checks the SHA256 hash and the signature with a public key compiled into the rclone binary. ## Release signing key You may obtain the release signing key from: - From [KEYS](/KEYS) on this website - this file contains all past signing keys also. - The git repository hosted on GitHub - - `gpg --keyserver hkps://keys.openpgp.org --search nick@craig-wood.com` - `gpg --keyserver hkps://keyserver.ubuntu.com --search nick@craig-wood.com` - After importing the key, verify that the fingerprint of one of the keys matches: `FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA` ads this key is used for signing. We recommend that you cross-check the fingerprint shown above through the domains listed below. By cross-checking the integrity of the fingerprint across multiple domains you can be confident that you obtained the correct key. - The [source for this page on GitHub](https://github.com/rclone/rclone/blob/master/docs/content/release_signing.md). - Through DNS `dig key.rclone.org txt` If you find anything that doesn't not match, please contact the developers at once. ## How to verify the release In the release directory you will see the release files and some files called `MD5SUMS`, `SHA1SUMS` and `SHA256SUMS`. ```console $ rclone lsf --http-url https://downloads.rclone.org/v1.63.1 :http: MD5SUMS SHA1SUMS SHA256SUMS rclone-v1.63.1-freebsd-386.zip rclone-v1.63.1-freebsd-amd64.zip ... rclone-v1.63.1-windows-arm64.zip rclone-v1.63.1.tar.gz version.txt ``` The `MD5SUMS`, `SHA1SUMS` and `SHA256SUMS` contain hashes of the binary files in the release directory along with a signature. For example: ```console $ rclone cat --http-url https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 f6d1b2d7477475ce681bdce8cb56f7870f174cb6b2a9ac5d7b3764296ea4a113 rclone-v1.63.1-freebsd-386.zip 7266febec1f01a25d6575de51c44ddf749071a4950a6384e4164954dff7ac37e rclone-v1.63.1-freebsd-amd64.zip ... 66ca083757fb22198309b73879831ed2b42309892394bf193ff95c75dff69c73 rclone-v1.63.1-windows-amd64.zip bbb47c16882b6c5f2e8c1b04229378e28f68734c613321ef0ea2263760f74cd0 rclone-v1.63.1-windows-arm64.zip -----BEGIN PGP SIGNATURE----- iF0EARECAB0WIQT79zfs6firGGBL0qyTk14C/ztU+gUCZLVKJQAKCRCTk14C/ztU +pZuAJ0XJ+QWLP/3jCtkmgcgc4KAwd/rrwCcCRZQ7E+oye1FPY46HOVzCFU3L7g= =8qrL -----END PGP SIGNATURE----- ``` ### Download the files The first step is to download the binary and SUMs file and verify that the SUMs you have downloaded match. Here we download `rclone-v1.63.1-windows-amd64.zip` - choose the binary (or binaries) appropriate to your architecture. We've also chosen the `SHA256SUMS` as these are the most secure. You could verify the other types of hash also for extra security. `rclone selfupdate` verifies just the `SHA256SUMS`. ```console mkdir /tmp/check cd /tmp/check rclone copy --http-url https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS . rclone copy --http-url https://downloads.rclone.org/v1.63.1 :http:rclone-v1.63.1-windows-amd64.zip . ``` ### Verify the signatures First verify the signatures on the SHA256 file. Import the key. See above for ways to verify this key is correct. ```console $ gpg --keyserver keyserver.ubuntu.com --receive-keys FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: key 93935E02FF3B54FA: public key "Nick Craig-Wood " imported gpg: Total number processed: 1 gpg: imported: 1 ``` Then check the signature: ```console $ gpg --verify SHA256SUMS gpg: Signature made Mon 17 Jul 2023 15:03:17 BST gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: Good signature from "Nick Craig-Wood " [ultimate] ``` Verify the signature was good and is using the fingerprint shown above. Repeat for `MD5SUMS` and `SHA1SUMS` if desired. ### Verify the hashes Now that we know the signatures on the hashes are OK we can verify the binaries match the hashes, completing the verification. ```console $ sha256sum -c SHA256SUMS 2>&1 | grep OK rclone-v1.63.1-windows-amd64.zip: OK ``` Or do the check with rclone ```console $ rclone hashsum sha256 -C SHA256SUMS rclone-v1.63.1-windows-amd64.zip 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 0 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 1 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 49 2023/09/11 10:53:58 NOTICE: SHA256SUMS: 4 warning(s) suppressed... = rclone-v1.63.1-windows-amd64.zip 2023/09/11 10:53:58 NOTICE: Local file system at /tmp/check: 0 differences found 2023/09/11 10:53:58 NOTICE: Local file system at /tmp/check: 1 matching files ``` ### Verify signatures and hashes together You can verify the signatures and hashes in one command line like this: ```console $ h=$(gpg --decrypt SHA256SUMS) && echo "$h" | sha256sum - -c --ignore-missing gpg: Signature made Mon 17 Jul 2023 15:03:17 BST gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: Good signature from "Nick Craig-Wood " [ultimate] gpg: aka "Nick Craig-Wood " [unknown] rclone-v1.63.1-windows-amd64.zip: OK ``` # 1Fichier This is a backend for the [1fichier](https://1fichier.com) cloud storage service. Note that a Premium subscription is required to use the API. Paths are specified as `remote:path` Paths may be as deep as required, e.g. `remote:directory/subdirectory`. ## Configuration The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser. Here is an example of how to make a remote called `remote`. First run: ```console rclone config ``` This will guide you through an interactive setup process: ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / 1Fichier \ "fichier" [snip] Storage> fichier ** See help for fichier backend at: https://rclone.org/fichier/ ** Your API Key, get it from https://1fichier.com/console/params.pl Enter a string value. Press Enter for the default (""). api_key> example_key Edit advanced config? (y/n) y) Yes n) No y/n> Remote config Configuration complete. Options: - type: fichier - api_key: example_key Keep this "remote" remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` Once configured you can then use `rclone` like this (replace `remote` with the name you gave your remote): List directories in top level of your 1Fichier account ```console rclone lsd remote: ``` List all the files in your 1Fichier account ```console rclone ls remote: ``` To copy a local directory to a 1Fichier directory called backup ```console rclone copy /home/source remote:backup ``` ### Modification times and hashes 1Fichier does not support modification times. It supports the Whirlpool hash algorithm. ### Duplicated files 1Fichier can have two files with exactly the same name and path (unlike a normal file system). Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. ### Restricted filename characters In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) the following characters are also replaced: | Character | Value | Replacement | | --------- |:-----:|:-----------:| | \ | 0x5C | ＼ | | < | 0x3C | ＜ | | > | 0x3E | ＞ | | " | 0x22 | ＂ | | $ | 0x24 | ＄ | | ` | 0x60 | ｀ | | ' | 0x27 | ＇ | File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name: | Character | Value | Replacement | | --------- |:-----:|:-----------:| | SP | 0x20 | ␠ | Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), as they can't be used in JSON strings. ### Standard options Here are the Standard options specific to fichier (1Fichier). #### --fichier-api-key Your API Key, get it from https://1fichier.com/console/params.pl. Properties: - Config: api_key - Env Var: RCLONE_FICHIER_API_KEY - Type: string - Required: false ### Advanced options Here are the Advanced options specific to fichier (1Fichier). #### --fichier-shared-folder If you want to download a shared folder, add this parameter. Properties: - Config: shared_folder - Env Var: RCLONE_FICHIER_SHARED_FOLDER - Type: string - Required: false #### --fichier-file-password If you want to download a shared file that is password protected, add this parameter. **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). Properties: - Config: file_password - Env Var: RCLONE_FICHIER_FILE_PASSWORD - Type: string - Required: false #### --fichier-folder-password If you want to list the files in a shared folder that is password protected, add this parameter. **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). Properties: - Config: folder_password - Env Var: RCLONE_FICHIER_FOLDER_PASSWORD - Type: string - Required: false #### --fichier-cdn Set if you wish to use CDN download links. Properties: - Config: cdn - Env Var: RCLONE_FICHIER_CDN - Type: bool - Default: false #### --fichier-encoding The encoding for the backend. See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. Properties: - Config: encoding - Env Var: RCLONE_FICHIER_ENCODING - Type: Encoding - Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot #### --fichier-description Description of the remote. Properties: - Config: description - Env Var: RCLONE_FICHIER_DESCRIPTION - Type: string - Required: false ## Limitations `rclone about` is not supported by the 1Fichier backend. Backends without this capability cannot determine free space for an rclone mount or use policy `mfs` (most free space) as a member of an rclone union remote. See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/). # Alias The `alias` remote provides a new name for another remote. Paths may be as deep as required or a local path, e.g. `remote:directory/subdirectory` or `/directory/subdirectory`. During the initial setup with `rclone config` you will specify the target remote. The target remote can either be a local path or another remote. Subfolders can be used in target remote. Assume an alias remote named `backup` with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. There will be no special handling of paths containing `..` segments. Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking `rclone mkdir mydrive:private/backup/../desktop`. The empty path is not allowed as a remote. To alias the current directory use `.` instead. The target remote can also be a [connection string](https://rclone.org/docs/#connection-strings). This can be used to modify the config of a remote for different uses, e.g. the alias `myDriveTrash` with the target remote `myDrive,trashed_only:` can be used to only show the trashed files in `myDrive`. ## Configuration Here is an example of how to make an alias called `remote` for local folder. First run: ```console rclone config ``` This will guide you through an interactive setup process: ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Alias for an existing remote \ "alias" [snip] Storage> alias Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". remote> /mnt/storage/backup Remote config Configuration complete. Options: - type: alias - remote: /mnt/storage/backup Keep this "remote" remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== remote alias e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q> q ``` Once configured you can then use `rclone` like this (replace `remote` with the name you gave your remote): List directories in top level in `/mnt/storage/backup` ```console rclone lsd remote: ``` List all the files in `/mnt/storage/backup` ```console rclone ls remote: ``` Copy another local directory to the alias directory called source ```console rclone copy /home/source remote:source ``` ### Standard options Here are the Standard options specific to alias (Alias for an existing remote). #### --alias-remote Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". Properties: - Config: remote - Env Var: RCLONE_ALIAS_REMOTE - Type: string - Required: true ### Advanced options Here are the Advanced options specific to alias (Alias for an existing remote). #### --alias-description Description of the remote. Properties: - Config: description - Env Var: RCLONE_ALIAS_DESCRIPTION - Type: string - Required: false # Amazon S3 Storage Providers The S3 backend can be used with a number of different providers: - AWS S3 - Alibaba Cloud (Aliyun) Object Storage System (OSS) - Ceph - China Mobile Ecloud Elastic Object Storage (EOS) - Cloudflare R2 - Arvan Cloud Object Storage (AOS) - Bizfly Cloud Simple Storage - Cubbit DS3 - DigitalOcean Spaces - Dreamhost - Exaba - Fastly Object Storage - FileLu S5 (S3-Compatible Object Storage) - GCS - Hetzner - Hitachi Content Platform (HCP) - Huawei OBS - IBM COS S3 - IDrive e2 - Impossible Cloud - Intercolo Object Storage - IONOS Cloud - Leviia Object Storage - Liara Object Storage - Linode Object Storage - Magalu Object Storage - MEGA S4 Object Storage - Minio - Outscale - OVHcloud - Petabox - Pure Storage FlashBlade - Qiniu Cloud Object Storage (Kodo) - Rabata Cloud Storage - RackCorp Object Storage - Rclone Serve S3 - Scaleway - Scality (RING / ARTESCA) - Seagate Lyve Cloud - SeaweedFS - Selectel - Servercore Object Storage - Spectra Logic - Storj - Synology C2 Object Storage - Tencent Cloud Object Storage (COS) - US3 - Wasabi - Zadara Object Storage - Zata - Zero Services (ZERO-Z3) Paths are specified as `remote:bucket` (or `remote:` for the `lsd` command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. Once you have made a remote (see the provider specific section above) you can use it like this: See all buckets ```console rclone lsd remote: ``` Make a new bucket ```console rclone mkdir remote:bucket ``` List the contents of a bucket ```console rclone ls remote:bucket ``` Sync `/home/local/directory` to the remote bucket, deleting any excess files in the bucket. ```console rclone sync --interactive /home/local/directory remote:bucket ``` ## Configuration Here is an example of making an s3 configuration for the AWS S3 provider. Most applies to the other providers as well, any differences are described [below](#providers). First run ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ "s3" [snip] Storage> s3 Choose your S3 provider. Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \ "AWS" 2 / Ceph Object Storage \ "Ceph" 3 / DigitalOcean Spaces \ "DigitalOcean" 4 / Dreamhost DreamObjects \ "Dreamhost" 5 / IBM COS S3 \ "IBMCOS" 6 / Minio Object Storage \ "Minio" 7 / Wasabi Object Storage \ "Wasabi" 8 / Any other S3 compatible provider \ "Other" provider> 1 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \ "false" 2 / Get AWS credentials from the environment (env vars or IAM) \ "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> XXX AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YYY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia, or Pacific Northwest. | Leave location constraint empty. \ "us-east-1" / US East (Ohio) Region 2 | Needs location constraint us-east-2. \ "us-east-2" / US West (Oregon) Region 3 | Needs location constraint us-west-2. \ "us-west-2" / US West (Northern California) Region 4 | Needs location constraint us-west-1. \ "us-west-1" / Canada (Central) Region 5 | Needs location constraint ca-central-1. \ "ca-central-1" / EU (Ireland) Region 6 | Needs location constraint EU or eu-west-1. \ "eu-west-1" / EU (London) Region 7 | Needs location constraint eu-west-2. \ "eu-west-2" / EU (Frankfurt) Region 8 | Needs location constraint eu-central-1. \ "eu-central-1" / Asia Pacific (Singapore) Region 9 | Needs location constraint ap-southeast-1. \ "ap-southeast-1" / Asia Pacific (Sydney) Region 10 | Needs location constraint ap-southeast-2. \ "ap-southeast-2" / Asia Pacific (Tokyo) Region 11 | Needs location constraint ap-northeast-1. \ "ap-northeast-1" / Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2. \ "ap-northeast-2" / Asia Pacific (Mumbai) 13 | Needs location constraint ap-south-1. \ "ap-south-1" / Asia Pacific (Hong Kong) Region 14 | Needs location constraint ap-east-1. \ "ap-east-1" / South America (Sao Paulo) Region 15 | Needs location constraint sa-east-1. \ "sa-east-1" region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. endpoint> Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. \ "" 2 / US East (Ohio) Region. \ "us-east-2" 3 / US West (Oregon) Region. \ "us-west-2" 4 / US West (Northern California) Region. \ "us-west-1" 5 / Canada (Central) Region. \ "ca-central-1" 6 / EU (Ireland) Region. \ "eu-west-1" 7 / EU (London) Region. \ "eu-west-2" 8 / EU Region. \ "EU" 9 / Asia Pacific (Singapore) Region. \ "ap-southeast-1" 10 / Asia Pacific (Sydney) Region. \ "ap-southeast-2" 11 / Asia Pacific (Tokyo) Region. \ "ap-northeast-1" 12 / Asia Pacific (Seoul) \ "ap-northeast-2" 13 / Asia Pacific (Mumbai) \ "ap-south-1" 14 / Asia Pacific (Hong Kong) \ "ap-east-1" 15 / South America (Sao Paulo) Region. \ "sa-east-1" location_constraint> 1 Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). \ "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. \ "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 3 | Granting this on a bucket is generally not recommended. \ "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. \ "authenticated-read" / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. \ "bucket-owner-read" / Both the object owner and the bucket owner get FULL_CONTROL over the object. 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. \ "bucket-owner-full-control" acl> 1 The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None \ "" 2 / AES256 \ "AES256" server_side_encryption> 1 The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default \ "" 2 / Standard storage class \ "STANDARD" 3 / Reduced redundancy storage class \ "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access storage class \ "STANDARD_IA" 5 / One Zone Infrequent Access storage class \ "ONEZONE_IA" 6 / Glacier Flexible Retrieval storage class \ "GLACIER" 7 / Glacier Deep Archive storage class \ "DEEP_ARCHIVE" 8 / Intelligent-Tiering storage class \ "INTELLIGENT_TIERING" 9 / Glacier Instant Retrieval storage class \ "GLACIER_IR" storage_class> 1 Remote config Configuration complete. Options: - type: s3 - provider: AWS - env_auth: false - access_key_id: XXX - secret_access_key: YYY - region: us-east-1 - endpoint: - location_constraint: - acl: private - server_side_encryption: - storage_class: Keep this "remote" remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> ``` ### Modification times and hashes #### Modification times The modified time is stored as metadata on the object as `X-Amz-Meta-Mtime` as floating point since the epoch, accurate to 1 ns. If the modification time needs to be updated rclone will attempt to perform a server side copy to update the modification if the object can be copied in a single part. In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive storage the object will be uploaded rather than copied. Note that reading this from the object takes an additional `HEAD` request as the metadata isn't returned in object listings. #### Hashes For small objects which weren't uploaded as multipart uploads (objects sized below `--s3-upload-cutoff` if uploaded with rclone) rclone uses the `ETag:` header as an MD5 checksum. However for objects which were uploaded as multipart uploads or with server side encryption (SSE-AWS or SSE-C) the `ETag` header is no longer the MD5 sum of the data, so rclone adds an additional piece of metadata `X-Amz-Meta-Md5chksum` which is a base64 encoded MD5 hash (in the same format as is required for `Content-MD5`). You can use base64 -d and hexdump to check this value manually: ```console echo 'VWTGdNx3LyXQDfA0e2Edxw==' | base64 -d | hexdump ``` or you can use `rclone check` to verify the hashes are OK. For large objects, calculating this hash can take some time so the addition of this hash can be disabled with `--s3-disable-checksum`. This will mean that these objects do not have an MD5 checksum. Note that reading this from the object takes an additional `HEAD` request as the metadata isn't returned in object listings. ### Reducing costs #### Avoiding HEAD requests to read the modification time By default, rclone will use the modification time of objects stored in S3 for syncing. This is stored in object metadata which unfortunately takes an extra HEAD request to read which can be expensive (in time and money). The modification time is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient on S3 because it requires an extra API call to retrieve the metadata. The extra API calls can be avoided when syncing (using `rclone sync` or `rclone copy`) in a few different ways, each with its own tradeoffs. - `--size-only` - Only checks the size of files. - Uses no extra transactions. - If the file doesn't change size then rclone won't detect it has changed. - `rclone sync --size-only /path/to/source s3:bucket` - `--checksum` - Checks the size and MD5 checksum of files. - Uses no extra transactions. - The most accurate detection of changes possible. - Will cause the source to read an MD5 checksum which, if it is a local disk, will cause lots of disk activity. - If the source and destination are both S3 this is the **recommended** flag to use for maximum efficiency. - `rclone sync --checksum /path/to/source s3:bucket` - `--update --use-server-modtime` - Uses no extra transactions. - Modification time becomes the time the object was uploaded. - For many operations this is sufficient to determine if it needs uploading. - Using `--update` along with `--use-server-modtime`, avoids the extra API call and uploads files whose local modification time is newer than the time it was last uploaded. - Files created with timestamps in the past will be missed by the sync. - `rclone sync --update --use-server-modtime /path/to/source s3:bucket` These flags can and should be used in combination with `--fast-list` - see below. If using `rclone mount` or any command using the VFS (eg `rclone serve`) commands then you might want to consider using the VFS flag `--no-modtime` which will stop rclone reading the modification time for every object. You could also use `--use-server-modtime` if you are happy with the modification times of the objects being the time of upload. #### Avoiding GET requests to read directory listings Rclone's default directory traversal is to process each directory individually. This takes one API call per directory. Using the `--fast-list` flag will read all info about the objects into memory first using a smaller number of API calls (one per 1000 objects). See the [rclone docs](https://rclone.org/docs/#fast-list) for more details. ```console rclone sync --fast-list --checksum /path/to/source s3:bucket ``` `--fast-list` trades off API transactions for memory use. As a rough guide rclone uses 1k of memory per object stored, so using `--fast-list` on a sync of a million objects will use roughly 1 GiB of RAM. If you are only copying a small number of files into a big repository then using `--no-traverse` is a good idea. This finds objects directly instead of through directory listings. You can do a "top-up" sync very cheaply by using `--max-age` and `--no-traverse` to copy only recent files, eg ```console rclone copy --max-age 24h --no-traverse /path/to/source s3:bucket ``` You'd then do a full `rclone sync` less often. Note that `--fast-list` isn't required in the top-up sync. #### Avoiding HEAD requests after PUT By default, rclone will HEAD every object it uploads. It does this to check the object got uploaded correctly. You can disable this with the [--s3-no-head](#s3-no-head) option - see there for more details. Setting this flag increases the chance for undetected upload failures. ### Increasing performance #### Using server-side copy If you are copying objects between S3 buckets in the same region, you should use server-side copy. This is much faster than downloading and re-uploading the objects, as no data is transferred. For rclone to use server-side copy, you must use the same remote for the source and destination. ```console rclone copy s3:source-bucket s3:destination-bucket ``` When using server-side copy, the performance is limited by the rate at which rclone issues API requests to S3. See below for how to increase the number of API requests rclone makes. #### Increasing the rate of API requests You can increase the rate of API requests to S3 by increasing the parallelism using `--transfers` and `--checkers` options. Rclone uses a very conservative defaults for these settings, as not all providers support high rates of requests. Depending on your provider, you can increase significantly the number of transfers and checkers. For example, with AWS S3, if you can increase the number of checkers to values like 200. If you are doing a server-side copy, you can also increase the number of transfers to 200. ```console rclone sync --transfers 200 --checkers 200 --checksum s3:source-bucket s3:destination-bucket ``` You will need to experiment with these values to find the optimal settings for your setup. ### Data integrity Rclone does its best to verify every part of an upload or download to the s3 provider using various hashes. Every HTTP transaction to/from the provider has a `X-Amz-Content-Sha256` or a `Content-Md5` header to guard against corruption of the HTTP body. The HTTP Header is protected by the signature passed in the `Authorization` header. All communications with the provider is done over https for encryption and additional error protection. #### Single part uploads - Rclone uploads single part uploads with a `Content-Md5` using the MD5 hash read from the source. The provider checks this is correct on receipt of the data. - Rclone then does a HEAD request (disable with `--s3-no-head`) to read the `ETag` back which is the MD5 of the file and checks that with what it sent. Note that if the source does not have an MD5 then the single part uploads will not have hash protection. In this case it is recommended to use `--s3-upload-cutoff 0` so all files are uploaded as multipart uploads. #### Multipart uploads For files above `--s3-upload-cutoff` rclone splits the file into multiple parts for upload. - Each part is protected with both an `X-Amz-Content-Sha256` and a `Content-Md5` When rclone has finished the upload of all the parts it then completes the upload by sending: - The MD5 hash of each part - The number of parts - This info is all protected with a `X-Amz-Content-Sha256` The provider checks the MD5 for all the parts it has received against what rclone sends and if it is good it returns OK. Rclone then does a HEAD request (disable with `--s3-no-head`) and checks the ETag is what it expects (in this case it should be the MD5 sum of all the MD5 sums of all the parts with the number of parts on the end). If the source has an MD5 sum then rclone will attach the `X-Amz-Meta-Md5chksum` with it as the `ETag` for a multipart upload can't easily be checked against the file as the chunk size must be known in order to calculate it. #### Downloads Rclone checks the MD5 hash of the data downloaded against either the ETag or the `X-Amz-Meta-Md5chksum` metadata (if present) which rclone uploads with multipart uploads. #### Further checking At each stage rclone and the provider are sending and checking hashes of **everything**. Rclone deliberately HEADs each object after upload to check it arrived safely for extra security. (You can disable this with `--s3-no-head`). If you require further assurance that your data is intact you can use `rclone check` to check the hashes locally vs the remote. And if you are feeling ultimately paranoid use `rclone check --download` which will download the files and check them against the local copies. (Note that this doesn't use disk to do this - it streams them in memory). ### Versions When bucket versioning is enabled (this can be done with rclone with the [`rclone backend versioning`](#versioning) command) when rclone uploads a new version of a file it creates a [new version of it](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) Likewise when you delete a file, the old version will be marked hidden and still be available. Old versions of files, where available, are visible using the [`--s3-versions`](#s3-versions) flag. It is also possible to view a bucket as it was at a certain point in time, using the [`--s3-version-at`](#s3-version-at) flag. This will show the file versions as they were at that time, showing files that have been deleted afterwards, and hiding files that were created since. If you wish to remove all the old versions then you can use the [`rclone backend cleanup-hidden remote:bucket`](#cleanup-hidden) command which will delete all the old hidden versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, e.g. `rclone backend cleanup-hidden remote:bucket/path/to/stuff`. When you `purge` a bucket, the current and the old versions will be deleted then the bucket will be deleted. However `delete` will cause the current versions of the files to become hidden old versions. Here is a session showing the listing and retrieval of an old version followed by a `cleanup` of the old versions. Show current version and all the versions with `--s3-versions` flag. ```console $ rclone -q ls s3:cleanup-test 9 one.txt $ rclone -q --s3-versions ls s3:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt ``` Retrieve an old version ```console $ rclone -q --s3-versions copy s3:cleanup-test/one-v2016-07-04-141003-000.txt /tmp $ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt ``` Clean up all the old versions and show that they've gone. ```console $ rclone -q backend cleanup-hidden s3:cleanup-test $ rclone -q ls s3:cleanup-test 9 one.txt $ rclone -q --s3-versions ls s3:cleanup-test 9 one.txt ``` #### Versions naming caveat When using `--s3-versions` flag rclone is relying on the file name to work out whether the objects are versions or not. Versions' names are created by inserting timestamp between file name and its extension. ```text 9 file.txt 8 file-v2023-07-17-161032-000.txt 16 file-v2023-06-15-141003-000.txt ``` If there are real files present with the same names as versions, then behaviour of `--s3-versions` can be unpredictable. ### Cleanup If you run `rclone cleanup s3:bucket` then it will remove all pending multipart uploads older than 24 hours. You can use the `--interactive`/`i` or `--dry-run` flag to see exactly what it will do. If you want more control over the expiry date then run `rclone backend cleanup s3:bucket -o max-age=1h` to expire all uploads older than one hour. You can use `rclone backend list-multipart-uploads s3:bucket` to see the pending multipart uploads. ### Restricted filename characters S3 allows any valid UTF-8 string as a key. Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), as they can't be used in XML. The following characters are replaced since these are problematic when dealing with the REST API: | Character | Value | Replacement | | --------- |:-----:|:-----------:| | NUL | 0x00 | ␀ | | / | 0x2F | ／ | The encoding will also encode these file names as they don't seem to work with the SDK properly: | File name | Replacement | | --------- |:-----------:| | . | ． | | .. | ．． | #### Important note about double slashes (`//`) Object keys containing consecutive forward slashes (`//`) are **not supported** by rclone. When rclone encounters an object key with `//` (e.g., `a//b`), it will normalize the path to use a single slash (e.g., `a/b`). This normalization can cause "object not found" errors when trying to access the original object, as rclone will look for the normalized path instead of the actual object key. **Example:** - Original S3 object key: `folder//file.txt` - rclone interprets it as: `folder/file.txt` - Result: "object not found" error when trying to access `folder//file.txt` **Workaround:** Avoid using consecutive forward slashes (`//`) in S3 object keys when using rclone. If you have existing objects with `//` in their keys, you will need to rename them to use single slashes or access them through other means. ### Multipart uploads rclone supports multipart uploads with S3 which means that it can upload files bigger than 5 GiB. Note that files uploaded *both* with multipart upload *and* through crypt remotes do not have MD5 sums. rclone switches from single part uploads to multipart uploads at the point specified by `--s3-upload-cutoff`. This can be a maximum of 5 GiB and a minimum of 0 (ie always upload multipart files). The chunk sizes used in the multipart upload are specified by `--s3-chunk-size` and the number of chunks uploaded concurrently is specified by `--s3-upload-concurrency`. Multipart uploads will use extra memory equal to: `--transfers` × `--s3-upload-concurrency` × `--s3-chunk-size`. Single part uploads do not use extra memory. Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 - the more latency, the more likely single part transfers will be faster. Increasing `--s3-upload-concurrency` will increase throughput (8 would be a sensible value) and increasing `--s3-chunk-size` also increases throughput (16M would be sensible). Increasing either of these will use more memory. The default values are high enough to gain most of the possible performance without using too much memory. ### Buckets and Regions With Amazon S3 you can list buckets (`rclone lsd`) using any region, but you can only access the content of a bucket from the region it was created in. If you attempt to access a bucket from the wrong region, you will get an error, `incorrect region, the bucket is not in 'XXX' region`. ### Authentication There are a number of ways to supply `rclone` with a set of AWS credentials, with and without using the environment. The different authentication methods are tried in this order: - Directly in the rclone configuration file (`env_auth = false` in the config file): - `access_key_id` and `secret_access_key` are required. - `session_token` can be optionally set when using AWS STS. - Runtime configuration (`env_auth = true` in the config file): - Export the following environment variables before running `rclone`: - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` - Session Token: `AWS_SESSION_TOKEN` (optional) - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html): - Profile files are standard files used by AWS CLI tools - By default it will use the profile in your home directory (e.g. `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables or config keys: - `AWS_SHARED_CREDENTIALS_FILE` to control which file or the `shared_credentials_file` config key. - `AWS_PROFILE` to control which profile to use or the `profile` config key. - Or, run `rclone` in an ECS task with an IAM role (AWS only). - Or, run `rclone` on an EC2 instance with an IAM role (AWS only). - Or, run `rclone` in an EKS pod with an IAM role that is associated with a service account (AWS only). - Or, use [process credentials](https://docs.aws.amazon.com/sdkref/latest/guide/feature-process-credentials.html) to read config from an external program. With `env_auth = true` rclone (which uses the SDK for Go v2) should support [all authentication methods](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html) that the `aws` CLI tool does and the other AWS SDKs. If none of these option actually end up providing `rclone` with AWS credentials then S3 interaction will be non-authenticated (see the [anonymous access](#anonymous-access) section for more info). #### Assume Role (Cross-Account Access) If you need to access S3 resources in a different AWS account, you can use IAM role assumption. This is useful for cross-account access scenarios where you have credentials in one account but need to access resources in another account. To use assume role, configure the following parameters: - `role_arn` - The ARN (Amazon Resource Name) of the IAM role to assume in the target account. Format: `arn:aws:iam::ACCOUNT-ID:role/ROLE-NAME` - `role_session_name` (optional) - A name for the assumed role session. If not specified, rclone will generate one automatically. - `role_session_duration` (optional) - Duration for which the assumed role credentials are valid. If not specified, AWS default duration will be used (typically 1 hour). - `role_external_id` (optional) - An external ID required by the role's trust policy for additional security. This is typically used when the role is accessed by a third party. The assume role feature works with both direct credentials (`env_auth = false`) and environment-based authentication (`env_auth = true`). Rclone will first authenticate using the base credentials, then use those credentials to assume the specified role. Example configuration for cross-account access: ``` [s3-cross-account] type = s3 provider = AWS env_auth = true region = us-east-1 role_arn = arn:aws:iam::123456789012:role/CrossAccountS3Role role_session_name = rclone-session role_external_id = unique-role-external-id-12345 ``` In this example: - Base credentials are obtained from the environment (IAM role, credentials file, or environment variables) - These credentials are then used to assume the role `CrossAccountS3Role` in account `123456789012` - An external ID is provided for additional security as required by the role's trust policy The target role's trust policy in the destination account must allow the source account or user to assume it. Example trust policy: ```json { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::SOURCE-ACCOUNT-ID:root" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalID": "unique-role-external-id-12345" } } } ] } ``` ### S3 Permissions When using the `sync` subcommand of `rclone` the following minimum permissions are required to be available on the bucket being written to: - `ListBucket` - `DeleteObject` - `GetObject` - `PutObject` - `PutObjectACL` - `CreateBucket` (unless using [s3-no-check-bucket](#s3-no-check-bucket)) When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required. Example policy: ```json { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" }, "Action": [ "s3:ListBucket", "s3:DeleteObject", "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ "arn:aws:s3:::BUCKET_NAME/*", "arn:aws:s3:::BUCKET_NAME" ] }, { "Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": "arn:aws:s3:::*" } ] } ``` Notes on above: 1. This is a policy that can be used when creating bucket. It assumes that `USER_NAME` has been created. 2. The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket's objects. 3. When using [s3-no-check-bucket](#s3-no-check-bucket) and the bucket already exists, the `"arn:aws:s3:::BUCKET_NAME"` doesn't have to be included. For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) that will generate one or more buckets that will work with `rclone sync`. ### Key Management System (KMS) If you are using server-side encryption with KMS then you must make sure rclone is configured with `server_side_encryption = aws:kms` otherwise you will find you can't transfer small objects - these will create checksum errors. ### Glacier and Glacier Deep Archive You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below. ```text 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file ``` In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) the object(s) in question before accessing object contents. The [restore](#restore) section below shows how to do this with rclone. Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults. ### Object-lock enabled S3 bucket According to AWS's [documentation on S3 Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission): > If you configure a default retention period on a bucket, requests to upload objects in such a bucket must include the Content-MD5 header. Rclone automatically computes and includes the Content-MD5 header when uploading objects with Object Lock parameters set. No special configuration is needed. #### Setting Object Lock retention Rclone supports setting Object Lock retention on uploaded objects with the following options: - `--s3-object-lock-mode` - Set the Object Lock mode (GOVERNANCE or COMPLIANCE) - `--s3-object-lock-retain-until-date` - Set the retention date (RFC3339 format or duration like `365d`, `24h`) - `--s3-object-lock-legal-hold-status` - Set legal hold (ON or OFF) Example - upload files with 1 year GOVERNANCE retention: rclone copy local:/data remote:bucket \ --s3-object-lock-mode GOVERNANCE \ --s3-object-lock-retain-until-date 365d #### Copying Object Lock settings from source When using `--metadata`, you can use the special value `copy` to preserve the source object's Object Lock settings: rclone copy source:bucket dest:bucket \ --metadata \ --s3-object-lock-mode copy \ --s3-object-lock-retain-until-date copy You can also mix copied and explicit values. For example, to change the mode from COMPLIANCE to GOVERNANCE while preserving the original retention date: rclone copy source:bucket dest:bucket \ --metadata \ --s3-object-lock-mode GOVERNANCE \ --s3-object-lock-retain-until-date copy #### Additional Object Lock options - `--s3-bypass-governance-retention` - Required to delete or overwrite objects with GOVERNANCE mode retention before the retention date expires - `--s3-bucket-object-lock-enabled` - Enable Object Lock when creating a new bucket with `rclone mkdir` - `--s3-object-lock-set-after-upload` - Set Object Lock via separate API calls after upload (for providers that don't support Object Lock headers during PUT) ### Standard options Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, Scality, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, ZeroServices, Other). #### --s3-provider Choose your S3 provider. Properties: - Config: provider - Env Var: RCLONE_S3_PROVIDER - Type: string - Required: false - Examples: - "AWS" - Amazon Web Services (AWS) S3 - "Alibaba" - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - "ArvanCloud" - Arvan Cloud Object Storage (AOS) - "BizflyCloud" - Bizfly Cloud Simple Storage - "Ceph" - Ceph Object Storage - "ChinaMobile" - China Mobile Ecloud Elastic Object Storage (EOS) - "Cloudflare" - Cloudflare R2 Storage - "Cubbit" - Cubbit DS3 Object Storage - "DigitalOcean" - DigitalOcean Spaces - "Dreamhost" - Dreamhost DreamObjects - "Exaba" - Exaba Object Storage - "Fastly" - Fastly Object Storage - "FileLu" - FileLu S5 (S3-Compatible Object Storage) - "FlashBlade" - Pure Storage FlashBlade Object Storage - "GCS" - Google Cloud Storage - "HCP" - Hitachi Content Platform (HCP) - "Hetzner" - Hetzner Object Storage - "HuaweiOBS" - Huawei Object Storage Service - "IBMCOS" - IBM COS S3 - "IDrive" - IDrive e2 - "ImpossibleCloud" - Impossible Cloud Object Storage - "Intercolo" - Intercolo Object Storage - "IONOS" - IONOS Cloud - "Leviia" - Leviia Object Storage - "Liara" - Liara Object Storage - "Linode" - Linode Object Storage - "LyveCloud" - Seagate Lyve Cloud - "Magalu" - Magalu Object Storage - "Mega" - MEGA S4 Object Storage - "Minio" - Minio Object Storage - "Netease" - Netease Object Storage (NOS) - "Outscale" - OUTSCALE Object Storage (OOS) - "OVHcloud" - OVHcloud Object Storage - "Petabox" - Petabox Object Storage - "Qiniu" - Qiniu Object Storage (Kodo) - "Rabata" - Rabata Cloud Storage - "RackCorp" - RackCorp Object Storage - "Rclone" - Rclone S3 Server - "Scaleway" - Scaleway Object Storage - "Scality" - Scality (RING / ARTESCA) - "SeaweedFS" - SeaweedFS S3 - "Selectel" - Selectel Object Storage - "Servercore" - Servercore Object Storage - "SpectraLogic" - Spectra Logic Black Pearl - "Storj" - Storj (S3 Compatible Gateway) - "Synology" - Synology C2 Object Storage - "TencentCOS" - Tencent Cloud Object Storage (COS) - "US3" - US3 Object Storage - "Wasabi" - Wasabi Object Storage - "Zadara" - Zadara Object Storage - "Zata" - Zata (S3 compatible Gateway) - "ZeroServices" - Zero Services GmbH (ZERO-Z3) - "Other" - Any other S3 compatible provider #### --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Properties: - Config: env_auth - Env Var: RCLONE_S3_ENV_AUTH - Type: bool - Default: false - Examples: - "false" - Enter AWS credentials in the next step. - "true" - Get AWS credentials from the environment (env vars or IAM). #### --s3-access-key-id AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Properties: - Config: access_key_id - Env Var: RCLONE_S3_ACCESS_KEY_ID - Type: string - Required: false #### --s3-secret-access-key AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Properties: - Config: secret_access_key - Env Var: RCLONE_S3_SECRET_ACCESS_KEY - Type: string - Required: false #### --s3-region Region to connect to. Leave blank if you are using an S3 clone and you don't have a region. Properties: - Config: region - Env Var: RCLONE_S3_REGION - Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,Scality,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,ZeroServices,Other - Type: string - Required: false - Examples: - "us-east-1" - The default endpoint - a good choice if you are unsure. - US Region, Northern Virginia, or Pacific Northwest. - Leave location constraint empty. - Provider: AWS - "us-east-2" - US East (Ohio) Region. - Needs location constraint us-east-2. - Provider: AWS - "us-west-1" - US West (Northern California) Region. - Needs location constraint us-west-1. - Provider: AWS - "us-west-2" - US West (Oregon) Region. - Needs location constraint us-west-2. - Provider: AWS - "ca-central-1" - Canada (Central) Region. - Needs location constraint ca-central-1. - Provider: AWS - "eu-west-1" - EU (Ireland) Region. - Needs location constraint EU or eu-west-1. - Provider: AWS - "eu-west-2" - EU (London) Region. - Needs location constraint eu-west-2. - Provider: AWS - "eu-west-3" - EU (Paris) Region. - Needs location constraint eu-west-3. - Provider: AWS - "eu-north-1" - EU (Stockholm) Region. - Needs location constraint eu-north-1. - Provider: AWS - "eu-south-1" - EU (Milan) Region. - Needs location constraint eu-south-1. - Provider: AWS - "eu-central-1" - EU (Frankfurt) Region. - Needs location constraint eu-central-1. - Provider: AWS - "ap-southeast-1" - Asia Pacific (Singapore) Region. - Needs location constraint ap-southeast-1. - Provider: AWS - "ap-southeast-2" - Asia Pacific (Sydney) Region. - Needs location constraint ap-southeast-2. - Provider: AWS - "ap-northeast-1" - Asia Pacific (Tokyo) Region. - Needs location constraint ap-northeast-1. - Provider: AWS - "ap-northeast-2" - Asia Pacific (Seoul). - Needs location constraint ap-northeast-2. - Provider: AWS - "ap-northeast-3" - Asia Pacific (Osaka-Local). - Needs location constraint ap-northeast-3. - Provider: AWS - "ap-south-1" - Asia Pacific (Mumbai). - Needs location constraint ap-south-1. - Provider: AWS - "ap-east-1" - Asia Pacific (Hong Kong) Region. - Needs location constraint ap-east-1. - Provider: AWS - "sa-east-1" - South America (Sao Paulo) Region. - Needs location constraint sa-east-1. - Provider: AWS - "il-central-1" - Israel (Tel Aviv) Region. - Needs location constraint il-central-1. - Provider: AWS - "me-south-1" - Middle East (Bahrain) Region. - Needs location constraint me-south-1. - Provider: AWS - "af-south-1" - Africa (Cape Town) Region. - Needs location constraint af-south-1. - Provider: AWS - "cn-north-1" - China (Beijing) Region. - Needs location constraint cn-north-1. - Provider: AWS - "cn-northwest-1" - China (Ningxia) Region. - Needs location constraint cn-northwest-1. - Provider: AWS - "us-gov-east-1" - AWS GovCloud (US-East) Region. - Needs location constraint us-gov-east-1. - Provider: AWS - "us-gov-west-1" - AWS GovCloud (US) Region. - Needs location constraint us-gov-west-1. - Provider: AWS - "hn" - Ha Noi - Provider: BizflyCloud - "hcm" - Ho Chi Minh - Provider: BizflyCloud - "" - Use this if unsure. - Will use v4 signatures and an empty region. - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,Scality,SeaweedFS,Wasabi,Other - "other-v2-signature" - Use this only if v4 signatures don't work. - E.g. pre Jewel/v10 CEPH. - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,Scality,SeaweedFS,Wasabi,Other - "auto" - R2 buckets are automatically distributed across Cloudflare's data centers for low latency. - Provider: Cloudflare - "eu-west-1" - Europe West - Provider: Cubbit - "au-east-1" - AU East 1 - Provider: Fastly - "eu-central" - EU Central - Provider: Fastly - "eu-south-1" - EU South 1 - Provider: Fastly - "eu-west-1" - EU West 1 - Provider: Fastly - "jp-central-1" - JP Central 1 - Provider: Fastly - "uk-east-1" - UK East 1 - Provider: Fastly - "us-central-1" - US Central 1 - Provider: Fastly - "us-east" - US East - Provider: Fastly - "us-east-1" - US East 1 - Provider: Fastly - "us-west" - US West - Provider: Fastly - "us-west-1" - US West 1 - Provider: Fastly - "global" - Global - Provider: FileLu - "us-east" - North America (US-East) - Provider: FileLu - "eu-central" - Europe (EU-Central) - Provider: FileLu - "ap-southeast" - Asia Pacific (AP-Southeast) - Provider: FileLu - "me-central" - Middle East (ME-Central) - Provider: FileLu - "hel1" - Helsinki - Provider: Hetzner - "fsn1" - Falkenstein - Provider: Hetzner - "nbg1" - Nuremberg - Provider: Hetzner - "af-south-1" - AF-Johannesburg - Provider: HuaweiOBS - "ap-southeast-2" - AP-Bangkok - Provider: HuaweiOBS - "ap-southeast-3" - AP-Singapore - Provider: HuaweiOBS - "cn-east-3" - CN East-Shanghai1 - Provider: HuaweiOBS - "cn-east-2" - CN East-Shanghai2 - Provider: HuaweiOBS - "cn-north-1" - CN North-Beijing1 - Provider: HuaweiOBS - "cn-north-4" - CN North-Beijing4 - Provider: HuaweiOBS - "cn-south-1" - CN South-Guangzhou - Provider: HuaweiOBS - "ap-southeast-1" - CN-Hong Kong - Provider: HuaweiOBS - "sa-argentina-1" - LA-Buenos Aires1 - Provider: HuaweiOBS - "sa-peru-1" - LA-Lima1 - Provider: HuaweiOBS - "na-mexico-1" - LA-Mexico City1 - Provider: HuaweiOBS - "sa-chile-1" - LA-Santiago2 - Provider: HuaweiOBS - "sa-brazil-1" - LA-Sao Paulo1 - Provider: HuaweiOBS - "ru-northwest-2" - RU-Moscow2 - Provider: HuaweiOBS - "eu-central-2" - Frankfurt, Germany - Provider: ImpossibleCloud - "eu-west-1" - Amsterdam, Netherlands - Provider: ImpossibleCloud - "eu-west-2" - London, UK - Provider: ImpossibleCloud - "eu-west-3" - Paris, France - Provider: ImpossibleCloud - "eu-east-1" - Poznań, Poland - Provider: ImpossibleCloud - "eu-north-1" - Copenhagen, Denmark - Provider: ImpossibleCloud - "us-east-1" - New York, USA - Provider: ImpossibleCloud - "de-fra" - Frankfurt, Germany - Provider: Intercolo - "de" - Frankfurt, Germany - Provider: IONOS,OVHcloud - "eu-central-2" - Berlin, Germany - Provider: IONOS - "eu-central-3" - Berlin, Germany - Provider: IONOS - "eu-central-4" - Frankfurt, Germany - Provider: IONOS - "eu-south-2" - Logrono, Spain - Provider: IONOS - "us-central-1" - Lenexa, USA - Provider: IONOS - "eu-west-2" - Paris, France - Provider: Outscale - "us-east-2" - New Jersey, USA - Provider: Outscale - "us-west-1" - California, USA - Provider: Outscale - "cloudgouv-eu-west-1" - SecNumCloud, Paris, France - Provider: Outscale - "ap-northeast-1" - Tokyo, Japan - Provider: Outscale - "gra" - Gravelines, France - Provider: OVHcloud - "rbx" - Roubaix, France - Provider: OVHcloud - "sbg" - Strasbourg, France - Provider: OVHcloud - "eu-west-par" - Paris, France (3AZ) - Provider: OVHcloud - "uk" - London, United Kingdom - Provider: OVHcloud - "waw" - Warsaw, Poland - Provider: OVHcloud - "bhs" - Beauharnois, Canada - Provider: OVHcloud - "ca-east-tor" - Toronto, Canada - Provider: OVHcloud - "sgp" - Singapore - Provider: OVHcloud - "ap-southeast-syd" - Sydney, Australia - Provider: OVHcloud - "ap-south-mum" - Mumbai, India - Provider: OVHcloud - "us-east-va" - Vint Hill, Virginia, USA - Provider: OVHcloud - "us-west-or" - Hillsboro, Oregon, USA - Provider: OVHcloud - "rbx-archive" - Roubaix, France (Cold Archive) - Provider: OVHcloud - "us-east-1" - US East (N. Virginia) - Provider: Petabox,Rabata - "eu-central-1" - Europe (Frankfurt) - Provider: Petabox - "ap-southeast-1" - Asia Pacific (Singapore) - Provider: Petabox - "me-south-1" - Middle East (Bahrain) - Provider: Petabox - "sa-east-1" - South America (São Paulo) - Provider: Petabox - "cn-east-1" - The default endpoint - a good choice if you are unsure. - East China Region 1. - Needs location constraint cn-east-1. - Provider: Qiniu - "cn-east-2" - East China Region 2. - Needs location constraint cn-east-2. - Provider: Qiniu - "cn-north-1" - North China Region 1. - Needs location constraint cn-north-1. - Provider: Qiniu - "cn-south-1" - South China Region 1. - Needs location constraint cn-south-1. - Provider: Qiniu - "us-north-1" - North America Region. - Needs location constraint us-north-1. - Provider: Qiniu - "ap-southeast-1" - Southeast Asia Region 1. - Needs location constraint ap-southeast-1. - Provider: Qiniu - "ap-northeast-1" - Northeast Asia Region 1. - Needs location constraint ap-northeast-1. - Provider: Qiniu - "eu-west-1" - EU (Ireland) - Provider: Rabata - "eu-west-2" - EU (London) - Provider: Rabata - "global" - Global CDN (All locations) Region - Provider: RackCorp - "au" - Australia (All states) - Provider: RackCorp - "au-nsw" - NSW (Australia) Region - Provider: RackCorp - "au-qld" - QLD (Australia) Region - Provider: RackCorp - "au-vic" - VIC (Australia) Region - Provider: RackCorp - "au-wa" - Perth (Australia) Region - Provider: RackCorp - "ph" - Manila (Philippines) Region - Provider: RackCorp - "th" - Bangkok (Thailand) Region - Provider: RackCorp - "hk" - HK (Hong Kong) Region - Provider: RackCorp - "mn" - Ulaanbaatar (Mongolia) Region - Provider: RackCorp - "kg" - Bishkek (Kyrgyzstan) Region - Provider: RackCorp - "id" - Jakarta (Indonesia) Region - Provider: RackCorp - "jp" - Tokyo (Japan) Region - Provider: RackCorp - "sg" - SG (Singapore) Region - Provider: RackCorp - "de" - Frankfurt (Germany) Region - Provider: RackCorp - "us" - USA (AnyCast) Region - Provider: RackCorp - "us-east-1" - New York (USA) Region - Provider: RackCorp - "us-west-1" - Freemont (USA) Region - Provider: RackCorp - "nz" - Auckland (New Zealand) Region - Provider: RackCorp - "nl-ams" - Amsterdam, The Netherlands - Provider: Scaleway - "fr-par" - Paris, France - Provider: Scaleway - "pl-waw" - Warsaw, Poland - Provider: Scaleway - "ru-1" - St. Petersburg - Provider: Selectel,Servercore - "ru-3" - St. Petersburg - Provider: Selectel - "ru-7" - Moscow - Provider: Selectel,Servercore - "gis-1" - Moscow - Provider: Selectel,Servercore - "kz-1" - Kazakhstan - Provider: Selectel - "uz-2" - Uzbekistan - Provider: Selectel - "uz-2" - Tashkent, Uzbekistan - Provider: Servercore - "kz-1" - Almaty, Kazakhstan - Provider: Servercore - "eu-001" - Europe Region 1 - Provider: Synology - "eu-002" - Europe Region 2 - Provider: Synology - "us-001" - US Region 1 - Provider: Synology - "us-002" - US Region 2 - Provider: Synology - "tw-001" - Asia (Taiwan) - Provider: Synology - "us-east-1" - The default region. - Leave location constraint empty. - Provider: Zadara - "us-east-1" - Indore, Madhya Pradesh, India - Provider: Zata - "zero-fra1" - Frankfurt 1 - Provider: ZeroServices - "zero-fra2" - Frankfurt 2 - Provider: ZeroServices - "zero-eyl1" - Eyl 1 - Provider: ZeroServices #### --s3-endpoint Endpoint for S3 API. Required when using an S3 clone. Properties: - Config: endpoint - Env Var: RCLONE_S3_ENDPOINT - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,Scality,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,ZeroServices,Other - Type: string - Required: false - Examples: - "oss-accelerate.aliyuncs.com" - Global Accelerate - Provider: Alibaba - "oss-accelerate-overseas.aliyuncs.com" - Global Accelerate (outside mainland China) - Provider: Alibaba - "oss-cn-hangzhou.aliyuncs.com" - East China 1 (Hangzhou) - Provider: Alibaba - "oss-cn-shanghai.aliyuncs.com" - East China 2 (Shanghai) - Provider: Alibaba - "oss-cn-qingdao.aliyuncs.com" - North China 1 (Qingdao) - Provider: Alibaba - "oss-cn-beijing.aliyuncs.com" - North China 2 (Beijing) - Provider: Alibaba - "oss-cn-zhangjiakou.aliyuncs.com" - North China 3 (Zhangjiakou) - Provider: Alibaba - "oss-cn-huhehaote.aliyuncs.com" - North China 5 (Hohhot) - Provider: Alibaba - "oss-cn-wulanchabu.aliyuncs.com" - North China 6 (Ulanqab) - Provider: Alibaba - "oss-cn-shenzhen.aliyuncs.com" - South China 1 (Shenzhen) - Provider: Alibaba - "oss-cn-heyuan.aliyuncs.com" - South China 2 (Heyuan) - Provider: Alibaba - "oss-cn-guangzhou.aliyuncs.com" - South China 3 (Guangzhou) - Provider: Alibaba - "oss-cn-chengdu.aliyuncs.com" - West China 1 (Chengdu) - Provider: Alibaba - "oss-cn-hongkong.aliyuncs.com" - Hong Kong (Hong Kong) - Provider: Alibaba - "oss-us-west-1.aliyuncs.com" - US West 1 (Silicon Valley) - Provider: Alibaba - "oss-us-east-1.aliyuncs.com" - US East 1 (Virginia) - Provider: Alibaba - "oss-ap-southeast-1.aliyuncs.com" - Southeast Asia Southeast 1 (Singapore) - Provider: Alibaba - "oss-ap-southeast-2.aliyuncs.com" - Asia Pacific Southeast 2 (Sydney) - Provider: Alibaba - "oss-ap-southeast-3.aliyuncs.com" - Southeast Asia Southeast 3 (Kuala Lumpur) - Provider: Alibaba - "oss-ap-southeast-5.aliyuncs.com" - Asia Pacific Southeast 5 (Jakarta) - Provider: Alibaba - "oss-ap-northeast-1.aliyuncs.com" - Asia Pacific Northeast 1 (Japan) - Provider: Alibaba - "oss-ap-south-1.aliyuncs.com" - Asia Pacific South 1 (Mumbai) - Provider: Alibaba - "oss-eu-central-1.aliyuncs.com" - Central Europe 1 (Frankfurt) - Provider: Alibaba - "oss-eu-west-1.aliyuncs.com" - West Europe (London) - Provider: Alibaba - "oss-me-east-1.aliyuncs.com" - Middle East 1 (Dubai) - Provider: Alibaba - "s3.ir-thr-at1.arvanstorage.ir" - The default endpoint - a good choice if you are unsure. - Tehran Iran (Simin) - Provider: ArvanCloud - "s3.ir-tbz-sh1.arvanstorage.ir" - Tabriz Iran (Shahriar) - Provider: ArvanCloud - "hn.ss.bfcplatform.vn" - Hanoi endpoint - Provider: BizflyCloud - "hcm.ss.bfcplatform.vn" - Ho Chi Minh endpoint - Provider: BizflyCloud - "eos-wuxi-1.cmecloud.cn" - The default endpoint - a good choice if you are unsure. - East China (Suzhou) - Provider: ChinaMobile - "eos-jinan-1.cmecloud.cn" - East China (Jinan) - Provider: ChinaMobile - "eos-ningbo-1.cmecloud.cn" - East China (Hangzhou) - Provider: ChinaMobile - "eos-shanghai-1.cmecloud.cn" - East China (Shanghai-1) - Provider: ChinaMobile - "eos-zhengzhou-1.cmecloud.cn" - Central China (Zhengzhou) - Provider: ChinaMobile - "eos-hunan-1.cmecloud.cn" - Central China (Changsha-1) - Provider: ChinaMobile - "eos-zhuzhou-1.cmecloud.cn" - Central China (Changsha-2) - Provider: ChinaMobile - "eos-guangzhou-1.cmecloud.cn" - South China (Guangzhou-2) - Provider: ChinaMobile - "eos-dongguan-1.cmecloud.cn" - South China (Guangzhou-3) - Provider: ChinaMobile - "eos-beijing-1.cmecloud.cn" - North China (Beijing-1) - Provider: ChinaMobile - "eos-beijing-2.cmecloud.cn" - North China (Beijing-2) - Provider: ChinaMobile - "eos-beijing-4.cmecloud.cn" - North China (Beijing-3) - Provider: ChinaMobile - "eos-huhehaote-1.cmecloud.cn" - North China (Huhehaote) - Provider: ChinaMobile - "eos-chengdu-1.cmecloud.cn" - Southwest China (Chengdu) - Provider: ChinaMobile - "eos-chongqing-1.cmecloud.cn" - Southwest China (Chongqing) - Provider: ChinaMobile - "eos-guiyang-1.cmecloud.cn" - Southwest China (Guiyang) - Provider: ChinaMobile - "eos-xian-1.cmecloud.cn" - Nouthwest China (Xian) - Provider: ChinaMobile - "eos-yunnan.cmecloud.cn" - Yunnan China (Kunming) - Provider: ChinaMobile - "eos-yunnan-2.cmecloud.cn" - Yunnan China (Kunming-2) - Provider: ChinaMobile - "eos-tianjin-1.cmecloud.cn" - Tianjin China (Tianjin) - Provider: ChinaMobile - "eos-jilin-1.cmecloud.cn" - Jilin China (Changchun) - Provider: ChinaMobile - "eos-hubei-1.cmecloud.cn" - Hubei China (Xiangyan) - Provider: ChinaMobile - "eos-jiangxi-1.cmecloud.cn" - Jiangxi China (Nanchang) - Provider: ChinaMobile - "eos-gansu-1.cmecloud.cn" - Gansu China (Lanzhou) - Provider: ChinaMobile - "eos-shanxi-1.cmecloud.cn" - Shanxi China (Taiyuan) - Provider: ChinaMobile - "eos-liaoning-1.cmecloud.cn" - Liaoning China (Shenyang) - Provider: ChinaMobile - "eos-hebei-1.cmecloud.cn" - Hebei China (Shijiazhuang) - Provider: ChinaMobile - "eos-fujian-1.cmecloud.cn" - Fujian China (Xiamen) - Provider: ChinaMobile - "eos-guangxi-1.cmecloud.cn" - Guangxi China (Nanning) - Provider: ChinaMobile - "eos-anhui-1.cmecloud.cn" - Anhui China (Huainan) - Provider: ChinaMobile - "s3.cubbit.eu" - Cubbit DS3 Object Storage endpoint - Provider: Cubbit - "s3.{tenant_name}.cubbit.eu" - Multi-tenant endpoint - replace {tenant_name} with your actual tenant name. Do not select this directly - Provider: Cubbit - "syd1.digitaloceanspaces.com" - DigitalOcean Spaces Sydney 1 - Provider: DigitalOcean - "sfo3.digitaloceanspaces.com" - DigitalOcean Spaces San Francisco 3 - Provider: DigitalOcean - "sfo2.digitaloceanspaces.com" - DigitalOcean Spaces San Francisco 2 - Provider: DigitalOcean - "fra1.digitaloceanspaces.com" - DigitalOcean Spaces Frankfurt 1 - Provider: DigitalOcean - "nyc3.digitaloceanspaces.com" - DigitalOcean Spaces New York 3 - Provider: DigitalOcean - "ams3.digitaloceanspaces.com" - DigitalOcean Spaces Amsterdam 3 - Provider: DigitalOcean - "sgp1.digitaloceanspaces.com" - DigitalOcean Spaces Singapore 1 - Provider: DigitalOcean - "lon1.digitaloceanspaces.com" - DigitalOcean Spaces London 1 - Provider: DigitalOcean - "tor1.digitaloceanspaces.com" - DigitalOcean Spaces Toronto 1 - Provider: DigitalOcean - "blr1.digitaloceanspaces.com" - DigitalOcean Spaces Bangalore 1 - Provider: DigitalOcean - "objects-us-east-1.dream.io" - Dream Objects endpoint - Provider: Dreamhost - "au-east-1.object.fastlystorage.app" - AU East 1 - Provider: Fastly - "eu-central.object.fastlystorage.app" - EU Central - Provider: Fastly - "eu-south-1.object.fastlystorage.app" - EU South 1 - Provider: Fastly - "eu-west-1.object.fastlystorage.app" - EU West 1 - Provider: Fastly - "jp-central-1.object.fastlystorage.app" - JP Central 1 - Provider: Fastly - "uk-east-1.object.fastlystorage.app" - UK East 1 - Provider: Fastly - "us-central-1.object.fastlystorage.app" - US Central 1 - Provider: Fastly - "us-east.object.fastlystorage.app" - US East - Provider: Fastly - "us-east-1.object.fastlystorage.app" - US East 1 - Provider: Fastly - "us-west.object.fastlystorage.app" - US West - Provider: Fastly - "us-west-1.object.fastlystorage.app" - US West 1 - Provider: Fastly - "s5lu.com" - Global FileLu S5 endpoint - Provider: FileLu - "us.s5lu.com" - North America (US-East) region endpoint - Provider: FileLu - "eu.s5lu.com" - Europe (EU-Central) region endpoint - Provider: FileLu - "ap.s5lu.com" - Asia Pacific (AP-Southeast) region endpoint - Provider: FileLu - "me.s5lu.com" - Middle East (ME-Central) region endpoint - Provider: FileLu - "https://storage.googleapis.com" - Google Cloud Storage endpoint - Provider: GCS - "hel1.your-objectstorage.com" - Helsinki - Provider: Hetzner - "fsn1.your-objectstorage.com" - Falkenstein - Provider: Hetzner - "nbg1.your-objectstorage.com" - Nuremberg - Provider: Hetzner - "obs.af-south-1.myhuaweicloud.com" - AF-Johannesburg - Provider: HuaweiOBS - "obs.ap-southeast-2.myhuaweicloud.com" - AP-Bangkok - Provider: HuaweiOBS - "obs.ap-southeast-3.myhuaweicloud.com" - AP-Singapore - Provider: HuaweiOBS - "obs.cn-east-3.myhuaweicloud.com" - CN East-Shanghai1 - Provider: HuaweiOBS - "obs.cn-east-2.myhuaweicloud.com" - CN East-Shanghai2 - Provider: HuaweiOBS - "obs.cn-north-1.myhuaweicloud.com" - CN North-Beijing1 - Provider: HuaweiOBS - "obs.cn-north-4.myhuaweicloud.com" - CN North-Beijing4 - Provider: HuaweiOBS - "obs.cn-south-1.myhuaweicloud.com" - CN South-Guangzhou - Provider: HuaweiOBS - "obs.ap-southeast-1.myhuaweicloud.com" - CN-Hong Kong - Provider: HuaweiOBS - "obs.sa-argentina-1.myhuaweicloud.com" - LA-Buenos Aires1 - Provider: HuaweiOBS - "obs.sa-peru-1.myhuaweicloud.com" - LA-Lima1 - Provider: HuaweiOBS - "obs.na-mexico-1.myhuaweicloud.com" - LA-Mexico City1 - Provider: HuaweiOBS - "obs.sa-chile-1.myhuaweicloud.com" - LA-Santiago2 - Provider: HuaweiOBS - "obs.sa-brazil-1.myhuaweicloud.com" - LA-Sao Paulo1 - Provider: HuaweiOBS - "obs.ru-northwest-2.myhuaweicloud.com" - RU-Moscow2 - Provider: HuaweiOBS - "s3.us.cloud-object-storage.appdomain.cloud" - US Cross Region Endpoint - Provider: IBMCOS - "s3.dal.us.cloud-object-storage.appdomain.cloud" - US Cross Region Dallas Endpoint - Provider: IBMCOS - "s3.wdc.us.cloud-object-storage.appdomain.cloud" - US Cross Region Washington DC Endpoint - Provider: IBMCOS - "s3.sjc.us.cloud-object-storage.appdomain.cloud" - US Cross Region San Jose Endpoint - Provider: IBMCOS - "s3.private.us.cloud-object-storage.appdomain.cloud" - US Cross Region Private Endpoint - Provider: IBMCOS - "s3.private.dal.us.cloud-object-storage.appdomain.cloud" - US Cross Region Dallas Private Endpoint - Provider: IBMCOS - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud" - US Cross Region Washington DC Private Endpoint - Provider: IBMCOS - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud" - US Cross Region San Jose Private Endpoint - Provider: IBMCOS - "s3.us-east.cloud-object-storage.appdomain.cloud" - US Region East Endpoint - Provider: IBMCOS - "s3.private.us-east.cloud-object-storage.appdomain.cloud" - US Region East Private Endpoint - Provider: IBMCOS - "s3.us-south.cloud-object-storage.appdomain.cloud" - US Region South Endpoint - Provider: IBMCOS - "s3.private.us-south.cloud-object-storage.appdomain.cloud" - US Region South Private Endpoint - Provider: IBMCOS - "s3.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Endpoint - Provider: IBMCOS - "s3.fra.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Frankfurt Endpoint - Provider: IBMCOS - "s3.mil.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Milan Endpoint - Provider: IBMCOS - "s3.ams.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Amsterdam Endpoint - Provider: IBMCOS - "s3.private.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Private Endpoint - Provider: IBMCOS - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Frankfurt Private Endpoint - Provider: IBMCOS - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Milan Private Endpoint - Provider: IBMCOS - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud" - EU Cross Region Amsterdam Private Endpoint - Provider: IBMCOS - "s3.eu-gb.cloud-object-storage.appdomain.cloud" - Great Britain Endpoint - Provider: IBMCOS - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud" - Great Britain Private Endpoint - Provider: IBMCOS - "s3.eu-de.cloud-object-storage.appdomain.cloud" - EU Region DE Endpoint - Provider: IBMCOS - "s3.private.eu-de.cloud-object-storage.appdomain.cloud" - EU Region DE Private Endpoint - Provider: IBMCOS - "s3.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Endpoint - Provider: IBMCOS - "s3.tok.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Tokyo Endpoint - Provider: IBMCOS - "s3.hkg.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Hong Kong Endpoint - Provider: IBMCOS - "s3.seo.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Seoul Endpoint - Provider: IBMCOS - "s3.private.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Private Endpoint - Provider: IBMCOS - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Tokyo Private Endpoint - Provider: IBMCOS - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Hong Kong Private Endpoint - Provider: IBMCOS - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud" - APAC Cross Regional Seoul Private Endpoint - Provider: IBMCOS - "s3.jp-tok.cloud-object-storage.appdomain.cloud" - APAC Region Japan Endpoint - Provider: IBMCOS - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud" - APAC Region Japan Private Endpoint - Provider: IBMCOS - "s3.au-syd.cloud-object-storage.appdomain.cloud" - APAC Region Australia Endpoint - Provider: IBMCOS - "s3.private.au-syd.cloud-object-storage.appdomain.cloud" - APAC Region Australia Private Endpoint - Provider: IBMCOS - "s3.ams03.cloud-object-storage.appdomain.cloud" - Amsterdam Single Site Endpoint - Provider: IBMCOS - "s3.private.ams03.cloud-object-storage.appdomain.cloud" - Amsterdam Single Site Private Endpoint - Provider: IBMCOS - "s3.che01.cloud-object-storage.appdomain.cloud" - Chennai Single Site Endpoint - Provider: IBMCOS - "s3.private.che01.cloud-object-storage.appdomain.cloud" - Chennai Single Site Private Endpoint - Provider: IBMCOS - "s3.mel01.cloud-object-storage.appdomain.cloud" - Melbourne Single Site Endpoint - Provider: IBMCOS - "s3.private.mel01.cloud-object-storage.appdomain.cloud" - Melbourne Single Site Private Endpoint - Provider: IBMCOS - "s3.osl01.cloud-object-storage.appdomain.cloud" - Oslo Single Site Endpoint - Provider: IBMCOS - "s3.private.osl01.cloud-object-storage.appdomain.cloud" - Oslo Single Site Private Endpoint - Provider: IBMCOS - "s3.tor01.cloud-object-storage.appdomain.cloud" - Toronto Single Site Endpoint - Provider: IBMCOS - "s3.private.tor01.cloud-object-storage.appdomain.cloud" - Toronto Single Site Private Endpoint - Provider: IBMCOS - "s3.seo01.cloud-object-storage.appdomain.cloud" - Seoul Single Site Endpoint - Provider: IBMCOS - "s3.private.seo01.cloud-object-storage.appdomain.cloud" - Seoul Single Site Private Endpoint - Provider: IBMCOS - "s3.mon01.cloud-object-storage.appdomain.cloud" - Montreal Single Site Endpoint - Provider: IBMCOS - "s3.private.mon01.cloud-object-storage.appdomain.cloud" - Montreal Single Site Private Endpoint - Provider: IBMCOS - "s3.mex01.cloud-object-storage.appdomain.cloud" - Mexico Single Site Endpoint - Provider: IBMCOS - "s3.private.mex01.cloud-object-storage.appdomain.cloud" - Mexico Single Site Private Endpoint - Provider: IBMCOS - "s3.sjc04.cloud-object-storage.appdomain.cloud" - San Jose Single Site Endpoint - Provider: IBMCOS - "s3.private.sjc04.cloud-object-storage.appdomain.cloud" - San Jose Single Site Private Endpoint - Provider: IBMCOS - "s3.mil01.cloud-object-storage.appdomain.cloud" - Milan Single Site Endpoint - Provider: IBMCOS - "s3.private.mil01.cloud-object-storage.appdomain.cloud" - Milan Single Site Private Endpoint - Provider: IBMCOS - "s3.hkg02.cloud-object-storage.appdomain.cloud" - Hong Kong Single Site Endpoint - Provider: IBMCOS - "s3.private.hkg02.cloud-object-storage.appdomain.cloud" - Hong Kong Single Site Private Endpoint - Provider: IBMCOS - "s3.par01.cloud-object-storage.appdomain.cloud" - Paris Single Site Endpoint - Provider: IBMCOS - "s3.private.par01.cloud-object-storage.appdomain.cloud" - Paris Single Site Private Endpoint - Provider: IBMCOS - "s3.sng01.cloud-object-storage.appdomain.cloud" - Singapore Single Site Endpoint - Provider: IBMCOS - "s3.private.sng01.cloud-object-storage.appdomain.cloud" - Singapore Single Site Private Endpoint - Provider: IBMCOS - "eu-central-2.storage.impossibleapi.net" - Frankfurt, Germany - Provider: ImpossibleCloud - "eu-west-1.storage.impossibleapi.net" - Amsterdam, Netherlands - Provider: ImpossibleCloud - "eu-west-2.storage.impossibleapi.net" - London, UK - Provider: ImpossibleCloud - "eu-west-3.storage.impossibleapi.net" - Paris, France - Provider: ImpossibleCloud - "eu-east-1.storage.impossibleapi.net" - Poznań, Poland - Provider: ImpossibleCloud - "eu-north-1.storage.impossibleapi.net" - Copenhagen, Denmark - Provider: ImpossibleCloud - "us-east-1.storage.impossibleapi.net" - New York, USA - Provider: ImpossibleCloud - "de-fra.i3storage.com" - Frankfurt, Germany - Provider: Intercolo - "s3.eu-central-1.ionoscloud.com" - Frankfurt, Germany - Provider: IONOS - "s3.eu-central-2.ionoscloud.com" - Berlin, Germany - Provider: IONOS - "s3.eu-central-3.ionoscloud.com" - Berlin, Germany - Provider: IONOS - "s3.eu-central-4.ionoscloud.com" - Frankfurt, Germany - Provider: IONOS - "s3.eu-south-2.ionoscloud.com" - Logrono, Spain - Provider: IONOS - "s3.us-central-1.ionoscloud.com" - Lenexa, USA - Provider: IONOS - "s3.leviia.com" - The default endpoint - Leviia - Provider: Leviia - "storage.iran.liara.space" - The default endpoint - Iran - Provider: Liara - "nl-ams-1.linodeobjects.com" - Amsterdam, NL (nl-ams-1) - Provider: Linode - "us-southeast-1.linodeobjects.com" - Atlanta, GA, US (us-southeast-1) - Provider: Linode - "in-maa-1.linodeobjects.com" - Chennai, IN (in-maa-1) - Provider: Linode - "us-ord-1.linodeobjects.com" - Chicago, IL, US (us-ord-1) - Provider: Linode - "eu-central-1.linodeobjects.com" - Frankfurt, DE (eu-central-1) - Provider: Linode - "id-cgk-1.linodeobjects.com" - Jakarta, ID (id-cgk-1) - Provider: Linode - "gb-lon-1.linodeobjects.com" - London 2, UK (gb-lon-1) - Provider: Linode - "us-lax-1.linodeobjects.com" - Los Angeles, CA, US (us-lax-1) - Provider: Linode - "es-mad-1.linodeobjects.com" - Madrid, ES (es-mad-1) - Provider: Linode - "us-mia-1.linodeobjects.com" - Miami, FL, US (us-mia-1) - Provider: Linode - "it-mil-1.linodeobjects.com" - Milan, IT (it-mil-1) - Provider: Linode - "us-east-1.linodeobjects.com" - Newark, NJ, US (us-east-1) - Provider: Linode - "jp-osa-1.linodeobjects.com" - Osaka, JP (jp-osa-1) - Provider: Linode - "fr-par-1.linodeobjects.com" - Paris, FR (fr-par-1) - Provider: Linode - "br-gru-1.linodeobjects.com" - Sao Paulo, BR (br-gru-1) - Provider: Linode - "us-sea-1.linodeobjects.com" - Seattle, WA, US (us-sea-1) - Provider: Linode - "ap-south-1.linodeobjects.com" - Singapore, SG (ap-south-1) - Provider: Linode - "sg-sin-1.linodeobjects.com" - Singapore 2, SG (sg-sin-1) - Provider: Linode - "se-sto-1.linodeobjects.com" - Stockholm, SE (se-sto-1) - Provider: Linode - "jp-tyo-1.linodeobjects.com" - Tokyo 3, JP (jp-tyo-1) - Provider: Linode - "us-iad-10.linodeobjects.com" - Washington, DC, US (us-iad-10) - Provider: Linode - "s3.us-west-1.{account_name}.lyve.seagate.com" - US West 1 - California - Provider: LyveCloud - "s3.eu-west-1.{account_name}.lyve.seagate.com" - EU West 1 - Ireland - Provider: LyveCloud - "br-se1.magaluobjects.com" - São Paulo, SP (BR), br-se1 - Provider: Magalu - "br-ne1.magaluobjects.com" - Fortaleza, CE (BR), br-ne1 - Provider: Magalu - "s3.eu-amsterdam.megas4.com" - Mega S4 Amsterdam - Provider: Mega - "s3.eu-luxembourg.megas4.com" - Mega S4 Luxembourg - Provider: Mega - "s3.eu-paris.megas4.com" - Mega S4 Paris - Provider: Mega - "s3.eu-barcelona.megas4.com" - Mega S4 Barcelona - Provider: Mega - "s3.ca-montreal.megas4.com" - Mega S4 Montreal - Provider: Mega - "s3.ca-vancouver.megas4.com" - Mega S4 Vancouver - Provider: Mega - "s3.ap-tokyo.megas4.com" - Mega S4 Tokyo - Provider: Mega - "s3.eu-central-1.s4.mega.io" - Mega S4 eu-central-1 (Amsterdam, legacy) - Provider: Mega - "s3.eu-central-2.s4.mega.io" - Mega S4 eu-central-2 (Bettembourg, legacy) - Provider: Mega - "s3.ca-central-1.s4.mega.io" - Mega S4 ca-central-1 (Montreal, legacy) - Provider: Mega - "s3.ca-west-1.s4.mega.io" - Mega S4 ca-west-1 (Vancouver, legacy) - Provider: Mega - "oos.eu-west-2.outscale.com" - Outscale EU West 2 (Paris) - Provider: Outscale - "oos.us-east-2.outscale.com" - Outscale US east 2 (New Jersey) - Provider: Outscale - "oos.us-west-1.outscale.com" - Outscale EU West 1 (California) - Provider: Outscale - "oos.cloudgouv-eu-west-1.outscale.com" - Outscale SecNumCloud (Paris) - Provider: Outscale - "oos.ap-northeast-1.outscale.com" - Outscale AP Northeast 1 (Japan) - Provider: Outscale - "s3.gra.io.cloud.ovh.net" - OVHcloud Gravelines, France - Provider: OVHcloud - "s3.rbx.io.cloud.ovh.net" - OVHcloud Roubaix, France - Provider: OVHcloud - "s3.sbg.io.cloud.ovh.net" - OVHcloud Strasbourg, France - Provider: OVHcloud - "s3.eu-west-par.io.cloud.ovh.net" - OVHcloud Paris, France (3AZ) - Provider: OVHcloud - "s3.de.io.cloud.ovh.net" - OVHcloud Frankfurt, Germany - Provider: OVHcloud - "s3.uk.io.cloud.ovh.net" - OVHcloud London, United Kingdom - Provider: OVHcloud - "s3.waw.io.cloud.ovh.net" - OVHcloud Warsaw, Poland - Provider: OVHcloud - "s3.bhs.io.cloud.ovh.net" - OVHcloud Beauharnois, Canada - Provider: OVHcloud - "s3.ca-east-tor.io.cloud.ovh.net" - OVHcloud Toronto, Canada - Provider: OVHcloud - "s3.sgp.io.cloud.ovh.net" - OVHcloud Singapore - Provider: OVHcloud - "s3.ap-southeast-syd.io.cloud.ovh.net" - OVHcloud Sydney, Australia - Provider: OVHcloud - "s3.ap-south-mum.io.cloud.ovh.net" - OVHcloud Mumbai, India - Provider: OVHcloud - "s3.us-east-va.io.cloud.ovh.us" - OVHcloud Vint Hill, Virginia, USA - Provider: OVHcloud - "s3.us-west-or.io.cloud.ovh.us" - OVHcloud Hillsboro, Oregon, USA - Provider: OVHcloud - "s3.rbx-archive.io.cloud.ovh.net" - OVHcloud Roubaix, France (Cold Archive) - Provider: OVHcloud - "s3.petabox.io" - US East (N. Virginia) - Provider: Petabox - "s3.us-east-1.petabox.io" - US East (N. Virginia) - Provider: Petabox - "s3.eu-central-1.petabox.io" - Europe (Frankfurt) - Provider: Petabox - "s3.ap-southeast-1.petabox.io" - Asia Pacific (Singapore) - Provider: Petabox - "s3.me-south-1.petabox.io" - Middle East (Bahrain) - Provider: Petabox - "s3.sa-east-1.petabox.io" - South America (São Paulo) - Provider: Petabox - "s3-cn-east-1.qiniucs.com" - East China Endpoint 1 - Provider: Qiniu - "s3-cn-east-2.qiniucs.com" - East China Endpoint 2 - Provider: Qiniu - "s3-cn-north-1.qiniucs.com" - North China Endpoint 1 - Provider: Qiniu - "s3-cn-south-1.qiniucs.com" - South China Endpoint 1 - Provider: Qiniu - "s3-us-north-1.qiniucs.com" - North America Endpoint 1 - Provider: Qiniu - "s3-ap-southeast-1.qiniucs.com" - Southeast Asia Endpoint 1 - Provider: Qiniu - "s3-ap-northeast-1.qiniucs.com" - Northeast Asia Endpoint 1 - Provider: Qiniu - "s3.us-east-1.rabata.io" - US East (N. Virginia) - Provider: Rabata - "s3.eu-west-1.rabata.io" - EU West (Ireland) - Provider: Rabata - "s3.eu-west-2.rabata.io" - EU West (London) - Provider: Rabata - "s3.rackcorp.com" - Global (AnyCast) Endpoint - Provider: RackCorp - "au.s3.rackcorp.com" - Australia (Anycast) Endpoint - Provider: RackCorp - "au-nsw.s3.rackcorp.com" - Sydney (Australia) Endpoint - Provider: RackCorp - "au-qld.s3.rackcorp.com" - Brisbane (Australia) Endpoint - Provider: RackCorp - "au-vic.s3.rackcorp.com" - Melbourne (Australia) Endpoint - Provider: RackCorp - "au-wa.s3.rackcorp.com" - Perth (Australia) Endpoint - Provider: RackCorp - "ph.s3.rackcorp.com" - Manila (Philippines) Endpoint - Provider: RackCorp - "th.s3.rackcorp.com" - Bangkok (Thailand) Endpoint - Provider: RackCorp - "hk.s3.rackcorp.com" - HK (Hong Kong) Endpoint - Provider: RackCorp - "mn.s3.rackcorp.com" - Ulaanbaatar (Mongolia) Endpoint - Provider: RackCorp - "kg.s3.rackcorp.com" - Bishkek (Kyrgyzstan) Endpoint - Provider: RackCorp - "id.s3.rackcorp.com" - Jakarta (Indonesia) Endpoint - Provider: RackCorp - "jp.s3.rackcorp.com" - Tokyo (Japan) Endpoint - Provider: RackCorp - "sg.s3.rackcorp.com" - SG (Singapore) Endpoint - Provider: RackCorp - "de.s3.rackcorp.com" - Frankfurt (Germany) Endpoint - Provider: RackCorp - "us.s3.rackcorp.com" - USA (AnyCast) Endpoint - Provider: RackCorp - "us-east-1.s3.rackcorp.com" - New York (USA) Endpoint - Provider: RackCorp - "us-west-1.s3.rackcorp.com" - Freemont (USA) Endpoint - Provider: RackCorp - "nz.s3.rackcorp.com" - Auckland (New Zealand) Endpoint - Provider: RackCorp - "s3.nl-ams.scw.cloud" - Amsterdam Endpoint - Provider: Scaleway - "s3.fr-par.scw.cloud" - Paris Endpoint - Provider: Scaleway - "s3.pl-waw.scw.cloud" - Warsaw Endpoint - Provider: Scaleway - "localhost:8333" - SeaweedFS S3 localhost - Provider: SeaweedFS - "s3.ru-1.storage.selcloud.ru" - St. Petersburg - Provider: Selectel - "s3.ru-3.storage.selcloud.ru" - St. Petersburg - Provider: Selectel - "s3.ru-7.storage.selcloud.ru" - Moscow - Provider: Selectel,Servercore - "s3.gis-1.storage.selcloud.ru" - Moscow - Provider: Selectel,Servercore - "s3.kz-1.storage.selcloud.ru" - Kazakhstan - Provider: Selectel - "s3.uz-2.storage.selcloud.ru" - Uzbekistan - Provider: Selectel - "s3.ru-1.storage.selcloud.ru" - Saint Petersburg - Provider: Servercore - "s3.uz-2.srvstorage.uz" - Tashkent, Uzbekistan - Provider: Servercore - "s3.kz-1.srvstorage.kz" - Almaty, Kazakhstan - Provider: Servercore - "gateway.storjshare.io" - Global Hosted Gateway - Provider: Storj - "eu-001.s3.synologyc2.net" - EU Endpoint 1 - Provider: Synology - "eu-002.s3.synologyc2.net" - EU Endpoint 2 - Provider: Synology - "us-001.s3.synologyc2.net" - US Endpoint 1 - Provider: Synology - "us-002.s3.synologyc2.net" - US Endpoint 2 - Provider: Synology - "tw-001.s3.synologyc2.net" - TW Endpoint 1 - Provider: Synology - "cos.ap-beijing.myqcloud.com" - Beijing Region - Provider: TencentCOS - "cos.ap-nanjing.myqcloud.com" - Nanjing Region - Provider: TencentCOS - "cos.ap-shanghai.myqcloud.com" - Shanghai Region - Provider: TencentCOS - "cos.ap-guangzhou.myqcloud.com" - Guangzhou Region - Provider: TencentCOS - "cos.ap-chengdu.myqcloud.com" - Chengdu Region - Provider: TencentCOS - "cos.ap-chongqing.myqcloud.com" - Chongqing Region - Provider: TencentCOS - "cos.ap-hongkong.myqcloud.com" - Hong Kong (China) Region - Provider: TencentCOS - "cos.ap-singapore.myqcloud.com" - Singapore Region - Provider: TencentCOS - "cos.ap-mumbai.myqcloud.com" - Mumbai Region - Provider: TencentCOS - "cos.ap-seoul.myqcloud.com" - Seoul Region - Provider: TencentCOS - "cos.ap-bangkok.myqcloud.com" - Bangkok Region - Provider: TencentCOS - "cos.ap-tokyo.myqcloud.com" - Tokyo Region - Provider: TencentCOS - "cos.na-siliconvalley.myqcloud.com" - Silicon Valley Region - Provider: TencentCOS - "cos.na-ashburn.myqcloud.com" - Virginia Region - Provider: TencentCOS - "cos.na-toronto.myqcloud.com" - Toronto Region - Provider: TencentCOS - "cos.eu-frankfurt.myqcloud.com" - Frankfurt Region - Provider: TencentCOS - "cos.eu-moscow.myqcloud.com" - Moscow Region - Provider: TencentCOS - "cos.accelerate.myqcloud.com" - Use Tencent COS Accelerate Endpoint - Provider: TencentCOS - "s3-cn-bj.ufileos.com" - North China (Beijing 2) - Provider: US3 - "s3-cn-wlcb.ufileos.com" - North China (Ulanqab) - Provider: US3 - "s3-cn-sh2.ufileos.com" - Shanghai - Provider: US3 - "s3-cn-gd.ufileos.com" - South China (Guangzhou) - Provider: US3 - "s3-hk.ufileos.com" - Hongkong - Provider: US3 - "s3-us-ca.ufileos.com" - United States (Los Angeles) - Provider: US3 - "s3-sg.ufileos.com" - Singapore - Provider: US3 - "s3-idn-jakarta.ufileos.com" - Indonesia (Jakarta) - Provider: US3 - "s3-tw-tp.ufileos.com" - Taiwan (Taipei) - Provider: US3 - "s3-afr-nigeria.ufileos.com" - Nigeria (Lagos) - Provider: US3 - "s3-bra-saopaulo.ufileos.com" - Brazil (São Paulo) - Provider: US3 - "s3-uae-dubai.ufileos.com" - United Arab Emirates (Dubai) - Provider: US3 - "s3-ge-fra.ufileos.com" - Germany (Frankfurt) - Provider: US3 - "s3-vn-sng.ufileos.com" - Vietnam (Ho Chi Minh City) - Provider: US3 - "s3-us-ws.ufileos.com" - United States (Washington) - Provider: US3 - "s3-ind-mumbai.ufileos.com" - India (Mumbai) - Provider: US3 - "s3-kr-seoul.ufileos.com" - Seoul (South Korea) - Provider: US3 - "s3-jpn-tky.ufileos.com" - Japan (Tokyo) - Provider: US3 - "s3-th-bkk.ufileos.com" - Bangkok (Thailand) - Provider: US3 - "s3-uk-london.ufileos.com" - United Kingdom (London) - Provider: US3 - "s3-rus-mosc.ufileos.com" - Russia (Moscow) - Provider: US3 - "s3-cn-guiyang1.ufileos.com" - Guiyang 1 - Provider: US3 - "s3-pk-khi.ufileos.com" - Pakistan - Provider: US3 - "s3.wasabisys.com" - Wasabi US East 1 (N. Virginia) - Provider: Wasabi - "s3.us-east-2.wasabisys.com" - Wasabi US East 2 (N. Virginia) - Provider: Wasabi - "s3.us-central-1.wasabisys.com" - Wasabi US Central 1 (Texas) - Provider: Wasabi - "s3.us-west-1.wasabisys.com" - Wasabi US West 1 (Oregon) - Provider: Wasabi - "s3.ca-central-1.wasabisys.com" - Wasabi CA Central 1 (Toronto) - Provider: Wasabi - "s3.eu-central-1.wasabisys.com" - Wasabi EU Central 1 (Amsterdam) - Provider: Wasabi - "s3.eu-central-2.wasabisys.com" - Wasabi EU Central 2 (Frankfurt) - Provider: Wasabi - "s3.eu-west-1.wasabisys.com" - Wasabi EU West 1 (London) - Provider: Wasabi - "s3.eu-west-2.wasabisys.com" - Wasabi EU West 2 (Paris) - Provider: Wasabi - "s3.eu-south-1.wasabisys.com" - Wasabi EU South 1 (Milan) - Provider: Wasabi - "s3.ap-northeast-1.wasabisys.com" - Wasabi AP Northeast 1 (Tokyo) endpoint - Provider: Wasabi - "s3.ap-northeast-2.wasabisys.com" - Wasabi AP Northeast 2 (Osaka) endpoint - Provider: Wasabi - "s3.ap-southeast-1.wasabisys.com" - Wasabi AP Southeast 1 (Singapore) - Provider: Wasabi - "s3.ap-southeast-2.wasabisys.com" - Wasabi AP Southeast 2 (Sydney) - Provider: Wasabi - "idr01.zata.ai" - South Asia Endpoint - Provider: Zata - "fra1.s3.zeroservices.eu" - Frankfurt 1 - Provider: ZeroServices - "fra.s3.zeroservices.eu" - Frankfurt 2 - Provider: ZeroServices - "eyl1.s3.zeroservices.eu" - Eyl 1 - Provider: ZeroServices #### --s3-location-constraint Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only. Properties: - Config: location_constraint - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,Scality,SeaweedFS,Synology,Wasabi,Zata,ZeroServices,Other - Type: string - Required: false - Examples: - "" - Empty for US Region, Northern Virginia, or Pacific Northwest - Provider: AWS - "us-east-2" - US East (Ohio) Region - Provider: AWS - "us-west-1" - US West (Northern California) Region - Provider: AWS - "us-west-2" - US West (Oregon) Region - Provider: AWS - "ca-central-1" - Canada (Central) Region - Provider: AWS - "eu-west-1" - EU (Ireland) Region - Provider: AWS - "eu-west-2" - EU (London) Region - Provider: AWS - "eu-west-3" - EU (Paris) Region - Provider: AWS - "eu-north-1" - EU (Stockholm) Region - Provider: AWS - "eu-south-1" - EU (Milan) Region - Provider: AWS - "EU" - EU Region - Provider: AWS - "ap-southeast-1" - Asia Pacific (Singapore) Region - Provider: AWS - "ap-southeast-2" - Asia Pacific (Sydney) Region - Provider: AWS - "ap-northeast-1" - Asia Pacific (Tokyo) Region - Provider: AWS - "ap-northeast-2" - Asia Pacific (Seoul) Region - Provider: AWS - "ap-northeast-3" - Asia Pacific (Osaka-Local) Region - Provider: AWS - "ap-south-1" - Asia Pacific (Mumbai) Region - Provider: AWS - "ap-east-1" - Asia Pacific (Hong Kong) Region - Provider: AWS - "sa-east-1" - South America (Sao Paulo) Region - Provider: AWS - "il-central-1" - Israel (Tel Aviv) Region - Provider: AWS - "me-south-1" - Middle East (Bahrain) Region - Provider: AWS - "af-south-1" - Africa (Cape Town) Region - Provider: AWS - "cn-north-1" - China (Beijing) Region - Provider: AWS - "cn-northwest-1" - China (Ningxia) Region - Provider: AWS - "us-gov-east-1" - AWS GovCloud (US-East) Region - Provider: AWS - "us-gov-west-1" - AWS GovCloud (US) Region - Provider: AWS - "ir-thr-at1" - Tehran Iran (Simin) - Provider: ArvanCloud - "ir-tbz-sh1" - Tabriz Iran (Shahriar) - Provider: ArvanCloud - "wuxi1" - East China (Suzhou) - Provider: ChinaMobile - "jinan1" - East China (Jinan) - Provider: ChinaMobile - "ningbo1" - East China (Hangzhou) - Provider: ChinaMobile - "shanghai1" - East China (Shanghai-1) - Provider: ChinaMobile - "zhengzhou1" - Central China (Zhengzhou) - Provider: ChinaMobile - "hunan1" - Central China (Changsha-1) - Provider: ChinaMobile - "zhuzhou1" - Central China (Changsha-2) - Provider: ChinaMobile - "guangzhou1" - South China (Guangzhou-2) - Provider: ChinaMobile - "dongguan1" - South China (Guangzhou-3) - Provider: ChinaMobile - "beijing1" - North China (Beijing-1) - Provider: ChinaMobile - "beijing2" - North China (Beijing-2) - Provider: ChinaMobile - "beijing4" - North China (Beijing-3) - Provider: ChinaMobile - "huhehaote1" - North China (Huhehaote) - Provider: ChinaMobile - "chengdu1" - Southwest China (Chengdu) - Provider: ChinaMobile - "chongqing1" - Southwest China (Chongqing) - Provider: ChinaMobile - "guiyang1" - Southwest China (Guiyang) - Provider: ChinaMobile - "xian1" - Northwest China (Xian) - Provider: ChinaMobile - "yunnan" - Yunnan China (Kunming) - Provider: ChinaMobile - "yunnan2" - Yunnan China (Kunming-2) - Provider: ChinaMobile - "tianjin1" - Tianjin China (Tianjin) - Provider: ChinaMobile - "jilin1" - Jilin China (Changchun) - Provider: ChinaMobile - "hubei1" - Hubei China (Xiangyan) - Provider: ChinaMobile - "jiangxi1" - Jiangxi China (Nanchang) - Provider: ChinaMobile - "gansu1" - Gansu China (Lanzhou) - Provider: ChinaMobile - "shanxi1" - Shanxi China (Taiyuan) - Provider: ChinaMobile - "liaoning1" - Liaoning China (Shenyang) - Provider: ChinaMobile - "hebei1" - Hebei China (Shijiazhuang) - Provider: ChinaMobile - "fujian1" - Fujian China (Xiamen) - Provider: ChinaMobile - "guangxi1" - Guangxi China (Nanning) - Provider: ChinaMobile - "anhui1" - Anhui China (Huainan) - Provider: ChinaMobile - "us-standard" - US Cross Region Standard - Provider: IBMCOS - "us-vault" - US Cross Region Vault - Provider: IBMCOS - "us-cold" - US Cross Region Cold - Provider: IBMCOS - "us-flex" - US Cross Region Flex - Provider: IBMCOS - "us-east-standard" - US East Region Standard - Provider: IBMCOS - "us-east-vault" - US East Region Vault - Provider: IBMCOS - "us-east-cold" - US East Region Cold - Provider: IBMCOS - "us-east-flex" - US East Region Flex - Provider: IBMCOS - "us-south-standard" - US South Region Standard - Provider: IBMCOS - "us-south-vault" - US South Region Vault - Provider: IBMCOS - "us-south-cold" - US South Region Cold - Provider: IBMCOS - "us-south-flex" - US South Region Flex - Provider: IBMCOS - "eu-standard" - EU Cross Region Standard - Provider: IBMCOS - "eu-vault" - EU Cross Region Vault - Provider: IBMCOS - "eu-cold" - EU Cross Region Cold - Provider: IBMCOS - "eu-flex" - EU Cross Region Flex - Provider: IBMCOS - "eu-gb-standard" - Great Britain Standard - Provider: IBMCOS - "eu-gb-vault" - Great Britain Vault - Provider: IBMCOS - "eu-gb-cold" - Great Britain Cold - Provider: IBMCOS - "eu-gb-flex" - Great Britain Flex - Provider: IBMCOS - "ap-standard" - APAC Standard - Provider: IBMCOS - "ap-vault" - APAC Vault - Provider: IBMCOS - "ap-cold" - APAC Cold - Provider: IBMCOS - "ap-flex" - APAC Flex - Provider: IBMCOS - "mel01-standard" - Melbourne Standard - Provider: IBMCOS - "mel01-vault" - Melbourne Vault - Provider: IBMCOS - "mel01-cold" - Melbourne Cold - Provider: IBMCOS - "mel01-flex" - Melbourne Flex - Provider: IBMCOS - "tor01-standard" - Toronto Standard - Provider: IBMCOS - "tor01-vault" - Toronto Vault - Provider: IBMCOS - "tor01-cold" - Toronto Cold - Provider: IBMCOS - "tor01-flex" - Toronto Flex - Provider: IBMCOS - "cn-east-1" - East China Region 1 - Provider: Qiniu - "cn-east-2" - East China Region 2 - Provider: Qiniu - "cn-north-1" - North China Region 1 - Provider: Qiniu - "cn-south-1" - South China Region 1 - Provider: Qiniu - "us-north-1" - North America Region 1 - Provider: Qiniu - "ap-southeast-1" - Southeast Asia Region 1 - Provider: Qiniu - "ap-northeast-1" - Northeast Asia Region 1 - Provider: Qiniu - "us-east-1" - US East (N. Virginia) - Provider: Rabata - "eu-west-1" - EU (Ireland) - Provider: Rabata - "eu-west-2" - EU (London) - Provider: Rabata - "global" - Global CDN Region - Provider: RackCorp - "au" - Australia (All locations) - Provider: RackCorp - "au-nsw" - NSW (Australia) Region - Provider: RackCorp - "au-qld" - QLD (Australia) Region - Provider: RackCorp - "au-vic" - VIC (Australia) Region - Provider: RackCorp - "au-wa" - Perth (Australia) Region - Provider: RackCorp - "ph" - Manila (Philippines) Region - Provider: RackCorp - "th" - Bangkok (Thailand) Region - Provider: RackCorp - "hk" - HK (Hong Kong) Region - Provider: RackCorp - "mn" - Ulaanbaatar (Mongolia) Region - Provider: RackCorp - "kg" - Bishkek (Kyrgyzstan) Region - Provider: RackCorp - "id" - Jakarta (Indonesia) Region - Provider: RackCorp - "jp" - Tokyo (Japan) Region - Provider: RackCorp - "sg" - SG (Singapore) Region - Provider: RackCorp - "de" - Frankfurt (Germany) Region - Provider: RackCorp - "us" - USA (AnyCast) Region - Provider: RackCorp - "us-east-1" - New York (USA) Region - Provider: RackCorp - "us-west-1" - Fremont (USA) Region - Provider: RackCorp - "nz" - Auckland (New Zealand) Region - Provider: RackCorp #### --s3-acl Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used. Properties: - Config: acl - Env Var: RCLONE_S3_ACL - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other - Type: string - Required: false - Examples: - "private" - Owner gets FULL_CONTROL. - No one else has access rights (default). - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,US3,Wasabi,Zata,ZeroServices,Other - "public-read" - Owner gets FULL_CONTROL. - The AllUsers group gets READ access. - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other - "public-read-write" - Owner gets FULL_CONTROL. - The AllUsers group gets READ and WRITE access. - Granting this on a bucket is generally not recommended. - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other - "authenticated-read" - Owner gets FULL_CONTROL. - The AuthenticatedUsers group gets READ access. - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other - "bucket-owner-read" - Object owner gets FULL_CONTROL. - Bucket owner gets READ access. - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other - "bucket-owner-full-control" - Both the object owner and the bucket owner get FULL_CONTROL over the object. - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other - "private" - Owner gets FULL_CONTROL. - No one else has access rights (default). - This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS. - Provider: IBMCOS - "public-read" - Owner gets FULL_CONTROL. - The AllUsers group gets READ access. - This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS. - Provider: IBMCOS - "public-read-write" - Owner gets FULL_CONTROL. - The AllUsers group gets READ and WRITE access. - This acl is available on IBM Cloud (Infra), On-Premise IBM COS. - Provider: IBMCOS - "authenticated-read" - Owner gets FULL_CONTROL. - The AuthenticatedUsers group gets READ access. - Not supported on Buckets. - This acl is available on IBM Cloud (Infra) and On-Premise IBM COS. - Provider: IBMCOS - "default" - Owner gets Full_CONTROL. - No one else has access rights (default). - Provider: TencentCOS #### --s3-server-side-encryption The server-side encryption algorithm used when storing this object in S3. Properties: - Config: server_side_encryption - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION - Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: - "" - None - Provider: AWS,Ceph,ChinaMobile,Minio - "AES256" - AES256 - Provider: AWS,Ceph,ChinaMobile,Minio - "aws:kms" - aws:kms - Provider: AWS,Ceph,Minio #### --s3-sse-kms-key-id If using KMS ID you must provide the ARN of Key. Properties: - Config: sse_kms_key_id - Env Var: RCLONE_S3_SSE_KMS_KEY_ID - Provider: AWS,Ceph,Minio - Type: string - Required: false - Examples: - "" - None - "arn:aws:kms:us-east-1:*" - arn:aws:kms:* #### --s3-storage-class The storage class to use when storing new objects in S3. Properties: - Config: storage_class - Env Var: RCLONE_S3_STORAGE_CLASS - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3 - Type: string - Required: false - Examples: - "" - Default - Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3 - "STANDARD" - Standard storage class - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3 - "REDUCED_REDUNDANCY" - Reduced redundancy storage class - Provider: AWS - "STANDARD_IA" - Standard Infrequent Access storage class - Provider: AWS,OVHcloud - "ONEZONE_IA" - One Zone Infrequent Access storage class - Provider: AWS - "GLACIER" - Glacier Flexible Retrieval storage class - Provider: AWS - "DEEP_ARCHIVE" - Glacier Deep Archive storage class - Provider: AWS - "INTELLIGENT_TIERING" - Intelligent-Tiering storage class - Provider: AWS - "GLACIER_IR" - Glacier Instant Retrieval storage class - Provider: AWS,Magalu - "GLACIER" - Archive storage mode - Provider: Alibaba,ChinaMobile,Qiniu - "STANDARD_IA" - Infrequent access storage mode - Provider: Alibaba,ChinaMobile,TencentCOS,US3 - "EXPRESS_ONEZONE" - High Performance storage class - Provider: OVHcloud - "ONEZONE_IA" - Standard Infrequent Access storage class - Provider: OVHcloud - "GLACIER" - Active Archive storage class - Provider: OVHcloud - "GLACIER_IR" - Active Archive storage class - Provider: OVHcloud - "DEEP_ARCHIVE" - Cold Archive storage class - Provider: OVHcloud - "INTELLIGENT_TIERING" - Standard storage class - Provider: OVHcloud - "LINE" - Infrequent access storage mode - Provider: Qiniu - "DEEP_ARCHIVE" - Deep archive storage mode - Provider: Qiniu - "" - Default. - Provider: Scaleway - "STANDARD" - The Standard class for any upload. - Suitable for on-demand content like streaming or CDN. - Available in all regions. - Provider: Scaleway - "GLACIER" - Archived storage. - Prices are lower, but it needs to be restored first to be accessed. - Available in the FR-PAR region only. - Provider: Scaleway - "ONEZONE_IA" - One Zone - Infrequent Access. - A good choice for storing secondary backup copies or easily re-creatable data. - Available in all regions. - Provider: Scaleway - "ARCHIVE" - Archive storage mode - Provider: TencentCOS,US3 #### --s3-ibm-api-key IBM API Key to be used to obtain IAM token Properties: - Config: ibm_api_key - Env Var: RCLONE_S3_IBM_API_KEY - Provider: IBMCOS - Type: string - Required: false #### --s3-ibm-resource-instance-id IBM service instance id Properties: - Config: ibm_resource_instance_id - Env Var: RCLONE_S3_IBM_RESOURCE_INSTANCE_ID - Provider: IBMCOS - Type: string - Required: false #### --s3-bucket-object-lock-enabled Enable Object Lock when creating new buckets. Properties: - Config: bucket_object_lock_enabled - Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED - Type: bool - Default: false ### Advanced options Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, Scality, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, ZeroServices, Other). #### --s3-bucket-acl Canned ACL used when creating buckets. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when only when creating buckets. If it isn't set then "acl" is used instead. If the "acl" and "bucket_acl" are empty strings then no X-Amz-Acl: header is added and the default (private) will be used. Properties: - Config: bucket_acl - Env Var: RCLONE_S3_BUCKET_ACL - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other - Type: string - Required: false - Examples: - "private" - Owner gets FULL_CONTROL. - No one else has access rights (default). - "public-read" - Owner gets FULL_CONTROL. - The AllUsers group gets READ access. - "public-read-write" - Owner gets FULL_CONTROL. - The AllUsers group gets READ and WRITE access. - Granting this on a bucket is generally not recommended. - "authenticated-read" - Owner gets FULL_CONTROL. - The AuthenticatedUsers group gets READ access. #### --s3-requester-pays Enables requester pays option when interacting with S3 bucket. Properties: - Config: requester_pays - Env Var: RCLONE_S3_REQUESTER_PAYS - Provider: AWS - Type: bool - Default: false #### --s3-sse-customer-algorithm If using SSE-C, the server-side encryption algorithm used when storing this object in S3. Properties: - Config: sse_customer_algorithm - Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM - Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: - "" - None - "AES256" - AES256 #### --s3-sse-customer-key To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data. Alternatively you can provide --sse-customer-key-base64. Properties: - Config: sse_customer_key - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY - Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: - "" - None #### --s3-sse-customer-key-base64 If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data. Alternatively you can provide --sse-customer-key. Properties: - Config: sse_customer_key_base64 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64 - Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: - "" - None #### --s3-sse-customer-key-md5 If using SSE-C you may provide the secret encryption key MD5 checksum (optional). If you leave it blank, this is calculated automatically from the sse_customer_key provided. Properties: - Config: sse_customer_key_md5 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 - Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: - "" - None #### --s3-upload-cutoff Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB. Properties: - Config: upload_cutoff - Env Var: RCLONE_S3_UPLOAD_CUTOFF - Type: SizeSuffix - Default: 200Mi #### --s3-chunk-size Chunk size to use for uploading. When uploading files larger than upload_cutoff or files with unknown size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size. Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer. If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers. Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit. Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5 MiB and there can be at most 10,000 chunks, this means that by default the maximum size of a file you can stream upload is 48 GiB. If you wish to stream upload larger files then you will need to increase chunk_size. Increasing the chunk size decreases the accuracy of the progress statistics displayed with "-P" flag. Rclone treats chunk as sent when it's buffered by the AWS SDK, when in fact it may still be uploading. A bigger chunk size means a bigger AWS SDK buffer and progress reporting more deviating from the truth. Properties: - Config: chunk_size - Env Var: RCLONE_S3_CHUNK_SIZE - Type: SizeSuffix - Default: 5Mi #### --s3-max-upload-parts Maximum number of parts in a multipart upload. This option defines the maximum number of multipart chunks to use when doing a multipart upload. This can be useful if a service does not support the AWS S3 specification of 10,000 chunks. Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit. Properties: - Config: max_upload_parts - Env Var: RCLONE_S3_MAX_UPLOAD_PARTS - Type: int - Default: 10000 #### --s3-copy-cutoff Cutoff for switching to multipart copy. Any files larger than this that need to be server-side copied will be copied in chunks of this size. The minimum is 1 byte and the maximum is 5 GiB. Properties: - Config: copy_cutoff - Env Var: RCLONE_S3_COPY_CUTOFF - Type: SizeSuffix - Default: 4.656Gi #### --s3-disable-checksum Don't store MD5 checksum with object metadata. Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading. Properties: - Config: disable_checksum - Env Var: RCLONE_S3_DISABLE_CHECKSUM - Type: bool - Default: false #### --s3-shared-credentials-file Path to the shared credentials file. If env_auth = true then rclone can use a shared credentials file. If this variable is empty rclone will look for the "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it will default to the current user's home directory. Linux/OSX: "$HOME/.aws/credentials" Windows: "%USERPROFILE%\.aws\credentials" Properties: - Config: shared_credentials_file - Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE - Type: string - Required: false #### --s3-profile Profile to use in the shared credentials file. If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file. If empty it will default to the environment variable "AWS_PROFILE" or "default" if that environment variable is also not set. Properties: - Config: profile - Env Var: RCLONE_S3_PROFILE - Type: string - Required: false #### --s3-session-token An AWS session token. Properties: - Config: session_token - Env Var: RCLONE_S3_SESSION_TOKEN - Type: string - Required: false #### --s3-role-arn ARN of the IAM role to assume. Leave blank if not using assume role. Properties: - Config: role_arn - Env Var: RCLONE_S3_ROLE_ARN - Type: string - Required: false #### --s3-role-session-name Session name for assumed role. If empty, a session name will be generated automatically. Properties: - Config: role_session_name - Env Var: RCLONE_S3_ROLE_SESSION_NAME - Type: string - Required: false #### --s3-role-session-duration Session duration for assumed role. If empty, the default session duration will be used. Properties: - Config: role_session_duration - Env Var: RCLONE_S3_ROLE_SESSION_DURATION - Type: string - Required: false #### --s3-role-external-id External ID for assumed role. Leave blank if not using an external ID. Properties: - Config: role_external_id - Env Var: RCLONE_S3_ROLE_EXTERNAL_ID - Type: string - Required: false #### --s3-upload-concurrency Concurrency for multipart uploads and copies. This is the number of chunks of the same file that are uploaded concurrently for multipart uploads and copies. If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. Properties: - Config: upload_concurrency - Env Var: RCLONE_S3_UPLOAD_CONCURRENCY - Type: int - Default: 4 #### --s3-force-path-style If true use path style access if false use virtual hosted style. If this is true (the default) then rclone will use path style access, if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html) for more info. Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting. Note that if your bucket isn't a valid DNS name, i.e. has '.' or '_' in, you'll need to set this to true. Properties: - Config: force_path_style - Env Var: RCLONE_S3_FORCE_PATH_STYLE - Type: bool - Default: true #### --s3-v2-auth If true use v2 authentication. If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication. Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH. Properties: - Config: v2_auth - Env Var: RCLONE_S3_V2_AUTH - Type: bool - Default: false #### --s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support). See [AWS Docs on Dualstack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html) Properties: - Config: use_dual_stack - Env Var: RCLONE_S3_USE_DUAL_STACK - Type: bool - Default: false #### --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) Properties: - Config: use_accelerate_endpoint - Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT - Provider: AWS - Type: bool - Default: false #### --s3-use-arn-region If true, enables arn region support for the service. Properties: - Config: use_arn_region - Env Var: RCLONE_S3_USE_ARN_REGION - Type: bool - Default: false #### --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. It should be set to true for resuming uploads across different sessions. WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. Properties: - Config: leave_parts_on_error - Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR - Provider: AWS - Type: bool - Default: false #### --s3-list-chunk Size of listing chunk (response list for each ListObject S3 request). This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). In Ceph, this can be increased with the "rgw list buckets max chunk" option. Properties: - Config: list_chunk - Env Var: RCLONE_S3_LIST_CHUNK - Type: int - Default: 1000 #### --s3-list-version Version of ListObjects to use: 1,2 or 0 for auto. When S3 originally launched it only provided the ListObjects call to enumerate objects in a bucket. However in May 2016 the ListObjectsV2 call was introduced. This is much higher performance and should be used if at all possible. If set to the default, 0, rclone will guess according to the provider set which list objects method to call. If it guesses wrong, then it may be set manually here. Properties: - Config: list_version - Env Var: RCLONE_S3_LIST_VERSION - Type: int - Default: 0 #### --s3-list-url-encode Whether to url encode listings: true/false/unset Some providers support URL encoding listings and where this is available this is more reliable when using control characters in file names. If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here. Properties: - Config: list_url_encode - Env Var: RCLONE_S3_LIST_URL_ENCODE - Type: Tristate - Default: unset #### --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it. This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. It can also be needed if the user you are using does not have bucket creation permissions. Before v1.52.0 this would have passed silently due to a bug. Properties: - Config: no_check_bucket - Env Var: RCLONE_S3_NO_CHECK_BUCKET - Type: bool - Default: false #### --s3-no-head If set, don't HEAD uploaded objects to check integrity. This can be useful when trying to minimise the number of transactions rclone does. Setting it means that if rclone receives a 200 OK message after uploading an object with PUT then it will assume that it got uploaded properly. In particular it will assume: - the metadata, including modtime, storage class and content type was as uploaded - the size was as uploaded It reads the following items from the response for a single part PUT: - the MD5SUM - The uploaded date For multipart uploads these items aren't read. If an source object of unknown length is uploaded then rclone **will** do a HEAD request. Setting this flag increases the chance for undetected upload failures, in particular an incorrect size, so it isn't recommended for normal operation. In practice the chance of an undetected upload failure is very small even with this flag. Properties: - Config: no_head - Env Var: RCLONE_S3_NO_HEAD - Type: bool - Default: false #### --s3-no-head-object If set, do not do HEAD before GET when getting objects. Properties: - Config: no_head_object - Env Var: RCLONE_S3_NO_HEAD_OBJECT - Type: bool - Default: false #### --s3-encoding The encoding for the backend. See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. Properties: - Config: encoding - Env Var: RCLONE_S3_ENCODING - Type: Encoding - Default: Slash,InvalidUtf8,Dot #### --s3-disable-http2 Disable usage of http2 for S3 backends. There is currently an unsolved issue with the s3 (specifically minio) backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be disabled here. When the issue is solved this flag will be removed. See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631 Properties: - Config: disable_http2 - Env Var: RCLONE_S3_DISABLE_HTTP2 - Type: bool - Default: false #### --s3-download-url Custom endpoint for downloads. This is usually set to a CloudFront CDN URL as AWS S3 offers cheaper egress for data downloaded through the CloudFront network. Properties: - Config: download_url - Env Var: RCLONE_S3_DOWNLOAD_URL - Type: string - Required: false #### --s3-directory-markers Upload an empty object with a trailing slash when a new directory is created Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with "/", to persist the folder. Properties: - Config: directory_markers - Env Var: RCLONE_S3_DIRECTORY_MARKERS - Type: bool - Default: false #### --s3-use-multipart-etag Whether to use ETag in multipart uploads for verification This should be true, false or left unset to use the default for the provider. Properties: - Config: use_multipart_etag - Env Var: RCLONE_S3_USE_MULTIPART_ETAG - Type: Tristate - Default: unset #### --s3-use-unsigned-payload Whether to use an unsigned payload in PutObject Rclone has to avoid the AWS SDK seeking the body when calling PutObject. The AWS provider can add checksums in the trailer to avoid seeking but other providers can't. This should be true, false or left unset to use the default for the provider. Properties: - Config: use_unsigned_payload - Env Var: RCLONE_S3_USE_UNSIGNED_PAYLOAD - Type: Tristate - Default: unset #### --s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads If this is false rclone will use PutObject from the AWS SDK to upload an object. Versions of rclone < 1.59 use presigned requests to upload a single part object and setting this flag to true will re-enable that functionality. This shouldn't be necessary except in exceptional circumstances or for testing. Properties: - Config: use_presigned_request - Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST - Type: bool - Default: false #### --s3-use-data-integrity-protections If true use AWS S3 data integrity protections. See [AWS Docs on Data Integrity Protections](https://docs.aws.amazon.com/sdkref/latest/guide/feature-dataintegrity.html) Properties: - Config: use_data_integrity_protections - Env Var: RCLONE_S3_USE_DATA_INTEGRITY_PROTECTIONS - Type: Tristate - Default: unset #### --s3-versions Include old versions in directory listings. Properties: - Config: versions - Env Var: RCLONE_S3_VERSIONS - Type: bool - Default: false #### --s3-version-at Show file versions as they were at the specified time. The parameter should be a date, "2006-01-02", datetime "2006-01-02 15:04:05" or a duration for that long ago, eg "100d" or "1h". Note that when using this no file write operations are permitted, so you can't upload files or delete them. See [the time option docs](https://rclone.org/docs/#time-options) for valid formats. Properties: - Config: version_at - Env Var: RCLONE_S3_VERSION_AT - Type: Time - Default: off #### --s3-version-deleted Show deleted file markers when using versions. This shows deleted file markers in the listing when using versions. These will appear as 0 size files. The only operation which can be performed on them is deletion. Deleting a delete marker will reveal the previous version. Deleted files will always show with a timestamp. Properties: - Config: version_deleted - Env Var: RCLONE_S3_VERSION_DELETED - Type: bool - Default: false #### --s3-decompress If set this will decompress gzip encoded objects. It is possible to upload objects to S3 with "Content-Encoding: gzip" set. Normally rclone will download these files as compressed objects. If this flag is set then rclone will decompress these files with "Content-Encoding: gzip" as they are received. This means that rclone can't check the size and hash but the file contents will be decompressed. Properties: - Config: decompress - Env Var: RCLONE_S3_DECOMPRESS - Type: bool - Default: false #### --s3-might-gzip Set this if the backend might gzip objects. Normally providers will not alter objects when they are downloaded. If an object was not uploaded with `Content-Encoding: gzip` then it won't be set on download. However some providers may gzip objects even if they weren't uploaded with `Content-Encoding: gzip` (eg Cloudflare). A symptom of this would be receiving errors like ERROR corrupted on transfer: sizes differ NNN vs MMM If you set this flag and rclone downloads an object with Content-Encoding: gzip set and chunked transfer encoding, then rclone will decompress the object on the fly. If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here. Properties: - Config: might_gzip - Env Var: RCLONE_S3_MIGHT_GZIP - Type: Tristate - Default: unset #### --s3-use-accept-encoding-gzip Whether to send `Accept-Encoding: gzip` header. By default, rclone will append `Accept-Encoding: gzip` to the request to download compressed objects whenever possible. However some providers such as Google Cloud Storage may alter the HTTP headers, breaking the signature of the request. A symptom of this would be receiving errors like SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided. In this case, you might want to try disabling this option. Properties: - Config: use_accept_encoding_gzip - Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP - Type: Tristate - Default: unset #### --s3-no-system-metadata Suppress setting and reading of system metadata Properties: - Config: no_system_metadata - Env Var: RCLONE_S3_NO_SYSTEM_METADATA - Type: bool - Default: false #### --s3-use-already-exists Set if rclone should report BucketAlreadyExists errors on bucket creation. At some point during the evolution of the s3 protocol, AWS started returning an `AlreadyOwnedByYou` error when attempting to create a bucket that the user already owned, rather than a `BucketAlreadyExists` error. Unfortunately exactly what has been implemented by s3 clones is a little inconsistent, some return `AlreadyOwnedByYou`, some return `BucketAlreadyExists` and some return no error at all. This is important to rclone because it ensures the bucket exists by creating it on quite a lot of operations (unless `--s3-no-check-bucket` is used). If rclone knows the provider can return `AlreadyOwnedByYou` or returns no error then it can report `BucketAlreadyExists` errors when the user attempts to create a bucket not owned by them. Otherwise rclone ignores the `BucketAlreadyExists` error which can lead to confusion. This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. Properties: - Config: use_already_exists - Env Var: RCLONE_S3_USE_ALREADY_EXISTS - Type: Tristate - Default: unset #### --s3-use-multipart-uploads Set if rclone should use multipart uploads. You can change this if you want to disable the use of multipart uploads. This shouldn't be necessary in normal operation. This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. Properties: - Config: use_multipart_uploads - Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS - Type: Tristate - Default: unset #### --s3-list-versions-oldest-first Set if the backend returns object versions oldest first. The S3 standard returns object versions newest first. Some backends (e.g. Hitachi HCP) return them oldest first instead. Set this quirk if --s3-version-at or --s3-versions produce incorrect results with your backend. This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. Properties: - Config: list_versions_oldest_first - Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST - Type: Tristate - Default: unset #### --s3-use-x-id Set if rclone should add x-id URL parameters. You can change this if you want to disable the AWS SDK from adding x-id URL parameters. This shouldn't be necessary in normal operation. This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. Properties: - Config: use_x_id - Env Var: RCLONE_S3_USE_X_ID - Type: Tristate - Default: unset #### --s3-sign-accept-encoding Set if rclone should include Accept-Encoding as part of the signature. You can change this if you want to stop rclone including Accept-Encoding as part of the signature. This shouldn't be necessary in normal operation. This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. Properties: - Config: sign_accept_encoding - Env Var: RCLONE_S3_SIGN_ACCEPT_ENCODING - Type: Tristate - Default: unset #### --s3-directory-bucket Set to use AWS Directory Buckets If you are using an AWS Directory Bucket then set this flag. This will ensure no `Content-Md5` headers are sent and ensure `ETag` headers are not interpreted as MD5 sums. `X-Amz-Meta-Md5chksum` will be set on all objects whether single or multipart uploaded. This also sets `no_check_bucket = true`. Note that Directory Buckets do not support: - Versioning - `Content-Encoding: gzip` Rclone limitations with Directory Buckets: - rclone does not support creating Directory Buckets with `rclone mkdir` - ... or removing them with `rclone rmdir` yet - Directory Buckets do not appear when doing `rclone lsf` at the top level. - Rclone can't remove auto created directories yet. In theory this should work with `directory_markers = true` but it doesn't. - Directories don't seem to appear in recursive (ListR) listings. Properties: - Config: directory_bucket - Env Var: RCLONE_S3_DIRECTORY_BUCKET - Provider: AWS - Type: bool - Default: false #### --s3-sdk-log-mode Set to debug the SDK This can be set to a comma separated list of the following functions: - `Signing` - `Retries` - `Request` - `RequestWithBody` - `Response` - `ResponseWithBody` - `DeprecatedUsage` - `RequestEventMessage` - `ResponseEventMessage` Use `Off` to disable and `All` to set all log levels. You will need to use `-vv` to see the debug level logs. Properties: - Config: sdk_log_mode - Env Var: RCLONE_S3_SDK_LOG_MODE - Type: Bits - Default: Off #### --s3-ibm-iam-endpoint IBM IAM Endpoint to use for authentication. Leave blank to use the default public endpoint. Properties: - Config: ibm_iam_endpoint - Env Var: RCLONE_S3_IBM_IAM_ENDPOINT - Provider: IBMCOS - Type: string - Required: false #### --s3-object-lock-mode Object Lock mode to apply when uploading or copying objects. Set this to apply Object Lock retention mode to objects. If not set, no Object Lock mode is applied (even with --metadata). Note: To enable Object Lock retention, you must set BOTH object_lock_mode AND object_lock_retain_until_date. Setting only one has no effect. - GOVERNANCE: Set Object Lock mode to GOVERNANCE - COMPLIANCE: Set Object Lock mode to COMPLIANCE - copy: Copy the mode from the source object (requires --metadata) See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html Properties: - Config: object_lock_mode - Env Var: RCLONE_S3_OBJECT_LOCK_MODE - Type: string - Required: false - Examples: - "GOVERNANCE" - Set Object Lock mode to GOVERNANCE - "COMPLIANCE" - Set Object Lock mode to COMPLIANCE - "copy" - Copy from source object (requires --metadata) #### --s3-object-lock-retain-until-date Object Lock retention until date to apply when uploading or copying objects. Set this to apply Object Lock retention date to objects. If not set, no retention date is applied (even with --metadata). Note: To enable Object Lock retention, you must set BOTH object_lock_mode AND object_lock_retain_until_date. Setting only one has no effect. Accepts: - RFC 3339 format: 2030-01-02T15:04:05Z - Duration from now: 365d, 1y, 6M (days, years, months) - copy: Copy the date from the source object (requires --metadata) See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html Properties: - Config: object_lock_retain_until_date - Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE - Type: string - Required: false - Examples: - "copy" - Copy from source object (requires --metadata) - "2030-01-01T00:00:00Z" - Set specific date (RFC 3339 format) - "365d" - Set retention for 365 days from now - "1y" - Set retention for 1 year from now #### --s3-object-lock-legal-hold-status Object Lock legal hold status to apply when uploading or copying objects. Set this to apply Object Lock legal hold to objects. If not set, no legal hold is applied (even with --metadata). Note: Legal hold is independent of retention and can be set separately. - ON: Enable legal hold - OFF: Disable legal hold - copy: Copy the legal hold status from the source object (requires --metadata) See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html Properties: - Config: object_lock_legal_hold_status - Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS - Type: string - Required: false - Examples: - "ON" - Enable legal hold - "OFF" - Disable legal hold - "copy" - Copy from source object (requires --metadata) #### --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode. Properties: - Config: bypass_governance_retention - Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION - Type: bool - Default: false #### --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload. Use this for S3-compatible providers that don't support setting Object Lock headers during PUT operations. When enabled, Object Lock is set via separate PutObjectRetention and PutObjectLegalHold API calls after the upload completes. This adds extra API calls per object, so only enable if your provider requires it. Properties: - Config: object_lock_set_after_upload - Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD - Type: bool - Default: false #### --s3-object-lock-supported Whether the provider supports S3 Object Lock. This should be true, false or left unset to use the default for the provider. Set to false for providers that don't fully support the S3 Object Lock API (e.g. GCS which uses non-standard headers for bypass governance retention and doesn't implement Legal Hold via the S3 API). Properties: - Config: object_lock_supported - Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED - Type: Tristate - Default: unset #### --s3-description Description of the remote. Properties: - Config: description - Env Var: RCLONE_S3_DESCRIPTION - Type: string - Required: false ### Metadata User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case. Here are the possible system metadata items for the s3 backend. | Name | Help | Type | Example | Read Only | |------|------|------|---------|-----------| | btime | Time of file birth (creation) read from Last-Modified header | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | **Y** | | cache-control | Cache-Control header | string | no-cache | N | | content-disposition | Content-Disposition header | string | inline | N | | content-encoding | Content-Encoding header | string | gzip | N | | content-language | Content-Language header | string | en-US | N | | content-type | Content-Type header | string | text/plain | N | | mtime | Time of last modification, read from rclone metadata | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | N | | object-lock-legal-hold-status | Object Lock legal hold status: ON or OFF | string | OFF | N | | object-lock-mode | Object Lock mode: GOVERNANCE or COMPLIANCE | string | GOVERNANCE | N | | object-lock-retain-until-date | Object Lock retention until date | RFC 3339 | 2030-01-02T15:04:05Z | N | | tier | Tier of the object | string | GLACIER | **Y** | See the [metadata](https://rclone.org/docs/#metadata) docs for more info. ## Backend commands Here are the commands specific to the s3 backend. Run them with: ```console rclone backend COMMAND remote: ``` The help below will explain what arguments each command takes. See the [backend](https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. These can be run on a running backend using the rc command [backend/command](https://rclone.org/rc/#backend-command). ### restore Restore objects from GLACIER or INTELLIGENT-TIERING archive tier. ```console rclone backend restore remote: [options] [+] ``` This command can be used to restore one or more objects from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier. Usage examples: ```console rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY ``` This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags. ```console rclone --interactive backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1 ``` All the objects shown will be marked for restore, then: ```console rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1 ``` It returns a list of status dictionaries with Remote and Status keys. The Status will be OK if it was successful or an error message if not. ```json [ { "Status": "OK", "Remote": "test.txt" }, { "Status": "OK", "Remote": "test/file4.txt" } ] ``` Options: - "description": The optional description for the job. - "lifetime": Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING storage. - "priority": Priority of restore: Standard|Expedited|Bulk ### restore-status Show the status for objects being restored from GLACIER or INTELLIGENT-TIERING. ```console rclone backend restore-status remote: [options] [+] ``` This command can be used to show the status for objects being restored from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier. Usage examples: ```console rclone backend restore-status s3:bucket/path/to/object rclone backend restore-status s3:bucket/path/to/directory rclone backend restore-status -o all s3:bucket/path/to/directory ``` This command does not obey the filters. It returns a list of status dictionaries: ```json [ { "Remote": "file.txt", "VersionID": null, "RestoreStatus": { "IsRestoreInProgress": true, "RestoreExpiryDate": "2023-09-06T12:29:19+01:00" }, "StorageClass": "GLACIER" }, { "Remote": "test.pdf", "VersionID": null, "RestoreStatus": { "IsRestoreInProgress": false, "RestoreExpiryDate": "2023-09-06T12:29:19+01:00" }, "StorageClass": "DEEP_ARCHIVE" }, { "Remote": "test.gz", "VersionID": null, "RestoreStatus": { "IsRestoreInProgress": true, "RestoreExpiryDate": "null" }, "StorageClass": "INTELLIGENT_TIERING" } ] ``` Options: - "all": If set then show all objects, not just ones with restore status. ### list-multipart-uploads List the unfinished multipart uploads. ```console rclone backend list-multipart-uploads remote: [options] [+] ``` This command lists the unfinished multipart uploads in JSON format. Usage examples: ```console rclone backend list-multipart s3:bucket/path/to/object ``` It returns a dictionary of buckets with values as lists of unfinished multipart uploads. You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path. ```json { "rclone": [ { "Initiated": "2020-06-26T14:20:36Z", "Initiator": { "DisplayName": "XXX", "ID": "arn:aws:iam::XXX:user/XXX" }, "Key": "KEY", "Owner": { "DisplayName": null, "ID": "XXX" }, "StorageClass": "STANDARD", "UploadId": "XXX" } ], "rclone-1000files": [], "rclone-dst": [] } ``` ### cleanup Remove unfinished multipart uploads. ```console rclone backend cleanup remote: [options] [+] ``` This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours. Note that you can use --interactive/-i or --dry-run with this command to see what it would do. Usage examples: ```console rclone backend cleanup s3:bucket/path/to/object rclone backend cleanup -o max-age=7w s3:bucket/path/to/object ``` Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. Options: - "max-age": Max age of upload to delete. ### cleanup-hidden Remove old versions of files. ```console rclone backend cleanup-hidden remote: [options] [+] ``` This command removes any old hidden versions of files on a versions enabled bucket. Note that you can use --interactive/-i or --dry-run with this command to see what it would do. Usage example: ```console rclone backend cleanup-hidden s3:bucket/path/to/dir ``` ### versioning Set/get versioning support for a bucket. ```console rclone backend versioning remote: [options] [+] ``` This command sets versioning support if a parameter is passed and then returns the current versioning status for the bucket supplied. Usage examples: ```console rclone backend versioning s3:bucket # read status only rclone backend versioning s3:bucket Enabled rclone backend versioning s3:bucket Suspended ``` It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning has been enabled the status can't be set back to "Unversioned". ### set Set command for updating the config parameters. ```console rclone backend set remote: [options] [+] ``` This set command can be used to update the config parameters for a running s3 backend. Usage examples: ```console rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2] rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2] rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X ``` The option keys are named as they are in the config file. This rebuilds the connection to the s3 backend when it is called with the new parameters. Only new parameters need be passed as the values will default to those currently in use. It doesn't return anything. ### Anonymous access to public buckets {#anonymous-access} If you want to use rclone to access a public bucket, configure with a blank `access_key_id` and `secret_access_key`. Your config should end up looking like this: ```ini [anons3] type = s3 provider = AWS ``` Then use it as normal with the name of the public bucket, e.g. ```console rclone lsd anons3:1000genomes ``` You will be able to list and copy data but not upload it. You can also do this entirely on the command line ```console rclone lsd :s3,provider=AWS:1000genomes ``` ## Providers ### AWS S3 This is the provider used as main example and described in the [configuration](#configuration) section above. ### AWS Directory Buckets From rclone v1.69 [Directory Buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) are supported. You will need to set the `directory_buckets = true` config parameter or use `--s3-directory-buckets`. Note that rclone cannot yet: - Create directory buckets - List directory buckets See [the --s3-directory-buckets flag](#s3-directory-buckets) for more info ### AWS Snowball Edge [AWS Snowball](https://aws.amazon.com/snowball/) is a hardware appliance used for transferring bulk data back to AWS. Its main software interface is S3 object storage. To use rclone with AWS Snowball Edge devices, configure as standard for an 'S3 Compatible Service'. If using rclone pre v1.59 be sure to set `upload_cutoff = 0` otherwise you will run into authentication header issues as the snowball device does not support query parameter based authentication. With rclone v1.59 or later setting `upload_cutoff` should not be necessary. eg. ```ini [snowball] type = s3 provider = Other access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY endpoint = http://[IP of Snowball]:8080 upload_cutoff = 0 ``` ### Alibaba OSS {#alibaba-oss} Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n name> oss Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ "s3" [snip] Storage> s3 Choose your S3 provider. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \ "AWS" 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun \ "Alibaba" 3 / Ceph Object Storage \ "Ceph" [snip] provider> Alibaba Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Enter a boolean value (true or false). Press Enter for the default ("false"). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \ "false" 2 / Get AWS credentials from the environment (env vars or IAM) \ "true" env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). secret_access_key> secretaccesskey Endpoint for OSS API. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / East China 1 (Hangzhou) \ "oss-cn-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai) \ "oss-cn-shanghai.aliyuncs.com" 3 / North China 1 (Qingdao) \ "oss-cn-qingdao.aliyuncs.com" [snip] endpoint> 1 Canned ACL used when creating buckets and storing or copying objects. Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). \ "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. \ "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. [snip] acl> 1 The storage class to use when storing new objects in OSS. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Default \ "" 2 / Standard storage class \ "STANDARD" 3 / Archive storage mode. \ "GLACIER" 4 / Infrequent access storage mode. \ "STANDARD_IA" storage_class> 1 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [oss] type = s3 provider = Alibaba env_auth = false access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint = oss-cn-hangzhou.aliyuncs.com acl = private storage_class = Standard -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` ### ArvanCloud {#arvan-cloud} [ArvanCloud](https://www.arvancloud.com/en/products/cloud-storage) ArvanCloud Object Storage goes beyond the limited traditional file storage. It gives you access to backup and archived files and allows sharing. Files like profile image in the app, images sent by users or scanned documents can be stored securely and easily in our Object Storage service. ArvanCloud provides an S3 interface which can be configured for use with rclone like this. ```text No remotes found, make a new one\? n) New remote s) Set configuration password n/s> n name> ArvanCloud Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, Minio) \ "s3" [snip] Storage> s3 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \ "false" 2 / Get AWS credentials from the environment (env vars or IAM) \ "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> YOURACCESSKEY AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YOURSECRETACCESSKEY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia, or Pacific Northwest. | Leave location constraint empty. \ "us-east-1" [snip] region> Endpoint for S3 API. Leave blank if using ArvanCloud to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. endpoint> s3.arvanstorage.com Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for Iran-Tehran Region. \ "" [snip] location_constraint> Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). \ "private" [snip] acl> The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None \ "" 2 / AES256 \ "AES256" server_side_encryption> The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default \ "" 2 / Standard storage class \ "STANDARD" storage_class> Remote config -------------------- [ArvanCloud] env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = ir-thr-at1 endpoint = s3.arvanstorage.com location_constraint = acl = server_side_encryption = storage_class = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` This will leave the config file looking like this. ```ini [ArvanCloud] type = s3 provider = ArvanCloud env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint = s3.arvanstorage.com location_constraint = acl = server_side_encryption = storage_class = ``` ### BizflyCloud {#bizflycloud} [Bizfly Cloud Simple Storage](https://bizflycloud.vn/simple-storage) is an S3-compatible service with regions in Hanoi (HN) and Ho Chi Minh City (HCM). Use the endpoint for your region: - HN: `hn.ss.bfcplatform.vn` - HCM: `hcm.ss.bfcplatform.vn` A minimal configuration looks like this. ```ini [bizfly] type = s3 provider = BizflyCloud env_auth = false access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY region = HN endpoint = hn.ss.bfcplatform.vn location_constraint = acl = server_side_encryption = storage_class = ``` Switch `region` and `endpoint` to `HCM` and `hcm.ss.bfcplatform.vn` for Ho Chi Minh City. ### Ceph [Ceph](https://ceph.com/) is an open-source, unified, distributed storage system designed for excellent performance, reliability and scalability. It has an S3 compatible object storage interface. To use rclone with Ceph, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config: ```ini [ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX secret_access_key = YYY region = endpoint = https://ceph.endpoint.example.com location_constraint = acl = server_side_encryption = storage_class = ``` If you are using an older version of CEPH (e.g. 10.2.x Jewel) and a version of rclone before v1.59 then you may need to supply the parameter `--s3-upload-cutoff 0` or put this in the config file as `upload_cutoff 0` to work around a bug which causes uploading of small files to fail. Note also that Ceph sometimes puts `/` in the passwords it gives users. If you read the secret access key using the command line tools you will get a JSON blob with the `/` escaped as `\/`. Make sure you only write `/` in the secret access key. Eg the dump from Ceph looks something like this (irrelevant keys removed). ```json { "user_id": "xxx", "display_name": "xxxx", "keys": [ { "user": "xxx", "access_key": "xxxxxx", "secret_key": "xxxxxx\/xxxx" } ], } ``` Because this is a json dump, it is encoding the `/` as `\/`, so if you use the secret key as `xxxxxx/xxxx` it will work fine. ### China Mobile Ecloud Elastic Object Storage (EOS) {#china-mobile-ecloud-eos} Here is an example of making an [China Mobile Ecloud Elastic Object Storage (EOS)](https:///ecloud.10086.cn/home/product-introduction/eos/) configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n name> ChinaMobile Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. ... XX / Amazon S3 Compliant Storage Providers including AWS, ... \ (s3) ... Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. ... 4 / China Mobile Ecloud Elastic Object Storage (EOS) \ (ChinaMobile) ... provider> ChinaMobile Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> accesskeyid Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> secretaccesskey Option endpoint. Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. Choose a number from below, or type in your own value. Press Enter to leave empty. / The default endpoint - a good choice if you are unsure. 1 | East China (Suzhou) \ (eos-wuxi-1.cmecloud.cn) 2 / East China (Jinan) \ (eos-jinan-1.cmecloud.cn) 3 / East China (Hangzhou) \ (eos-ningbo-1.cmecloud.cn) 4 / East China (Shanghai-1) \ (eos-shanghai-1.cmecloud.cn) 5 / Central China (Zhengzhou) \ (eos-zhengzhou-1.cmecloud.cn) 6 / Central China (Changsha-1) \ (eos-hunan-1.cmecloud.cn) 7 / Central China (Changsha-2) \ (eos-zhuzhou-1.cmecloud.cn) 8 / South China (Guangzhou-2) \ (eos-guangzhou-1.cmecloud.cn) 9 / South China (Guangzhou-3) \ (eos-dongguan-1.cmecloud.cn) 10 / North China (Beijing-1) \ (eos-beijing-1.cmecloud.cn) 11 / North China (Beijing-2) \ (eos-beijing-2.cmecloud.cn) 12 / North China (Beijing-3) \ (eos-beijing-4.cmecloud.cn) 13 / North China (Huhehaote) \ (eos-huhehaote-1.cmecloud.cn) 14 / Southwest China (Chengdu) \ (eos-chengdu-1.cmecloud.cn) 15 / Southwest China (Chongqing) \ (eos-chongqing-1.cmecloud.cn) 16 / Southwest China (Guiyang) \ (eos-guiyang-1.cmecloud.cn) 17 / Nouthwest China (Xian) \ (eos-xian-1.cmecloud.cn) 18 / Yunnan China (Kunming) \ (eos-yunnan.cmecloud.cn) 19 / Yunnan China (Kunming-2) \ (eos-yunnan-2.cmecloud.cn) 20 / Tianjin China (Tianjin) \ (eos-tianjin-1.cmecloud.cn) 21 / Jilin China (Changchun) \ (eos-jilin-1.cmecloud.cn) 22 / Hubei China (Xiangyan) \ (eos-hubei-1.cmecloud.cn) 23 / Jiangxi China (Nanchang) \ (eos-jiangxi-1.cmecloud.cn) 24 / Gansu China (Lanzhou) \ (eos-gansu-1.cmecloud.cn) 25 / Shanxi China (Taiyuan) \ (eos-shanxi-1.cmecloud.cn) 26 / Liaoning China (Shenyang) \ (eos-liaoning-1.cmecloud.cn) 27 / Hebei China (Shijiazhuang) \ (eos-hebei-1.cmecloud.cn) 28 / Fujian China (Xiamen) \ (eos-fujian-1.cmecloud.cn) 29 / Guangxi China (Nanning) \ (eos-guangxi-1.cmecloud.cn) 30 / Anhui China (Huainan) \ (eos-anhui-1.cmecloud.cn) endpoint> 1 Option location_constraint. Location constraint - must match endpoint. Used when creating buckets only. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / East China (Suzhou) \ (wuxi1) 2 / East China (Jinan) \ (jinan1) 3 / East China (Hangzhou) \ (ningbo1) 4 / East China (Shanghai-1) \ (shanghai1) 5 / Central China (Zhengzhou) \ (zhengzhou1) 6 / Central China (Changsha-1) \ (hunan1) 7 / Central China (Changsha-2) \ (zhuzhou1) 8 / South China (Guangzhou-2) \ (guangzhou1) 9 / South China (Guangzhou-3) \ (dongguan1) 10 / North China (Beijing-1) \ (beijing1) 11 / North China (Beijing-2) \ (beijing2) 12 / North China (Beijing-3) \ (beijing4) 13 / North China (Huhehaote) \ (huhehaote1) 14 / Southwest China (Chengdu) \ (chengdu1) 15 / Southwest China (Chongqing) \ (chongqing1) 16 / Southwest China (Guiyang) \ (guiyang1) 17 / Nouthwest China (Xian) \ (xian1) 18 / Yunnan China (Kunming) \ (yunnan) 19 / Yunnan China (Kunming-2) \ (yunnan2) 20 / Tianjin China (Tianjin) \ (tianjin1) 21 / Jilin China (Changchun) \ (jilin1) 22 / Hubei China (Xiangyan) \ (hubei1) 23 / Jiangxi China (Nanchang) \ (jiangxi1) 24 / Gansu China (Lanzhou) \ (gansu1) 25 / Shanxi China (Taiyuan) \ (shanxi1) 26 / Liaoning China (Shenyang) \ (liaoning1) 27 / Hebei China (Shijiazhuang) \ (hebei1) 28 / Fujian China (Xiamen) \ (fujian1) 29 / Guangxi China (Nanning) \ (guangxi1) 30 / Anhui China (Huainan) \ (anhui1) location_constraint> 1 Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \ (public-read) / Owner gets FULL_CONTROL. 3 | The AllUsers group gets READ and WRITE access. | Granting this on a bucket is generally not recommended. \ (public-read-write) / Owner gets FULL_CONTROL. 4 | The AuthenticatedUsers group gets READ access. \ (authenticated-read) / Object owner gets FULL_CONTROL. acl> private Option server_side_encryption. The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / None \ () 2 / AES256 \ (AES256) server_side_encryption> Option storage_class. The storage class to use when storing new objects in ChinaMobile. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Default \ () 2 / Standard storage class \ (STANDARD) 3 / Archive storage mode \ (GLACIER) 4 / Infrequent access storage mode \ (STANDARD_IA) storage_class> Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [ChinaMobile] type = s3 provider = ChinaMobile access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint = eos-wuxi-1.cmecloud.cn location_constraint = wuxi1 acl = private -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y ``` ### Cloudflare R2 {#cloudflare-r2} [Cloudflare R2](https://blog.cloudflare.com/r2-open-beta/) Storage allows developers to store large amounts of unstructured data without the costly egress bandwidth fees associated with typical cloud storage services. Here is an example of making a Cloudflare R2 configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. Note that all buckets are private, and all are stored in the same "auto" region. It is necessary to use Cloudflare workers to share the content of a bucket publicly. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n name> r2 Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. ... XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi \ (s3) ... Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. ... XX / Cloudflare R2 Storage \ (Cloudflare) ... provider> Cloudflare Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> 1 Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> SECRET_ACCESS_KEY Option region. Region to connect to. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / R2 buckets are automatically distributed across Cloudflare's data centers for low latency. \ (auto) region> 1 Option endpoint. Endpoint for S3 API. Required when using an S3 clone. Enter a value. Press Enter to leave empty. endpoint> https://ACCOUNT_ID.r2.cloudflarestorage.com Edit advanced config? y) Yes n) No (default) y/n> n -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y ``` This will leave your config looking something like: ```ini [r2] type = s3 provider = Cloudflare access_key_id = ACCESS_KEY secret_access_key = SECRET_ACCESS_KEY region = auto endpoint = https://ACCOUNT_ID.r2.cloudflarestorage.com acl = private ``` Now run `rclone lsf r2:` to see your buckets and `rclone lsf r2:bucket` to look within a bucket. For R2 tokens with the "Object Read & Write" permission, you may also need to add `no_check_bucket = true` for object uploads to work correctly. Note that Cloudflare decompresses files uploaded with `Content-Encoding: gzip` by default which is a deviation from what AWS does. If this is causing a problem then upload the files with `--header-upload "Cache-Control: no-transform"` A consequence of this is that `Content-Encoding: gzip` will never appear in the metadata on Cloudflare. ### Cubbit DS3 {#Cubbit} [Cubbit Object Storage](https://www.cubbit.io/ds3-cloud) is a geo-distributed cloud object storage platform. To connect to Cubbit DS3 you will need an access key and secret key pair. You can follow this [guide](https://docs.cubbit.io/getting-started/quickstart#api-keys) to retrieve these keys. They will be needed when prompted by `rclone config`. Default region will correspond to `eu-west-1` and the endpoint has to be specified as `s3.cubbit.eu`. If you set a custom tenant endpoint, you must use `s3.{tenant_name}.cubbit.eu`, because the generic `s3.cubbit.eu` endpoint will not work in this case. Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: ```console name> cubbit-ds3 (or any name you like) Storage> s3 provider> Cubbit env_auth> false access_key_id> YOUR_ACCESS_KEY secret_access_key> YOUR_SECRET_KEY region> eu-west-1 (or leave empty) endpoint> s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu) acl> ``` The resulting configuration file should look like: ```ini [cubbit-ds3] type = s3 provider = Cubbit access_key_id = ACCESS_KEY secret_access_key = SECRET_KEY region = eu-west-1 endpoint = s3.cubbit.eu ``` You can then start using Cubbit DS3 with rclone. For example, to create a new bucket and copy files into it, you can run: ```console rclone mkdir cubbit-ds3:my-bucket rclone copy /path/to/files cubbit-ds3:my-bucket ``` ### DigitalOcean Spaces [Spaces](https://www.digitalocean.com/products/object-storage/) is an [S3-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean. To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the [Applications & API](https://cloud.digitalocean.com/settings/api/tokens) page of the DigitalOcean control panel. They will be needed when prompted by `rclone config` for your `access_key_id` and `secret_access_key`. When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings. Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: ```console Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY secret_access_key> YOUR_SECRET_KEY region> endpoint> nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> ``` The resulting configuration file should look like: ```ini [spaces] type = s3 provider = DigitalOcean env_auth = false access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY region = endpoint = nyc3.digitaloceanspaces.com location_constraint = acl = server_side_encryption = storage_class = ``` Once configured, you can create a new Space and begin copying files. For example: ```console rclone mkdir spaces:my-new-space rclone copy /path/to/files spaces:my-new-space ``` ### Dreamhost Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is an object storage system based on CEPH. To use rclone with Dreamhost, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config: ```ini [dreamobjects] type = s3 provider = DreamHost env_auth = false access_key_id = your_access_key secret_access_key = your_secret_key region = endpoint = objects-us-west-1.dream.io location_constraint = acl = private server_side_encryption = storage_class = ``` ### Exaba {#exaba} [Exaba](https://exaba.com/) is an on-premises, S3-compatible storage for service providers and large enterprises. It is quick to deploy, with dynamic node management, tenant accounting, and a built-in key management system. It delivers secure, high-performance data storage with flexible, usage-based pricing. A container version [exaba/exaba](https://hub.docker.com/r/exaba/exaba) is free for end-users and on that page you can find instructions on how to set it up. You will need to log into the admin first (on port 9006 by default) to set up the container, then you can use the service on port 9000. You can also join the [exaba support slack](https://join.slack.com/t/exabasupport/shared_invite/zt-3b5jycjs3-0gDNyv60xKsAdNgjX72amQ) if you need more help. An `rclone config` walkthrough might look like this but details may vary depending exactly on how you have set up the container. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> exaba Option Storage. Type of storage to configure. Storage> s3 Option provider. Choose your S3 provider. provider> Exaba Option env_auth. env_auth> 1 Option access_key_id. access_key_id> XXX Option secret_access_key. secret_access_key> YYY Option region. region> Option endpoint. endpoint> http://127.0.0.1:9000/ Option location_constraint. location_constraint> Option acl. acl> Edit advanced config? y) Yes n) No (default) y/n> n ``` And the config generated will end up looking like this: ```ini [exaba] type = s3 provider = Exaba access_key_id = XXX secret_access_key = XXX endpoint = http://127.0.0.1:9000/ ``` ### Fastly Object Storage {#fastly} [Fastly Object Storage](https://www.fastly.com/products/storage) is an S3-compatible object storage service from Fastly. It provides three regions (US East, US West, and EU Central) with mandatory server-side encryption. Here is an example of making a configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> fastly Option Storage. Type of storage to configure. Storage> s3 Option provider. Choose your S3 provider. provider> Fastly Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. env_auth> false Option access_key_id. AWS Access Key ID. access_key_id> YOUR_ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). secret_access_key> YOUR_SECRET_KEY Option region. Region where your bucket will be created and your data stored. region> us-east Option endpoint. Endpoint for S3 API. endpoint> us-east.object.fastlystorage.app Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: s3 - provider: Fastly - access_key_id: YOUR_ACCESS_KEY - secret_access_key: YOUR_SECRET_KEY - region: us-east - endpoint: us-east.object.fastlystorage.app Keep this "fastly" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y ``` The resulting configuration file should look like: ```ini [fastly] type = s3 provider = Fastly access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY region = us-east endpoint = us-east.object.fastlystorage.app ``` ### Google Cloud Storage [GoogleCloudStorage](https://cloud.google.com/storage/docs) is an [S3-interoperable](https://cloud.google.com/storage/docs/interoperability) object storage service from Google Cloud Platform. To connect to Google Cloud Storage you will need an access key and secret key. These can be retrieved by creating an [HMAC key](https://cloud.google.com/storage/docs/authentication/managing-hmackeys). ```ini [gs] type = s3 provider = GCS access_key_id = your_access_key secret_access_key = your_secret_key endpoint = https://storage.googleapis.com ``` **Note** that `--s3-versions` does not work with GCS when it needs to do directory paging. Rclone will return the error: ```text s3 protocol error: received versions listing with IsTruncated set with no NextKeyMarker ``` This is Google bug [#312292516](https://issuetracker.google.com/u/0/issues/312292516). ### Hetzner Object Storage {#hetzner} Here is an example of making a [Hetzner Object Storage](https://www.hetzner.com/storage/object-storage/) configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> my-hetzner Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / Hetzner Object Storage \ (Hetzner) [snip] provider> Hetzner Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> SECRET_KEY Option region. Region to connect to. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Helsinki \ (hel1) 2 / Falkenstein \ (fsn1) 3 / Nuremberg \ (nbg1) region> Option endpoint. Endpoint for Hetzner Object Storage Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Helsinki \ (hel1.your-objectstorage.com) 2 / Falkenstein \ (fsn1.your-objectstorage.com) 3 / Nuremberg \ (nbg1.your-objectstorage.com) endpoint> Option location_constraint. Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only. Enter a value. Press Enter to leave empty. location_constraint> Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \ (public-read) acl> Edit advanced config? y) Yes n) No (default) y/n> Configuration complete. Options: - type: s3 - provider: Hetzner - access_key_id: ACCESS_KEY - secret_access_key: SECRET_KEY Keep this "my-hetzner" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> Current remotes: Name Type ==== ==== my-hetzner s3 e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q> ``` This will leave the config file looking like this. ```ini [my-hetzner] type = s3 provider = Hetzner access_key_id = ACCESS_KEY secret_access_key = SECRET_KEY region = hel1 endpoint = hel1.your-objectstorage.com acl = private ``` ### Hitachi Content Platform (HCP) {#hcp} Here is an example of making a [Hitachi Content Platform (HCP)](https://www.hitachivantara.com/en-us/products/storage/content-platform.html) configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> my-hcp Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / Hitachi Content Platform (HCP) \ (HCP) [snip] provider> HCP Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> SECRET_KEY Option endpoint. Endpoint for HCP S3 compatible API. Enter a value. Press Enter to leave empty. endpoint> https://hcp.example.com Edit advanced config? y) Yes n) No (default) y/n> Configuration complete. Options: - type: s3 - provider: HCP - access_key_id: ACCESS_KEY - secret_access_key: SECRET_KEY - endpoint: https://hcp.example.com Keep this "my-hcp" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> Current remotes: Name Type ==== ==== my-hcp s3 e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q> ``` This will leave the config file looking like this. ```ini [my-hcp] type = s3 provider = HCP access_key_id = ACCESS_KEY secret_access_key = SECRET_KEY endpoint = https://hcp.example.com ``` #### Known limitations These limitations have been observed with HCP version 9.7.x. **Automatic directory objects** HCP automatically creates zero-byte directory objects (keys ending in `/`) for every path component when an object is stored. These directory objects are managed by HCP internally: deleting one via the S3 API does not remove it but instead creates a delete marker with a special version ID (`-3`) that cannot itself be deleted. As a result, rclone cannot fully purge a bucket on HCP — leftover directory objects will remain after a `purge` or `delete` operation. **Transparent gzip decompression** HCP [transparently decompresses](https://docs.hitachivantara.com/r/en-us/content-platform/9.6.x/mk-95hcph002/using-the-hitachi-api-for-amazon-s3/working-with-objects/creating-an-object) objects uploaded with `Content-Encoding: gzip` before storing them. This means the stored object contains the raw (uncompressed) data, while the `Content-MD5` sent by rclone was computed over the compressed bytes. HCP will reject such uploads with a `BadDigest` error. To avoid this, do not set `content-encoding: gzip` in object metadata when using HCP. ### Huawei OBS {#huawei-obs} Object Storage Service (OBS) provides stable, secure, efficient, and easy-to-use cloud storage that lets you store virtually any volume of unstructured data in any format and access it from anywhere. OBS provides an S3 interface, you can copy and modify the following configuration and add it to your rclone configuration file. ```ini [obs] type = s3 provider = HuaweiOBS access_key_id = your-access-key-id secret_access_key = your-secret-access-key region = af-south-1 endpoint = obs.af-south-1.myhuaweicloud.com acl = private ``` Or you can also configure via the interactive command line: ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n name> obs Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] 9 / Huawei Object Storage Service \ (HuaweiOBS) [snip] provider> 9 Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> 1 Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> your-access-key-id Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> your-secret-access-key Option region. Region to connect to. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / AF-Johannesburg \ (af-south-1) 2 / AP-Bangkok \ (ap-southeast-2) [snip] region> 1 Option endpoint. Endpoint for OBS API. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / AF-Johannesburg \ (obs.af-south-1.myhuaweicloud.com) 2 / AP-Bangkok \ (obs.ap-southeast-2.myhuaweicloud.com) [snip] endpoint> 1 Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) [snip] acl> 1 Edit advanced config? y) Yes n) No (default) y/n> -------------------- [obs] type = s3 provider = HuaweiOBS access_key_id = your-access-key-id secret_access_key = your-secret-access-key region = af-south-1 endpoint = obs.af-south-1.myhuaweicloud.com acl = private -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== obs s3 e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q> q ``` ### IBM COS (S3) Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: To configure access to IBM COS S3, follow the steps below: 1. Run rclone config and select n for a new remote. ```text 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n ``` 2. Enter the name for the configuration ```text name> ``` 3. Select "s3" storage. ```text Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ "s3" [snip] Storage> s3 ``` 4. Select IBM COS as the S3 Storage Provider. ```text Choose the S3 provider. Choose a number from below, or type in your own value 1 / Choose this option to configure Storage to AWS S3 \ "AWS" 2 / Choose this option to configure Storage to Ceph Systems \ "Ceph" 3 / Choose this option to configure Storage to Dreamhost \ "Dreamhost" 4 / Choose this option to the configure Storage to IBM COS S3 \ "IBMCOS" 5 / Choose this option to the configure Storage to Minio \ "Minio" Provider>4 ``` 5. Enter the Access Key and Secret. ```text AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> <> AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> <> ``` 6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint address. ```text Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. Choose a number from below, or type in your own value 1 / US Cross Region Endpoint \ "s3-api.us-geo.objectstorage.softlayer.net" 2 / US Cross Region Dallas Endpoint \ "s3-api.dal.us-geo.objectstorage.softlayer.net" 3 / US Cross Region Washington DC Endpoint \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" 4 / US Cross Region San Jose Endpoint \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" 5 / US Cross Region Private Endpoint \ "s3-api.us-geo.objectstorage.service.networklayer.com" 6 / US Cross Region Dallas Private Endpoint \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" 7 / US Cross Region Washington DC Private Endpoint \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" 8 / US Cross Region San Jose Private Endpoint \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" 9 / US Region East Endpoint \ "s3.us-east.objectstorage.softlayer.net" 10 / US Region East Private Endpoint \ "s3.us-east.objectstorage.service.networklayer.com" 11 / US Region South Endpoint [snip] 34 / Toronto Single Site Private Endpoint \ "s3.tor01.objectstorage.service.networklayer.com" endpoint>1 ``` 7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter ```text 1 / US Cross Region Standard \ "us-standard" 2 / US Cross Region Vault \ "us-vault" 3 / US Cross Region Cold \ "us-cold" 4 / US Cross Region Flex \ "us-flex" 5 / US East Region Standard \ "us-east-standard" 6 / US East Region Vault \ "us-east-vault" 7 / US East Region Cold \ "us-east-cold" 8 / US East Region Flex \ "us-east-flex" 9 / US South Region Standard \ "us-south-standard" 10 / US South Region Vault \ "us-south-vault" [snip] 32 / Toronto Flex \ "tor01-flex" location_constraint>1 ``` 8. Specify a canned ACL. IBM Cloud (Storage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs. ```text Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS \ "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS \ "public-read" 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS \ "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS \ "authenticated-read" acl> 1 ``` 9. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this ```ini [xxx] type = s3 Provider = IBMCOS access_key_id = xxx secret_access_key = yyy endpoint = s3-api.us-geo.objectstorage.softlayer.net location_constraint = us-standard acl = private ``` 10. Execute rclone commands ```text 1) Create a bucket. rclone mkdir IBM-COS-XREGION:newbucket 2) List available buckets. rclone lsd IBM-COS-XREGION: -1 2017-11-08 21:16:22 -1 test -1 2018-02-14 20:16:39 -1 newbucket 3) List contents of a bucket. rclone ls IBM-COS-XREGION:newbucket 18685952 test.exe 4) Copy a file from local to remote. rclone copy /Users/file.txt IBM-COS-XREGION:newbucket 5) Copy a file from remote to local. rclone copy IBM-COS-XREGION:newbucket/file.txt . 6) Delete a file on remote. rclone delete IBM-COS-XREGION:newbucket/file.txt ``` #### IBM IAM authentication If using IBM IAM authentication with IBM API KEY you need to fill in these additional parameters 1. Select false for env_auth 2. Leave `access_key_id` and `secret_access_key` blank 3. Paste your `ibm_api_key` ```text Option ibm_api_key. IBM API Key to be used to obtain IAM token Enter a value of type string. Press Enter for the default (1). ibm_api_key> ``` 4. Paste your `ibm_resource_instance_id` ```text Option ibm_resource_instance_id. IBM service instance id Enter a value of type string. Press Enter for the default (2). ibm_resource_instance_id> ``` 5. In advanced settings type true for `v2_auth` ```text Option v2_auth. If true use v2 authentication. If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication. Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH. Enter a boolean value (true or false). Press Enter for the default (true). v2_auth> ``` ### IDrive e2 {#idrive-e2} Here is an example of making an [IDrive e2](https://www.idrive.com/e2/) configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one\? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> e2 Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / IDrive e2 \ (IDrive) [snip] provider> IDrive Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> YOUR_ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> YOUR_SECRET_KEY Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \ (public-read) / Owner gets FULL_CONTROL. 3 | The AllUsers group gets READ and WRITE access. | Granting this on a bucket is generally not recommended. \ (public-read-write) / Owner gets FULL_CONTROL. 4 | The AuthenticatedUsers group gets READ access. \ (authenticated-read) / Object owner gets FULL_CONTROL. 5 | Bucket owner gets READ access. | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. \ (bucket-owner-read) / Both the object owner and the bucket owner get FULL_CONTROL over the object. 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. \ (bucket-owner-full-control) acl> Edit advanced config? y) Yes n) No (default) y/n> Configuration complete. Options: - type: s3 - provider: IDrive - access_key_id: YOUR_ACCESS_KEY - secret_access_key: YOUR_SECRET_KEY - endpoint: q9d9.la12.idrivee2-5.com Keep this "e2" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y ``` ### Impossible Cloud {#impossible-cloud} [Impossible Cloud](https://www.impossiblecloud.com/) is a European S3-compatible object storage provider with regions in Europe and the US. Note: Impossible Cloud does not preserve the `Cache-Control`, `Content-Disposition`, `Content-Encoding` or `Content-Language` system metadata fields on retrieval, even when they were set at upload time. Because the `Content-Encoding` response header is also dropped, the `--s3-decompress` flag has no effect on objects stored there. Other metadata such as `Content-Type` and the modification time round-trip normally. Here is an example of making an Impossible Cloud configuration. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> my-impossible-cloud Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / Impossible Cloud Object Storage \ (ImpossibleCloud) [snip] provider> ImpossibleCloud Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> SECRET_KEY Option region. Region to connect to. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (eu-central-2) 2 / Amsterdam, Netherlands \ (eu-west-1) 3 / London, UK \ (eu-west-2) 4 / Paris, France \ (eu-west-3) 5 / Poznań, Poland \ (eu-east-1) 6 / Copenhagen, Denmark \ (eu-north-1) 7 / New York, USA \ (us-east-1) region> 1 Option endpoint. Endpoint for Impossible Cloud Object Storage Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (eu-central-2.storage.impossibleapi.net) 2 / Amsterdam, Netherlands \ (eu-west-1.storage.impossibleapi.net) 3 / London, UK \ (eu-west-2.storage.impossibleapi.net) 4 / Paris, France \ (eu-west-3.storage.impossibleapi.net) 5 / Poznań, Poland \ (eu-east-1.storage.impossibleapi.net) 6 / Copenhagen, Denmark \ (eu-north-1.storage.impossibleapi.net) 7 / New York, USA \ (us-east-1.storage.impossibleapi.net) endpoint> 1 Option location_constraint. Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only. Enter a value. Press Enter to leave empty. location_constraint> Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \ (public-read) acl> Edit advanced config? y) Yes n) No (default) y/n> Configuration complete. Options: - type: s3 - provider: ImpossibleCloud - access_key_id: ACCESS_KEY - secret_access_key: SECRET_KEY - region: eu-central-2 - endpoint: eu-central-2.storage.impossibleapi.net Keep this "my-impossible-cloud" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> Current remotes: Name Type ==== ==== my-impossible-cloud s3 e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q> ``` This will leave the config file looking like this. ```ini [my-impossible-cloud] type = s3 provider = ImpossibleCloud access_key_id = ACCESS_KEY secret_access_key = SECRET_KEY region = eu-central-2 endpoint = eu-central-2.storage.impossibleapi.net acl = private ``` ### Intercolo Object Storage {#intercolo} [Intercolo Object Storage](https://intercolo.de/object-storage) offers GDPR-compliant, transparently priced, S3-compatible cloud storage hosted in Frankfurt, Germany. Here's an example of making a configuration for Intercolo. First run: ```console rclone config ``` This will guide you through an interactive setup process. ```text No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter name for new remote. name> intercolo Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] xx / Amazon S3 Compliant Storage Providers including AWS, ... \ (s3) [snip] Storage> s3 Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] xx / Intercolo Object Storage \ (Intercolo) [snip] provider> Intercolo Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> false Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> SECRET_KEY Option region. Region where your bucket will be created and your data stored. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (de-fra) region> 1 Option endpoint. Endpoint for Intercolo Object Storage. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (de-fra.i3storage.com) endpoint> 1 Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) [snip] acl> Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: s3 - provider: Intercolo - access_key_id: ACCESS_KEY - secret_access_key: SECRET_KEY - region: de-fra - endpoint: de-fra.i3storage.com Keep this "intercolo" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y ``` This will leave the config file looking like this. ```ini [intercolo] type = s3 provider = Intercolo access_key_id = ACCESS_KEY secret_access_key = SECRET_KEY region = de-fra endpoint = de-fra.i3storage.com ``` ### IONOS Cloud {#ionos} [IONOS S3 Object Storage](https://cloud.ionos.com/storage/object-storage) is a service offered by IONOS for storing and accessing unstructured data. To connect to the service, you will need an access key and a secret key. These can be found in the [Data Center Designer](https://dcd.ionos.com/), by selecting **Manager resources** > **Object Storage Key Manager**. Here is an example of a configuration. First, run `rclone config`. This will walk you through an interactive setup process. Type `n` to add the new remote, and then enter a name: ```text Enter name for new remote. name> ionos-fra ``` Type `s3` to choose the connection type: ```text Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \ (s3) [snip] Storage> s3 ``` Type `IONOS`: ```text Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / IONOS Cloud \ (IONOS) [snip] provider> IONOS ``` Press Enter to choose the default option `Enter AWS credentials in the next step`: ```text Option env_auth. Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \ (false) 2 / Get AWS credentials from the environment (env vars or IAM). \ (true) env_auth> ``` Enter your Access Key and Secret key. These can be retrieved in the [Data Center Designer](https://dcd.ionos.com/), click on the menu "Manager resources" / "Object Storage Key Manager". ```text Option access_key_id. AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> YOUR_ACCESS_KEY Option secret_access_key. AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> YOUR_SECRET_KEY ``` Choose the region where your bucket is located: ```text Option region. Region where your bucket will be created and your data stored. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (de) 2 / Berlin, Germany \ (eu-central-2) 3 / Logrono, Spain \ (eu-south-2) region> 2 ``` Choose the endpoint from the same region: ```text Option endpoint. Endpoint for IONOS S3 Object Storage. Specify the endpoint from the same region. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Frankfurt, Germany \ (s3-eu-central-1.ionoscloud.com) 2 / Berlin, Germany \ (s3-eu-central-2.ionoscloud.com) 3 / Logrono, Spain \ (s3-eu-south-2.ionoscloud.com) endpoint> 1 ``` Press Enter to choose the default option or choose the desired ACL setting: ```text Option acl. Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Choose a number from below, or type in your own value. Press Enter to leave empty. / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \ (private) / Owner gets FULL_CONTRO