/
githubmirror
/
rclone
Обзор
Документация
Войти
/
githubmirror
/
rclone
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
v1.69.2
rclone.1
92 384 строки
3 MB
Nick Craig-Wood
Version v1.69.2
01 май 2025, 17:33
01 май 2025, 17:33
13875b4
Код
Авторство
О чём код?
.\"t .\" Automatically generated by Pandoc 2.9.2.1 .\" .TH "rclone" "1" "May 01, 2025" "User Manual" "" .hy .SH NAME .PP rclone - manage files on cloud storage .SH SYNOPSIS .IP .nf \f[C] Usage: rclone [flags] rclone [command] Available commands: about Get quota information from the remote. 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. 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. 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\[aq]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 \[dq]rclone [command] --help\[dq] for more information about a command. Use \[dq]rclone help flags\[dq] for to see the global flags. Use \[dq]rclone help backends\[dq] for a list of supported services. \f[R] .fi .SH Rclone syncs your files to cloud storage .PP .IP \[bu] 2 About rclone .IP \[bu] 2 What can rclone do for you? .IP \[bu] 2 What features does rclone have? .IP \[bu] 2 What providers does rclone support? .IP \[bu] 2 Download (https://rclone.org/downloads/) .IP \[bu] 2 Install (https://rclone.org/install/) .IP \[bu] 2 Donate. (https://rclone.org/donate/) .SS About rclone .PP Rclone is a command-line program to manage files on cloud storage. It is a feature-rich alternative to cloud vendors\[aq] web storage interfaces. Over 70 cloud storage products support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols. .PP Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone\[aq]s familiar syntax includes shell pipeline support, and \f[C]--dry-run\f[R] protection. It is used at the command line, in scripts or via its API. .PP Users call rclone \f[I]\[dq]The Swiss army knife of cloud storage\[dq]\f[R], and \f[I]\[dq]Technology indistinguishable from magic\[dq]\f[R]. .PP 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. .PP 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/). .PP 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/). .PP 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. .PP 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. .PP Rclone does the heavy lifting of communicating with cloud storage. .SS What can rclone do for you? .PP Rclone helps you: .IP \[bu] 2 Backup (and encrypt) files to cloud storage .IP \[bu] 2 Restore (and decrypt) files from cloud storage .IP \[bu] 2 Mirror cloud data to other cloud services or locally .IP \[bu] 2 Migrate data to the cloud, or between cloud storage vendors .IP \[bu] 2 Mount multiple, encrypted, cached or diverse cloud storage as a disk .IP \[bu] 2 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/) .IP \[bu] 2 Union (https://rclone.org/union/) file systems together to present multiple local and/or cloud file systems as one .SS Features .IP \[bu] 2 Transfers .RS 2 .IP \[bu] 2 MD5, SHA1 hashes are checked at all times for file integrity .IP \[bu] 2 Timestamps are preserved on files .IP \[bu] 2 Operations can be restarted at any time .IP \[bu] 2 Can be to and from network, e.g. two different cloud providers .IP \[bu] 2 Can use multi-threaded downloads to local disk .RE .IP \[bu] 2 Copy (https://rclone.org/commands/rclone_copy/) new or changed files to cloud storage .IP \[bu] 2 Sync (https://rclone.org/commands/rclone_sync/) (one way) to make a directory identical .IP \[bu] 2 Bisync (https://rclone.org/bisync/) (two way) to keep two directories in sync bidirectionally .IP \[bu] 2 Move (https://rclone.org/commands/rclone_move/) files to cloud storage deleting the local after verification .IP \[bu] 2 Check (https://rclone.org/commands/rclone_check/) hashes and for missing/extra files .IP \[bu] 2 Mount (https://rclone.org/commands/rclone_mount/) your cloud storage as a network disk .IP \[bu] 2 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/) .IP \[bu] 2 Experimental Web based GUI (https://rclone.org/gui/) .SS Supported providers .PP (There are many others, built on standard protocols such as WebDAV or S3, that work out of the box.) .IP \[bu] 2 1Fichier .IP \[bu] 2 Akamai Netstorage .IP \[bu] 2 Alibaba Cloud (Aliyun) Object Storage System (OSS) .IP \[bu] 2 Amazon S3 .IP \[bu] 2 Backblaze B2 .IP \[bu] 2 Box .IP \[bu] 2 Ceph .IP \[bu] 2 China Mobile Ecloud Elastic Object Storage (EOS) .IP \[bu] 2 Arvan Cloud Object Storage (AOS) .IP \[bu] 2 Citrix ShareFile .IP \[bu] 2 Cloudflare R2 .IP \[bu] 2 Cloudinary .IP \[bu] 2 DigitalOcean Spaces .IP \[bu] 2 Digi Storage .IP \[bu] 2 Dreamhost .IP \[bu] 2 Dropbox .IP \[bu] 2 Enterprise File Fabric .IP \[bu] 2 Fastmail Files .IP \[bu] 2 Files.com .IP \[bu] 2 FTP .IP \[bu] 2 Gofile .IP \[bu] 2 Google Cloud Storage .IP \[bu] 2 Google Drive .IP \[bu] 2 Google Photos .IP \[bu] 2 HDFS .IP \[bu] 2 Hetzner Storage Box .IP \[bu] 2 HiDrive .IP \[bu] 2 HTTP .IP \[bu] 2 iCloud Drive .IP \[bu] 2 ImageKit .IP \[bu] 2 Internet Archive .IP \[bu] 2 Jottacloud .IP \[bu] 2 IBM COS S3 .IP \[bu] 2 IDrive e2 .IP \[bu] 2 IONOS Cloud .IP \[bu] 2 Koofr .IP \[bu] 2 Leviia Object Storage .IP \[bu] 2 Liara Object Storage .IP \[bu] 2 Linkbox .IP \[bu] 2 Linode Object Storage .IP \[bu] 2 Magalu .IP \[bu] 2 Mail.ru Cloud .IP \[bu] 2 Memset Memstore .IP \[bu] 2 Mega .IP \[bu] 2 Memory .IP \[bu] 2 Microsoft Azure Blob Storage .IP \[bu] 2 Microsoft Azure Files Storage .IP \[bu] 2 Microsoft OneDrive .IP \[bu] 2 Minio .IP \[bu] 2 Nextcloud .IP \[bu] 2 OVH .IP \[bu] 2 Blomp Cloud Storage .IP \[bu] 2 OpenDrive .IP \[bu] 2 OpenStack Swift .IP \[bu] 2 Oracle Cloud Storage Swift .IP \[bu] 2 Oracle Object Storage .IP \[bu] 2 Outscale .IP \[bu] 2 ownCloud .IP \[bu] 2 pCloud .IP \[bu] 2 Petabox .IP \[bu] 2 PikPak .IP \[bu] 2 Pixeldrain .IP \[bu] 2 premiumize.me .IP \[bu] 2 put.io .IP \[bu] 2 Proton Drive .IP \[bu] 2 QingStor .IP \[bu] 2 Qiniu Cloud Object Storage (Kodo) .IP \[bu] 2 Quatrix by Maytech .IP \[bu] 2 Rackspace Cloud Files .IP \[bu] 2 rsync.net .IP \[bu] 2 Scaleway .IP \[bu] 2 Seafile .IP \[bu] 2 Seagate Lyve Cloud .IP \[bu] 2 SeaweedFS .IP \[bu] 2 Selectel .IP \[bu] 2 SFTP .IP \[bu] 2 Sia .IP \[bu] 2 SMB / CIFS .IP \[bu] 2 StackPath .IP \[bu] 2 Storj .IP \[bu] 2 Synology .IP \[bu] 2 SugarSync .IP \[bu] 2 Tencent Cloud Object Storage (COS) .IP \[bu] 2 Uloz.to .IP \[bu] 2 Uptobox .IP \[bu] 2 Wasabi .IP \[bu] 2 WebDAV .IP \[bu] 2 Yandex Disk .IP \[bu] 2 Zoho WorkDrive .IP \[bu] 2 The local filesystem .SS Virtual providers .PP These backends adapt or modify other storage providers: .IP \[bu] 2 Alias: Rename existing remotes .IP \[bu] 2 Cache: Cache remotes (DEPRECATED) .IP \[bu] 2 Chunker: Split large files .IP \[bu] 2 Combine: Combine multiple remotes into a directory tree .IP \[bu] 2 Compress: Compress files .IP \[bu] 2 Crypt: Encrypt files .IP \[bu] 2 Hasher: Hash files .IP \[bu] 2 Union: Join multiple remotes to work together .SS Links .IP \[bu] 2 Home page (https://rclone.org/) .IP \[bu] 2 GitHub project page for source and bug tracker (https://github.com/rclone/rclone) .IP \[bu] 2 Rclone Forum (https://forum.rclone.org) .IP \[bu] 2 Downloads (https://rclone.org/downloads/) .SH Install .PP Rclone is a Go program and comes as a single binary file. .SS Quickstart .IP \[bu] 2 Download (https://rclone.org/downloads/) the relevant binary. .IP \[bu] 2 Extract the \f[C]rclone\f[R] executable, \f[C]rclone.exe\f[R] on Windows, from the archive. .IP \[bu] 2 Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP \[bu] 2 Optionally configure automatic execution. .PP See below for some expanded Linux / macOS / Windows instructions. .PP See the usage (https://rclone.org/docs/) docs for how to use rclone, or run \f[C]rclone -h\f[R]. .PP Already installed rclone can be easily updated to the latest version using the rclone selfupdate (https://rclone.org/commands/rclone_selfupdate/) command. .PP See the release signing docs (https://rclone.org/release_signing/) for how to verify signatures on the release. .SS Script installation .PP To install rclone on Linux/macOS/BSD systems, run: .IP .nf \f[C] sudo -v ; curl https://rclone.org/install.sh | sudo bash \f[R] .fi .PP For beta installation, run: .IP .nf \f[C] sudo -v ; curl https://rclone.org/install.sh | sudo bash -s beta \f[R] .fi .PP Note that this script checks the version of rclone installed first and won\[aq]t re-download if not needed. .SS Linux installation .SS Precompiled binary .PP Fetch and unpack .IP .nf \f[C] curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip unzip rclone-current-linux-amd64.zip cd rclone-*-linux-amd64 \f[R] .fi .PP Copy binary file .IP .nf \f[C] sudo cp rclone /usr/bin/ sudo chown root:root /usr/bin/rclone sudo chmod 755 /usr/bin/rclone \f[R] .fi .PP Install manpage .IP .nf \f[C] sudo mkdir -p /usr/local/share/man/man1 sudo cp rclone.1 /usr/local/share/man/man1/ sudo mandb \f[R] .fi .PP Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP .nf \f[C] rclone config \f[R] .fi .SS macOS installation .SS Installation with brew .IP .nf \f[C] brew install rclone \f[R] .fi .PP NOTE: This version of rclone will not support \f[C]mount\f[R] 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. .PP 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. .PP [IMAGE: Homebrew package (https://repology.org/badge/version-for-repo/homebrew/rclone.svg)] (https://repology.org/project/rclone/versions) .SS Installation with MacPorts .PP On macOS, rclone can also be installed via MacPorts (https://www.macports.org): .IP .nf \f[C] sudo port install rclone \f[R] .fi .PP 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. .PP [IMAGE: MacPorts port (https://repology.org/badge/version-for-repo/macports/rclone.svg)] (https://repology.org/project/rclone/versions) .PP More information here (https://ports.macports.org/port/rclone/). .SS Precompiled binary, using curl .PP To avoid problems with macOS gatekeeper enforcing the binary to be signed and notarized it is enough to download with \f[C]curl\f[R]. .PP Download the latest version of rclone. .IP .nf \f[C] cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip \f[R] .fi .PP Unzip the download and cd to the extracted folder. .IP .nf \f[C] unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64 \f[R] .fi .PP Move rclone to your $PATH. You will be prompted for your password. .IP .nf \f[C] sudo mkdir -p /usr/local/bin sudo mv rclone /usr/local/bin/ \f[R] .fi .PP (the \f[C]mkdir\f[R] command is safe to run, even if the directory already exists). .PP Remove the leftover files. .IP .nf \f[C] cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip \f[R] .fi .PP Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP .nf \f[C] rclone config \f[R] .fi .SS Precompiled binary, using a web browser .PP When downloading a binary with a web browser, the browser will set the macOS gatekeeper quarantine attribute. Starting from Catalina, when attempting to run \f[C]rclone\f[R], a pop-up will appear saying: .IP .nf \f[C] \[dq]rclone\[dq] cannot be opened because the developer cannot be verified. macOS cannot verify that this app is free from malware. \f[R] .fi .PP The simplest fix is to run .IP .nf \f[C] xattr -d com.apple.quarantine rclone \f[R] .fi .SS Windows installation .SS Precompiled binary .PP Fetch the correct binary for your processor type by clicking on these links. If not sure, use the first link. .IP \[bu] 2 Intel/AMD - 64 Bit (https://downloads.rclone.org/rclone-current-windows-amd64.zip) .IP \[bu] 2 Intel/AMD - 32 Bit (https://downloads.rclone.org/rclone-current-windows-386.zip) .IP \[bu] 2 ARM - 64 Bit (https://downloads.rclone.org/rclone-current-windows-arm64.zip) .PP Open this file in the Explorer and extract \f[C]rclone.exe\f[R]. Rclone is a portable executable so you can place it wherever is convenient. .PP 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. .IP \[bu] 2 Run \f[C]rclone.exe config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP \[bu] 2 Optionally configure automatic execution. .PP 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. .SS Windows package manager (Winget) .PP 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. .PP To install rclone .IP .nf \f[C] winget install Rclone.Rclone \f[R] .fi .PP To uninstall rclone .IP .nf \f[C] winget uninstall Rclone.Rclone --force \f[R] .fi .SS Chocolatey package manager .PP Make sure you have Choco (https://chocolatey.org/) installed .IP .nf \f[C] choco search rclone choco install rclone \f[R] .fi .PP This will install rclone on your Windows machine. If you are planning to use rclone mount (https://rclone.org/commands/rclone_mount/) then .IP .nf \f[C] choco install winfsp \f[R] .fi .PP will install that too. .PP 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. .PP [IMAGE: Chocolatey package (https://repology.org/badge/version-for-repo/chocolatey/rclone.svg)] (https://repology.org/project/rclone/versions) .SS Scoop package manager .PP Make sure you have Scoop (https://scoop.sh/) installed .IP .nf \f[C] scoop install rclone \f[R] .fi .PP 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. .PP [IMAGE: Scoop package (https://repology.org/badge/version-for-repo/scoop/rclone.svg)] (https://repology.org/project/rclone/versions) .SS Package manager installation .PP Many Linux, Windows, macOS and other OS distributions package and distribute rclone. .PP 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. .PP You can get an idea of how up to date or not your OS distribution\[aq]s package is here. .PP [IMAGE: Packaging status (https://repology.org/badge/vertical-allrepos/rclone.svg?columns=3)] (https://repology.org/project/rclone/versions) .SS Docker installation .PP The rclone developers maintain a docker image for rclone (https://hub.docker.com/r/rclone/rclone). .PP These images are built as part of the release process based on a minimal Alpine Linux. .PP The \f[C]:latest\f[R] tag will always point to the latest stable release. You can use the \f[C]:beta\f[R] tag to get the latest build from master. You can also use version tags, e.g. \f[C]:1.49.1\f[R], \f[C]:1.49\f[R] or \f[C]:1\f[R]. .IP .nf \f[C] $ docker pull rclone/rclone: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 \f[R] .fi .PP There are a few command line options to consider when starting an rclone Docker container from the rclone image. .IP \[bu] 2 You need to mount the host rclone config dir at \f[C]/config/rclone\f[R] into the Docker container. Due to the fact that rclone updates tokens inside its config file, 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. .IP \[bu] 2 You need to mount a host data dir at \f[C]/data\f[R] into the Docker container. .IP \[bu] 2 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. .IP \[bu] 2 If you want to access the RC interface (either via the API or the Web UI), it is required to set the \f[C]--rc-addr\f[R] to \f[C]:5572\f[R] in order to connect to it from outside the container. An explanation about why this is necessary is present here (https://web.archive.org/web/20200808071950/https://pythonspeed.com/articles/docker-connection-refused/). .RS 2 .IP \[bu] 2 NOTE: Users running this container with the docker network set to \f[C]host\f[R] should probably set it to listen to localhost only, with \f[C]127.0.0.1:5572\f[R] as the value for \f[C]--rc-addr\f[R] .RE .IP \[bu] 2 It is possible to use \f[C]rclone mount\f[R] inside a userspace Docker container, and expose the resulting fuse mount to the host. The exact \f[C]docker run\f[R] options to do that might vary slightly between hosts. See, e.g. the discussion in this thread (https://github.com/moby/moby/issues/9448). .RS 2 .PP You also need to mount the host \f[C]/etc/passwd\f[R] and \f[C]/etc/group\f[R] for fuse to work inside the container. .RE .PP Here are some commands tested on an Ubuntu 18.04.3 host: .IP .nf \f[C] # config on host at \[ti]/.config/rclone/rclone.conf # data on host at \[ti]/data # add a remote interactively docker run --rm -it \[rs] --volume \[ti]/.config/rclone:/config/rclone \[rs] --user $(id -u):$(id -g) \[rs] rclone/rclone \[rs] config # make sure the config is ok by listing the remotes docker run --rm \[rs] --volume \[ti]/.config/rclone:/config/rclone \[rs] --user $(id -u):$(id -g) \[rs] rclone/rclone \[rs] listremotes # perform mount inside Docker container, expose result to host mkdir -p \[ti]/data/mount docker run --rm \[rs] --volume \[ti]/.config/rclone:/config/rclone \[rs] --volume \[ti]/data:/data:shared \[rs] --user $(id -u):$(id -g) \[rs] --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \[rs] --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \[rs] rclone/rclone \[rs] mount dropbox:Photos /data/mount & ls \[ti]/data/mount kill %1 \f[R] .fi .SS Snap installation .PP [IMAGE: Get it from the Snap Store (https://snapcraft.io/static/images/badges/en/snap-store-black.svg)] (https://snapcraft.io/rclone) .PP Make sure you have Snapd installed (https://snapcraft.io/docs/installing-snapd) .IP .nf \f[C] $ sudo snap install rclone \f[R] .fi .PP Due to the strict confinement of Snap, rclone snap cannot access real /home/$USER/.config/rclone directory, default config path is as below. .IP \[bu] 2 Default config directory: .RS 2 .IP \[bu] 2 /home/$USER/snap/rclone/current/.config/rclone .RE .PP Note: Due to the strict confinement of Snap, \f[C]rclone mount\f[R] feature is \f[C]not\f[R] supported. .PP If mounting is wanted, either install a precompiled binary or enable the relevant option when installing from source. .PP 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. .PP [IMAGE: rclone (https://snapcraft.io/rclone/badge.svg)] (https://snapcraft.io/rclone) .SS Source installation .PP Make sure you have git and Go (https://golang.org/) installed. Go version 1.18 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: .IP .nf \f[C] git clone https://github.com/rclone/rclone.git cd rclone go build \f[R] .fi .PP 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 \f[C]./rclone version\f[R] (\f[C].\[rs]rclone version\f[R] on Windows). .PP 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 \f[C]cmount\f[R]. .IP .nf \f[C] go build -tags cmount \f[R] .fi .PP 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). .PP Additionally, to build with mount on Windows, you must install the third party utility WinFsp (https://winfsp.dev/), with the \[dq]Developer\[dq] feature selected. If building with cgo, you must also set environment variable CPATH pointing to the fuse include directory within the WinFsp installation (normally \f[C]C:\[rs]Program Files (x86)\[rs]WinFsp\[rs]inc\[rs]fuse\f[R]). .PP You may add arguments \f[C]-ldflags -s\f[R] to omit symbol table and debug information, making the executable file smaller, and \f[C]-trimpath\f[R] to remove references to local file system paths. The official rclone releases are built with both of these. .IP .nf \f[C] go build -trimpath -ldflags -s -tags cmount \f[R] .fi .PP If you want to customize the version string, as reported by the \f[C]rclone version\f[R] command, you can set one of the variables \f[C]fs.Version\f[R], \f[C]fs.VersionTag\f[R] (to keep default suffix but customize the number), or \f[C]fs.VersionSuffix\f[R] (to keep default number but customize the suffix). This can be done from the build command, by adding to the \f[C]-ldflags\f[R] argument value as shown below. .IP .nf \f[C] go build -trimpath -ldflags \[dq]-s -X github.com/rclone/rclone/fs.Version=v9.9.9-test\[dq] -tags cmount \f[R] .fi .PP 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 \f[B]before\f[R] the build command. It generates a Windows resource system object file, with extension \&.syso, e.g. \f[C]resource_windows_amd64.syso\f[R], that will be automatically picked up by future build commands. .IP .nf \f[C] go run bin/resource_windows.go \f[R] .fi .PP 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. .IP .nf \f[C] go run bin/resource_windows.go -version v9.9.9-test \f[R] .fi .PP Instead of executing the \f[C]go build\f[R] command directly, you can run it via the Makefile. The default target changes the version suffix from \[dq]-DEV\[dq] to \[dq]-beta\[dq] followed by additional commit details, embeds version information binary resources on Windows, and copies the resulting rclone executable into your GOPATH bin folder (\f[C]$(go env GOPATH)/bin\f[R], which corresponds to \f[C]\[ti]/go/bin/rclone\f[R] by default). .IP .nf \f[C] make \f[R] .fi .PP To include mount command on macOS and Windows with Makefile build: .IP .nf \f[C] make GOTAGS=cmount \f[R] .fi .PP 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. .PP 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 (\f[C]$(go env GOPATH)/bin\f[R], which corresponds to \f[C]\[ti]/go/bin/rclone\f[R] by default). .IP .nf \f[C] go install github.com/rclone/rclone\[at]latest \f[R] .fi .PP 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 \f[C]backends/all/all.go\f[R] and unused commands in \f[C]cmd/all/all.go\f[R] before building with \f[C]go build\f[R] or \f[C]make\f[R] .SS Ansible installation .PP This can be done with Stefan Weichinger\[aq]s ansible role (https://github.com/stefangweichinger/ansible-rclone). .PP Instructions .IP "1." 3 \f[C]git clone https://github.com/stefangweichinger/ansible-rclone.git\f[R] into your local roles-directory .IP "2." 3 add the role to the hosts you want rclone installed to: .IP .nf \f[C] - hosts: rclone-hosts roles: - rclone \f[R] .fi .SS Portable installation .PP As mentioned above (https://rclone.org/install/#quickstart), rclone is single executable (\f[C]rclone\f[R], or \f[C]rclone.exe\f[R] 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. .PP Run the config paths (https://rclone.org/commands/rclone_config_paths/) command to see the locations that rclone will use. .PP 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-config-file) - --cache-dir (https://rclone.org/docs/#cache-dir-dir) - --temp-dir (https://rclone.org/docs/#temp-dir-dir) .SS Autostart .PP 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 \f[I]periodic\f[R] 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\[aq]s scheduler. If you need to expose \f[I]service\f[R]-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. .PP NOTE: Before setting up autorun it is highly recommended that you have tested your command manually from a Command Prompt first. .SS Autostart on Windows .PP 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 .SS Running in background .PP 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 \f[C]--no-console\f[R] (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 \f[C]--log-file\f[R] for that. .PP Example command to run a sync in background: .IP .nf \f[C] c:\[rs]rclone\[rs]rclone.exe sync c:\[rs]files remote:/files --no-console --log-file c:\[rs]rclone\[rs]logs\[rs]sync_files.txt \f[R] .fi .SS User account .PP 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 \f[C]SYSTEM\f[R] user account, it will create drives accessible for everyone on the system. Both scheduled task and Windows service can be used to achieve this. .PP NOTE: Remember that when rclone runs as the \f[C]SYSTEM\f[R] 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 \f[C]--config\f[R] (https://rclone.org/docs/#config-config-file) option, or else it will look in the system users profile path (\f[C]C:\[rs]Windows\[rs]System32\[rs]config\[rs]systemprofile\f[R]). 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\[aq]s Sysinternals suite, which takes option \f[C]-s\f[R] to execute commands as the \f[C]SYSTEM\f[R] user. .SS Start from Startup folder .PP 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 \[dq]Startup\[dq] start-menu folder, Windows will automatically run it at login. To open this folder in Windows Explorer, enter path \f[C]%APPDATA%\[rs]Microsoft\[rs]Windows\[rs]Start Menu\[rs]Programs\[rs]Startup\f[R], or \f[C]C:\[rs]ProgramData\[rs]Microsoft\[rs]Windows\[rs]Start Menu\[rs]Programs\[rs]StartUp\f[R] if you want the command to start for \f[I]every\f[R] user that logs in. .PP 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. .SS Start from Task Scheduler .PP 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 \f[C]SYSTEM\f[R] user. For technical information, see https://docs.microsoft.com/windows/win32/taskschd/task-scheduler-start-page. .SS Run as service .PP 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. .SS Mount command built-in service integration .PP 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 \f[C]New-Service\f[R] (requires administrative privileges). .PP Example of a PowerShell command that creates a Windows service for mounting some \f[C]remote:/files\f[R] as drive letter \f[C]X:\f[R], for \f[I]all\f[R] users (service will be running as the local system account): .IP .nf \f[C] New-Service -Name Rclone -BinaryPathName \[aq]c:\[rs]rclone\[rs]rclone.exe mount remote:/files X: --config c:\[rs]rclone\[rs]config\[rs]rclone.conf --log-file c:\[rs]rclone\[rs]logs\[rs]mount.txt\[aq] \f[R] .fi .PP 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 \[dq]child services\[dq]. 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 here (https://github.com/rclone/rclone/issues/3340). .SS Third-party service integration .PP To Windows service running any rclone command, the excellent third-party utility NSSM (http://nssm.cc), the \[dq]Non-Sucking Service Manager\[dq], 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 ). .PP There are also several other alternatives. To mention one more, WinSW (https://github.com/winsw/winsw), \[dq]Windows Service Wrapper\[dq], 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 \[dq]onfailure\[dq] parameter). .SS Autostart on Linux .SS Start as a service .PP 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. .SS Run periodically from cron .PP To run a periodic command, such as a copy/sync, you can set up a cron job. .SH Usage .PP Rclone is a command line program to manage files on cloud storage. After download (https://rclone.org/downloads/) and install, continue here to learn how to use it: Initial configuration, what the basic syntax looks like, describes the various subcommands, the various options, and more. .SS Configure .PP First, you\[aq]ll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. (See the \f[C]--config\f[R] entry for how to find the config file and choose its location.) .PP The easiest way to make the config is to run rclone with the config option: .IP .nf \f[C] rclone config \f[R] .fi .PP See the following for detailed instructions for .IP \[bu] 2 1Fichier (https://rclone.org/fichier/) .IP \[bu] 2 Akamai Netstorage (https://rclone.org/netstorage/) .IP \[bu] 2 Alias (https://rclone.org/alias/) .IP \[bu] 2 Amazon S3 (https://rclone.org/s3/) .IP \[bu] 2 Backblaze B2 (https://rclone.org/b2/) .IP \[bu] 2 Box (https://rclone.org/box/) .IP \[bu] 2 Chunker (https://rclone.org/chunker/) - transparently splits large files for other remotes .IP \[bu] 2 Citrix ShareFile (https://rclone.org/sharefile/) .IP \[bu] 2 Compress (https://rclone.org/compress/) .IP \[bu] 2 Cloudinary (https://rclone.org/cloudinary/) .IP \[bu] 2 Combine (https://rclone.org/combine/) .IP \[bu] 2 Crypt (https://rclone.org/crypt/) - to encrypt other remotes .IP \[bu] 2 DigitalOcean Spaces (https://rclone.org/s3/#digitalocean-spaces) .IP \[bu] 2 Digi Storage (https://rclone.org/koofr/#digi-storage) .IP \[bu] 2 Dropbox (https://rclone.org/dropbox/) .IP \[bu] 2 Enterprise File Fabric (https://rclone.org/filefabric/) .IP \[bu] 2 Files.com (https://rclone.org/filescom/) .IP \[bu] 2 FTP (https://rclone.org/ftp/) .IP \[bu] 2 Gofile (https://rclone.org/gofile/) .IP \[bu] 2 Google Cloud Storage (https://rclone.org/googlecloudstorage/) .IP \[bu] 2 Google Drive (https://rclone.org/drive/) .IP \[bu] 2 Google Photos (https://rclone.org/googlephotos/) .IP \[bu] 2 Hasher (https://rclone.org/hasher/) - to handle checksums for other remotes .IP \[bu] 2 HDFS (https://rclone.org/hdfs/) .IP \[bu] 2 Hetzner Storage Box (https://rclone.org/sftp/#hetzner-storage-box) .IP \[bu] 2 HiDrive (https://rclone.org/hidrive/) .IP \[bu] 2 HTTP (https://rclone.org/http/) .IP \[bu] 2 iCloud Drive (https://rclone.org/iclouddrive/) .IP \[bu] 2 Internet Archive (https://rclone.org/internetarchive/) .IP \[bu] 2 Jottacloud (https://rclone.org/jottacloud/) .IP \[bu] 2 Koofr (https://rclone.org/koofr/) .IP \[bu] 2 Linkbox (https://rclone.org/linkbox/) .IP \[bu] 2 Mail.ru Cloud (https://rclone.org/mailru/) .IP \[bu] 2 Mega (https://rclone.org/mega/) .IP \[bu] 2 Memory (https://rclone.org/memory/) .IP \[bu] 2 Microsoft Azure Blob Storage (https://rclone.org/azureblob/) .IP \[bu] 2 Microsoft Azure Files Storage (https://rclone.org/azurefiles/) .IP \[bu] 2 Microsoft OneDrive (https://rclone.org/onedrive/) .IP \[bu] 2 OpenStack Swift / Rackspace Cloudfiles / Blomp Cloud Storage / Memset Memstore (https://rclone.org/swift/) .IP \[bu] 2 OpenDrive (https://rclone.org/opendrive/) .IP \[bu] 2 Oracle Object Storage (https://rclone.org/oracleobjectstorage/) .IP \[bu] 2 Pcloud (https://rclone.org/pcloud/) .IP \[bu] 2 PikPak (https://rclone.org/pikpak/) .IP \[bu] 2 Pixeldrain (https://rclone.org/pixeldrain/) .IP \[bu] 2 premiumize.me (https://rclone.org/premiumizeme/) .IP \[bu] 2 put.io (https://rclone.org/putio/) .IP \[bu] 2 Proton Drive (https://rclone.org/protondrive/) .IP \[bu] 2 QingStor (https://rclone.org/qingstor/) .IP \[bu] 2 Quatrix by Maytech (https://rclone.org/quatrix/) .IP \[bu] 2 rsync.net (https://rclone.org/sftp/#rsync-net) .IP \[bu] 2 Seafile (https://rclone.org/seafile/) .IP \[bu] 2 SFTP (https://rclone.org/sftp/) .IP \[bu] 2 Sia (https://rclone.org/sia/) .IP \[bu] 2 SMB (https://rclone.org/smb/) .IP \[bu] 2 Storj (https://rclone.org/storj/) .IP \[bu] 2 SugarSync (https://rclone.org/sugarsync/) .IP \[bu] 2 Union (https://rclone.org/union/) .IP \[bu] 2 Uloz.to (https://rclone.org/ulozto/) .IP \[bu] 2 Uptobox (https://rclone.org/uptobox/) .IP \[bu] 2 WebDAV (https://rclone.org/webdav/) .IP \[bu] 2 Yandex Disk (https://rclone.org/yandex/) .IP \[bu] 2 Zoho WorkDrive (https://rclone.org/zoho/) .IP \[bu] 2 The local filesystem (https://rclone.org/local/) .SS Basic syntax .PP Rclone syncs a directory tree from one storage system to another. .PP Its syntax is like this .IP .nf \f[C] rclone subcommand [options] <parameters> <parameters...> \f[R] .fi .PP A \f[C]subcommand\f[R] is a the rclone operation required, (e.g. \f[C]sync\f[R], \f[C]copy\f[R], \f[C]ls\f[R]). .PP An \f[C]option\f[R] is a single letter flag (e.g. \f[C]-v\f[R]) or a group of single letter flags (e.g. \f[C]-Pv\f[R]) or a long flag (e.g. \f[C]--progress\f[R]). No options are required. Options can come after the \f[C]subcommand\f[R] or in between parameters too or on the end, but only global options can be used before the \f[C]subcommand\f[R]. Anything after a \f[C]--\f[R] option will not be interpreted as an option so if you need to add a parameter which starts with a \f[C]-\f[R] then put a \f[C]--\f[R] on its own first, eg .IP .nf \f[C] rclone lsf -- -directory-starting-with-dash \f[R] .fi .PP A \f[C]parameter\f[R] is usually a file path or rclone remote, eg \f[C]/path/to/file\f[R] or \f[C]remote:path/to/file\f[R] but it can be other things - the \f[C]subcommand\f[R] help will tell you what. .PP Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, e.g. \[dq]drive:myfolder\[dq] to look at \[dq]myfolder\[dq] in Google drive. .PP You can define as many storage paths as you like in the config file. .PP Please use the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag while learning rclone to avoid accidental data loss. .SS Subcommands .PP rclone uses a system of subcommands. For example .IP .nf \f[C] 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 \f[R] .fi .SH rclone config .PP Enter an interactive configuration session. .SS Synopsis .PP 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. .IP .nf \f[C] rclone config [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for config \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .IP \[bu] 2 rclone config create (https://rclone.org/commands/rclone_config_create/) - Create a new remote with name, type and options. .IP \[bu] 2 rclone config delete (https://rclone.org/commands/rclone_config_delete/) - Delete an existing remote. .IP \[bu] 2 rclone config disconnect (https://rclone.org/commands/rclone_config_disconnect/) - Disconnects user from remote .IP \[bu] 2 rclone config dump (https://rclone.org/commands/rclone_config_dump/) - Dump the config file as JSON. .IP \[bu] 2 rclone config edit (https://rclone.org/commands/rclone_config_edit/) - Enter an interactive configuration session. .IP \[bu] 2 rclone config encryption (https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file .IP \[bu] 2 rclone config file (https://rclone.org/commands/rclone_config_file/) - Show path of configuration file in use. .IP \[bu] 2 rclone config password (https://rclone.org/commands/rclone_config_password/) - Update password in an existing remote. .IP \[bu] 2 rclone config paths (https://rclone.org/commands/rclone_config_paths/) - Show paths used for configuration, cache, temp etc. .IP \[bu] 2 rclone config providers (https://rclone.org/commands/rclone_config_providers/) - List in JSON format all the providers and options. .IP \[bu] 2 rclone config reconnect (https://rclone.org/commands/rclone_config_reconnect/) - Re-authenticates user with remote. .IP \[bu] 2 rclone config redacted (https://rclone.org/commands/rclone_config_redacted/) - Print redacted (decrypted) config file, or the redacted config for a single remote. .IP \[bu] 2 rclone config show (https://rclone.org/commands/rclone_config_show/) - Print (decrypted) config file, or the config for a single remote. .IP \[bu] 2 rclone config touch (https://rclone.org/commands/rclone_config_touch/) - Ensure configuration file exists. .IP \[bu] 2 rclone config update (https://rclone.org/commands/rclone_config_update/) - Update options in an existing remote. .IP \[bu] 2 rclone config userinfo (https://rclone.org/commands/rclone_config_userinfo/) - Prints info about logged in user of remote. .SH rclone copy .PP Copy files from source to dest, skipping identical files. .SS Synopsis .PP 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\[aq]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. .PP 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\[aq]s the contents of source:path that are copied, not the directory name and contents. .PP To copy single files, use the copyto (https://rclone.org/commands/rclone_copyto/) command instead. .PP If dest:path doesn\[aq]t exist, it is created and the source:path contents go there. .PP For example .IP .nf \f[C] rclone copy source:sourcepath dest:destpath \f[R] .fi .PP Let\[aq]s say there are two files in sourcepath .IP .nf \f[C] sourcepath/one.txt sourcepath/two.txt \f[R] .fi .PP This copies them to .IP .nf \f[C] destpath/one.txt destpath/two.txt \f[R] .fi .PP Not to .IP .nf \f[C] destpath/sourcepath/one.txt destpath/sourcepath/two.txt \f[R] .fi .PP If you are familiar with \f[C]rsync\f[R], rclone always works as if you had written a trailing \f[C]/\f[R] - meaning \[dq]copy the contents of this directory\[dq]. This applies to all commands and whether you are talking about the source or destination. .PP 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. .PP 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: .IP .nf \f[C] rclone copy --max-age 24h --no-traverse /path/to/src remote: \f[R] .fi .PP Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the \f[C]--metadata\f[R] flag. .PP Note that the modification time and metadata for the root directory will \f[B]not\f[R] be synced. See https://github.com/rclone/rclone/issues/7652 for more info. .PP \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view real-time transfer statistics. .PP \f[B]Note\f[R]: Use the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag to test without copying anything. .IP .nf \f[C] rclone copy source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --create-empty-src-dirs Create empty source dirs on destination after copy -h, --help help for copy \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone sync .PP Make source and dest identical, modifying destination only. .SS Synopsis .PP Sync the source to the destination, changing the destination only. Doesn\[aq]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\[aq]t want to delete files from destination, use the copy (https://rclone.org/commands/rclone_copy/) command instead. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .IP .nf \f[C] rclone sync --interactive SOURCE remote:DESTINATION \f[R] .fi .PP Note that files in the destination won\[aq]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 also not yet handled. .PP It is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it\[aq]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. .PP If dest:path doesn\[aq]t exist, it is created and the source:path contents go there. .PP 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. .PP Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the \f[C]--metadata\f[R] flag. .PP Note that the modification time and metadata for the root directory will \f[B]not\f[R] be synced. See https://github.com/rclone/rclone/issues/7652 for more info. .PP \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view real-time transfer statistics .PP \f[B]Note\f[R]: Use the \f[C]rclone dedupe\f[R] command to deal with \[dq]Duplicate object/directory found in source/destination - ignoring\[dq] errors. See this forum post (https://forum.rclone.org/t/sync-not-clearing-duplicates/14372) for more info. .SH Logger Flags .PP The \f[C]--differ\f[R], \f[C]--missing-on-dst\f[R], \f[C]--missing-on-src\f[R], \f[C]--match\f[R] and \f[C]--error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]-\f[R]) supplied. What they write is described in the help below. For example \f[C]--differ\f[R] will write all paths which are present on both the source and destination but different. .PP The \f[C]--combined\f[R] 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. .IP \[bu] 2 \f[C]= path\f[R] means path was found in source and destination and was identical .IP \[bu] 2 \[ga]- path\[ga] means path was missing on the source, so only in the destination .IP \[bu] 2 \[ga]+ path\[ga] means path was missing on the destination, so only in the source .IP \[bu] 2 \[ga]* path\[ga] means path was present in source and destination but different. .IP \[bu] 2 \f[C]! path\f[R] means there was an error reading or hashing the source or dest. .PP The \f[C]--dest-after\f[R] flag writes a list file using the same format flags as \f[C]lsf\f[R] (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\[aq]s \f[C]--itemize-changes\f[R], but not identical -- it should output an accurate list of what will be on the destination after the sync. .PP Note that these logger flags have a few limitations, and certain scenarios are not currently supported: .IP \[bu] 2 \f[C]--max-duration\f[R] / \f[C]CutoffModeHard\f[R] .IP \[bu] 2 \f[C]--compare-dest\f[R] / \f[C]--copy-dest\f[R] .IP \[bu] 2 server-side moves of an entire dir at once .IP \[bu] 2 High-level retries, because there would be duplicates (use \f[C]--retries 1\f[R] to disable) .IP \[bu] 2 Possibly some unusual error scenarios .PP Note also that each file is logged during the sync, 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.) .IP .nf \f[C] rclone sync source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \[dq]p\[dq]) --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default \[dq]md5\[dq]) -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 \[dq];\[dq]) -t, --timeformat string Specify a custom time format, or \[aq]max\[aq] for max precision supported by remote (default: 2006-01-02 15:04:05) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Sync Options .PP Flags used for sync commands .IP .nf \f[C] --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 --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 \[dq]hash\[dq]) \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone move .PP Move files from source to dest. .SS Synopsis .PP 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. .PP To move single files, use the moveto (https://rclone.org/commands/rclone_moveto/) command instead. .PP If no filters are in use and if possible this will server-side move \f[C]source:path\f[R] into \f[C]dest:path\f[R]. After this \f[C]source:path\f[R] will no longer exist. .PP Otherwise for each file in \f[C]source:path\f[R] selected by the filters (if any) this will move it into \f[C]dest:path\f[R]. If possible a server-side move will be used, otherwise it will copy it (server-side if possible) into \f[C]dest:path\f[R] then delete the original (if no errors on copy) in \f[C]source:path\f[R]. .PP If you want to delete empty source directories after move, use the \f[C]--delete-empty-src-dirs\f[R] flag. .PP 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. .PP Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the \f[C]--metadata\f[R] flag. .PP Note that the modification time and metadata for the root directory will \f[B]not\f[R] be synced. See https://github.com/rclone/rclone/issues/7652 for more info. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .PP \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view real-time transfer statistics. .IP .nf \f[C] rclone move source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 move \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone delete .PP Remove the files in path. .SS Synopsis .PP 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. .PP \f[C]rclone delete\f[R] 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. .PP If you supply the \f[C]--rmdirs\f[R] 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. .PP For example, to delete all files bigger than 100 MiB, you may first want to check what would be deleted (use either): .IP .nf \f[C] rclone --min-size 100M lsl remote:path rclone --dry-run --min-size 100M delete remote:path \f[R] .fi .PP Then proceed with the actual delete: .IP .nf \f[C] rclone --min-size 100M delete remote:path \f[R] .fi .PP That reads \[dq]delete everything with a minimum size of 100 MiB\[dq], hence delete all files bigger than 100 MiB. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .IP .nf \f[C] rclone delete remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for delete --rmdirs rmdirs removes empty directories but leaves root intact \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone purge .PP Remove the path and all of its contents. .SS Synopsis .PP 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/). .PP The concurrency of this operation is controlled by the \f[C]--checkers\f[R] global flag. However, some backends will implement this command directly, in which case \f[C]--checkers\f[R] will be ignored. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .IP .nf \f[C] rclone purge remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for purge \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone mkdir .PP Make the path if it doesn\[aq]t already exist. .IP .nf \f[C] rclone mkdir remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for mkdir \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone rmdir .PP Remove the empty directory at path. .SS Synopsis .PP 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 \f[C]--rmdirs\f[R]) to do that. .PP To delete a path and any objects in it, use purge (https://rclone.org/commands/rclone_purge/) command. .IP .nf \f[C] rclone rmdir remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for rmdir \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone check .PP Checks the files in the source and destination match. .SS Synopsis .PP 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\[aq]t match. It doesn\[aq]t alter the source or destination. .PP 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. .PP If you supply the \f[C]--size-only\f[R] flag, it will only compare the sizes not the hashes as well. Use this for a quick check. .PP If you supply the \f[C]--download\f[R] 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\[aq]t support hashes or if you really want to check all the data. .PP If you supply the \f[C]--checkfile HASH\f[R] flag with a valid hash name, the \f[C]source:path\f[R] must point to a text file in the SUM format. .PP If you supply the \f[C]--one-way\f[R] 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. .PP The \f[C]--differ\f[R], \f[C]--missing-on-dst\f[R], \f[C]--missing-on-src\f[R], \f[C]--match\f[R] and \f[C]--error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]-\f[R]) supplied. What they write is described in the help below. For example \f[C]--differ\f[R] will write all paths which are present on both the source and destination but different. .PP The \f[C]--combined\f[R] 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. .IP \[bu] 2 \f[C]= path\f[R] means path was found in source and destination and was identical .IP \[bu] 2 \[ga]- path\[ga] means path was missing on the source, so only in the destination .IP \[bu] 2 \[ga]+ path\[ga] means path was missing on the destination, so only in the source .IP \[bu] 2 \[ga]* path\[ga] means path was present in source and destination but different. .IP \[bu] 2 \f[C]! path\f[R] means there was an error reading or hashing the source or dest. .PP The default number of parallel checks is 8. See the --checkers=N (https://rclone.org/docs/#checkers-n) option for more information. .IP .nf \f[C] rclone check source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Check Options .PP Flags used for check commands .IP .nf \f[C] --max-backlog int Maximum number of objects in sync or check backlog (default 10000) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone ls .PP List the objects in the path with size and path. .SS Synopsis .PP Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default. .PP Eg .IP .nf \f[C] $ rclone ls swift:bucket 60295 bevajer5jef 90613 canole 94467 diwogej7 37600 fubuwic \f[R] .fi .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 \f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 \f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 \f[C]lsd\f[R] to list directories only .IP \[bu] 2 \f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 \f[C]lsjson\f[R] to list objects and directories in JSON format .PP \f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human-readable. \f[C]lsf\f[R] is designed to be human and machine-readable. \f[C]lsjson\f[R] is designed to be machine-readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default - use \f[C]--max-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do not recurse by default - use \f[C]-R\f[R] to make them recurse. .PP Listing a nonexistent directory will produce an error except for remotes which can\[aq]t have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). .IP .nf \f[C] rclone ls remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for ls \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone lsd .PP List all directories/containers/buckets in the path. .SS Synopsis .PP Lists the directories in the source path to standard output. Does not recurse by default. Use the \f[C]-R\f[R] flag to recurse. .PP 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, Eg .IP .nf \f[C] $ rclone lsd swift: 494000 2018-04-26 08:43:20 10000 10000files 65 2018-04-26 08:43:20 1 1File \f[R] .fi .PP Or .IP .nf \f[C] $ 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 \f[R] .fi .PP If you just want the directory names use \f[C]rclone lsf --dirs-only\f[R]. .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 \f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 \f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 \f[C]lsd\f[R] to list directories only .IP \[bu] 2 \f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 \f[C]lsjson\f[R] to list objects and directories in JSON format .PP \f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human-readable. \f[C]lsf\f[R] is designed to be human and machine-readable. \f[C]lsjson\f[R] is designed to be machine-readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default - use \f[C]--max-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do not recurse by default - use \f[C]-R\f[R] to make them recurse. .PP Listing a nonexistent directory will produce an error except for remotes which can\[aq]t have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). .IP .nf \f[C] rclone lsd remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for lsd -R, --recursive Recurse into the listing \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone lsl .PP List the objects in path with modification time, size and path. .SS Synopsis .PP Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default. .PP Eg .IP .nf \f[C] $ 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 \f[R] .fi .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 \f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 \f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 \f[C]lsd\f[R] to list directories only .IP \[bu] 2 \f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 \f[C]lsjson\f[R] to list objects and directories in JSON format .PP \f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human-readable. \f[C]lsf\f[R] is designed to be human and machine-readable. \f[C]lsjson\f[R] is designed to be machine-readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default - use \f[C]--max-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do not recurse by default - use \f[C]-R\f[R] to make them recurse. .PP Listing a nonexistent directory will produce an error except for remotes which can\[aq]t have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). .IP .nf \f[C] rclone lsl remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for lsl \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone md5sum .PP Produces an md5sum file for all the objects in the path. .SS Synopsis .PP Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. .PP 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. .PP For other algorithms, see the hashsum (https://rclone.org/commands/rclone_hashsum/) command. Running \f[C]rclone md5sum remote:path\f[R] is equivalent to running \f[C]rclone hashsum MD5 remote:path\f[R]. .PP 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). .IP .nf \f[C] rclone md5sum remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone sha1sum .PP Produces an sha1sum file for all the objects in the path. .SS Synopsis .PP Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. .PP 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. .PP For other algorithms, see the hashsum (https://rclone.org/commands/rclone_hashsum/) command. Running \f[C]rclone sha1sum remote:path\f[R] is equivalent to running \f[C]rclone hashsum SHA1 remote:path\f[R]. .PP 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). .PP This command can also hash data received on STDIN, if not passing a remote:path. .IP .nf \f[C] rclone sha1sum remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone size .PP Prints the total size and number of objects in remote:path. .SS Synopsis .PP Counts objects in the path and calculates the total size. Prints the result to standard output. .PP 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 \f[C]--human-readable\f[R] is not considered). Use option \f[C]--json\f[R] to format output as JSON instead. .PP Recurses by default, use \f[C]--max-depth 1\f[R] to stop the recursion. .PP 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. .IP .nf \f[C] rclone size remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for size --json Format output as JSON \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone version .PP Show the version number. .SS Synopsis .PP 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). .PP For example: .IP .nf \f[C] $ 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 \f[R] .fi .PP Note: before rclone version 1.55 the os/type and os/arch lines were merged, and the \[dq]go/version\[dq] line was tagged as \[dq]go version\[dq]. .PP 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. .IP .nf \f[C] $ rclone version --check yours: 1.42.0.6 latest: 1.42 (released 2018-06-16) beta: 1.42.0.5 (released 2018-06-17) \f[R] .fi .PP Or .IP .nf \f[C] $ 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 \f[R] .fi .IP .nf \f[C] rclone version [flags] \f[R] .fi .SS Options .IP .nf \f[C] --check Check for new version -h, --help help for version \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone cleanup .PP Clean up the remote if possible. .SS Synopsis .PP Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes. .IP .nf \f[C] rclone cleanup remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for cleanup \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone dedupe .PP Interactively find duplicate filenames and delete/rename them. .SS Synopsis .PP By default \f[C]dedupe\f[R] 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. .PP 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. .PP However if \f[C]--by-hash\f[R] 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. .PP 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. .PP 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 \f[C]dedupe\f[R] command will not be interactive. .PP \f[C]dedupe\f[R] 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 \f[C]--size-only\f[R] 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. .PP 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. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .PP Here is an example run. .PP Before - with duplicates .IP .nf \f[C] $ 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 \f[R] .fi .PP Now the \f[C]dedupe\f[R] session .IP .nf \f[C] $ rclone dedupe drive:dupes 2016/03/05 16:24:37 Google drive root \[aq]dupes\[aq]: Looking for duplicates using interactive mode. one.txt: Found 4 files with duplicate names one.txt: Deleting 2/3 identical duplicates (MD5 \[dq]1eedaa9fe86fd4b8632e2ac549403b36\[dq]) 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 \f[R] .fi .PP The result being .IP .nf \f[C] $ 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 \f[R] .fi .PP Dedupe can be run non interactively using the \f[C]--dedupe-mode\f[R] flag or by using an extra parameter with the same value .IP \[bu] 2 \f[C]--dedupe-mode interactive\f[R] - interactive as above. .IP \[bu] 2 \f[C]--dedupe-mode skip\f[R] - removes identical files then skips anything left. .IP \[bu] 2 \f[C]--dedupe-mode first\f[R] - removes identical files then keeps the first one. .IP \[bu] 2 \f[C]--dedupe-mode newest\f[R] - removes identical files then keeps the newest one. .IP \[bu] 2 \f[C]--dedupe-mode oldest\f[R] - removes identical files then keeps the oldest one. .IP \[bu] 2 \f[C]--dedupe-mode largest\f[R] - removes identical files then keeps the largest one. .IP \[bu] 2 \f[C]--dedupe-mode smallest\f[R] - removes identical files then keeps the smallest one. .IP \[bu] 2 \f[C]--dedupe-mode rename\f[R] - removes identical files then renames the rest to be different. .IP \[bu] 2 \f[C]--dedupe-mode list\f[R] - lists duplicate dirs and files only and changes nothing. .PP For example, to rename all the identically named photos in your Google Photos directory, do .IP .nf \f[C] rclone dedupe --dedupe-mode rename \[dq]drive:Google Photos\[dq] \f[R] .fi .PP Or .IP .nf \f[C] rclone dedupe rename \[dq]drive:Google Photos\[dq] \f[R] .fi .IP .nf \f[C] rclone dedupe [mode] remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --by-hash Find identical hashes rather than names --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename (default \[dq]interactive\[dq]) -h, --help help for dedupe \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone about .PP Get quota information from the remote. .SS Synopsis .PP Prints quota information about a remote to standard output. The output is typically used, free, quota and trash contents. .PP E.g. Typical output from \f[C]rclone about remote:\f[R] is: .IP .nf \f[C] Total: 17 GiB Used: 7.444 GiB Free: 1.315 GiB Trashed: 100.000 MiB Other: 8.241 GiB \f[R] .fi .PP Where the fields are: .IP \[bu] 2 Total: Total size available. .IP \[bu] 2 Used: Total size used. .IP \[bu] 2 Free: Total space available to this user. .IP \[bu] 2 Trashed: Total space used by trash. .IP \[bu] 2 Other: Total amount in other storage (e.g. Gmail, Google Photos). .IP \[bu] 2 Objects: Total number of objects in the storage. .PP All sizes are in number of bytes. .PP Applying a \f[C]--full\f[R] flag to the command prints the bytes in full, e.g. .IP .nf \f[C] Total: 18253611008 Used: 7993453766 Free: 1411001220 Trashed: 104857602 Other: 8849156022 \f[R] .fi .PP A \f[C]--json\f[R] flag generates conveniently machine-readable output, e.g. .IP .nf \f[C] { \[dq]total\[dq]: 18253611008, \[dq]used\[dq]: 7993453766, \[dq]trashed\[dq]: 104857602, \[dq]other\[dq]: 8849156022, \[dq]free\[dq]: 1411001220 } \f[R] .fi .PP 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. .PP Some backends does not support the \f[C]rclone about\f[R] command at all, see complete list in documentation (https://rclone.org/overview/#optional-features). .IP .nf \f[C] rclone about remote: [flags] \f[R] .fi .SS Options .IP .nf \f[C] --full Full numbers instead of human-readable -h, --help help for about --json Format output as JSON \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone authorize .PP Remote authorization. .SS Synopsis .PP Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config. .PP The command requires 1-3 arguments: - fs name (e.g., \[dq]drive\[dq], \[dq]s3\[dq], etc.) - 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 .PP Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically. .PP 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. .IP .nf \f[C] rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone backend .PP Run a backend-specific command. .SS Synopsis .PP This runs a backend-specific command. The commands themselves (except for \[dq]help\[dq] and \[dq]features\[dq]) are defined by the backends and you should see the backend docs for definitions. .PP You can discover what commands a backend implements by using .IP .nf \f[C] rclone backend help remote: rclone backend help <backendname> \f[R] .fi .PP 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). .IP .nf \f[C] rclone backend features remote: \f[R] .fi .PP Pass options to the backend command with -o. This should be key=value or key, e.g.: .IP .nf \f[C] rclone backend stats remote:path stats -o format=json -o long \f[R] .fi .PP Pass arguments to the backend by placing them on the end of the line .IP .nf \f[C] rclone backend cleanup remote:path file1 file2 file3 \f[R] .fi .PP Note to run these commands on a running backend then see backend/command (https://rclone.org/rc/#backend-command) in the rc docs. .IP .nf \f[C] rclone backend <command> remote:path [opts] <args> [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for backend --json Always output in JSON format -o, --option stringArray Option in the form name=value or name \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone bisync .PP Perform bidirectional synchronization between two paths. .SS Synopsis .PP Perform bidirectional synchronization between two paths. .PP 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 \f[C]New\f[R], \f[C]Newer\f[R], \f[C]Older\f[R], and \f[C]Deleted\f[R] files. - Propagate changes on Path1 to Path2, and vice-versa. .PP Bisync is \f[B]in beta\f[R] and is considered an \f[B]advanced command\f[R], 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/). .PP See full bisync description (https://rclone.org/bisync/) for details. .IP .nf \f[C] rclone bisync remote1:path1 remote2:path2 [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \[dq]true\[dq]) --compare string Comma-separated list of bisync-specific compare options ex. \[aq]size,modtime,checksum\[aq] (default: \[aq]size,modtime\[aq]) --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 \[dq]none\[dq]) --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: \[aq]conflict\[aq]) --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. Use at your own risk! -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 \[dq]none\[dq]) --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}) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone cat .PP Concatenates any files and sends them to stdout. .SS Synopsis .PP Sends any files to standard output. .PP You can use it like this to output a single file .IP .nf \f[C] rclone cat remote:path/to/file \f[R] .fi .PP Or like this to output any file in dir or its subdirectories. .IP .nf \f[C] rclone cat remote:path/to/dir \f[R] .fi .PP Or like this to output any .txt files in dir or its subdirectories. .IP .nf \f[C] rclone --include \[dq]*.txt\[dq] cat remote:path/to/dir \f[R] .fi .PP Use the \f[C]--head\f[R] flag to print characters only at the start, \f[C]--tail\f[R] for the end and \f[C]--offset\f[R] and \f[C]--count\f[R] to print a section in the middle. Note that if offset is negative it will count from the end, so \f[C]--offset -1 --count 1\f[R] is equivalent to \f[C]--tail 1\f[R]. .PP Use the \f[C]--separator\f[R] flag to print a separator value between files. Be sure to shell-escape special characters. For example, to print a newline between files, use: .IP \[bu] 2 bash: .RS 2 .IP .nf \f[C] rclone --include \[dq]*.txt\[dq] --separator $\[aq]\[rs]n\[aq] cat remote:path/to/dir \f[R] .fi .RE .IP \[bu] 2 powershell: .RS 2 .IP .nf \f[C] rclone --include \[dq]*.txt\[dq] --separator \[dq]\[ga]n\[dq] cat remote:path/to/dir \f[R] .fi .RE .IP .nf \f[C] rclone cat remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone checksum .PP Checks the files in the destination against a SUM file. .SS Synopsis .PP Checks that hashsums of destination files match the SUM file. It compares hashes (MD5, SHA1, etc) and logs a report of files which don\[aq]t match. It doesn\[aq]t alter the file system. .PP The sumfile is treated as the source and the dst:path is treated as the destination for the purposes of the output. .PP If you supply the \f[C]--download\f[R] 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\[aq]t support hashes or if you really want to check all the data. .PP Note that hash values in the SUM file are treated as case insensitive. .PP If you supply the \f[C]--one-way\f[R] 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. .PP The \f[C]--differ\f[R], \f[C]--missing-on-dst\f[R], \f[C]--missing-on-src\f[R], \f[C]--match\f[R] and \f[C]--error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]-\f[R]) supplied. What they write is described in the help below. For example \f[C]--differ\f[R] will write all paths which are present on both the source and destination but different. .PP The \f[C]--combined\f[R] 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. .IP \[bu] 2 \f[C]= path\f[R] means path was found in source and destination and was identical .IP \[bu] 2 \[ga]- path\[ga] means path was missing on the source, so only in the destination .IP \[bu] 2 \[ga]+ path\[ga] means path was missing on the destination, so only in the source .IP \[bu] 2 \[ga]* path\[ga] means path was present in source and destination but different. .IP \[bu] 2 \f[C]! path\f[R] means there was an error reading or hashing the source or dest. .PP The default number of parallel checks is 8. See the --checkers=N (https://rclone.org/docs/#checkers-n) option for more information. .IP .nf \f[C] rclone checksum <hash> sumfile dst:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone completion .PP Output completion script for a given shell. .SS Synopsis .PP Generates a shell completion script for rclone. Run with \f[C]--help\f[R] to list the supported shells. .SS Options .IP .nf \f[C] -h, --help help for completion \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .IP \[bu] 2 rclone completion bash (https://rclone.org/commands/rclone_completion_bash/) - Output bash completion script for rclone. .IP \[bu] 2 rclone completion fish (https://rclone.org/commands/rclone_completion_fish/) - Output fish completion script for rclone. .IP \[bu] 2 rclone completion powershell (https://rclone.org/commands/rclone_completion_powershell/) - Output powershell completion script for rclone. .IP \[bu] 2 rclone completion zsh (https://rclone.org/commands/rclone_completion_zsh/) - Output zsh completion script for rclone. .SH rclone completion bash .PP Output bash completion script for rclone. .SS Synopsis .PP Generates a bash shell autocompletion script for rclone. .PP By default, when run without any arguments, .IP .nf \f[C] rclone completion bash \f[R] .fi .PP the generated script will be written to .IP .nf \f[C] /etc/bash_completion.d/rclone \f[R] .fi .PP and so rclone will probably need to be run as root, or with sudo. .PP 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. .PP If output_file is \[dq]-\[dq], then the output will be written to stdout. .PP If you have installed the script into the default location, you can logout and login again to use the autocompletion script. .PP Alternatively, you can source the script directly .IP .nf \f[C] \&. /path/to/my_bash_completion_scripts/rclone \f[R] .fi .PP and the autocompletion functionality will be added to your current shell. .IP .nf \f[C] rclone completion bash [output_file] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for bash \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone completion (https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. .SH rclone completion fish .PP Output fish completion script for rclone. .SS Synopsis .PP Generates a fish autocompletion script for rclone. .PP This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g. .IP .nf \f[C] sudo rclone completion fish \f[R] .fi .PP Logout and login again to use the autocompletion scripts, or source them directly .IP .nf \f[C] \&. /etc/fish/completions/rclone.fish \f[R] .fi .PP If you supply a command line argument the script will be written there. .PP If output_file is \[dq]-\[dq], then the output will be written to stdout. .IP .nf \f[C] rclone completion fish [output_file] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for fish \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone completion (https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. .SH rclone completion powershell .PP Output powershell completion script for rclone. .SS Synopsis .PP Generate the autocompletion script for powershell. .PP To load completions in your current shell session: .IP .nf \f[C] rclone completion powershell | Out-String | Invoke-Expression \f[R] .fi .PP To load completions for every new session, add the output of the above command to your powershell profile. .PP If output_file is \[dq]-\[dq] or missing, then the output will be written to stdout. .IP .nf \f[C] rclone completion powershell [output_file] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for powershell \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone completion (https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. .SH rclone completion zsh .PP Output zsh completion script for rclone. .SS Synopsis .PP Generates a zsh autocompletion script for rclone. .PP 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. .IP .nf \f[C] sudo rclone completion zsh \f[R] .fi .PP Logout and login again to use the autocompletion scripts, or source them directly .IP .nf \f[C] autoload -U compinit && compinit \f[R] .fi .PP If you supply a command line argument the script will be written there. .PP If output_file is \[dq]-\[dq], then the output will be written to stdout. .IP .nf \f[C] rclone completion zsh [output_file] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for zsh \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone completion (https://rclone.org/commands/rclone_completion/) - Output completion script for a given shell. .SH rclone config create .PP Create a new remote with name, type and options. .SS Synopsis .PP Create a new remote of \f[C]name\f[R] with \f[C]type\f[R] and options. The options should be passed in pairs of \f[C]key\f[R] \f[C]value\f[R] or as \f[C]key=value\f[R]. .PP For example, to make a swift remote of name myremote using auto config you would do: .IP .nf \f[C] rclone config create myremote swift env_auth true rclone config create myremote swift env_auth=true \f[R] .fi .PP So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: .IP .nf \f[C] rclone config create mydrive drive config_is_local=false \f[R] .fi .PP Note that if the config process would normally ask a question the default is taken (unless \f[C]--non-interactive\f[R] is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken. .PP If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren\[aq]t already obscured before putting them in the config file. .PP \f[B]NB\f[R] 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 \f[C]--obscure\f[R] flag, or if you are 100% certain you are already passing obscured passwords then use \f[C]--no-obscure\f[R]. You can also set obscured passwords using the \f[C]rclone config password\f[R] command. .PP The flag \f[C]--non-interactive\f[R] is for use by applications that wish to configure rclone themselves, rather than using rclone\[aq]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. .PP This will look something like (some irrelevant detail removed): .IP .nf \f[C] { \[dq]State\[dq]: \[dq]*oauth-islocal,teamdrive,,\[dq], \[dq]Option\[dq]: { \[dq]Name\[dq]: \[dq]config_is_local\[dq], \[dq]Help\[dq]: \[dq]Use web browser to automatically authenticate rclone with remote?\[rs]n * Say Y if the machine running rclone has a web browser you can use\[rs]n * Say N if running rclone on a (remote) machine without web browser access\[rs]nIf not sure try Y. If Y failed, try N.\[rs]n\[dq], \[dq]Default\[dq]: true, \[dq]Examples\[dq]: [ { \[dq]Value\[dq]: \[dq]true\[dq], \[dq]Help\[dq]: \[dq]Yes\[dq] }, { \[dq]Value\[dq]: \[dq]false\[dq], \[dq]Help\[dq]: \[dq]No\[dq] } ], \[dq]Required\[dq]: false, \[dq]IsPassword\[dq]: false, \[dq]Type\[dq]: \[dq]bool\[dq], \[dq]Exclusive\[dq]: true, }, \[dq]Error\[dq]: \[dq]\[dq], } \f[R] .fi .PP The format of \f[C]Option\f[R] is the same as returned by \f[C]rclone config providers\f[R]. The question should be asked to the user and returned to rclone as the \f[C]--result\f[R] option along with the \f[C]--state\f[R] parameter. .PP The keys of \f[C]Option\f[R] are used as follows: .IP \[bu] 2 \f[C]Name\f[R] - name of variable - show to user .IP \[bu] 2 \f[C]Help\f[R] - help text. Hard wrapped at 80 chars. Any URLs should be clicky. .IP \[bu] 2 \f[C]Default\f[R] - default value - return this if the user just wants the default. .IP \[bu] 2 \f[C]Examples\f[R] - the user should be able to choose one of these .IP \[bu] 2 \f[C]Required\f[R] - the value should be non-empty .IP \[bu] 2 \f[C]IsPassword\f[R] - the value is a password and should be edited as such .IP \[bu] 2 \f[C]Type\f[R] - type of value, eg \f[C]bool\f[R], \f[C]string\f[R], \f[C]int\f[R] and others .IP \[bu] 2 \f[C]Exclusive\f[R] - if set no free-form entry allowed only the \f[C]Examples\f[R] .IP \[bu] 2 Irrelevant keys \f[C]Provider\f[R], \f[C]ShortOpt\f[R], \f[C]Hide\f[R], \f[C]NoPrefix\f[R], \f[C]Advanced\f[R] .PP If \f[C]Error\f[R] is set then it should be shown to the user at the same time as the question. .IP .nf \f[C] rclone config update name --continue --state \[dq]*oauth-islocal,teamdrive,,\[dq] --result \[dq]true\[dq] \f[R] .fi .PP Note that when using \f[C]--continue\f[R] all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of \f[C]--continue\f[R]. .PP At the end of the non interactive process, rclone will return a result with \f[C]State\f[R] as empty string. .PP If \f[C]--all\f[R] 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. .PP Note that \f[C]bin/config.py\f[R] in the rclone source implements this protocol as a readable demonstration. .IP .nf \f[C] rclone config create name type [key value]* [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 --non-interactive Don\[aq]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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config delete .PP Delete an existing remote. .IP .nf \f[C] rclone config delete name [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for delete \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config disconnect .PP Disconnects user from remote .SS Synopsis .PP This disconnects the remote: passed in to the cloud storage system. .PP This normally means revoking the oauth token. .PP To reconnect use \[dq]rclone config reconnect\[dq]. .IP .nf \f[C] rclone config disconnect remote: [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for disconnect \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config dump .PP Dump the config file as JSON. .IP .nf \f[C] rclone config dump [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for dump \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config edit .PP Enter an interactive configuration session. .SS Synopsis .PP 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. .IP .nf \f[C] rclone config edit [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for edit \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config encryption .PP set, remove and check the encryption for the config file .SS Synopsis .PP This command sets, clears and checks the encryption for the config file using the subcommands below. .SS Options .IP .nf \f[C] -h, --help help for encryption \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .IP \[bu] 2 rclone config encryption check (https://rclone.org/commands/rclone_config_encryption_check/) - Check that the config file is encrypted .IP \[bu] 2 rclone config encryption remove (https://rclone.org/commands/rclone_config_encryption_remove/) - Remove the config file encryption password .IP \[bu] 2 rclone config encryption set (https://rclone.org/commands/rclone_config_encryption_set/) - Set or change the config file encryption password .SH rclone config encryption check .PP Check that the config file is encrypted .SS Synopsis .PP This checks the config file is encrypted and that you can decrypt it. .PP It will attempt to decrypt the config using the password you supply. .PP If decryption fails it will return a non-zero exit code if using \f[C]--password-command\f[R], otherwise it will prompt again for the password. .PP If the config file is not encrypted it will return a non zero exit code. .IP .nf \f[C] rclone config encryption check [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for check \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config encryption (https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file .SH rclone config encryption remove .PP Remove the config file encryption password .SS Synopsis .PP Remove the config file encryption password .PP This removes the config file encryption, returning it to un-encrypted. .PP If \f[C]--password-command\f[R] is in use, this will be called to supply the old config password. .PP If the config was not encrypted then no error will be returned and this command will do nothing. .IP .nf \f[C] rclone config encryption remove [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for remove \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config encryption (https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file .SH rclone config encryption set .PP Set or change the config file encryption password .SS Synopsis .PP This command sets or changes the config file encryption password. .PP If there was no config password set then it sets a new one, otherwise it changes the existing config password. .PP Note that if you are changing an encryption password using \f[C]--password-command\f[R] 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. .PP When \f[C]--password-command\f[R] is called to change the password then the environment variable \f[C]RCLONE_PASSWORD_CHANGE=1\f[R] will be set. So if changing passwords programmatically you can use the environment variable to distinguish which password you must supply. .PP Alternatively you can remove the password first (with \f[C]rclone config encryption remove\f[R]), then set it again with this command which may be easier if you don\[aq]t mind the unencrypted config file being on the disk briefly. .IP .nf \f[C] rclone config encryption set [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for set \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config encryption (https://rclone.org/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file .SH rclone config file .PP Show path of configuration file in use. .IP .nf \f[C] rclone config file [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for file \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config password .PP Update password in an existing remote. .SS Synopsis .PP Update an existing remote\[aq]s password. The password should be passed in pairs of \f[C]key\f[R] \f[C]password\f[R] or as \f[C]key=password\f[R]. The \f[C]password\f[R] should be passed in in clear (unobscured). .PP For example, to set password of a remote of name myremote you would do: .IP .nf \f[C] rclone config password myremote fieldname mypassword rclone config password myremote fieldname=mypassword \f[R] .fi .PP This command is obsolete now that \[dq]config update\[dq] and \[dq]config create\[dq] both support obscuring passwords directly. .IP .nf \f[C] rclone config password name [key value]+ [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for password \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config paths .PP Show paths used for configuration, cache, temp etc. .IP .nf \f[C] rclone config paths [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for paths \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config providers .PP List in JSON format all the providers and options. .IP .nf \f[C] rclone config providers [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for providers \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config reconnect .PP Re-authenticates user with remote. .SS Synopsis .PP This reconnects remote: passed in to the cloud storage system. .PP To disconnect the remote use \[dq]rclone config disconnect\[dq]. .PP This normally means going through the interactive oauth flow again. .IP .nf \f[C] rclone config reconnect remote: [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for reconnect \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config redacted .PP Print redacted (decrypted) config file, or the redacted config for a single remote. .SS Synopsis .PP This prints a redacted copy of the config file, either the whole config file or for a given remote. .PP The config file will be redacted by replacing all passwords and other sensitive info with XXX. .PP This makes the config file suitable for posting online for support. .PP It should be double checked before posting as the redaction may not be perfect. .IP .nf \f[C] rclone config redacted [<remote>] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for redacted \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config show .PP Print (decrypted) config file, or the config for a single remote. .IP .nf \f[C] rclone config show [<remote>] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for show \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config touch .PP Ensure configuration file exists. .IP .nf \f[C] rclone config touch [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for touch \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config update .PP Update options in an existing remote. .SS Synopsis .PP Update an existing remote\[aq]s options. The options should be passed in pairs of \f[C]key\f[R] \f[C]value\f[R] or as \f[C]key=value\f[R]. .PP For example, to update the env_auth field of a remote of name myremote you would do: .IP .nf \f[C] rclone config update myremote env_auth true rclone config update myremote env_auth=true \f[R] .fi .PP If the remote uses OAuth the token will be updated, if you don\[aq]t require this add an extra parameter thus: .IP .nf \f[C] rclone config update myremote env_auth=true config_refresh_token=false \f[R] .fi .PP Note that if the config process would normally ask a question the default is taken (unless \f[C]--non-interactive\f[R] is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken. .PP If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren\[aq]t already obscured before putting them in the config file. .PP \f[B]NB\f[R] 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 \f[C]--obscure\f[R] flag, or if you are 100% certain you are already passing obscured passwords then use \f[C]--no-obscure\f[R]. You can also set obscured passwords using the \f[C]rclone config password\f[R] command. .PP The flag \f[C]--non-interactive\f[R] is for use by applications that wish to configure rclone themselves, rather than using rclone\[aq]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. .PP This will look something like (some irrelevant detail removed): .IP .nf \f[C] { \[dq]State\[dq]: \[dq]*oauth-islocal,teamdrive,,\[dq], \[dq]Option\[dq]: { \[dq]Name\[dq]: \[dq]config_is_local\[dq], \[dq]Help\[dq]: \[dq]Use web browser to automatically authenticate rclone with remote?\[rs]n * Say Y if the machine running rclone has a web browser you can use\[rs]n * Say N if running rclone on a (remote) machine without web browser access\[rs]nIf not sure try Y. If Y failed, try N.\[rs]n\[dq], \[dq]Default\[dq]: true, \[dq]Examples\[dq]: [ { \[dq]Value\[dq]: \[dq]true\[dq], \[dq]Help\[dq]: \[dq]Yes\[dq] }, { \[dq]Value\[dq]: \[dq]false\[dq], \[dq]Help\[dq]: \[dq]No\[dq] } ], \[dq]Required\[dq]: false, \[dq]IsPassword\[dq]: false, \[dq]Type\[dq]: \[dq]bool\[dq], \[dq]Exclusive\[dq]: true, }, \[dq]Error\[dq]: \[dq]\[dq], } \f[R] .fi .PP The format of \f[C]Option\f[R] is the same as returned by \f[C]rclone config providers\f[R]. The question should be asked to the user and returned to rclone as the \f[C]--result\f[R] option along with the \f[C]--state\f[R] parameter. .PP The keys of \f[C]Option\f[R] are used as follows: .IP \[bu] 2 \f[C]Name\f[R] - name of variable - show to user .IP \[bu] 2 \f[C]Help\f[R] - help text. Hard wrapped at 80 chars. Any URLs should be clicky. .IP \[bu] 2 \f[C]Default\f[R] - default value - return this if the user just wants the default. .IP \[bu] 2 \f[C]Examples\f[R] - the user should be able to choose one of these .IP \[bu] 2 \f[C]Required\f[R] - the value should be non-empty .IP \[bu] 2 \f[C]IsPassword\f[R] - the value is a password and should be edited as such .IP \[bu] 2 \f[C]Type\f[R] - type of value, eg \f[C]bool\f[R], \f[C]string\f[R], \f[C]int\f[R] and others .IP \[bu] 2 \f[C]Exclusive\f[R] - if set no free-form entry allowed only the \f[C]Examples\f[R] .IP \[bu] 2 Irrelevant keys \f[C]Provider\f[R], \f[C]ShortOpt\f[R], \f[C]Hide\f[R], \f[C]NoPrefix\f[R], \f[C]Advanced\f[R] .PP If \f[C]Error\f[R] is set then it should be shown to the user at the same time as the question. .IP .nf \f[C] rclone config update name --continue --state \[dq]*oauth-islocal,teamdrive,,\[dq] --result \[dq]true\[dq] \f[R] .fi .PP Note that when using \f[C]--continue\f[R] all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of \f[C]--continue\f[R]. .PP At the end of the non interactive process, rclone will return a result with \f[C]State\f[R] as empty string. .PP If \f[C]--all\f[R] 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. .PP Note that \f[C]bin/config.py\f[R] in the rclone source implements this protocol as a readable demonstration. .IP .nf \f[C] rclone config update name [key value]+ [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 --non-interactive Don\[aq]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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone config userinfo .PP Prints info about logged in user of remote. .SS Synopsis .PP This prints the details of the person logged in to the cloud storage system. .IP .nf \f[C] rclone config userinfo remote: [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for userinfo --json Format output as JSON \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone config (https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. .SH rclone copyto .PP Copy files from source to dest, skipping identical files. .SS Synopsis .PP If source:path is a file or directory then it copies it to a file or directory named dest:path. .PP This can be used to upload single files to other than their current name. If the source is a directory then it acts exactly like the copy (https://rclone.org/commands/rclone_copy/) command. .PP So .IP .nf \f[C] rclone copyto src dst \f[R] .fi .PP where src and dst are rclone paths, either remote:path or /path/to/local or C:. .PP This will: .IP .nf \f[C] 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 \f[R] .fi .PP This doesn\[aq]t transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. It doesn\[aq]t delete files from the destination. .PP \f[I]If you are looking to copy just a byte range of a file, please see \[aq]rclone cat --offset X --count Y\[aq]\f[R] .PP \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view real-time transfer statistics .IP .nf \f[C] rclone copyto source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for copyto \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone copyurl .PP Copy the contents of the URL supplied content to dest:path. .SS Synopsis .PP Download a URL\[aq]s content and copy it to the destination without saving it in temporary storage. .PP Setting \f[C]--auto-filename\f[R] will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path. .PP With \f[C]--header-filename\f[R] in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. With \f[C]--print-filename\f[R] in addition, the resulting file name will be printed. .PP Setting \f[C]--no-clobber\f[R] will prevent overwriting file on the destination if there is one with the same name. .PP Setting \f[C]--stdout\f[R] or making the output file name \f[C]-\f[R] will cause the output to be written to standard output. .SS Troubleshooting .PP If you can\[aq]t get \f[C]rclone copyurl\f[R] to work then here are some things you can try: .IP \[bu] 2 \f[C]--disable-http2\f[R] rclone will use HTTP2 if available - try disabling it .IP \[bu] 2 \f[C]--bind 0.0.0.0\f[R] rclone will use IPv6 if available - try disabling it .IP \[bu] 2 \f[C]--bind ::0\f[R] to disable IPv4 .IP \[bu] 2 \f[C]--user agent curl\f[R] - some sites have whitelists for curl\[aq]s user-agent - try that .IP \[bu] 2 Make sure the site works with \f[C]curl\f[R] directly .IP .nf \f[C] rclone copyurl https://example.com dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone cryptcheck .PP Cryptcheck checks the integrity of an encrypted remote. .SS Synopsis .PP Checks a remote against a crypted (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. .PP For it to work the underlying remote of the cryptedremote must support some kind of checksum. .PP 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. .PP Use it like this .IP .nf \f[C] rclone cryptcheck /path/to/files encryptedremote:path \f[R] .fi .PP You can use it like this also, but that will involve downloading all the files in remote:path. .IP .nf \f[C] rclone cryptcheck remote:path encryptedremote:path \f[R] .fi .PP After it has run it will log the status of the encryptedremote:. .PP If you supply the \f[C]--one-way\f[R] 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. .PP The \f[C]--differ\f[R], \f[C]--missing-on-dst\f[R], \f[C]--missing-on-src\f[R], \f[C]--match\f[R] and \f[C]--error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]-\f[R]) supplied. What they write is described in the help below. For example \f[C]--differ\f[R] will write all paths which are present on both the source and destination but different. .PP The \f[C]--combined\f[R] 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. .IP \[bu] 2 \f[C]= path\f[R] means path was found in source and destination and was identical .IP \[bu] 2 \[ga]- path\[ga] means path was missing on the source, so only in the destination .IP \[bu] 2 \[ga]+ path\[ga] means path was missing on the destination, so only in the source .IP \[bu] 2 \[ga]* path\[ga] means path was present in source and destination but different. .IP \[bu] 2 \f[C]! path\f[R] means there was an error reading or hashing the source or dest. .PP The default number of parallel checks is 8. See the --checkers=N (https://rclone.org/docs/#checkers-n) option for more information. .IP .nf \f[C] rclone cryptcheck remote:path cryptedremote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Check Options .PP Flags used for check commands .IP .nf \f[C] --max-backlog int Maximum number of objects in sync or check backlog (default 10000) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone cryptdecode .PP Cryptdecode returns unencrypted file names. .SS Synopsis .PP Returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items. .PP If you supply the \f[C]--reverse\f[R] flag, it will return encrypted file names. .PP use it like this .IP .nf \f[C] rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 rclone cryptdecode --reverse encryptedremote: filename1 filename2 \f[R] .fi .PP Another way to accomplish this is by using the \f[C]rclone backend encode\f[R] (or \f[C]decode\f[R]) command. See the documentation on the crypt (https://rclone.org/crypt/) overlay for more info. .IP .nf \f[C] rclone cryptdecode encryptedremote: encryptedfilename [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for cryptdecode --reverse Reverse cryptdecode, encrypts filenames \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone deletefile .PP Remove a single file from remote. .SS Synopsis .PP Remove a single file from remote. Unlike \f[C]delete\f[R] it cannot be used to remove a directory and it doesn\[aq]t obey include/exclude filters - if the specified file exists, it will always be removed. .IP .nf \f[C] rclone deletefile remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for deletefile \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone gendocs .PP Output markdown docs for rclone to the directory supplied. .SS Synopsis .PP 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. .IP .nf \f[C] rclone gendocs output_directory [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for gendocs \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone gitannex .PP Speaks with git-annex over stdin/stdout. .SS Synopsis .PP Rclone\[aq]s \f[C]gitannex\f[R] subcommand enables git-annex (https://git-annex.branchable.com/) to store and retrieve content from an rclone remote. It is meant to be run by git-annex, not directly by users. .SS Installation on Linux .IP "1." 3 Skip this step if your version of git-annex is 10.20240430 (https://git-annex.branchable.com/news/version_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 \[dq]gitannex\[dq] subcommand. .RS 4 .IP .nf \f[C] # Create the helper symlink in \[dq]$HOME/bin\[dq]. ln -s \[dq]$(realpath rclone)\[dq] \[dq]$HOME/bin/git-annex-remote-rclone-builtin\[dq] # Verify the new symlink is on your PATH. which git-annex-remote-rclone-builtin \f[R] .fi .RE .IP "2." 3 Add a new remote to your git-annex repo. This new remote will connect git-annex with the \f[C]rclone gitannex\f[R] subcommand. .RS 4 .PP Start by asking git-annex to describe the remote\[aq]s available configuration parameters. .IP .nf \f[C] # If you skipped step 1: git annex initremote MyRemote type=rclone --whatelse # If you created a symlink in step 1: git annex initremote MyRemote type=external externaltype=rclone-builtin --whatelse \f[R] .fi .RS .PP \f[B]NOTE\f[R]: If you\[aq]re porting an existing git-annex-remote-rclone (https://github.com/git-annex-remote-rclone/git-annex-remote-rclone) remote to use \f[C]rclone gitannex\f[R], you can probably reuse the configuration parameters verbatim without renaming them. Check parameter synonyms with \f[C]--whatelse\f[R] as shown above. .RE .PP The following example creates a new git-annex remote named \[dq]MyRemote\[dq] that will use the rclone remote named \[dq]SomeRcloneRemote\[dq]. That rclone remote must be one configured in your rclone.conf file, which can be located with \f[C]rclone config file\f[R]. .IP .nf \f[C] git annex initremote MyRemote \[rs] type=external \[rs] externaltype=rclone-builtin \[rs] encryption=none \[rs] rcloneremotename=SomeRcloneRemote \[rs] rcloneprefix=git-annex-content \[rs] rclonelayout=nodir \f[R] .fi .RE .IP "3." 3 Before you trust this command with your precious data, be sure to \f[B]test the remote\f[R]. This command is very new and has not been tested on many rclone backends. Caveat emptor! .RS 4 .IP .nf \f[C] git annex testremote MyRemote \f[R] .fi .RE .PP Happy annexing! .IP .nf \f[C] rclone gitannex [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for gitannex \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone hashsum .PP Produces a hashsum file for all the objects in the path. .SS Synopsis .PP 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. .PP 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. .PP 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/). .PP 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). .PP Run without a hash to see the list of all supported hashes, e.g. .IP .nf \f[C] $ rclone hashsum Supported hashes are: * md5 * sha1 * whirlpool * crc32 * sha256 \f[R] .fi .PP Then .IP .nf \f[C] $ rclone hashsum MD5 remote:path \f[R] .fi .PP Note that hash names are case insensitive and values are output in lower case. .IP .nf \f[C] rclone hashsum [<hash> remote:path] [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone link .PP Generate public link to file/folder. .SS Synopsis .PP Create, retrieve or remove a public link to the given file or folder. .IP .nf \f[C] 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 \f[R] .fi .PP If you supply the --expire flag, it will set the expiration time otherwise it will use the default (100 years). \f[B]Note\f[R] not all backends support the --expire flag - if the backend doesn\[aq]t support it then the link returned won\[aq]t expire. .PP Use the --unlink flag to remove existing public links to the file or folder. \f[B]Note\f[R] not all backends support \[dq]--unlink\[dq] flag - those that don\[aq]t will just ignore it. .PP 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 \[en] e.g. no expiry, no password protection, accessible without account. .IP .nf \f[C] rclone link remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone listremotes .PP List all the remotes in the config file and defined in environment variables. .SS Synopsis .PP Lists all the available remotes from the config file, or the remotes matching an optional filter. .PP Prints the result in human-readable format by default, and as a simple list of remote names, or if used with flag \f[C]--long\f[R] a tabular format including the remote names, types and descriptions. Using flag \f[C]--json\f[R] produces machine-readable output instead, which always includes all attributes - including the source (file or environment). .PP 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. .IP .nf \f[C] rclone listremotes [<filter>] [flags] \f[R] .fi .SS Options .IP .nf \f[C] --description string Filter remotes by description -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. \[aq]type,name=descending\[aq] --source string Filter remotes by source, e.g. \[aq]file\[aq] or \[aq]environment\[aq] --type string Filter remotes by type \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone lsf .PP List directories and objects in remote:path formatted for parsing. .SS Synopsis .PP 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. .PP Eg .IP .nf \f[C] $ rclone lsf swift:bucket bevajer5jef canole diwogej7 ferejej3gux/ fubuwic \f[R] .fi .PP Use the \f[C]--format\f[R] option to control what gets listed. By default this is just the path, but you can use these parameters to control the output: .IP .nf \f[C] 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. \[dq]Hot\[dq] or \[dq]Cool\[dq] M - Metadata of object in JSON blob format, eg {\[dq]key\[dq]:\[dq]value\[dq]} \f[R] .fi .PP So if you wanted the path, size and modification time, you would use \f[C]--format \[dq]pst\[dq]\f[R], or maybe \f[C]--format \[dq]tsp\[dq]\f[R] to put the path last. .PP Eg .IP .nf \f[C] $ rclone lsf --format \[dq]tsp\[dq] 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 \f[R] .fi .PP If you specify \[dq]h\[dq] in the format you will get the MD5 hash by default, use the \f[C]--hash\f[R] flag to change which hash you want. Note that this can be returned as an empty string if it isn\[aq]t available on the object (and for directories), \[dq]ERROR\[dq] if there was an error reading it from the object and \[dq]UNSUPPORTED\[dq] if that object does not support that hash type. .PP For example, to emulate the md5sum command you can use .IP .nf \f[C] rclone lsf -R --hash MD5 --format hp --separator \[dq] \[dq] --files-only . \f[R] .fi .PP Eg .IP .nf \f[C] $ rclone lsf -R --hash MD5 --format hp --separator \[dq] \[dq] --files-only swift:bucket 7908e352297f0f530b84a756f188baa3 bevajer5jef cd65ac234e6fea5925974a51cdd865cc canole 03b5341b4f234b9d984d03ad076bae91 diwogej7 8fd37c3810dd660778137ac3a66cc06d fubuwic 99713e14a4c4ff553acaf1930fad985b gixacuh7ku \f[R] .fi .PP (Though \[dq]rclone md5sum .\[dq] is an easier way of typing this.) .PP By default the separator is \[dq];\[dq] this can be changed with the \f[C]--separator\f[R] flag. Note that separators aren\[aq]t escaped in the path so putting it last is a good strategy. .PP Eg .IP .nf \f[C] $ rclone lsf --separator \[dq],\[dq] --format \[dq]tshp\[dq] 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 \f[R] .fi .PP You can output in CSV standard format. This will escape things in \[dq] if they contain , .PP Eg .IP .nf \f[C] $ rclone lsf --csv --files-only --format ps remote:path test.log,22355 test.sh,449 \[dq]this file contains a comma, in the file name.txt\[dq],6 \f[R] .fi .PP Note that the \f[C]--absolute\f[R] parameter is useful for making lists of files to pass to an rclone copy with the \f[C]--files-from-raw\f[R] flag. .PP For example, to find all the files modified within one day and copy those only (without traversing the whole directory structure): .IP .nf \f[C] 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 \f[R] .fi .PP The default time format is \f[C]\[aq]2006-01-02 15:04:05\[aq]\f[R]. Other formats (https://pkg.go.dev/time#pkg-constants) can be specified with the \f[C]--time-format\f[R] flag. Examples: .IP .nf \f[C] rclone lsf remote:path --format pt --time-format \[aq]Jan 2, 2006 at 3:04pm (MST)\[aq] rclone lsf remote:path --format pt --time-format \[aq]2006-01-02 15:04:05.000000000\[aq] rclone lsf remote:path --format pt --time-format \[aq]2006-01-02T15:04:05.999999999Z07:00\[aq] 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 \f[R] .fi .PP \f[C]--time-format max\f[R] will automatically truncate \[aq]\f[C]2006-01-02 15:04:05.000000000\f[R]\[aq] to the maximum precision supported by the remote. .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 \f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 \f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 \f[C]lsd\f[R] to list directories only .IP \[bu] 2 \f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 \f[C]lsjson\f[R] to list objects and directories in JSON format .PP \f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human-readable. \f[C]lsf\f[R] is designed to be human and machine-readable. \f[C]lsjson\f[R] is designed to be machine-readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default - use \f[C]--max-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do not recurse by default - use \f[C]-R\f[R] to make them recurse. .PP Listing a nonexistent directory will produce an error except for remotes which can\[aq]t have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). .IP .nf \f[C] rclone lsf remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \[dq]p\[dq]) --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default \[dq]md5\[dq]) -h, --help help for lsf -R, --recursive Recurse into the listing -s, --separator string Separator for the items in the format (default \[dq];\[dq]) -t, --time-format string Specify a custom time format, or \[aq]max\[aq] for max precision supported by remote (default: 2006-01-02 15:04:05) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone lsjson .PP List directories and objects in the path in JSON format. .SS Synopsis .PP List directories and objects in the path in JSON format. .PP The output is an array of Items, where each Item looks like this: .IP .nf \f[C] { \[dq]Hashes\[dq] : { \[dq]SHA-1\[dq] : \[dq]f572d396fae9206628714fb2ce00f72e94f2258f\[dq], \[dq]MD5\[dq] : \[dq]b1946ac92492d2347c6235b4d2611184\[dq], \[dq]DropboxHash\[dq] : \[dq]ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc\[dq] }, \[dq]ID\[dq]: \[dq]y2djkhiujf83u33\[dq], \[dq]OrigID\[dq]: \[dq]UYOJVTUW00Q1RzTDA\[dq], \[dq]IsBucket\[dq] : false, \[dq]IsDir\[dq] : false, \[dq]MimeType\[dq] : \[dq]application/octet-stream\[dq], \[dq]ModTime\[dq] : \[dq]2017-05-31T16:15:57.034468261+01:00\[dq], \[dq]Name\[dq] : \[dq]file.txt\[dq], \[dq]Encrypted\[dq] : \[dq]v0qpsdq8anpci8n929v3uu9338\[dq], \[dq]EncryptedPath\[dq] : \[dq]kja9098349023498/v0qpsdq8anpci8n929v3uu9338\[dq], \[dq]Path\[dq] : \[dq]full/path/goes/here/file.txt\[dq], \[dq]Size\[dq] : 6, \[dq]Tier\[dq] : \[dq]hot\[dq], } \f[R] .fi .PP The exact set of properties included depends on the backend: .IP \[bu] 2 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. .IP \[bu] 2 Properties Encrypted and EncryptedPath will only be included for encrypted remotes, and (as mentioned below) only if the \f[C]--encrypted\f[R] option is set. .PP Different options may also affect which properties are included: .IP \[bu] 2 If \f[C]--hash\f[R] is not specified, the Hashes property will be omitted. The types of hash can be specified with the \f[C]--hash-type\f[R] parameter (which may be repeated). If \f[C]--hash-type\f[R] is set then it implies \f[C]--hash\f[R]. .IP \[bu] 2 If \f[C]--no-modtime\f[R] 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). .IP \[bu] 2 If \f[C]--no-mimetype\f[R] 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). .IP \[bu] 2 If \f[C]--encrypted\f[R] is not specified the Encrypted and EncryptedPath properties will be omitted - even for encrypted remotes. .IP \[bu] 2 If \f[C]--metadata\f[R] 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. .PP The default is to list directories and files/objects, but this can be changed with the following options: .IP \[bu] 2 If \f[C]--dirs-only\f[R] is specified then directories will be returned only, no files/objects. .IP \[bu] 2 If \f[C]--files-only\f[R] is specified then files will be returned only, no directories. .PP If \f[C]--stat\f[R] is set then the 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\[aq]t found, however on bucket based backends (like s3, gcs, b2, azureblob etc) if the item isn\[aq]t found it will return an empty directory, as it isn\[aq]t possible to tell empty directories from missing directories there. .PP The Path field will only show folders below the remote path being listed. If \[dq]remote:path\[dq] contains the file \[dq]subfolder/file.txt\[dq], the Path for \[dq]file.txt\[dq] will be \[dq]subfolder/file.txt\[dq], not \[dq]remote:path/subfolder/file.txt\[dq]. When used without \f[C]--recursive\f[R] the Path will always be the same as Name. .PP 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 (\[dq]2017-05-31T16:15:57.034+01:00\[dq]) whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown (\[dq]2017-05-31T16:15:57+01:00\[dq]). .PP 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 \f[C]--stat\f[R]). .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 \f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 \f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 \f[C]lsd\f[R] to list directories only .IP \[bu] 2 \f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 \f[C]lsjson\f[R] to list objects and directories in JSON format .PP \f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human-readable. \f[C]lsf\f[R] is designed to be human and machine-readable. \f[C]lsjson\f[R] is designed to be machine-readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default - use \f[C]--max-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do not recurse by default - use \f[C]-R\f[R] to make them recurse. .PP Listing a nonexistent directory will produce an error except for remotes which can\[aq]t have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes). .IP .nf \f[C] rclone lsjson remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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\[aq]t read the mime type (can speed things up) --no-modtime Don\[aq]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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone mount .PP Mount the remote as file system on a mountpoint. .SS Synopsis .PP Rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. .PP First set up your remote using \f[C]rclone config\f[R]. Check it works with \f[C]rclone ls\f[R] etc. .PP 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 \f[C]--daemon\f[R] flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored. .PP 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). .PP On Linux/macOS/FreeBSD start the mount like this, where \f[C]/path/to/local/mount\f[R] is an \f[B]empty\f[R] \f[B]existing\f[R] directory: .IP .nf \f[C] rclone mount remote:path/to/files /path/to/local/mount \f[R] .fi .PP On Windows you can start a mount in different ways. See below 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. .PP The following examples will mount to an automatically assigned drive, to specific drive letter \f[C]X:\f[R], to path \f[C]C:\[rs]path\[rs]parent\[rs]mount\f[R] (where parent directory or drive must exist, and mount must \f[B]not\f[R] exist, and is not supported when mounting as a network drive), and the last example will mount as network share \f[C]\[rs]\[rs]cloud\[rs]remote\f[R] and map it to an automatically assigned drive: .IP .nf \f[C] rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\[rs]path\[rs]parent\[rs]mount rclone mount remote:path/to/files \[rs]\[rs]cloud\[rs]remote \f[R] .fi .PP 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. .PP When running in background mode the user will have to stop the mount manually: .IP .nf \f[C] # 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 \f[R] .fi .PP The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user\[aq]s responsibility to stop the mount manually. .PP 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. .SS Installing on Windows .PP To run rclone mount on Windows, you will need to download and install WinFsp (http://www.secfs.net/winfsp/). .PP 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. .SS Mounting modes on windows .PP 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. .PP 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. .PP When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a \f[B]nonexistent\f[R] subdirectory of an \f[B]existing\f[R] parent directory or drive. Using the special value \f[C]*\f[R] will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples: .IP .nf \f[C] rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\[rs]path\[rs]parent\[rs]mount rclone mount remote:path/to/files X: \f[R] .fi .PP Option \f[C]--volname\f[R] can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path. .PP To mount as network drive, you can add option \f[C]--network-mode\f[R] 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. .IP .nf \f[C] rclone mount remote:path/to/files X: --network-mode \f[R] .fi .PP A volume name specified with \f[C]--volname\f[R] will be used to create the network share path. A complete UNC path, such as \f[C]\[rs]\[rs]cloud\[rs]remote\f[R], optionally with path \f[C]\[rs]\[rs]cloud\[rs]remote\[rs]madeup\[rs]path\f[R], will be used as is. Any other string will be used as the share part, after a default prefix \f[C]\[rs]\[rs]server\[rs]\f[R]. If no volume name is specified then \f[C]\[rs]\[rs]server\[rs]share\f[R] 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 \f[C]\[rs]\[rs]server\[rs]share\f[R] will be reported as the remote UNC path by \f[C]net use\f[R] etc, just like a normal network drive mapping. .PP If you specify a full network share UNC path with \f[C]--volname\f[R], this will implicitly set the \f[C]--network-mode\f[R] option, so the following two examples have same result: .IP .nf \f[C] rclone mount remote:path/to/files X: --network-mode rclone mount remote:path/to/files X: --volname \[rs]\[rs]server\[rs]share \f[R] .fi .PP You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with \f[C]*\f[R] and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the \f[C]--volname\f[R] option. This will also implicitly set the \f[C]--network-mode\f[R] option. This means the following two examples have same result: .IP .nf \f[C] rclone mount remote:path/to/files \[rs]\[rs]cloud\[rs]remote rclone mount remote:path/to/files * --volname \[rs]\[rs]cloud\[rs]remote \f[R] .fi .PP There is yet another way to enable network mode, and to set the share path, and that is to pass the \[dq]native\[dq] libfuse/WinFsp option directly: \f[C]--fuse-flag --VolumePrefix=\[rs]server\[rs]share\f[R]. Note that the path must be with just a single backslash prefix in this case. .PP \f[I]Note:\f[R] In previous versions of rclone this was the only supported method. .PP Read more about drive mapping (https://en.wikipedia.org/wiki/Drive_mapping) .PP See also Limitations section below. .SS Windows filesystem permissions .PP 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). .PP 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 \[dq]Everyone\[dq] will be used to represent others. The user/group can be customized with FUSE options \[dq]UserName\[dq] and \[dq]GroupName\[dq], e.g. \f[C]-o UserName=user123 -o GroupName=\[dq]Authenticated Users\[dq]\f[R]. The permissions on each entry will be set according to options \f[C]--dir-perms\f[R] and \f[C]--file-perms\f[R], which takes a value in traditional Unix numeric notation (https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation). .PP The default permissions corresponds to \f[C]--file-perms 0666 --dir-perms 0777\f[R], 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. \f[C]--file-perms 0777 --dir-perms 0777\f[R] to add it to everyone. If the program needs to write files, chances are you will have to enable VFS File Caching as well (see also limitations). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the \[dq]write extended attributes\[dq], as explained next. .PP 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 \[dq]write attributes\[dq], \[dq]write data\[dq] and \[dq]append data\[dq], but not \[dq]write extended attributes\[dq]. Windows will then show this as basic permission \[dq]Special\[dq] instead of \[dq]Write\[dq], because \[dq]Write\[dq] also covers the \[dq]write extended attributes\[dq] permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions \[dq]read attributes\[dq], \[dq]read extended attributes\[dq] and \[dq]read permissions\[dq]. 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. .PP WinFsp 2021 (version 1.9) introduced a new FUSE option \[dq]FileSecurity\[dq], 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. .PP If you set POSIX permissions for only allowing access to the owner, using \f[C]--file-perms 0600 --dir-perms 0700\f[R], the user group and the built-in \[dq]Everyone\[dq] 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 \[dq]unprotected private key file\[dq]. You can work around this by specifying \f[C]-o FileSecurity=\[dq]D:P(A;;FA;;;OW)\[dq]\f[R], which sets file all access (FA) to the owner (OW), and nothing else. .PP When setting write permissions then, except for the owner, this does not include the \[dq]write extended attributes\[dq] 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 \[dq]Everyone\[dq] group, similar to what it gets by default but with the addition of the \[dq]write extended attributes\[dq], you can specify \f[C]-o FileSecurity=\[dq]D:P(A;;FRFW;;;WD)\[dq]\f[R], which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to \f[C]-o FileSecurity=\[dq]D:P(A;;FRFWFX;;;WD)\[dq]\f[R], or set file all access (FA) to get full access permissions, including delete, with \f[C]-o FileSecurity=\[dq]D:P(A;;FA;;;WD)\[dq]\f[R]. .SS Windows caveats .PP 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. .PP If you don\[aq]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. .PP 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. .PP 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\[aq]s Sysinternals suite, which has option \f[C]-s\f[R] 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 \f[C]--config\f[R] (https://rclone.org/docs/#config-config-file) 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 \[dq]write extended attributes\[dq] permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above. .PP Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations. .SS Mounting on macOS .PP 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 \[dq]mounts\[dq] via an NFSv4 local server. .SS Unicode Normalization .PP It is highly recommended to keep the default of \f[C]--no-unicode-normalization=false\f[R] for all \f[C]mount\f[R] and \f[C]serve\f[R] commands on macOS. For details, see vfs-case-sensitivity (https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity). .SS NFS mount .PP 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. .PP Note that \f[C]--nfs-cache-handle-limit\f[R] controls the maximum number of cached file handles stored by the \f[C]nfsmount\f[R] 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\[aq]s system resource usage causes problems. .SS macFUSE Notes .PP 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. .IP .nf \f[C] sudo mkdir /usr/local/lib cd /usr/local/lib sudo ln -s /opt/local/lib/libfuse.2.dylib \f[R] .fi .SS FUSE-T Limitations, Caveats, and Notes .PP There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14. .SS ModTime update on read .PP As per the FUSE-T wiki (https://github.com/macos-fuse-t/fuse-t/wiki#caveats): .RS .PP 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 \[aq]touch -m\[aq] and \[aq]touch -a\[aq] commands .RE .PP 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. .SS Read Only mounts .PP When mounting with \f[C]--read-only\f[R], attempts to write to files will fail \f[I]silently\f[R] as opposed to with a clear warning as in macFUSE. .SS Limitations .PP Without the use of \f[C]--vfs-cache-mode\f[R] this can only write files sequentially, it can only seek when reading. This means that many applications won\[aq]t work with their files on an rclone mount without \f[C]--vfs-cache-mode writes\f[R] or \f[C]--vfs-cache-mode full\f[R]. See the VFS File Caching section for more info. When using NFS mount on macOS, if you don\[aq]t specify |--vfs-cache-mode| the mount point will be read-only. .PP The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache. .PP When \f[C]rclone mount\f[R] is invoked on Unix with \f[C]--daemon\f[R] flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the \f[C]--daemon-wait\f[R] flag. On Linux it can check mount status using ProcFS so the flag in fact sets \f[B]maximum\f[R] 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. .PP Only supported on Linux, FreeBSD, OS X and Windows at the moment. .SS rclone mount vs rclone sync/copy .PP 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\[aq]t use retries in the same way without making local copies of the uploads. Look at the VFS File Caching for solutions to make mount more reliable. .SS Attribute caching .PP You can use the flag \f[C]--attr-timeout\f[R] to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries. .PP The default is \f[C]1s\f[R] which caches files just long enough to avoid too many callbacks to rclone from the kernel. .PP 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). .PP The kernel can cache the info about a file for the time given by \f[C]--attr-timeout\f[R]. 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 \f[C]--attr-timeout 1s\f[R] this is very unlikely but not impossible. The higher you set \f[C]--attr-timeout\f[R] the more likely it is. The default setting of \[dq]1s\[dq] is the lowest setting which mitigates the problems above. .PP If you set it higher (\f[C]10s\f[R] or \f[C]1m\f[R] 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. .PP If files don\[aq]t change on the remote outside of the control of rclone then there is no chance of corruption. .PP This is the same as setting the attr_timeout option in mount.fuse. .SS Filters .PP Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. .SS systemd .PP 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. .PP Note that systemd runs mount units without any environment variables including \f[C]PATH\f[R] or \f[C]HOME\f[R]. This means that tilde (\f[C]\[ti]\f[R]) expansion will not work and you should provide \f[C]--config\f[R] and \f[C]--cache-dir\f[R] explicitly as absolute paths via rclone arguments. Since mounting requires the \f[C]fusermount\f[R] or \f[C]fusermount3\f[R] program, rclone will use the fallback PATH of \f[C]/bin:/usr/bin\f[R] in this scenario. Please ensure that \f[C]fusermount\f[R]/\f[C]fusermount3\f[R] is present on this PATH. .SS Rclone as Unix mount helper .PP The core Unix program \f[C]/bin/mount\f[R] normally takes the \f[C]-t FSTYPE\f[R] argument then runs the \f[C]/sbin/mount.FSTYPE\f[R] helper program passing it mount options as \f[C]-o key=val,...\f[R] or \f[C]--opt=...\f[R]. Automount (classic or systemd) behaves in a similar way. .PP rclone by default expects GNU-style flags \f[C]--key val\f[R]. To run it as a mount helper you should symlink rclone binary to \f[C]/sbin/mount.rclone\f[R] and optionally \f[C]/usr/bin/rclonefs\f[R], e.g. \f[C]ln -s /usr/bin/rclone /sbin/mount.rclone\f[R]. rclone will detect it and translate command-line arguments appropriately. .PP Now you can run classic mounts like this: .IP .nf \f[C] mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem \f[R] .fi .PP or create systemd mount units: .IP .nf \f[C] # /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 \f[R] .fi .PP optionally accompanied by systemd automount unit .IP .nf \f[C] # /etc/systemd/system/mnt-data.automount [Unit] Description=AutoMount for /mnt/data [Automount] Where=/mnt/data TimeoutIdleSec=600 [Install] WantedBy=multi-user.target \f[R] .fi .PP or add in \f[C]/etc/fstab\f[R] a line like .IP .nf \f[C] 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 \f[R] .fi .PP or use classic Automountd. Remember to provide explicit \f[C]config=...,cache-dir=...\f[R] as a workaround for mount units being run without \f[C]HOME\f[R]. .PP Rclone in the mount helper mode will split \f[C]-o\f[R] argument(s) by comma, replace \f[C]_\f[R] by \f[C]-\f[R] and prepend \f[C]--\f[R] 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. .PP Mount option syntax includes a few extra options treated specially: .IP \[bu] 2 \f[C]env.NAME=VALUE\f[R] will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don\[aq]t allow setting custom environment for mount helpers. Typically you will use \f[C]env.HTTPS_PROXY=proxy.host:3128\f[R] or \f[C]env.HOME=/root\f[R] .IP \[bu] 2 \f[C]command=cmount\f[R] can be used to run \f[C]cmount\f[R] or any other rclone command rather than the default \f[C]mount\f[R]. .IP \[bu] 2 \f[C]args2env\f[R] 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 \f[C]ps\f[R] or \f[C]pgrep\f[R]. .IP \[bu] 2 \f[C]vv...\f[R] will be transformed into appropriate \f[C]--verbose=N\f[R] .IP \[bu] 2 standard mount options like \f[C]x-systemd.automount\f[R], \f[C]_netdev\f[R], \f[C]nosuid\f[R] and alike are intended only for Automountd and ignored by rclone. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone mount remote:path /path/to/mountpoint [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]t allow seeking in files --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) --noapplexattr Ignore all \[dq]com.apple.*\[dq] 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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone moveto .PP Move file or directory from source to dest. .SS Synopsis .PP If source:path is a file or directory then it moves it to a file or directory named dest:path. .PP 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. .PP So .IP .nf \f[C] rclone moveto src dst \f[R] .fi .PP where src and dst are rclone paths, either remote:path or /path/to/local or C:. .PP This will: .IP .nf \f[C] 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 \f[R] .fi .PP This doesn\[aq]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. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .PP \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view real-time transfer statistics. .IP .nf \f[C] rclone moveto source:path dest:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for moveto \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Copy Options .PP Flags for anything which can copy a file .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone ncdu .PP Explore a remote with a text based user interface. .SS Synopsis .PP This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - \[dq]What is using all my disk space?\[dq]. .PP 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. .PP You can interact with the user interface using key presses, press \[aq]?\[aq] to toggle the help on and off. The supported keys are: .IP .nf \f[C] \[ua],\[da] 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 \[ha]L refresh screen (fix screen corruption) r recalculate file sizes ? to toggle help on and off ESC to close the menu box q/\[ha]c to quit \f[R] .fi .PP 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: .IP .nf \f[C] e means this is an empty directory, i.e. contains no files (but may contain empty subdirectories) \[ti] 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 \f[R] .fi .PP 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. .PP Note that it might take some time to delete big files/directories. The UI won\[aq]t respond in the meantime since the deletion is done synchronously. .PP 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. .IP .nf \f[C] rclone ncdu remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for ncdu \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone nfsmount .PP Mount the remote as file system on a mountpoint. .SS Synopsis .PP Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. .PP First set up your remote using \f[C]rclone config\f[R]. Check it works with \f[C]rclone ls\f[R] etc. .PP 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 \f[C]--daemon\f[R] flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored. .PP 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). .PP On Linux/macOS/FreeBSD start the mount like this, where \f[C]/path/to/local/mount\f[R] is an \f[B]empty\f[R] \f[B]existing\f[R] directory: .IP .nf \f[C] rclone nfsmount remote:path/to/files /path/to/local/mount \f[R] .fi .PP On Windows you can start a mount in different ways. See below 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. .PP The following examples will mount to an automatically assigned drive, to specific drive letter \f[C]X:\f[R], to path \f[C]C:\[rs]path\[rs]parent\[rs]mount\f[R] (where parent directory or drive must exist, and mount must \f[B]not\f[R] exist, and is not supported when mounting as a network drive), and the last example will mount as network share \f[C]\[rs]\[rs]cloud\[rs]remote\f[R] and map it to an automatically assigned drive: .IP .nf \f[C] rclone nfsmount remote:path/to/files * rclone nfsmount remote:path/to/files X: rclone nfsmount remote:path/to/files C:\[rs]path\[rs]parent\[rs]mount rclone nfsmount remote:path/to/files \[rs]\[rs]cloud\[rs]remote \f[R] .fi .PP 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. .PP When running in background mode the user will have to stop the mount manually: .IP .nf \f[C] # 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 \f[R] .fi .PP The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user\[aq]s responsibility to stop the mount manually. .PP 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. .SS Installing on Windows .PP To run rclone nfsmount on Windows, you will need to download and install WinFsp (http://www.secfs.net/winfsp/). .PP 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. .SS Mounting modes on windows .PP 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. .PP 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. .PP When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a \f[B]nonexistent\f[R] subdirectory of an \f[B]existing\f[R] parent directory or drive. Using the special value \f[C]*\f[R] will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples: .IP .nf \f[C] rclone nfsmount remote:path/to/files * rclone nfsmount remote:path/to/files X: rclone nfsmount remote:path/to/files C:\[rs]path\[rs]parent\[rs]mount rclone nfsmount remote:path/to/files X: \f[R] .fi .PP Option \f[C]--volname\f[R] can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path. .PP To mount as network drive, you can add option \f[C]--network-mode\f[R] 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. .IP .nf \f[C] rclone nfsmount remote:path/to/files X: --network-mode \f[R] .fi .PP A volume name specified with \f[C]--volname\f[R] will be used to create the network share path. A complete UNC path, such as \f[C]\[rs]\[rs]cloud\[rs]remote\f[R], optionally with path \f[C]\[rs]\[rs]cloud\[rs]remote\[rs]madeup\[rs]path\f[R], will be used as is. Any other string will be used as the share part, after a default prefix \f[C]\[rs]\[rs]server\[rs]\f[R]. If no volume name is specified then \f[C]\[rs]\[rs]server\[rs]share\f[R] 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 \f[C]\[rs]\[rs]server\[rs]share\f[R] will be reported as the remote UNC path by \f[C]net use\f[R] etc, just like a normal network drive mapping. .PP If you specify a full network share UNC path with \f[C]--volname\f[R], this will implicitly set the \f[C]--network-mode\f[R] option, so the following two examples have same result: .IP .nf \f[C] rclone nfsmount remote:path/to/files X: --network-mode rclone nfsmount remote:path/to/files X: --volname \[rs]\[rs]server\[rs]share \f[R] .fi .PP You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with \f[C]*\f[R] and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the \f[C]--volname\f[R] option. This will also implicitly set the \f[C]--network-mode\f[R] option. This means the following two examples have same result: .IP .nf \f[C] rclone nfsmount remote:path/to/files \[rs]\[rs]cloud\[rs]remote rclone nfsmount remote:path/to/files * --volname \[rs]\[rs]cloud\[rs]remote \f[R] .fi .PP There is yet another way to enable network mode, and to set the share path, and that is to pass the \[dq]native\[dq] libfuse/WinFsp option directly: \f[C]--fuse-flag --VolumePrefix=\[rs]server\[rs]share\f[R]. Note that the path must be with just a single backslash prefix in this case. .PP \f[I]Note:\f[R] In previous versions of rclone this was the only supported method. .PP Read more about drive mapping (https://en.wikipedia.org/wiki/Drive_mapping) .PP See also Limitations section below. .SS Windows filesystem permissions .PP 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). .PP 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 \[dq]Everyone\[dq] will be used to represent others. The user/group can be customized with FUSE options \[dq]UserName\[dq] and \[dq]GroupName\[dq], e.g. \f[C]-o UserName=user123 -o GroupName=\[dq]Authenticated Users\[dq]\f[R]. The permissions on each entry will be set according to options \f[C]--dir-perms\f[R] and \f[C]--file-perms\f[R], which takes a value in traditional Unix numeric notation (https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation). .PP The default permissions corresponds to \f[C]--file-perms 0666 --dir-perms 0777\f[R], 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. \f[C]--file-perms 0777 --dir-perms 0777\f[R] to add it to everyone. If the program needs to write files, chances are you will have to enable VFS File Caching as well (see also limitations). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the \[dq]write extended attributes\[dq], as explained next. .PP 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 \[dq]write attributes\[dq], \[dq]write data\[dq] and \[dq]append data\[dq], but not \[dq]write extended attributes\[dq]. Windows will then show this as basic permission \[dq]Special\[dq] instead of \[dq]Write\[dq], because \[dq]Write\[dq] also covers the \[dq]write extended attributes\[dq] permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions \[dq]read attributes\[dq], \[dq]read extended attributes\[dq] and \[dq]read permissions\[dq]. 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. .PP WinFsp 2021 (version 1.9) introduced a new FUSE option \[dq]FileSecurity\[dq], 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. .PP If you set POSIX permissions for only allowing access to the owner, using \f[C]--file-perms 0600 --dir-perms 0700\f[R], the user group and the built-in \[dq]Everyone\[dq] 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 \[dq]unprotected private key file\[dq]. You can work around this by specifying \f[C]-o FileSecurity=\[dq]D:P(A;;FA;;;OW)\[dq]\f[R], which sets file all access (FA) to the owner (OW), and nothing else. .PP When setting write permissions then, except for the owner, this does not include the \[dq]write extended attributes\[dq] 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 \[dq]Everyone\[dq] group, similar to what it gets by default but with the addition of the \[dq]write extended attributes\[dq], you can specify \f[C]-o FileSecurity=\[dq]D:P(A;;FRFW;;;WD)\[dq]\f[R], which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to \f[C]-o FileSecurity=\[dq]D:P(A;;FRFWFX;;;WD)\[dq]\f[R], or set file all access (FA) to get full access permissions, including delete, with \f[C]-o FileSecurity=\[dq]D:P(A;;FA;;;WD)\[dq]\f[R]. .SS Windows caveats .PP 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. .PP If you don\[aq]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. .PP 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. .PP 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\[aq]s Sysinternals suite, which has option \f[C]-s\f[R] 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 \f[C]--config\f[R] (https://rclone.org/docs/#config-config-file) 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 \[dq]write extended attributes\[dq] permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above. .PP Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations. .SS Mounting on macOS .PP 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 \[dq]mounts\[dq] via an NFSv4 local server. .SS Unicode Normalization .PP It is highly recommended to keep the default of \f[C]--no-unicode-normalization=false\f[R] for all \f[C]mount\f[R] and \f[C]serve\f[R] commands on macOS. For details, see vfs-case-sensitivity (https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity). .SS NFS mount .PP 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. .PP Note that \f[C]--nfs-cache-handle-limit\f[R] controls the maximum number of cached file handles stored by the \f[C]nfsmount\f[R] 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\[aq]s system resource usage causes problems. .SS macFUSE Notes .PP 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. .IP .nf \f[C] sudo mkdir /usr/local/lib cd /usr/local/lib sudo ln -s /opt/local/lib/libfuse.2.dylib \f[R] .fi .SS FUSE-T Limitations, Caveats, and Notes .PP There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14. .SS ModTime update on read .PP As per the FUSE-T wiki (https://github.com/macos-fuse-t/fuse-t/wiki#caveats): .RS .PP 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 \[aq]touch -m\[aq] and \[aq]touch -a\[aq] commands .RE .PP 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. .SS Read Only mounts .PP When mounting with \f[C]--read-only\f[R], attempts to write to files will fail \f[I]silently\f[R] as opposed to with a clear warning as in macFUSE. .SS Limitations .PP Without the use of \f[C]--vfs-cache-mode\f[R] this can only write files sequentially, it can only seek when reading. This means that many applications won\[aq]t work with their files on an rclone mount without \f[C]--vfs-cache-mode writes\f[R] or \f[C]--vfs-cache-mode full\f[R]. See the VFS File Caching section for more info. When using NFS mount on macOS, if you don\[aq]t specify |--vfs-cache-mode| the mount point will be read-only. .PP The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache. .PP When \f[C]rclone mount\f[R] is invoked on Unix with \f[C]--daemon\f[R] flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the \f[C]--daemon-wait\f[R] flag. On Linux it can check mount status using ProcFS so the flag in fact sets \f[B]maximum\f[R] 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. .PP Only supported on Linux, FreeBSD, OS X and Windows at the moment. .SS rclone nfsmount vs rclone sync/copy .PP 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\[aq]t use retries in the same way without making local copies of the uploads. Look at the VFS File Caching for solutions to make nfsmount more reliable. .SS Attribute caching .PP You can use the flag \f[C]--attr-timeout\f[R] to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries. .PP The default is \f[C]1s\f[R] which caches files just long enough to avoid too many callbacks to rclone from the kernel. .PP 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). .PP The kernel can cache the info about a file for the time given by \f[C]--attr-timeout\f[R]. 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 \f[C]--attr-timeout 1s\f[R] this is very unlikely but not impossible. The higher you set \f[C]--attr-timeout\f[R] the more likely it is. The default setting of \[dq]1s\[dq] is the lowest setting which mitigates the problems above. .PP If you set it higher (\f[C]10s\f[R] or \f[C]1m\f[R] 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. .PP If files don\[aq]t change on the remote outside of the control of rclone then there is no chance of corruption. .PP This is the same as setting the attr_timeout option in mount.fuse. .SS Filters .PP Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. .SS systemd .PP 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. .PP Note that systemd runs mount units without any environment variables including \f[C]PATH\f[R] or \f[C]HOME\f[R]. This means that tilde (\f[C]\[ti]\f[R]) expansion will not work and you should provide \f[C]--config\f[R] and \f[C]--cache-dir\f[R] explicitly as absolute paths via rclone arguments. Since mounting requires the \f[C]fusermount\f[R] or \f[C]fusermount3\f[R] program, rclone will use the fallback PATH of \f[C]/bin:/usr/bin\f[R] in this scenario. Please ensure that \f[C]fusermount\f[R]/\f[C]fusermount3\f[R] is present on this PATH. .SS Rclone as Unix mount helper .PP The core Unix program \f[C]/bin/mount\f[R] normally takes the \f[C]-t FSTYPE\f[R] argument then runs the \f[C]/sbin/mount.FSTYPE\f[R] helper program passing it mount options as \f[C]-o key=val,...\f[R] or \f[C]--opt=...\f[R]. Automount (classic or systemd) behaves in a similar way. .PP rclone by default expects GNU-style flags \f[C]--key val\f[R]. To run it as a mount helper you should symlink rclone binary to \f[C]/sbin/mount.rclone\f[R] and optionally \f[C]/usr/bin/rclonefs\f[R], e.g. \f[C]ln -s /usr/bin/rclone /sbin/mount.rclone\f[R]. rclone will detect it and translate command-line arguments appropriately. .PP Now you can run classic mounts like this: .IP .nf \f[C] mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem \f[R] .fi .PP or create systemd mount units: .IP .nf \f[C] # /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 \f[R] .fi .PP optionally accompanied by systemd automount unit .IP .nf \f[C] # /etc/systemd/system/mnt-data.automount [Unit] Description=AutoMount for /mnt/data [Automount] Where=/mnt/data TimeoutIdleSec=600 [Install] WantedBy=multi-user.target \f[R] .fi .PP or add in \f[C]/etc/fstab\f[R] a line like .IP .nf \f[C] 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 \f[R] .fi .PP or use classic Automountd. Remember to provide explicit \f[C]config=...,cache-dir=...\f[R] as a workaround for mount units being run without \f[C]HOME\f[R]. .PP Rclone in the mount helper mode will split \f[C]-o\f[R] argument(s) by comma, replace \f[C]_\f[R] by \f[C]-\f[R] and prepend \f[C]--\f[R] 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. .PP Mount option syntax includes a few extra options treated specially: .IP \[bu] 2 \f[C]env.NAME=VALUE\f[R] will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don\[aq]t allow setting custom environment for mount helpers. Typically you will use \f[C]env.HTTPS_PROXY=proxy.host:3128\f[R] or \f[C]env.HOME=/root\f[R] .IP \[bu] 2 \f[C]command=cmount\f[R] can be used to run \f[C]cmount\f[R] or any other rclone command rather than the default \f[C]mount\f[R]. .IP \[bu] 2 \f[C]args2env\f[R] 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 \f[C]ps\f[R] or \f[C]pgrep\f[R]. .IP \[bu] 2 \f[C]vv...\f[R] will be transformed into appropriate \f[C]--verbose=N\f[R] .IP \[bu] 2 standard mount options like \f[C]x-systemd.automount\f[R], \f[C]_netdev\f[R], \f[C]nosuid\f[R] and alike are intended only for Automountd and ignored by rclone. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone nfsmount remote:path /path/to/mountpoint [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr string IPaddress:Port or :Port to bind server to --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) --no-checksum Don\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]t allow seeking in files --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) --noapplexattr Ignore all \[dq]com.apple.*\[dq] 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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone obscure .PP Obscure password for use in the rclone config file. .SS Synopsis .PP 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 \f[B]not\f[R] a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent \[dq]eyedropping\[dq] - namely someone seeing a password in the rclone config file by accident. .PP 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. .PP 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. .IP .nf \f[C] echo \[dq]secretpassword\[dq] | rclone obscure - \f[R] .fi .PP If there is no data on STDIN to read, rclone obscure will default to obfuscating the hyphen itself. .PP 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. .IP .nf \f[C] rclone obscure password [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for obscure \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone rc .PP Run a command against a running rclone. .SS Synopsis .PP This runs a command against a running rclone. Use the \f[C]--url\f[R] flag to specify an non default URL to connect on. This can be either a \[dq]:port\[dq] which is taken to mean \[dq]http://localhost:port\[dq] or a \[dq]host:port\[dq] which is taken to mean \[dq]http://host:port\[dq] .PP A username and password can be passed in with \f[C]--user\f[R] and \f[C]--pass\f[R]. .PP Note that \f[C]--rc-addr\f[R], \f[C]--rc-user\f[R], \f[C]--rc-pass\f[R] will be read also for \f[C]--url\f[R], \f[C]--user\f[R], \f[C]--pass\f[R]. .PP The \f[C]--unix-socket\f[R] flag can be used to connect over a unix socket like this .IP .nf \f[C] # 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 \f[R] .fi .PP Arguments should be passed in as parameter=value. .PP The result will be returned as a JSON object by default. .PP The \f[C]--json\f[R] 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. .PP The \f[C]-o\f[R]/\f[C]--opt\f[R] option can be used to set a key \[dq]opt\[dq] with key, value options in the form \f[C]-o key=value\f[R] or \f[C]-o key\f[R]. It can be repeated as many times as required. This is useful for rc commands which take the \[dq]opt\[dq] parameter which by convention is a dictionary of strings. .IP .nf \f[C] -o key=value -o key2 \f[R] .fi .PP Will place this in the \[dq]opt\[dq] value .IP .nf \f[C] {\[dq]key\[dq]:\[dq]value\[dq], \[dq]key2\[dq],\[dq]\[dq]) \f[R] .fi .PP The \f[C]-a\f[R]/\f[C]--arg\f[R] option can be used to set strings in the \[dq]arg\[dq] value. It can be repeated as many times as required. This is useful for rc commands which take the \[dq]arg\[dq] parameter which by convention is a list of strings. .IP .nf \f[C] -a value -a value2 \f[R] .fi .PP Will place this in the \[dq]arg\[dq] value .IP .nf \f[C] [\[dq]value\[dq], \[dq]value2\[dq]] \f[R] .fi .PP Use \f[C]--loopback\f[R] to connect to the rclone instance running \f[C]rclone rc\f[R]. This is very useful for testing commands without having to run an rclone rc server, e.g.: .IP .nf \f[C] rclone rc --loopback operations/about fs=/ \f[R] .fi .PP Use \f[C]rclone rc\f[R] to see a list of all possible commands. .IP .nf \f[C] rclone rc commands parameter [flags] \f[R] .fi .SS Options .IP .nf \f[C] -a, --arg stringArray Argument placed in the \[dq]arg\[dq] 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\[aq]t output the JSON result -o, --opt stringArray Option in the form name=value or name placed in the \[dq]opt\[dq] 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 \[dq]http://localhost:5572/\[dq]) --user string Username to use to rclone remote control \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone rcat .PP Copies standard input to file on remote. .SS Synopsis .PP Reads from standard input (stdin) and copies it to a single remote file. .IP .nf \f[C] echo \[dq]hello world\[dq] | rclone rcat remote:path/to/file ffmpeg - | rclone rcat remote:path/to/file \f[R] .fi .PP If the remote file already exists, it will be overwritten. .PP 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 \f[C]--streaming-upload-cutoff\f[R]. 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. .PP Use the \f[C]--size\f[R] flag to preallocate the file in advance at the remote end and actually stream it, even if remote backend doesn\[aq]t support streaming. .PP \f[C]--size\f[R] should be the exact size of the input stream in bytes. If the size of the stream is different in length to the \f[C]--size\f[R] passed in then the transfer will likely fail. .PP 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 \f[C]rclone move\f[R] it to the destination which can use retries. .IP .nf \f[C] rclone rcat remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for rcat --size int File size hint to preallocate (default -1) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone rcd .PP Run rclone listening to remote control commands only. .SS Synopsis .PP This runs rclone so that it only listens to remote control commands. .PP This is useful if you are controlling rclone via the rc API. .PP 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. .PP See the rc documentation (https://rclone.org/rc/) for more info on the rc flags. .SS Server options .PP Use \f[C]--rc-addr\f[R] to specify which IP address and port the server should listen on, eg \f[C]--rc-addr 1.2.3.4:8000\f[R] or \f[C]--rc-addr :8080\f[R] 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. .PP If you set \f[C]--rc-addr\f[R] to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. .PP You can use a unix socket by setting the url to \f[C]unix:///path/to/socket\f[R] or just by using an absolute path name. .PP \f[C]--rc-addr\f[R] may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. .PP \f[C]--rc-server-read-timeout\f[R] and \f[C]--rc-server-write-timeout\f[R] can be used to control the timeouts on the server. Note that this is the total time for a transfer. .PP \f[C]--rc-max-header-bytes\f[R] controls the maximum number of bytes the server will accept in the HTTP header. .PP \f[C]--rc-baseurl\f[R] controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used \f[C]--rc-baseurl \[dq]/rclone\[dq]\f[R] then rclone would serve from a URL starting with \[dq]/rclone/\[dq]. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing \[dq]/\[dq] on \f[C]--rc-baseurl\f[R], so \f[C]--rc-baseurl \[dq]rclone\[dq]\f[R], \f[C]--rc-baseurl \[dq]/rclone\[dq]\f[R] and \f[C]--rc-baseurl \[dq]/rclone/\[dq]\f[R] are all treated identically. .SS TLS (SSL) .PP By default this will serve over http. If you want you can serve over https. You will need to supply the \f[C]--rc-cert\f[R] and \f[C]--rc-key\f[R] flags. If you wish to do client side certificate validation then you will need to supply \f[C]--rc-client-ca\f[R] also. .PP \f[C]--rc-cert\f[R] must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. \f[C]--rc-key\f[R] must be set to the path of a file with the PEM encoded private key. If setting \f[C]--rc-client-ca\f[R], it should be set to the path of a file with PEM encoded client certificate authority certificates. .PP \f[C]--rc-min-tls-version\f[R] is minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS Socket activation .PP 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 \f[C]--rc-addr\f[R]). .PP This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command .IP .nf \f[C] systemd-socket-activate -l 8000 -- rclone serve \f[R] .fi .PP This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template .PP \f[C]--rc-template\f[R] 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: .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Parameter T}@T{ Description T} _ T{ \&.Name T}@T{ The full path of a file/directory. T} T{ \&.Title T}@T{ Directory listing of .Name T} T{ \&.Sort T}@T{ The current sort used. This is changeable via ?sort= parameter T} T{ T}@T{ Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order T}@T{ The current ordering used. This is changeable via ?order= parameter T} T{ T}@T{ Order Options: asc,desc (default asc) T} T{ \&.Query T}@T{ Currently unused. T} T{ \&.Breadcrumb T}@T{ Allows for creating a relative navigation T} T{ -- .Link T}@T{ The relative to the root link of the Text. T} T{ -- .Text T}@T{ The Name of the directory. T} T{ \&.Entries T}@T{ Information about a specific file/directory. T} T{ -- .URL T}@T{ The \[aq]url\[aq] of an entry. T} T{ -- .Leaf T}@T{ Currently same as \[aq]URL\[aq] but intended to be \[aq]just\[aq] the name. T} T{ -- .IsDir T}@T{ Boolean for if an entry is a directory or not. T} T{ -- .Size T}@T{ Size in Bytes of the entry. T} T{ -- .ModTime T}@T{ The UTC timestamp of an entry. T} .TE .PP 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. .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Function T}@T{ Description T} _ T{ afterEpoch T}@T{ Returns the time since the epoch for the given time. T} T{ contains T}@T{ Checks whether a given substring is present or not in a given string. T} T{ hasPrefix T}@T{ Checks whether the given string begins with the specified prefix. T} T{ hasSuffix T}@T{ Checks whether the given string end with the specified suffix. T} .TE .SS Authentication .PP By default this will serve files without needing a login. .PP You can either use an htpasswd file which can take lots of users, or set a single username and password with the \f[C]--rc-user\f[R] and \f[C]--rc-pass\f[R] flags. .PP If no static users are configured by either of the above methods, and client certificates are required by the \f[C]--client-ca\f[R] flag passed to the server, the client certificate common name will be considered as the username. .PP Use \f[C]--rc-htpasswd /path/to/htpasswd\f[R] to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. .PP To create an htpasswd file: .IP .nf \f[C] touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser \f[R] .fi .PP The password file can be updated while rclone is running. .PP Use \f[C]--rc-realm\f[R] to set the authentication realm. .PP Use \f[C]--rc-salt\f[R] to change the password hashing salt from the default. .IP .nf \f[C] rclone rcd <path to files to serve>* [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for rcd \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS RC Options .PP Flags to control the Remote Control API .IP .nf \f[C] --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 \[dq]tls1.0\[dq]) --rc-no-auth Don\[aq]t require auth for certain methods --rc-pass string Password for authentication --rc-realm string Realm for authentication --rc-salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --rc-serve Enable the serving of remote objects --rc-serve-no-modtime Don\[aq]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-web-fetch-url string URL to fetch the releases for webgui (default \[dq]https://api.github.com/repos/rclone/rclone-webui-react/releases/latest\[dq]) --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\[aq]t open the browser automatically --rc-web-gui-update Check and update to latest version of web gui \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone rmdirs .PP Remove empty directories under the path. .SS Synopsis .PP 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 \f[C]--leave-root\f[R] flag. .PP Use command rmdir (https://rclone.org/commands/rclone_rmdir/) to delete just the empty directory given by path, not recurse. .PP 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 \f[C]--rmdirs\f[R]). .PP This will delete \f[C]--checkers\f[R] directories concurrently so if you have thousands of empty directories consider increasing this number. .PP To delete a path and any objects in it, use the purge (https://rclone.org/commands/rclone_purge/) command. .IP .nf \f[C] rclone rmdirs remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for rmdirs --leave-root Do not remove root directory if empty \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone selfupdate .PP Update the rclone binary. .SS Synopsis .PP 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. .PP If used without flags (or with implied \f[C]--stable\f[R] 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 \f[C]--beta\f[R] flag, i.e. \f[C]rclone selfupdate --beta\f[R]. You can check in advance what version would be installed by adding the \f[C]--check\f[R] flag, then repeat the command without it when you are satisfied. .PP 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 \f[C]--version VER\f[R] flag, if given, will update to the concrete version instead of the latest one. If you omit micro version from \f[C]VER\f[R] (for example \f[C]1.53\f[R]), the latest matching micro version will be used. .PP 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\[aq]ll have to note the previous version and run the following command: \f[C]rclone selfupdate [--beta] OLDVER\f[R]. If the old version contains only dots and digits (for example \f[C]v1.54.0\f[R]) then it\[aq]s a stable release so you won\[aq]t need the \f[C]--beta\f[R] flag. Beta releases have an additional information similar to \f[C]v1.54.0-beta.5111.06f1c0c61\f[R]. (if you are a developer and use a locally built rclone, the version number will end with \f[C]-DEV\f[R], you will have to rebuild it as it obviously can\[aq]t be distributed). .PP 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 \f[C]--package deb\f[R] or \f[C]--package rpm\f[R] (whichever is correct for your OS) to update these too. This command with the default \f[C]--package zip\f[R] will update only the rclone executable so the local manual may become inaccurate after it. .PP The rclone mount (https://rclone.org/commands/rclone_mount/) command may or may not support extended FUSE options depending on the build and OS. \f[C]selfupdate\f[R] will refuse to update if the capability would be discarded. .PP Note: Windows forbids deletion of a currently running executable so this command will rename the old executable to \[aq]rclone.old.exe\[aq] upon success. .PP Please note that this command was not available before rclone version 1.55. If it fails for you with the message \f[C]unknown command \[dq]selfupdate\[dq]\f[R] then you will need to update manually following the install instructions located at https://rclone.org/install/ .IP .nf \f[C] rclone selfupdate [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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) \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone serve .PP Serve a remote over a protocol. .SS Synopsis .PP Serve a remote over a given protocol. Requires the use of a subcommand to specify the protocol, e.g. .IP .nf \f[C] rclone serve http remote: \f[R] .fi .PP Each subcommand has its own options which you can see in their help. .IP .nf \f[C] rclone serve <protocol> [opts] <remote> [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for serve \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .IP \[bu] 2 rclone serve dlna (https://rclone.org/commands/rclone_serve_dlna/) - Serve remote:path over DLNA .IP \[bu] 2 rclone serve docker (https://rclone.org/commands/rclone_serve_docker/) - Serve any remote on docker\[aq]s volume plugin API. .IP \[bu] 2 rclone serve ftp (https://rclone.org/commands/rclone_serve_ftp/) - Serve remote:path over FTP. .IP \[bu] 2 rclone serve http (https://rclone.org/commands/rclone_serve_http/) - Serve the remote over HTTP. .IP \[bu] 2 rclone serve nfs (https://rclone.org/commands/rclone_serve_nfs/) - Serve the remote as an NFS mount .IP \[bu] 2 rclone serve restic (https://rclone.org/commands/rclone_serve_restic/) - Serve the remote for restic\[aq]s REST API. .IP \[bu] 2 rclone serve s3 (https://rclone.org/commands/rclone_serve_s3/) - Serve remote:path over s3. .IP \[bu] 2 rclone serve sftp (https://rclone.org/commands/rclone_serve_sftp/) - Serve the remote over SFTP. .IP \[bu] 2 rclone serve webdav (https://rclone.org/commands/rclone_serve_webdav/) - Serve remote:path over WebDAV. .SH rclone serve dlna .PP Serve remote:path over DLNA .SS Synopsis .PP 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. .PP 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. .PP 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 \[dq]Subs\[dq] subdirectory. .SS Server options .PP Use \f[C]--addr\f[R] to specify which IP address and port the server should listen on, e.g. \f[C]--addr 1.2.3.4:8000\f[R] or \f[C]--addr :8080\f[R] to listen to all IPs. .PP Use \f[C]--name\f[R] to choose the friendly server name, which is by default \[dq]rclone (hostname)\[dq]. .PP Use \f[C]--log-trace\f[R] in conjunction with \f[C]-vv\f[R] to enable additional debug logging of all UPNP traffic. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone serve dlna remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr string The ip:port or :port to bind the DLNA http server to (default \[dq]:7879\[dq]) --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve docker .PP Serve any remote on docker\[aq]s volume plugin API. .SS Synopsis .PP 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 based on it. .PP 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: .IP .nf \f[C] sudo rclone serve docker --base-dir /tmp/rclone-volumes --socket-addr localhost:8787 -vv \f[R] .fi .PP Running \f[C]rclone serve docker\f[R] will create the said socket, listening for commands from Docker to create the necessary Volumes. Normally you need not give the \f[C]--socket-addr\f[R] flag. The API will listen on the unix domain socket at \f[C]/run/docker/plugins/rclone.sock\f[R]. In the example above rclone will create a TCP socket and a small file \f[C]/etc/docker/plugins/rclone.spec\f[R] containing the socket address. We use \f[C]sudo\f[R] because both paths are writeable only by the root user. .PP If you later decide to change listening socket, the docker daemon must be restarted to reconnect to \f[C]/run/docker/plugins/rclone.sock\f[R] or parse new \f[C]/etc/docker/plugins/rclone.spec\f[R]. Until you restart, any volume related docker commands will timeout trying to access the old socket. Running directly is supported on \f[B]Linux only\f[R], 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). .PP The command will create volume mounts under the path given by \f[C]--base-dir\f[R] (by default \f[C]/var/lib/docker-volumes/rclone\f[R] available only to root) and maintain the JSON formatted file \f[C]docker-plugin.state\f[R] in the rclone cache directory with book-keeping records of created and mounted volumes. .PP 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. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone serve docker [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \[dq]/var/lib/docker-volumes/rclone\[dq]) --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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 \[dq]com.apple.*\[dq] 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 <host:port> 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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve ftp .PP Serve remote:path over FTP. .SS Synopsis .PP 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. .SS Server options .PP 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. .PP 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. .SS Authentication .PP By default this will serve files without needing a login. .PP You can set a single username and password with the --user and --pass flags. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .SS Auth Proxy .PP If you supply the parameter \f[C]--auth-proxy /path/to/program\f[R] 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. .PP \f[B]PLEASE NOTE:\f[R] \f[C]--auth-proxy\f[R] and \f[C]--authorized-keys\f[R] cannot be used together, if \f[C]--auth-proxy\f[R] is set the authorized keys option will be ignored. .PP 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. .PP The program\[aq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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\[aq]t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. .PP This config generated must have this extra parameter - \f[C]_root\f[R] - root to use for the backend .PP And it may have this parameter - \f[C]_obscure\f[R] - comma separated strings for parameters to obscure .PP If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq] } \f[R] .fi .PP If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]public_key\[dq]: \[dq]AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf\[dq] } \f[R] .fi .PP And as an example return this on STDOUT .IP .nf \f[C] { \[dq]type\[dq]: \[dq]sftp\[dq], \[dq]_root\[dq]: \[dq]\[dq], \[dq]_obscure\[dq]: \[dq]pass\[dq], \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq], \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } \f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the \f[C]user\f[R] and \f[C]pass\f[R]/\f[C]public_key\f[R] returned in the output to the host given. Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP The program can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the \f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to \f[C]user\f[R]. For security you\[aq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP Note that an internal cache is keyed on \f[C]user\f[R] so only use that for configuration, don\[aq]t use \f[C]pass\f[R] or \f[C]public_key\f[R]. This also means that if a user\[aq]s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] rclone serve ftp remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr string IPaddress:Port or :Port to bind server to (default \[dq]localhost:2121\[dq]) --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]t allow seeking in files --pass string Password for authentication (empty value allow every password) --passive-port string Passive port range to use (default \[dq]30000-32000\[dq]) --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 \[dq]anonymous\[dq]) --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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve http .PP Serve the remote over HTTP. .SS Synopsis .PP 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. .PP You can use the filter flags (e.g. \f[C]--include\f[R], \f[C]--exclude\f[R]) to control what is served. .PP The server will log errors. Use \f[C]-v\f[R] to see access logs. .PP \f[C]--bwlimit\f[R] will be respected for file transfers. Use \f[C]--stats\f[R] to control the stats printing. .SS Server options .PP Use \f[C]--addr\f[R] to specify which IP address and port the server should listen on, eg \f[C]--addr 1.2.3.4:8000\f[R] or \f[C]--addr :8080\f[R] 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. .PP If you set \f[C]--addr\f[R] to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. .PP You can use a unix socket by setting the url to \f[C]unix:///path/to/socket\f[R] or just by using an absolute path name. .PP \f[C]--addr\f[R] may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. .PP \f[C]--server-read-timeout\f[R] and \f[C]--server-write-timeout\f[R] can be used to control the timeouts on the server. Note that this is the total time for a transfer. .PP \f[C]--max-header-bytes\f[R] controls the maximum number of bytes the server will accept in the HTTP header. .PP \f[C]--baseurl\f[R] controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used \f[C]--baseurl \[dq]/rclone\[dq]\f[R] then rclone would serve from a URL starting with \[dq]/rclone/\[dq]. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing \[dq]/\[dq] on \f[C]--baseurl\f[R], so \f[C]--baseurl \[dq]rclone\[dq]\f[R], \f[C]--baseurl \[dq]/rclone\[dq]\f[R] and \f[C]--baseurl \[dq]/rclone/\[dq]\f[R] are all treated identically. .SS TLS (SSL) .PP By default this will serve over http. If you want you can serve over https. You will need to supply the \f[C]--cert\f[R] and \f[C]--key\f[R] flags. If you wish to do client side certificate validation then you will need to supply \f[C]--client-ca\f[R] also. .PP \f[C]--cert\f[R] must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. \f[C]--key\f[R] must be set to the path of a file with the PEM encoded private key. If setting \f[C]--client-ca\f[R], it should be set to the path of a file with PEM encoded client certificate authority certificates. .PP \f[C]--min-tls-version\f[R] is minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS Socket activation .PP 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 \f[C]--addr\f[R]). .PP This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command .IP .nf \f[C] systemd-socket-activate -l 8000 -- rclone serve \f[R] .fi .PP This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template .PP \f[C]--template\f[R] 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: .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Parameter T}@T{ Description T} _ T{ \&.Name T}@T{ The full path of a file/directory. T} T{ \&.Title T}@T{ Directory listing of .Name T} T{ \&.Sort T}@T{ The current sort used. This is changeable via ?sort= parameter T} T{ T}@T{ Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order T}@T{ The current ordering used. This is changeable via ?order= parameter T} T{ T}@T{ Order Options: asc,desc (default asc) T} T{ \&.Query T}@T{ Currently unused. T} T{ \&.Breadcrumb T}@T{ Allows for creating a relative navigation T} T{ -- .Link T}@T{ The relative to the root link of the Text. T} T{ -- .Text T}@T{ The Name of the directory. T} T{ \&.Entries T}@T{ Information about a specific file/directory. T} T{ -- .URL T}@T{ The \[aq]url\[aq] of an entry. T} T{ -- .Leaf T}@T{ Currently same as \[aq]URL\[aq] but intended to be \[aq]just\[aq] the name. T} T{ -- .IsDir T}@T{ Boolean for if an entry is a directory or not. T} T{ -- .Size T}@T{ Size in Bytes of the entry. T} T{ -- .ModTime T}@T{ The UTC timestamp of an entry. T} .TE .PP 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. .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Function T}@T{ Description T} _ T{ afterEpoch T}@T{ Returns the time since the epoch for the given time. T} T{ contains T}@T{ Checks whether a given substring is present or not in a given string. T} T{ hasPrefix T}@T{ Checks whether the given string begins with the specified prefix. T} T{ hasSuffix T}@T{ Checks whether the given string end with the specified suffix. T} .TE .SS Authentication .PP By default this will serve files without needing a login. .PP You can either use an htpasswd file which can take lots of users, or set a single username and password with the \f[C]--user\f[R] and \f[C]--pass\f[R] flags. .PP If no static users are configured by either of the above methods, and client certificates are required by the \f[C]--client-ca\f[R] flag passed to the server, the client certificate common name will be considered as the username. .PP Use \f[C]--htpasswd /path/to/htpasswd\f[R] to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. .PP To create an htpasswd file: .IP .nf \f[C] touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser \f[R] .fi .PP The password file can be updated while rclone is running. .PP Use \f[C]--realm\f[R] to set the authentication realm. .PP Use \f[C]--salt\f[R] to change the password hashing salt from the default. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .SS Auth Proxy .PP If you supply the parameter \f[C]--auth-proxy /path/to/program\f[R] 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. .PP \f[B]PLEASE NOTE:\f[R] \f[C]--auth-proxy\f[R] and \f[C]--authorized-keys\f[R] cannot be used together, if \f[C]--auth-proxy\f[R] is set the authorized keys option will be ignored. .PP 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. .PP The program\[aq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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\[aq]t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. .PP This config generated must have this extra parameter - \f[C]_root\f[R] - root to use for the backend .PP And it may have this parameter - \f[C]_obscure\f[R] - comma separated strings for parameters to obscure .PP If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq] } \f[R] .fi .PP If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]public_key\[dq]: \[dq]AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf\[dq] } \f[R] .fi .PP And as an example return this on STDOUT .IP .nf \f[C] { \[dq]type\[dq]: \[dq]sftp\[dq], \[dq]_root\[dq]: \[dq]\[dq], \[dq]_obscure\[dq]: \[dq]pass\[dq], \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq], \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } \f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the \f[C]user\f[R] and \f[C]pass\f[R]/\f[C]public_key\f[R] returned in the output to the host given. Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP The program can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the \f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to \f[C]user\f[R]. For security you\[aq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP Note that an internal cache is keyed on \f[C]user\f[R] so only use that for configuration, don\[aq]t use \f[C]pass\f[R] or \f[C]public_key\f[R]. This also means that if a user\[aq]s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] rclone serve http remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket 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 Path to TLS PEM public key certificate file (can also include intermediate/CA certificates) --client-ca string Path to TLS PEM CA file with certificate authorities to verify clients with --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 http --htpasswd string A htpasswd file - if not provided no authentication is done --key string Path to TLS PEM private key file --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 \[dq]tls1.0\[dq]) --no-checksum Don\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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 --salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --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 --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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve nfs .PP Serve the remote as an NFS mount .SS Synopsis .PP Create an NFS server that serves the given remote over the network. .PP This implements an NFSv3 server to serve any rclone remote via NFS. .PP 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. .PP This server does not implement any authentication so any client will be able to access the data. To limit access, you can use \f[C]serve nfs\f[R] on the loopback address or rely on secure tunnels (such as SSH) or use firewalling. .PP 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 \f[C]--addr\f[R] flag. .PP Modifying files through the NFS protocol requires VFS caching. Usually you will need to specify \f[C]--vfs-cache-mode\f[R] in order to be able to write to the mountpoint (\f[C]full\f[R] is recommended). If you don\[aq]t specify VFS cache mode, the mount will be read-only. .PP \f[C]--nfs-cache-type\f[R] controls the type of the NFS handle cache. By default this is \f[C]memory\f[R] 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. .PP \f[C]--nfs-cache-type disk\f[R] 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 \f[C]--cache-dir\f[R] or the exact directory may be specified with \f[C]--nfs-cache-dir\f[R]. Using this means that the NFS server can be restarted at will without affecting the connected clients. .PP \f[C]--nfs-cache-type symlink\f[R] is similar to \f[C]--nfs-cache-type disk\f[R] 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\[aq]t be backed up and restored as the underlying handles will change. This is Linux only. It requires running rclone as root or with \f[C]CAP_DAC_READ_SEARCH\f[R]. You can run rclone with this extra permission by doing this to the rclone binary \f[C]sudo setcap cap_dac_read_search+ep /path/to/rclone\f[R]. .PP \f[C]--nfs-cache-handle-limit\f[R] 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 \f[C]1000000\f[R], but consider lowering this limit if the server\[aq]s system resource usage causes problems. This is only used by the \f[C]memory\f[R] type cache. .PP To serve NFS over the network use following command: .IP .nf \f[C] rclone serve nfs remote: --addr 0.0.0.0:$PORT --vfs-cache-mode=full \f[R] .fi .PP This specifies a port that can be used in the mount command. To mount the server under Linux/macOS, use the following command: .IP .nf \f[C] mount -t nfs -o port=$PORT,mountport=$PORT,tcp $HOSTNAME:/ path/to/mountpoint \f[R] .fi .PP Where \f[C]$PORT\f[R] is the same port number used in the \f[C]serve nfs\f[R] command and \f[C]$HOSTNAME\f[R] is the network address of the machine that \f[C]serve nfs\f[R] was run on. .PP This command is only available on Unix platforms. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone serve nfs remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve restic .PP Serve the remote for restic\[aq]s REST API. .SS Synopsis .PP Run a basic web server to serve a remote over restic\[aq]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. .PP Restic (https://restic.net/) is a command-line program for doing backups. .PP The server will log errors. Use -v to see access logs. .PP \f[C]--bwlimit\f[R] will be respected for file transfers. Use \f[C]--stats\f[R] to control the stats printing. .SS Setting up rclone for use by restic .PP First set up a remote for your chosen cloud provider (https://rclone.org/docs/#configure). .PP Once you have set up the remote, check it is working with, for example \[dq]rclone lsd remote:\[dq]. You may have called the remote something other than \[dq]remote:\[dq] - just substitute whatever you called it in the following instructions. .PP Now start the rclone restic server .IP .nf \f[C] rclone serve restic -v remote:backup \f[R] .fi .PP Where you can replace \[dq]backup\[dq] in the above by whatever path in the remote you wish to use. .PP By default this will serve on \[dq]localhost:8080\[dq] you can change this with use of the \f[C]--addr\f[R] flag. .PP You might wish to start this server on boot. .PP Adding \f[C]--cache-objects=false\f[R] 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. .SS Setting up restic to use rclone .PP 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. .PP Note that you will need restic 0.8.2 or later to interoperate with rclone. .PP For the example above you will want to use \[dq]http://localhost:8080/\[dq] as the URL for the REST server. .PP For example: .IP .nf \f[C] $ 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 \f[R] .fi .SS Multiple repositories .PP 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 \f[B]must\f[R] end with /. Eg .IP .nf \f[C] $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ # backup user1 stuff $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff \f[R] .fi .SS Private repositories .PP The\f[C]--private-repos\f[R] flag can be used to limit users to repositories starting with a path of \f[C]/<username>/\f[R]. .SS Server options .PP Use \f[C]--addr\f[R] to specify which IP address and port the server should listen on, eg \f[C]--addr 1.2.3.4:8000\f[R] or \f[C]--addr :8080\f[R] 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. .PP If you set \f[C]--addr\f[R] to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. .PP You can use a unix socket by setting the url to \f[C]unix:///path/to/socket\f[R] or just by using an absolute path name. .PP \f[C]--addr\f[R] may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. .PP \f[C]--server-read-timeout\f[R] and \f[C]--server-write-timeout\f[R] can be used to control the timeouts on the server. Note that this is the total time for a transfer. .PP \f[C]--max-header-bytes\f[R] controls the maximum number of bytes the server will accept in the HTTP header. .PP \f[C]--baseurl\f[R] controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used \f[C]--baseurl \[dq]/rclone\[dq]\f[R] then rclone would serve from a URL starting with \[dq]/rclone/\[dq]. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing \[dq]/\[dq] on \f[C]--baseurl\f[R], so \f[C]--baseurl \[dq]rclone\[dq]\f[R], \f[C]--baseurl \[dq]/rclone\[dq]\f[R] and \f[C]--baseurl \[dq]/rclone/\[dq]\f[R] are all treated identically. .SS TLS (SSL) .PP By default this will serve over http. If you want you can serve over https. You will need to supply the \f[C]--cert\f[R] and \f[C]--key\f[R] flags. If you wish to do client side certificate validation then you will need to supply \f[C]--client-ca\f[R] also. .PP \f[C]--cert\f[R] must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. \f[C]--key\f[R] must be set to the path of a file with the PEM encoded private key. If setting \f[C]--client-ca\f[R], it should be set to the path of a file with PEM encoded client certificate authority certificates. .PP \f[C]--min-tls-version\f[R] is minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS Socket activation .PP 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 \f[C]--addr\f[R]). .PP This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command .IP .nf \f[C] systemd-socket-activate -l 8000 -- rclone serve \f[R] .fi .PP This will socket-activate rclone on the first connection to port 8000 over TCP. ### Authentication .PP By default this will serve files without needing a login. .PP You can either use an htpasswd file which can take lots of users, or set a single username and password with the \f[C]--user\f[R] and \f[C]--pass\f[R] flags. .PP If no static users are configured by either of the above methods, and client certificates are required by the \f[C]--client-ca\f[R] flag passed to the server, the client certificate common name will be considered as the username. .PP Use \f[C]--htpasswd /path/to/htpasswd\f[R] to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. .PP To create an htpasswd file: .IP .nf \f[C] touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser \f[R] .fi .PP The password file can be updated while rclone is running. .PP Use \f[C]--realm\f[R] to set the authentication realm. .PP Use \f[C]--salt\f[R] to change the password hashing salt from the default. .IP .nf \f[C] rclone serve restic remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket 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 Path to TLS PEM public key certificate file (can also include intermediate/CA certificates) --client-ca string Path to TLS PEM CA file with certificate authorities to verify clients with -h, --help help for restic --htpasswd string A htpasswd file - if not provided no authentication is done --key string Path to TLS PEM private key file --max-header-bytes int Maximum size of request header (default 4096) --min-tls-version string Minimum TLS version that is acceptable (default \[dq]tls1.0\[dq]) --pass string Password for authentication --private-repos Users can only access their private repo --realm string Realm for authentication --salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve s3 .PP Serve remote:path over s3. .SS Synopsis .PP \f[C]serve s3\f[R] 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. .PP \f[C]serve s3\f[R] is considered \f[B]Experimental\f[R] so use with care. .PP S3 server supports Signature Version 4 authentication. Just use \f[C]--auth-key accessKey,secretKey\f[R] and set the \f[C]Authorization\f[R] header correctly in the request. (See the AWS docs (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)). .PP \f[C]--auth-key\f[R] can be repeated for multiple auth pairs. If \f[C]--auth-key\f[R] is not provided then \f[C]serve s3\f[R] will allow anonymous access. .PP Please note that some clients may require HTTPS endpoints. See the SSL docs for more information. .PP This command uses the VFS directory cache. All the functionality will work with \f[C]--vfs-cache-mode off\f[R]. Using \f[C]--vfs-cache-mode full\f[R] (or \f[C]writes\f[R]) can be used to cache objects locally to improve performance. .PP Use \f[C]--force-path-style=false\f[R] if you want to use the bucket name as a part of the hostname (such as mybucket.local) .PP Use \f[C]--etag-hash\f[R] if you want to change the hash uses for the \f[C]ETag\f[R]. Note that using anything other than \f[C]MD5\f[R] (the default) is likely to cause problems for S3 clients which rely on the Etag being the MD5. .SS Quickstart .PP For a simple set up, to serve \f[C]remote:path\f[R] over s3, run the server like this: .IP .nf \f[C] rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path \f[R] .fi .PP For example, to use a simple folder in the filesystem, run the server with a command like this: .IP .nf \f[C] rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY local:/path/to/folder \f[R] .fi .PP The \f[C]rclone.conf\f[R] for the server could look like this: .IP .nf \f[C] [local] type = local \f[R] .fi .PP The \f[C]local\f[R] configuration is optional though. If you run the server with a \f[C]remote:path\f[R] like \f[C]/path/to/folder\f[R] (without the \f[C]local:\f[R] prefix and without an \f[C]rclone.conf\f[R] file), rclone will fall back to a default configuration, which will be visible as a warning in the logs. But it will run nonetheless. .PP This will be compatible with an rclone (client) remote configuration which is defined like this: .IP .nf \f[C] [serves3] type = s3 provider = Rclone endpoint = http://127.0.0.1:8080/ access_key_id = ACCESS_KEY_ID secret_access_key = SECRET_ACCESS_KEY use_multipart_uploads = false \f[R] .fi .PP Note that setting \f[C]use_multipart_uploads = false\f[R] is to work around a bug which will be fixed in due course. .SS Bugs .PP When uploading multipart files \f[C]serve s3\f[R] holds all the parts in memory (see #7453 (https://github.com/rclone/rclone/issues/7453)). This is a limitaton of the library rclone uses for serving S3 and will hopefully be fixed at some point. .PP 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. .PP For a current list of \f[C]serve s3\f[R] bugs see the serve s3 (https://github.com/rclone/rclone/labels/serve%20s3) bug category on GitHub. .SS Limitations .PP \f[C]serve s3\f[R] will treat all directories in the root as buckets and ignore all files in the root. You can use \f[C]CreateBucket\f[R] to create folders under the root, but you can\[aq]t create empty folders under other folders not in the root. .PP When using \f[C]PutObject\f[R] or \f[C]DeleteObject\f[R], rclone will automatically create or clean up empty folders. If you don\[aq]t want to clean up empty folders automatically, use \f[C]--no-cleanup\f[R]. .PP When using \f[C]ListObjects\f[R], rclone will use \f[C]/\f[R] when the delimiter is empty. This reduces backend requests with no effect on most operations, but if the delimiter is something other than \f[C]/\f[R] and empty, rclone will do a full recursive search of the backend, which can take some time. .PP Versioning is not currently supported. .PP Metadata will only be saved in memory other than the rclone \f[C]mtime\f[R] metadata which will be set as the modification time of the file. .SS Supported operations .PP \f[C]serve s3\f[R] currently supports the following operations. .IP \[bu] 2 Bucket .RS 2 .IP \[bu] 2 \f[C]ListBuckets\f[R] .IP \[bu] 2 \f[C]CreateBucket\f[R] .IP \[bu] 2 \f[C]DeleteBucket\f[R] .RE .IP \[bu] 2 Object .RS 2 .IP \[bu] 2 \f[C]HeadObject\f[R] .IP \[bu] 2 \f[C]ListObjects\f[R] .IP \[bu] 2 \f[C]GetObject\f[R] .IP \[bu] 2 \f[C]PutObject\f[R] .IP \[bu] 2 \f[C]DeleteObject\f[R] .IP \[bu] 2 \f[C]DeleteObjects\f[R] .IP \[bu] 2 \f[C]CreateMultipartUpload\f[R] .IP \[bu] 2 \f[C]CompleteMultipartUpload\f[R] .IP \[bu] 2 \f[C]AbortMultipartUpload\f[R] .IP \[bu] 2 \f[C]CopyObject\f[R] .IP \[bu] 2 \f[C]UploadPart\f[R] .RE .PP Other operations will return error \f[C]Unimplemented\f[R]. .SS Authentication .PP By default this will serve files without needing a login. .PP You can either use an htpasswd file which can take lots of users, or set a single username and password with the \f[C]--user\f[R] and \f[C]--pass\f[R] flags. .PP If no static users are configured by either of the above methods, and client certificates are required by the \f[C]--client-ca\f[R] flag passed to the server, the client certificate common name will be considered as the username. .PP Use \f[C]--htpasswd /path/to/htpasswd\f[R] to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. .PP To create an htpasswd file: .IP .nf \f[C] touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser \f[R] .fi .PP The password file can be updated while rclone is running. .PP Use \f[C]--realm\f[R] to set the authentication realm. .PP Use \f[C]--salt\f[R] to change the password hashing salt from the default. .SS Server options .PP Use \f[C]--addr\f[R] to specify which IP address and port the server should listen on, eg \f[C]--addr 1.2.3.4:8000\f[R] or \f[C]--addr :8080\f[R] 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. .PP If you set \f[C]--addr\f[R] to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. .PP You can use a unix socket by setting the url to \f[C]unix:///path/to/socket\f[R] or just by using an absolute path name. .PP \f[C]--addr\f[R] may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. .PP \f[C]--server-read-timeout\f[R] and \f[C]--server-write-timeout\f[R] can be used to control the timeouts on the server. Note that this is the total time for a transfer. .PP \f[C]--max-header-bytes\f[R] controls the maximum number of bytes the server will accept in the HTTP header. .PP \f[C]--baseurl\f[R] controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used \f[C]--baseurl \[dq]/rclone\[dq]\f[R] then rclone would serve from a URL starting with \[dq]/rclone/\[dq]. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing \[dq]/\[dq] on \f[C]--baseurl\f[R], so \f[C]--baseurl \[dq]rclone\[dq]\f[R], \f[C]--baseurl \[dq]/rclone\[dq]\f[R] and \f[C]--baseurl \[dq]/rclone/\[dq]\f[R] are all treated identically. .SS TLS (SSL) .PP By default this will serve over http. If you want you can serve over https. You will need to supply the \f[C]--cert\f[R] and \f[C]--key\f[R] flags. If you wish to do client side certificate validation then you will need to supply \f[C]--client-ca\f[R] also. .PP \f[C]--cert\f[R] must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. \f[C]--key\f[R] must be set to the path of a file with the PEM encoded private key. If setting \f[C]--client-ca\f[R], it should be set to the path of a file with PEM encoded client certificate authority certificates. .PP \f[C]--min-tls-version\f[R] is minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS Socket activation .PP 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 \f[C]--addr\f[R]). .PP This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command .IP .nf \f[C] systemd-socket-activate -l 8000 -- rclone serve \f[R] .fi .PP This will socket-activate rclone on the first connection to port 8000 over TCP. ## VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .IP .nf \f[C] rclone serve s3 remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket 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 Path to TLS PEM public key certificate file (can also include intermediate/CA certificates) --client-ca string Path to TLS PEM CA file with certificate authorities to verify clients with --dir-cache-time Duration Time to cache directory entries for (default 5m0s) --dir-perms FileMode Directory permissions (default 777) --etag-hash string Which hash to use for the ETag, or auto or blank for off (default \[dq]MD5\[dq]) --file-perms FileMode File permissions (default 666) --force-path-style If true use path style access if false use virtual hosted style (default true) (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 Path to TLS PEM private key file --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 \[dq]tls1.0\[dq]) --no-checksum Don\[aq]t compare checksums on up/download --no-cleanup Not to cleanup empty folder after object is deleted --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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 --salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --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 --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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve sftp .PP Serve the remote over SFTP. .SS Synopsis .PP 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 to use with it. .PP You can use the filter flags (e.g. \f[C]--include\f[R], \f[C]--exclude\f[R]) to control what is served. .PP 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. .PP 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. .PP The server will log errors. Use \f[C]-v\f[R] to see access logs. .PP \f[C]--bwlimit\f[R] will be respected for file transfers. Use \f[C]--stats\f[R] to control the stats printing. .PP You must provide some means of authentication, either with \f[C]--user\f[R]/\f[C]--pass\f[R], an authorized keys file (specify location with \f[C]--authorized-keys\f[R] - the default is the same as ssh), an \f[C]--auth-proxy\f[R], or set the \f[C]--no-auth\f[R] flag for no authentication when logging in. .PP If you don\[aq]t supply a host \f[C]--key\f[R] then rclone will generate rsa, ecdsa and ed25519 variants, and cache them for later use in rclone\[aq]s cache directory (see \f[C]rclone help flags cache-dir\f[R]) in the \[dq]serve-sftp\[dq] directory. .PP By default the server binds to localhost:2022 - if you want it to be reachable externally then supply \f[C]--addr :2022\f[R] for example. .PP 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 https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command: .IP .nf \f[C] systemd-socket-activate -l 2222 -- rclone serve sftp :local:vfs/ \f[R] .fi .PP This will socket-activate rclone on the first connection to port 2222 over TCP. .PP Note that the default of \f[C]--vfs-cache-mode off\f[R] is fine for the rclone sftp backend, but it may not be with other SFTP clients. .PP If \f[C]--stdio\f[R] is specified, rclone will serve SFTP over stdio, which can be used with sshd via \[ti]/.ssh/authorized_keys, for example: .IP .nf \f[C] restrict,command=\[dq]rclone serve sftp --stdio ./photos\[dq] ssh-rsa ... \f[R] .fi .PP On the client you need to set \f[C]--transfers 1\f[R] when using \f[C]--stdio\f[R]. Otherwise multiple instances of the rclone server are started by OpenSSH which can lead to \[dq]corrupted on transfer\[dq] 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. .PP The \[dq]restrict\[dq] in authorized_keys prevents SHA1SUMs and MD5SUMs from being used. Omitting \[dq]restrict\[dq] and using \f[C]--sftp-path-override\f[R] to enable checksumming is possible but less secure and you could use the SFTP server provided by OpenSSH in this case. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .SS Auth Proxy .PP If you supply the parameter \f[C]--auth-proxy /path/to/program\f[R] 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. .PP \f[B]PLEASE NOTE:\f[R] \f[C]--auth-proxy\f[R] and \f[C]--authorized-keys\f[R] cannot be used together, if \f[C]--auth-proxy\f[R] is set the authorized keys option will be ignored. .PP 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. .PP The program\[aq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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\[aq]t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. .PP This config generated must have this extra parameter - \f[C]_root\f[R] - root to use for the backend .PP And it may have this parameter - \f[C]_obscure\f[R] - comma separated strings for parameters to obscure .PP If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq] } \f[R] .fi .PP If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]public_key\[dq]: \[dq]AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf\[dq] } \f[R] .fi .PP And as an example return this on STDOUT .IP .nf \f[C] { \[dq]type\[dq]: \[dq]sftp\[dq], \[dq]_root\[dq]: \[dq]\[dq], \[dq]_obscure\[dq]: \[dq]pass\[dq], \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq], \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } \f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the \f[C]user\f[R] and \f[C]pass\f[R]/\f[C]public_key\f[R] returned in the output to the host given. Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP The program can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the \f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to \f[C]user\f[R]. For security you\[aq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP Note that an internal cache is keyed on \f[C]user\f[R] so only use that for configuration, don\[aq]t use \f[C]pass\f[R] or \f[C]public_key\f[R]. This also means that if a user\[aq]s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] rclone serve sftp remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr string IPaddress:Port or :Port to bind server to (default \[dq]localhost:2022\[dq]) --auth-proxy string A program to use to create the backend from the auth --authorized-keys string Authorized keys file (default \[dq]\[ti]/.ssh/authorized_keys\[dq]) --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\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone serve webdav .PP Serve remote:path over WebDAV. .SS Synopsis .PP 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. .SS WebDAV options .SS --etag-hash .PP This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object. .PP If this flag is set to \[dq]auto\[dq] then rclone will choose the first supported hash on the backend or you can use a named hash such as \[dq]MD5\[dq] or \[dq]SHA-1\[dq]. Use the hashsum (https://rclone.org/commands/rclone_hashsum/) command to see the full list. .SS Access WebDAV on Windows .PP 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: \[dq]The folder you entered does not appear to be valid. Please choose another\[dq]. However, you still can connect if you set the following registry key on a client machine: HKEY_LOCAL_MACHINEto 2. The BasicAuthLevel can be set to the following values: 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. .SS Access Office applications on WebDAV .PP Navigate to following registry HKEY_CURRENT_USER[14.0/15.0/16.0] Create a new DWORD BasicAuthLevel with value 2. 0 - Basic authentication disabled 1 - Basic authentication enabled for SSL connections only 2 - Basic authentication enabled for SSL and for non-SSL connections .PP https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/office-opens-blank-from-sharepoint .SS Serving over a unix socket .PP You can serve the webdav on a unix socket like this: .IP .nf \f[C] rclone serve webdav --addr unix:///tmp/my.socket remote:path \f[R] .fi .PP and connect to it like this using rclone and the webdav backend: .IP .nf \f[C] rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :webdav: \f[R] .fi .PP Note that there is no authentication on http protocol - this is expected to be done by the permissions on the socket. .SS Server options .PP Use \f[C]--addr\f[R] to specify which IP address and port the server should listen on, eg \f[C]--addr 1.2.3.4:8000\f[R] or \f[C]--addr :8080\f[R] 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. .PP If you set \f[C]--addr\f[R] to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. .PP You can use a unix socket by setting the url to \f[C]unix:///path/to/socket\f[R] or just by using an absolute path name. .PP \f[C]--addr\f[R] may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same. .PP \f[C]--server-read-timeout\f[R] and \f[C]--server-write-timeout\f[R] can be used to control the timeouts on the server. Note that this is the total time for a transfer. .PP \f[C]--max-header-bytes\f[R] controls the maximum number of bytes the server will accept in the HTTP header. .PP \f[C]--baseurl\f[R] controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used \f[C]--baseurl \[dq]/rclone\[dq]\f[R] then rclone would serve from a URL starting with \[dq]/rclone/\[dq]. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing \[dq]/\[dq] on \f[C]--baseurl\f[R], so \f[C]--baseurl \[dq]rclone\[dq]\f[R], \f[C]--baseurl \[dq]/rclone\[dq]\f[R] and \f[C]--baseurl \[dq]/rclone/\[dq]\f[R] are all treated identically. .SS TLS (SSL) .PP By default this will serve over http. If you want you can serve over https. You will need to supply the \f[C]--cert\f[R] and \f[C]--key\f[R] flags. If you wish to do client side certificate validation then you will need to supply \f[C]--client-ca\f[R] also. .PP \f[C]--cert\f[R] must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. \f[C]--key\f[R] must be set to the path of a file with the PEM encoded private key. If setting \f[C]--client-ca\f[R], it should be set to the path of a file with PEM encoded client certificate authority certificates. .PP \f[C]--min-tls-version\f[R] is minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS Socket activation .PP 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 \f[C]--addr\f[R]). .PP This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html .PP Socket activation can be tested ad-hoc with the \f[C]systemd-socket-activate\f[R]command .IP .nf \f[C] systemd-socket-activate -l 8000 -- rclone serve \f[R] .fi .PP This will socket-activate rclone on the first connection to port 8000 over TCP. ### Template .PP \f[C]--template\f[R] 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: .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Parameter T}@T{ Description T} _ T{ \&.Name T}@T{ The full path of a file/directory. T} T{ \&.Title T}@T{ Directory listing of .Name T} T{ \&.Sort T}@T{ The current sort used. This is changeable via ?sort= parameter T} T{ T}@T{ Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order T}@T{ The current ordering used. This is changeable via ?order= parameter T} T{ T}@T{ Order Options: asc,desc (default asc) T} T{ \&.Query T}@T{ Currently unused. T} T{ \&.Breadcrumb T}@T{ Allows for creating a relative navigation T} T{ -- .Link T}@T{ The relative to the root link of the Text. T} T{ -- .Text T}@T{ The Name of the directory. T} T{ \&.Entries T}@T{ Information about a specific file/directory. T} T{ -- .URL T}@T{ The \[aq]url\[aq] of an entry. T} T{ -- .Leaf T}@T{ Currently same as \[aq]URL\[aq] but intended to be \[aq]just\[aq] the name. T} T{ -- .IsDir T}@T{ Boolean for if an entry is a directory or not. T} T{ -- .Size T}@T{ Size in Bytes of the entry. T} T{ -- .ModTime T}@T{ The UTC timestamp of an entry. T} .TE .PP 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. .PP .TS tab(@); lw(35.0n) lw(35.0n). T{ Function T}@T{ Description T} _ T{ afterEpoch T}@T{ Returns the time since the epoch for the given time. T} T{ contains T}@T{ Checks whether a given substring is present or not in a given string. T} T{ hasPrefix T}@T{ Checks whether the given string begins with the specified prefix. T} T{ hasSuffix T}@T{ Checks whether the given string end with the specified suffix. T} .TE .SS Authentication .PP By default this will serve files without needing a login. .PP You can either use an htpasswd file which can take lots of users, or set a single username and password with the \f[C]--user\f[R] and \f[C]--pass\f[R] flags. .PP If no static users are configured by either of the above methods, and client certificates are required by the \f[C]--client-ca\f[R] flag passed to the server, the client certificate common name will be considered as the username. .PP Use \f[C]--htpasswd /path/to/htpasswd\f[R] to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended. .PP To create an htpasswd file: .IP .nf \f[C] touch htpasswd htpasswd -B htpasswd user htpasswd -B htpasswd anotherUser \f[R] .fi .PP The password file can be updated while rclone is running. .PP Use \f[C]--realm\f[R] to set the authentication realm. .PP Use \f[C]--salt\f[R] to change the password hashing salt from the default. .SS VFS - Virtual File System .PP 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. .PP Cloud storage objects have lots of properties which aren\[aq]t like disk files - you can\[aq]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. .PP The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory. .SS VFS Directory Cache .PP Using the \f[C]--dir-cache-time\f[R] 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. .IP .nf \f[C] --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) \f[R] .fi .PP 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. .PP You can send a \f[C]SIGHUP\f[R] 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: .IP .nf \f[C] kill -SIGHUP $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use rclone rc to flush the whole directory cache: .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] rclone rc vfs/forget file=path/to/file dir=path/to/dir \f[R] .fi .SS VFS File Buffering .PP The \f[C]--buffer-size\f[R] flag determines the amount of memory, that will be used to buffer data in advance. .PP 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\[aq]t be shared. .PP 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. .PP The maximum memory used by rclone for buffering can be up to \f[C]--buffer-size * open files\f[R]. .SS VFS File Caching .PP 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. .PP For example you\[aq]ll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details. .PP Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both. .IP .nf \f[C] --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) \f[R] .fi .PP If run with \f[C]-vv\f[R] 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 \f[C]--cache-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by \f[C]--vfs-cache-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed and if they haven\[aq]t been accessed for \f[C]--vfs-write-back\f[R] seconds. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP If using \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every \f[C]--vfs-cache-poll-interval\f[R]. Secondly because open files cannot be evicted from the cache. When \f[C]--vfs-cache-max-size\f[R] or \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven\[aq]t been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached. .PP The \f[C]--vfs-cache-max-age\f[R] 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\[aq]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 . .PP You \f[B]should not\f[R] run two copies of rclone using the same VFS cache with the same or overlapping remotes if using \f[C]--vfs-cache-mode > off\f[R]. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with \f[C]--cache-dir\f[R]. You don\[aq]t need to worry about this if the remotes in use don\[aq]t overlap. .SS --vfs-cache-mode off .PP In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 Files can\[aq]t be opened for both read AND write .IP \[bu] 2 Files opened for write can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files open for read with O_TRUNC will be opened write only .IP \[bu] 2 Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode minimal .PP This is very similar to \[dq]off\[dq] 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. .PP These operations are not possible .IP \[bu] 2 Files opened for write only can\[aq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 If an upload fails it can\[aq]t be retried .SS --vfs-cache-mode writes .PP 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. .PP This mode should support all normal file system operations. .PP If an upload fails it will be retried at exponentially increasing intervals up to 1 minute. .SS --vfs-cache-mode full .PP 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. .PP 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. .PP 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. .PP This mode should support all normal file system operations and is otherwise identical to \f[C]--vfs-cache-mode\f[R] writes. .PP When reading a file rclone will read \f[C]--buffer-size\f[R] plus \f[C]--vfs-read-ahead\f[R] bytes ahead. The \f[C]--buffer-size\f[R] is buffered in memory whereas the \f[C]--vfs-read-ahead\f[R] is buffered on disk. .PP When using this mode it is recommended that \f[C]--buffer-size\f[R] is not set too large and \f[C]--vfs-read-ahead\f[R] is set large if required. .PP \f[B]IMPORTANT\f[R] 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\[aq]t support sparse files and it will log an ERROR message if one is detected. .SS Fingerprinting .PP 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: .IP \[bu] 2 size .IP \[bu] 2 modification time .IP \[bu] 2 hash .PP where available on an object. .PP On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object). .PP For example \f[C]hash\f[R] is slow with the \f[C]local\f[R] and \f[C]sftp\f[R] backends as they have to read the entire file and hash it, and \f[C]modtime\f[R] is slow with the \f[C]s3\f[R], \f[C]swift\f[R], \f[C]ftp\f[R] and \f[C]qinqstor\f[R] backends because they need to do an extra API call to fetch it. .PP If you use the \f[C]--vfs-fast-fingerprint\f[R] 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. .PP If you are running a vfs cache over \f[C]local\f[R], \f[C]s3\f[R] or \f[C]swift\f[R] backends then using this flag is recommended. .PP 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. .SS VFS Chunked Reading .PP 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. .PP These flags control the chunking: .IP .nf \f[C] --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 \f[R] .fi .PP The chunking behaves differently depending on the \f[C]--vfs-read-chunk-streams\f[R] parameter. .SS \f[C]--vfs-read-chunk-streams\f[R] == 0 .PP Rclone will start reading a chunk of size \f[C]--vfs-read-chunk-size\f[R], and then double the size for each read. When \f[C]--vfs-read-chunk-size-limit\f[R] is specified, and greater than \f[C]--vfs-read-chunk-size\f[R], the chunk size for each open file will get doubled only until the specified value is reached. If the value is \[dq]off\[dq], which is the default, the limit is disabled and the chunk size will grow indefinitely. .PP With \f[C]--vfs-read-chunk-size 100M\f[R] and \f[C]--vfs-read-chunk-size-limit 0\f[R] the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When \f[C]--vfs-read-chunk-size-limit 500M\f[R] is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. .PP Setting \f[C]--vfs-read-chunk-size\f[R] to \f[C]0\f[R] or \[dq]off\[dq] disables chunked reading. .PP The chunks will not be buffered in memory. .SS \f[C]--vfs-read-chunk-streams\f[R] > 0 .PP Rclone reads \f[C]--vfs-read-chunk-streams\f[R] chunks of size \f[C]--vfs-read-chunk-size\f[R] concurrently. The size for each read will stay constant. .PP This improves performance performance massively on high latency links or very high bandwidth links to high performance object stores. .PP Some experimentation will be needed to find the optimum values of \f[C]--vfs-read-chunk-size\f[R] and \f[C]--vfs-read-chunk-streams\f[R] as these will depend on the backend in use and the latency to the backend. .PP For high performance object stores (eg AWS S3) a reasonable place to start might be \f[C]--vfs-read-chunk-streams 16\f[R] and \f[C]--vfs-read-chunk-size 4M\f[R]. In testing with AWS S3 the performance scaled roughly as the \f[C]--vfs-read-chunk-streams\f[R] setting. .PP Similar settings should work for high latency links, but depending on the latency they may need more \f[C]--vfs-read-chunk-streams\f[R] in order to get the throughput. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the chunked reading feature. .PP In particular S3 and Swift benefit hugely from the \f[C]--no-modtime\f[R] flag (or use \f[C]--use-server-modtime\f[R] for a slightly different effect) as each read of the modification time takes a transaction. .IP .nf \f[C] --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. --read-only Only allow read-only access. \f[R] .fi .PP 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. .IP .nf \f[C] --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) \f[R] .fi .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] --transfers int Number of file transfers to run in parallel (default 4) \f[R] .fi .SS Symlinks .PP By default the VFS does not support symlinks. However this may be enabled with either of the following flags: .IP .nf \f[C] --links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension. --vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS \f[R] .fi .PP 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 \f[C]link-to-file.txt\f[R] would be stored on cloud storage as \f[C]link-to-file.txt.rclonelink\f[R] and the contents would be the path to the symlink destination. .PP Note that \f[C]--links\f[R] enables symlink translation globally in rclone - this includes any backend which supports the concept (for example the local backend). \f[C]--vfs-links\f[R] just enables it for the VFS layer. .PP This scheme is compatible with that used by the local backend with the --local-links flag (https://rclone.org/local/#symlinks-junction-points). .PP The \f[C]--vfs-links\f[R] flag has been designed for \f[C]rclone mount\f[R], \f[C]rclone nfsmount\f[R] and \f[C]rclone serve nfs\f[R]. .PP It hasn\[aq]t been tested with the other \f[C]rclone serve\f[R] commands yet. .PP A limitation of the current implementation is that it expects the caller to resolve sub-symlinks. For example given this directory tree .IP .nf \f[C] \&. \[u251C]\[u2500]\[u2500] dir \[br]\ \ \[u2514]\[u2500]\[u2500] file.txt \[u2514]\[u2500]\[u2500] linked-dir -> dir \f[R] .fi .PP The VFS will correctly resolve \f[C]linked-dir\f[R] but not \f[C]linked-dir/file.txt\f[R]. This is not a problem for the tested commands but may be for other commands. .PP \f[B]Note\f[R] 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). .SS VFS Case Sensitivity .PP Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. .PP 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. .PP Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the remote as-is. If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP 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. .PP 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 \[dq]fixup\[dq] is performed to satisfy the target. .PP If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: \[dq]true\[dq] on Windows and macOS, \[dq]false\[dq] otherwise. If the flag is provided without a value, then it is \[dq]true\[dq]. .PP The \f[C]--no-unicode-normalization\f[R] flag controls whether a similar \[dq]fixup\[dq] 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 \f[C]false\f[R] on macOS, to avoid encoding compatibility issues. .PP In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the \f[C]--vfs-block-norm-dupes\f[R] 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. \f[C]--vfs-block- norm-dupes\f[R] prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in \f[C]rclone sync\f[R]. .SS VFS Disk Options .PP 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. .IP .nf \f[C] --vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1) \f[R] .fi .SS Alternate report of used bytes .PP Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running \f[C]df\f[R] on the filesystem, then pass the flag \f[C]--vfs-used-is-size\f[R] to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to \f[C]rclone size\f[R] and compute the total used space itself. .PP \f[I]WARNING.\f[R] Contrary to \f[C]rclone size\f[R], 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. .SS Auth Proxy .PP If you supply the parameter \f[C]--auth-proxy /path/to/program\f[R] 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. .PP \f[B]PLEASE NOTE:\f[R] \f[C]--auth-proxy\f[R] and \f[C]--authorized-keys\f[R] cannot be used together, if \f[C]--auth-proxy\f[R] is set the authorized keys option will be ignored. .PP 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. .PP The program\[aq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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\[aq]t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config. .PP This config generated must have this extra parameter - \f[C]_root\f[R] - root to use for the backend .PP And it may have this parameter - \f[C]_obscure\f[R] - comma separated strings for parameters to obscure .PP If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq] } \f[R] .fi .PP If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: .IP .nf \f[C] { \[dq]user\[dq]: \[dq]me\[dq], \[dq]public_key\[dq]: \[dq]AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf\[dq] } \f[R] .fi .PP And as an example return this on STDOUT .IP .nf \f[C] { \[dq]type\[dq]: \[dq]sftp\[dq], \[dq]_root\[dq]: \[dq]\[dq], \[dq]_obscure\[dq]: \[dq]pass\[dq], \[dq]user\[dq]: \[dq]me\[dq], \[dq]pass\[dq]: \[dq]mypassword\[dq], \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } \f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the \f[C]user\f[R] and \f[C]pass\f[R]/\f[C]public_key\f[R] returned in the output to the host given. Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP The program can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the \f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to \f[C]user\f[R]. For security you\[aq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP Note that an internal cache is keyed on \f[C]user\f[R] so only use that for configuration, don\[aq]t use \f[C]pass\f[R] or \f[C]public_key\f[R]. This also means that if a user\[aq]s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] rclone serve webdav remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] --addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket 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 Path to TLS PEM public key certificate file (can also include intermediate/CA certificates) --client-ca string Path to TLS PEM CA file with certificate authorities 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 --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 Path to TLS PEM private key file --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 \[dq]tls1.0\[dq]) --no-checksum Don\[aq]t compare checksums on up/download --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]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 --salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --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 --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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS --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 (\[aq]off\[aq] 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) \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS See Also .IP \[bu] 2 rclone serve (https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. .SH rclone settier .PP Changes storage class/tier of objects in remote. .SS Synopsis .PP 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. .PP 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 .PP You can use it to tier single object .IP .nf \f[C] rclone settier Cool remote:path/file \f[R] .fi .PP Or use rclone filters to set tier on only specific files .IP .nf \f[C] rclone --include \[dq]*.txt\[dq] settier Hot remote:path/dir \f[R] .fi .PP Or just provide remote directory and all files in directory will be tiered .IP .nf \f[C] rclone settier tier remote:path/dir \f[R] .fi .IP .nf \f[C] rclone settier tier remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for settier \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone test .PP Run a test command .SS Synopsis .PP Rclone test is used to run test commands. .PP Select which test command you want with the subcommand, eg .IP .nf \f[C] rclone test memory remote: \f[R] .fi .PP Each subcommand has its own options which you can see in their help. .PP \f[B]NB\f[R] Be careful running these commands, they may do strange things so reading their documentation first is recommended. .SS Options .IP .nf \f[C] -h, --help help for test \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .IP \[bu] 2 rclone test changenotify (https://rclone.org/commands/rclone_test_changenotify/) - Log any change notify requests for the remote passed in. .IP \[bu] 2 rclone test histogram (https://rclone.org/commands/rclone_test_histogram/) - Makes a histogram of file name characters. .IP \[bu] 2 rclone test info (https://rclone.org/commands/rclone_test_info/) - Discovers file name or other limitations for paths. .IP \[bu] 2 rclone test makefile (https://rclone.org/commands/rclone_test_makefile/) - Make files with random contents of the size given .IP \[bu] 2 rclone test makefiles (https://rclone.org/commands/rclone_test_makefiles/) - Make a random file hierarchy in a directory .IP \[bu] 2 rclone test memory (https://rclone.org/commands/rclone_test_memory/) - Load all the objects at remote:path into memory and report memory stats. .SH rclone test changenotify .PP Log any change notify requests for the remote passed in. .IP .nf \f[C] rclone test changenotify remote: [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for changenotify --poll-interval Duration Time to wait between polling for changes (default 10s) \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone test histogram .PP Makes a histogram of file name characters. .SS Synopsis .PP This command outputs JSON which shows the histogram of characters used in filenames in the remote:path specified. .PP The data doesn\[aq]t contain any identifying information but is useful for the rclone developers when developing filename compression. .IP .nf \f[C] rclone test histogram [remote:path] [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for histogram \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone test info .PP Discovers file name or other limitations for paths. .SS Synopsis .PP 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. .PP \f[B]NB\f[R] this can create undeletable files and other hazards - use with care .IP .nf \f[C] rclone test info [remote:path]+ [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone test makefile .PP Make files with random contents of the size given .IP .nf \f[C] rclone test makefile <size> [<file>]+ [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone test makefiles .PP Make a random file hierarchy in a directory .IP .nf \f[C] rclone test makefiles <dir> [flags] \f[R] .fi .SS Options .IP .nf \f[C] --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 \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone test memory .PP Load all the objects at remote:path into memory and report memory stats. .IP .nf \f[C] rclone test memory remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -h, --help help for memory \f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS See Also .IP \[bu] 2 rclone test (https://rclone.org/commands/rclone_test/) - Run a test command .SH rclone touch .PP Create new file or change file modification time. .SS Synopsis .PP Set the modification time on file(s) as specified by remote:path to have the current time. .PP If remote:path does not exist then a zero sized file will be created, unless \f[C]--no-create\f[R] or \f[C]--recursive\f[R] is provided. .PP If \f[C]--recursive\f[R] 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 \f[C]--dry-run\f[R] or the \f[C]--interactive\f[R]/\f[C]-i\f[R] flag. .PP If \f[C]--timestamp\f[R] is used then sets the modification time to that time instead of the current time. Times may be specified as one of: .IP \[bu] 2 \[aq]YYMMDD\[aq] - e.g. 17.10.30 .IP \[bu] 2 \[aq]YYYY-MM-DDTHH:MM:SS\[aq] - e.g. 2006-01-02T15:04:05 .IP \[bu] 2 \[aq]YYYY-MM-DDTHH:MM:SS.SSS\[aq] - e.g. 2006-01-02T15:04:05.123456789 .PP Note that value of \f[C]--timestamp\f[R] is in UTC. If you want local time then add the \f[C]--localtime\f[R] flag. .IP .nf \f[C] rclone touch remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Important Options .PP Important flags useful for most commands .IP .nf \f[C] -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) \f[R] .fi .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SH rclone tree .PP List the contents of the remote in a tree like fashion. .SS Synopsis .PP Lists the contents of a remote in a similar way to the unix tree command. .PP For example .IP .nf \f[C] $ rclone tree remote:path / \[u251C]\[u2500]\[u2500] file1 \[u251C]\[u2500]\[u2500] file2 \[u251C]\[u2500]\[u2500] file3 \[u2514]\[u2500]\[u2500] subdir \[u251C]\[u2500]\[u2500] file4 \[u2514]\[u2500]\[u2500] file5 1 directories, 5 files \f[R] .fi .PP You can use any of the filtering options with the tree command (e.g. \f[C]--include\f[R] and \f[C]--exclude\f[R]. You can also use \f[C]--fast-list\f[R]. .PP 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 \f[C]--size\f[R]. Note that not all of them have short options as they conflict with rclone\[aq]s short options. .PP For a more interactive navigation of the remote see the ncdu (https://rclone.org/commands/rclone_ncdu/) command. .IP .nf \f[C] rclone tree remote:path [flags] \f[R] .fi .SS Options .IP .nf \f[C] -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\[aq]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 \f[R] .fi .PP Options shared with other commands are described next. See the global flags page (https://rclone.org/flags/) for global options not listed here. .SS Filter Options .PP Flags for filtering directory listings .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing Options .PP Flags for listing directories .IP .nf \f[C] --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 \f[R] .fi .SS See Also .IP \[bu] 2 rclone (https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. .SS Copying single files .PP 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 \f[C]Failed to create file system for \[dq]remote:file\[dq]: is a file not a directory\f[R] if it isn\[aq]t. .PP For example, suppose you have a remote with a file in called \f[C]test.jpg\f[R], then you could copy just that file like this .IP .nf \f[C] rclone copy remote:test.jpg /tmp/download \f[R] .fi .PP The file \f[C]test.jpg\f[R] will be placed inside \f[C]/tmp/download\f[R]. .PP This is equivalent to specifying .IP .nf \f[C] rclone copy --files-from /tmp/files remote: /tmp/download \f[R] .fi .PP Where \f[C]/tmp/files\f[R] contains the single line .IP .nf \f[C] test.jpg \f[R] .fi .PP It is recommended to use \f[C]copy\f[R] when copying individual files, not \f[C]sync\f[R]. They have pretty much the same effect but \f[C]copy\f[R] will use a lot less memory. .SS Syntax of remote paths .PP The syntax of the paths passed to the rclone command are as follows. .SS /path/to/dir .PP This refers to the local file system. .PP On Windows \f[C]\[rs]\f[R] may be used instead of \f[C]/\f[R] in local paths \f[B]only\f[R], non local paths must use \f[C]/\f[R]. See local filesystem (https://rclone.org/local/#paths-on-windows) documentation for more about Windows-specific paths. .PP These paths needn\[aq]t start with a leading \f[C]/\f[R] - if they don\[aq]t then they will be relative to the current directory. .SS remote:path/to/dir .PP This refers to a directory \f[C]path/to/dir\f[R] on \f[C]remote:\f[R] as defined in the config file (configured with \f[C]rclone config\f[R]). .SS remote:/path/to/dir .PP On most backends this is refers to the same directory as \f[C]remote:path/to/dir\f[R] 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 \f[C]/\f[R] will refer to your \[dq]home\[dq] directory and paths with a leading \f[C]/\f[R] will refer to the root. .SS :backend:path/to/dir .PP This is an advanced form for creating remotes on the fly. \f[C]backend\f[R] should be the name or prefix of a backend (the \f[C]type\f[R] in the config file) and all the configuration for the backend should be provided on the command line (or in environment variables). .PP Here are some examples: .IP .nf \f[C] rclone lsd --http-url https://pub.rclone.org :http: \f[R] .fi .PP To list all the directories in the root of \f[C]https://pub.rclone.org/\f[R]. .IP .nf \f[C] rclone lsf --http-url https://example.com :http:path/to/dir \f[R] .fi .PP To list files and directories in \f[C]https://example.com/path/to/dir/\f[R] .IP .nf \f[C] rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir \f[R] .fi .PP To copy files and directories in \f[C]https://example.com/path/to/dir\f[R] to \f[C]/tmp/dir\f[R]. .IP .nf \f[C] rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir \f[R] .fi .PP To copy files and directories from \f[C]example.com\f[R] in the relative directory \f[C]path/to/dir\f[R] to \f[C]/tmp/dir\f[R] using sftp. .SS Connection strings .PP The above examples can also be written using a connection string syntax, so instead of providing the arguments as command line parameters \f[C]--http-url https://pub.rclone.org\f[R] they are provided as part of the remote specification as a kind of connection string. .IP .nf \f[C] rclone lsd \[dq]:http,url=\[aq]https://pub.rclone.org\[aq]:\[dq] rclone lsf \[dq]:http,url=\[aq]https://example.com\[aq]:path/to/dir\[dq] rclone copy \[dq]:http,url=\[aq]https://example.com\[aq]:path/to/dir\[dq] /tmp/dir rclone copy :sftp,host=example.com:path/to/dir /tmp/dir \f[R] .fi .PP 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 \f[C]--drive-shared-with-me\f[R] parameter to the remote \f[C]gdrive:\f[R]. .IP .nf \f[C] rclone lsf \[dq]gdrive,shared_with_me:path/to/dir\[dq] \f[R] .fi .PP 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 \f[B]does not work\f[R] because the \f[C]--drive-shared-with-me\f[R] flag applies to both the source and the destination. .IP .nf \f[C] rclone copy --drive-shared-with-me gdrive:shared-file.txt gdrive: \f[R] .fi .PP However using the connection string syntax, this does work. .IP .nf \f[C] rclone copy \[dq]gdrive,shared_with_me:shared-file.txt\[dq] gdrive: \f[R] .fi .PP 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 \f[B]will not work\f[R] as intended, because \f[C]shared_with_me\f[R] is ignored by the crypt backend: .IP .nf \f[C] rclone copy \[dq]gdriveCrypt,shared_with_me:shared-file.txt\[dq] gdriveCrypt: \f[R] .fi .PP The connection strings have the following syntax .IP .nf \f[C] remote,parameter=value,parameter2=value2:path/to/dir :backend,parameter=value,parameter2=value2:path/to/dir \f[R] .fi .PP If the \f[C]parameter\f[R] has a \f[C]:\f[R] or \f[C],\f[R] then it must be placed in quotes \f[C]\[dq]\f[R] or \f[C]\[aq]\f[R], so .IP .nf \f[C] remote,parameter=\[dq]colon:value\[dq],parameter2=\[dq]comma,value\[dq]:path/to/dir :backend,parameter=\[aq]colon:value\[aq],parameter2=\[aq]comma,value\[aq]:path/to/dir \f[R] .fi .PP If a quoted value needs to include that quote, then it should be doubled, so .IP .nf \f[C] remote,parameter=\[dq]with\[dq]\[dq]quote\[dq],parameter2=\[aq]with\[aq]\[aq]quote\[aq]:path/to/dir \f[R] .fi .PP This will make \f[C]parameter\f[R] be \f[C]with\[dq]quote\f[R] and \f[C]parameter2\f[R] be \f[C]with\[aq]quote\f[R]. .PP If you leave off the \f[C]=parameter\f[R] then rclone will substitute \f[C]=true\f[R] which works very well with flags. For example, to use s3 configured in the environment you could use: .IP .nf \f[C] rclone lsd :s3,env_auth: \f[R] .fi .PP Which is equivalent to .IP .nf \f[C] rclone lsd :s3,env_auth=true: \f[R] .fi .PP Note that on the command line you might need to surround these connection strings with \f[C]\[dq]\f[R] or \f[C]\[aq]\f[R] to stop the shell interpreting any special characters within them. .PP If you are a shell master then you\[aq]ll know which strings are OK and which aren\[aq]t, but if you aren\[aq]t sure then enclose them in \f[C]\[dq]\f[R] and use \f[C]\[aq]\f[R] as the inside quote. This syntax works on all OSes. .IP .nf \f[C] rclone copy \[dq]:http,url=\[aq]https://example.com\[aq]:path/to/dir\[dq] /tmp/dir \f[R] .fi .PP On Linux/macOS some characters are still interpreted inside \f[C]\[dq]\f[R] strings in the shell (notably \f[C]\[rs]\f[R] and \f[C]$\f[R] and \f[C]\[dq]\f[R]) so if your strings contain those you can swap the roles of \f[C]\[dq]\f[R] and \f[C]\[aq]\f[R] thus. (This syntax does not work on Windows.) .IP .nf \f[C] rclone copy \[aq]:http,url=\[dq]https://example.com\[dq]:path/to/dir\[aq] /tmp/dir \f[R] .fi .SS Connection strings, config and logging .PP 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 .IP .nf \f[C] rclone -vv lsf --s3-chunk-size 20M s3: \f[R] .fi .PP Has the log message .IP .nf \f[C] DEBUG : s3: detected overridden config - adding \[dq]{Srj1p}\[dq] suffix to name \f[R] .fi .PP This is so rclone can tell the modified remote apart from the unmodified remote when caching the backends. .PP This should only be noticeable in the logs. .PP This means that on the fly backends such as .IP .nf \f[C] rclone -vv lsf :s3,env_auth: \f[R] .fi .PP Will get their own names .IP .nf \f[C] DEBUG : :s3: detected overridden config - adding \[dq]{YTu53}\[dq] suffix to name \f[R] .fi .SS Valid remote names .PP Remote names are case sensitive, and must adhere to the following rules: - May contain number, letter, \f[C]_\f[R], \f[C]-\f[R], \f[C].\f[R], \f[C]+\f[R], \f[C]\[at]\f[R] and space. - May not start with \f[C]-\f[R] or space. - May not end with space. .PP 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 \[dq]code page\[dq]. .PP Do not use single character names on Windows as it creates ambiguity with Windows drives\[aq] names, e.g.: remote called \f[C]C\f[R] is indistinguishable from \f[C]C\f[R] drive. Rclone will always assume that single letter name refers to a drive. .SS Quoting and the shell .PP 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. .PP Here are some gotchas which may help users unfamiliar with the shell rules .SS Linux / OSX .PP If your names have spaces or shell metacharacters (e.g. \f[C]*\f[R], \f[C]?\f[R], \f[C]$\f[R], \f[C]\[aq]\f[R], \f[C]\[dq]\f[R], etc.) then you must quote them. Use single quotes \f[C]\[aq]\f[R] by default. .IP .nf \f[C] rclone copy \[aq]Important files?\[aq] remote:backup \f[R] .fi .PP If you want to send a \f[C]\[aq]\f[R] you will need to use \f[C]\[dq]\f[R], e.g. .IP .nf \f[C] rclone copy \[dq]O\[aq]Reilly Reviews\[dq] remote:backup \f[R] .fi .PP The rules for quoting metacharacters are complicated and if you want the full details you\[aq]ll have to consult the manual page for your shell. .SS Windows .PP If your names have spaces in you need to put them in \f[C]\[dq]\f[R], e.g. .IP .nf \f[C] rclone copy \[dq]E:\[rs]folder name\[rs]folder name\[rs]folder name\[dq] remote:backup \f[R] .fi .PP If you are using the root directory on its own then don\[aq]t quote it (see #464 (https://github.com/rclone/rclone/issues/464) for why), e.g. .IP .nf \f[C] rclone copy E:\[rs] remote:backup \f[R] .fi .SS Copying files or directories with \f[C]:\f[R] in the names .PP rclone uses \f[C]:\f[R] 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 \f[C]:\f[R] up to the first \f[C]/\f[R] so if you need to act on a file or directory like this then use the full path starting with a \f[C]/\f[R], or use \f[C]./\f[R] as a current directory prefix. .PP So to sync a directory called \f[C]sync:me\f[R] to a remote called \f[C]remote:\f[R] use .IP .nf \f[C] rclone sync --interactive ./sync:me remote:path \f[R] .fi .PP or .IP .nf \f[C] rclone sync --interactive /full/path/to/sync:me remote:path \f[R] .fi .SS Server Side Copy .PP Most remotes (but not all - see the overview (https://rclone.org/overview/#optional-features)) support server-side copy. .PP This means if you want to copy one folder to another then rclone won\[aq]t download all the files and re-upload them; it will instruct the server to copy them in place. .PP Eg .IP .nf \f[C] rclone copy s3:oldbucket s3:newbucket \f[R] .fi .PP Will copy the contents of \f[C]oldbucket\f[R] to \f[C]newbucket\f[R] without downloading and re-uploading. .PP Remotes which don\[aq]t support server-side copy \f[B]will\f[R] download and re-upload in this case. .PP Server side copies are used with \f[C]sync\f[R] and \f[C]copy\f[R] and will be identified in the log when using the \f[C]-v\f[R] flag. The \f[C]move\f[R] command may also use them if remote doesn\[aq]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. .PP Server side copies will only be attempted if the remote names are the same. .PP This can be used when scripting to make aged backups efficiently, e.g. .IP .nf \f[C] rclone sync --interactive remote:current-backup remote:previous-backup rclone sync --interactive /path/to/files remote:current-backup \f[R] .fi .SS Metadata support .PP Metadata is data about a file (or directory) which isn\[aq]t the contents of the file (or directory). Normally rclone only preserves the modification time and the content (MIME) type where possible. .PP Rclone supports preserving all the available metadata on files and directories when using the \f[C]--metadata\f[R] or \f[C]-M\f[R] flag. .PP 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) .PP Some backends don\[aq]t support metadata, some only support metadata on files and some support metadata on both files and directories. .PP 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\[aq]t be synced to the destination object. This is in line with the way rclone syncs \f[C]Content-Type\f[R] without the \f[C]--metadata\f[R] flag. .PP Using \f[C]--metadata\f[R] when syncing from local to local will preserve file attributes such as file mode, owner, extended attributes (not Windows). .PP Note that arbitrary metadata may be added to objects using the \f[C]--metadata-set key=value\f[R] flag when the object is first uploaded. This flag can be repeated as many times as necessary. .PP The --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. .PP Rclone supports \f[C]--metadata-set\f[R] and \f[C]--metadata-mapper\f[R] when doing sever side \f[C]Move\f[R] and server side \f[C]Copy\f[R], but not when doing server side \f[C]DirMove\f[R] (renaming a directory) as this would involve recursing into the directory. Note that you can disable \f[C]DirMove\f[R] with \f[C]--disable DirMove\f[R] and rclone will revert back to using \f[C]Move\f[R] for each individual object where \f[C]--metadata-set\f[R] and \f[C]--metadata-mapper\f[R] are supported. .SS Types of metadata .PP Metadata is divided into two type. System metadata and User metadata. .PP Metadata which the backend uses itself is called system metadata. For example on the local backend the system metadata \f[C]uid\f[R] will store the user ID of the file when used on a unix based platform. .PP Arbitrary metadata is called user metadata and this can be set however is desired. .PP 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 \f[C]content-type\f[R] metadata. In a backend which understands this (like \f[C]azureblob\f[R]) this will become the Content-Type of the object. In a backend which doesn\[aq]t understand this (like the \f[C]local\f[R] backend) this will become user metadata. However should the local object be copied back to s3, the Content-Type will be set correctly. .SS Metadata framework .PP 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. .PP This metadata is stored as a dictionary with string keys and string values. .PP There are some limits on the names of the keys (these may be clarified further in the future). .IP \[bu] 2 must be lower case .IP \[bu] 2 may be \f[C]a-z\f[R] \f[C]0-9\f[R] containing \f[C].\f[R] \f[C]-\f[R] or \f[C]_\f[R] .IP \[bu] 2 length is backend dependent .PP Each backend can provide system metadata that it understands. Some backends can also store arbitrary user metadata. .PP 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. .PP Some backends have limits on the size of the metadata and rclone will give errors on upload if they are exceeded. .SS Metadata preservation .PP The goal of the implementation is to .IP "1." 3 Preserve metadata if at all possible .IP "2." 3 Interpret metadata if at all possible .PP 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. .PP 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. .SS Standard system metadata .PP Here is a table of standard system metadata which, if appropriate, a backend may implement. .PP .TS tab(@); lw(34.2n) lw(21.2n) lw(14.7n). T{ key T}@T{ description T}@T{ example T} _ T{ mode T}@T{ File type and mode: octal, unix style T}@T{ 0100664 T} T{ uid T}@T{ User ID of owner: decimal number T}@T{ 500 T} T{ gid T}@T{ Group ID of owner: decimal number T}@T{ 500 T} T{ rdev T}@T{ Device ID (if special file) => hexadecimal T}@T{ 0 T} T{ atime T}@T{ Time of last access: RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T} T{ mtime T}@T{ Time of last modification: RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T} T{ btime T}@T{ Time of file creation (birth): RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T} T{ utime T}@T{ Time of file upload: RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T} T{ cache-control T}@T{ Cache-Control header T}@T{ no-cache T} T{ content-disposition T}@T{ Content-Disposition header T}@T{ inline T} T{ content-encoding T}@T{ Content-Encoding header T}@T{ gzip T} T{ content-language T}@T{ Content-Language header T}@T{ en-US T} T{ content-type T}@T{ Content-Type header T}@T{ text/plain T} .TE .PP The metadata keys \f[C]mtime\f[R] and \f[C]content-type\f[R] will take precedence if supplied in the metadata over reading the \f[C]Content-Type\f[R] or modification time of the source object. .PP Hashes are not included in system metadata as there is a well defined way of reading those already. .SS Options .PP Rclone has a number of options to control its behaviour. .PP Options that take parameters can have the values passed in two ways, \f[C]--option=value\f[R] or \f[C]--option value\f[R]. However boolean (true/false) options behave slightly differently to the other options in that \f[C]--boolean\f[R] sets the option to \f[C]true\f[R] and the absence of the flag sets it to \f[C]false\f[R]. It is also possible to specify \f[C]--boolean=false\f[R] or \f[C]--boolean=true\f[R]. Note that \f[C]--boolean false\f[R] is not valid - this is parsed as \f[C]--boolean\f[R] and the \f[C]false\f[R] is parsed as an extra command line argument for rclone. .PP Options documented to take a \f[C]stringArray\f[R] parameter accept multiple values. To pass more than one value, repeat the option; for example: \f[C]--include value1 --include value2\f[R]. .SS Time or duration options .PP TIME or DURATION options can be specified as a duration string or a time string. .PP A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \[dq]300ms\[dq], \[dq]-1.5h\[dq] or \[dq]2h45m\[dq]. Default units are seconds or the following abbreviations are valid: .IP \[bu] 2 \f[C]ms\f[R] - Milliseconds .IP \[bu] 2 \f[C]s\f[R] - Seconds .IP \[bu] 2 \f[C]m\f[R] - Minutes .IP \[bu] 2 \f[C]h\f[R] - Hours .IP \[bu] 2 \f[C]d\f[R] - Days .IP \[bu] 2 \f[C]w\f[R] - Weeks .IP \[bu] 2 \f[C]M\f[R] - Months .IP \[bu] 2 \f[C]y\f[R] - Years .PP These can also be specified as an absolute time in the following formats: .IP \[bu] 2 RFC3339 - e.g. \f[C]2006-01-02T15:04:05Z\f[R] or \f[C]2006-01-02T15:04:05+07:00\f[R] .IP \[bu] 2 ISO8601 Date and time, local timezone - \f[C]2006-01-02T15:04:05\f[R] .IP \[bu] 2 ISO8601 Date and time, local timezone - \f[C]2006-01-02 15:04:05\f[R] .IP \[bu] 2 ISO8601 Date - \f[C]2006-01-02\f[R] (YYYY-MM-DD) .SS Size options .PP Options which use SIZE use KiB (multiples of 1024 bytes) by default. However, a suffix of \f[C]B\f[R] for Byte, \f[C]K\f[R] for KiB, \f[C]M\f[R] for MiB, \f[C]G\f[R] for GiB, \f[C]T\f[R] for TiB and \f[C]P\f[R] for PiB may be used. These are the binary units, e.g. 1, 2**10, 2**20, 2**30 respectively. .SS --backup-dir=DIR .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] any files which would have been overwritten or deleted are moved in their original hierarchy into this directory. .PP If \f[C]--suffix\f[R] 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 DIR, then it will be overwritten. .PP 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. .PP For example .IP .nf \f[C] rclone sync --interactive /path/to/local remote:current --backup-dir remote:old \f[R] .fi .PP will sync \f[C]/path/to/local\f[R] to \f[C]remote:current\f[R], but for any files which would have been updated or deleted will be stored in \f[C]remote:old\f[R]. .PP If running rclone from a script you might want to use today\[aq]s date as the directory name passed to \f[C]--backup-dir\f[R] to store the old files, or you might want to pass \f[C]--suffix\f[R] with today\[aq]s date. .PP See \f[C]--compare-dest\f[R] and \f[C]--copy-dest\f[R]. .SS --bind string .PP 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\[aq]t resolve or resolves to more than one IP address it will give an error. .PP You can use \f[C]--bind 0.0.0.0\f[R] to force rclone to use IPv4 addresses and \f[C]--bind ::0\f[R] to force rclone to use IPv6 addresses. .SS --bwlimit=BANDWIDTH_SPEC .PP This option controls the bandwidth limit. For example .IP .nf \f[C] --bwlimit 10M \f[R] .fi .PP would mean limit the upload and download bandwidth to 10 MiB/s. \f[B]NB\f[R] this is \f[B]bytes\f[R] per second not \f[B]bits\f[R] 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 \f[C]0\f[R] which means to not limit bandwidth. .PP The upload and download bandwidth can be specified separately, as \f[C]--bwlimit UP:DOWN\f[R], so .IP .nf \f[C] --bwlimit 10M:100k \f[R] .fi .PP would mean limit the upload bandwidth to 10 MiB/s and the download bandwidth to 100 KiB/s. Either limit can be \[dq]off\[dq] meaning no limit, so to just limit the upload bandwidth you would use .IP .nf \f[C] --bwlimit 10M:off \f[R] .fi .PP this would limit the upload bandwidth to 10 MiB/s but the download bandwidth would be unlimited. .PP When specified as above the bandwidth limits last for the duration of run of the rclone binary. .PP It is also possible to specify a \[dq]timetable\[dq] of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as \f[C]WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...\f[R] where: \f[C]WEEKDAY\f[R] is optional element. .IP \[bu] 2 \f[C]BANDWIDTH\f[R] can be a single number, e.g.\f[C]100k\f[R] or a pair of numbers for upload:download, e.g.\f[C]10M:1M\f[R]. .IP \[bu] 2 \f[C]WEEKDAY\f[R] can be written as the whole word or only using the first 3 characters. It is optional. .IP \[bu] 2 \f[C]HH:MM\f[R] is an hour from 00:00 to 23:59. .PP Entries can be separated by spaces or semicolons. .PP \f[B]Note:\f[R] Semicolons can be used as separators instead of spaces to avoid parsing issues in environments like Docker. .PP An example of a typical timetable to avoid link saturation during daytime working hours could be: .PP Using spaces as separators: \f[C]--bwlimit \[dq]08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off\[dq]\f[R] .PP Using semicolons as separators: \f[C]--bwlimit \[dq]08:00,512k;12:00,10M;13:00,512k;18:00,30M;23:00,off\[dq]\f[R] .PP 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. .PP An example of timetable with \f[C]WEEKDAY\f[R] could be: .PP Using spaces as separators: \f[C]--bwlimit \[dq]Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off\[dq]\f[R] .PP Using semicolons as separators: \f[C]--bwlimit \[dq]Mon-00:00,512;Fri-23:59,10M;Sat-10:00,1M;Sun-20:00,off\[dq]\f[R] .PP 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. .PP Timeslots without \f[C]WEEKDAY\f[R] are extended to the whole week. So this example: .PP \f[C]--bwlimit \[dq]Mon-00:00,512 12:00,1M Sun-20:00,off\[dq]\f[R] .PP Is equivalent to this: .PP \f[C]--bwlimit \[dq]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\[dq]\f[R] .PP 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, \f[C]ftp\f[R], \f[C]sftp\f[R] and \f[C]storj\f[R]). .PP Note that the units are \f[B]Byte/s\f[R], not \f[B]bit/s\f[R]. Typically connections are measured in bit/s - to convert divide by 8. For example, let\[aq]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 \f[C]--bwlimit 0.625M\f[R] parameter for rclone. .PP On Unix systems (Linux, macOS, \&...) the bandwidth limiter can be toggled by sending a \f[C]SIGUSR2\f[R] 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 \f[C]--bwlimit\f[R] quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this: .IP .nf \f[C] kill -SIGUSR2 $(pidof rclone) \f[R] .fi .PP If you configure rclone with a remote control then you can use change the bwlimit dynamically: .IP .nf \f[C] rclone rc core/bwlimit rate=1M \f[R] .fi .SS --bwlimit-file=BANDWIDTH_SPEC .PP This option controls per file bandwidth limit. For the options see the \f[C]--bwlimit\f[R] flag. .PP For example use this to allow no transfers to be faster than 1 MiB/s .IP .nf \f[C] --bwlimit-file 1M \f[R] .fi .PP This can be used in conjunction with \f[C]--bwlimit\f[R]. .PP Note that if a schedule is provided the file will use the schedule in effect at the start of the transfer. .SS --buffer-size=SIZE .PP Use this sized buffer to speed up file transfers. Each \f[C]--transfer\f[R] will use this much memory for buffering. .PP When using \f[C]mount\f[R] or \f[C]cmount\f[R] 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. .PP Set to \f[C]0\f[R] to disable the buffering for the minimum memory usage. .PP Note that the memory allocation of the buffers is influenced by the --use-mmap flag. .SS --cache-dir=DIR .PP Specify the directory rclone will use for caching, to override the default. .PP Default value is depending on operating system: - Windows \f[C]%LocalAppData%\[rs]rclone\f[R], if \f[C]LocalAppData\f[R] is defined. - macOS \f[C]$HOME/Library/Caches/rclone\f[R] if \f[C]HOME\f[R] is defined. - Unix \f[C]$XDG_CACHE_HOME/rclone\f[R] if \f[C]XDG_CACHE_HOME\f[R] is defined, else \f[C]$HOME/.cache/rclone\f[R] if \f[C]HOME\f[R] is defined. - Fallback (on all OS) to \f[C]$TMPDIR/rclone\f[R], where \f[C]TMPDIR\f[R] is the value from --temp-dir. .PP You can use the config paths (https://rclone.org/commands/rclone_config_paths/) command to see the current value. .PP 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 and other parts of rclone. .SS --check-first .PP If this flag is set then in a \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R], 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. .PP This flag can be useful on IO limited systems where transfers interfere with checking. .PP It can also be useful to ensure perfect ordering when using \f[C]--order-by\f[R]. .PP If both \f[C]--check-first\f[R] and \f[C]--order-by\f[R] are set when doing \f[C]rclone move\f[R] then rclone will use the transfer thread to delete source files which don\[aq]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. .PP Using this flag can use more memory as it effectively sets \f[C]--max-backlog\f[R] to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start. .SS --checkers=N .PP Originally controlling just the number of file checkers to run in parallel, e.g. by \f[C]rclone copy\f[R]. Now a fairly universal parallelism control used by \f[C]rclone\f[R] in several places. .PP 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. .PP 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 \f[C]--checkers\f[R] 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. .SS -c, --checksum .PP 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. .PP This is useful when the remote doesn\[aq]t support setting modified time and a more accurate sync is desired than just checking the file size. .PP 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/). .PP Eg \f[C]rclone --checksum sync s3:/bucket swift:/bucket\f[R] would run much quicker than without the \f[C]--checksum\f[R] flag. .PP When using this flag, rclone won\[aq]t update mtimes of remote files if they are incorrect as it would normally. .SS --color WHEN .PP Specify when colors (and other ANSI codes) should be added to the output. .PP \f[C]AUTO\f[R] (default) only allows ANSI codes when the output is a terminal .PP \f[C]NEVER\f[R] never allow ANSI codes .PP \f[C]ALWAYS\f[R] always add ANSI codes, regardless of the output format (terminal or file) .SS --compare-dest=DIR .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] DIR is 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. .PP You must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. .PP See \f[C]--copy-dest\f[R] and \f[C]--backup-dir\f[R]. .SS --config=CONFIG_FILE .PP Specify the location of the rclone configuration file, to override the default. E.g. \f[C]rclone config --config=\[dq]rclone.conf\[dq]\f[R]. .PP 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: .IP \[bu] 2 \f[C]%APPDATA%/rclone/rclone.conf\f[R] on Windows .IP \[bu] 2 \f[C]\[ti]/.config/rclone/rclone.conf\f[R] on other .PP The complete logic is as follows: Rclone will look for an existing configuration file in any of the following locations, in priority order: .IP "1." 3 \f[C]rclone.conf\f[R] (in program directory, where rclone executable is) .IP "2." 3 \f[C]%APPDATA%/rclone/rclone.conf\f[R] (only on Windows) .IP "3." 3 \f[C]$XDG_CONFIG_HOME/rclone/rclone.conf\f[R] (on all systems, including Windows) .IP "4." 3 \f[C]\[ti]/.config/rclone/rclone.conf\f[R] (see below for explanation of \[ti] symbol) .IP "5." 3 \f[C]\[ti]/.rclone.conf\f[R] .PP If no existing configuration file is found, then a new one will be created in the following location: .IP \[bu] 2 On Windows: Location 2 listed above, except in the unlikely event that \f[C]APPDATA\f[R] is not defined, then location 4 is used instead. .IP \[bu] 2 On Unix: Location 3 if \f[C]XDG_CONFIG_HOME\f[R] is defined, else location 4. .IP \[bu] 2 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 \f[C].rclone.conf\f[R] relative to current working directory will be used as a final resort. .PP The \f[C]\[ti]\f[R] symbol in paths above represent the home directory of the current user on any OS, and the value is defined as following: .IP \[bu] 2 On Windows: \f[C]%HOME%\f[R] if defined, else \f[C]%USERPROFILE%\f[R], or else \f[C]%HOMEDRIVE%\[rs]%HOMEPATH%\f[R]. .IP \[bu] 2 On Unix: \f[C]$HOME\f[R] 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 \f[C]cd && pwd\f[R]. .PP If you run \f[C]rclone config file\f[R] you will see where the default location is for you. .PP The fact that an existing file \f[C]rclone.conf\f[R] in the same directory as the rclone executable is always preferred, means that it is easy to run in \[dq]portable\[dq] mode by downloading rclone executable to a writable directory and then create an empty file \f[C]rclone.conf\f[R] in the same directory. .PP If the location is set to empty string \f[C]\[dq]\[dq]\f[R] or path to a file with name \f[C]notfound\f[R], or the os null device represented by value \f[C]NUL\f[R] on Windows and \f[C]/dev/null\f[R] on Unix systems, then rclone will keep the config file in memory only. .PP The file format is basic INI (https://en.wikipedia.org/wiki/INI_file#Format): Sections of text, led by a \f[C][section]\f[R] header and followed by \f[C]key=value\f[R] 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 \f[C]key=value\f[R] entries, where the key is the option name without the \f[C]--backend-\f[R] prefix, in lowercase and with \f[C]_\f[R] instead of \f[C]-\f[R]. E.g. option \f[C]--mega-hard-delete\f[R] corresponds to key \f[C]hard_delete\f[R]. Only backend options can be specified. A special, and required, key \f[C]type\f[R] identifies the storage system (https://rclone.org/overview/), where the value is the internal lowercase name as returned by command \f[C]rclone help backends\f[R]. Comments are indicated by \f[C];\f[R] or \f[C]#\f[R] at the beginning of a line. .PP Example: .IP .nf \f[C] [megaremote] type = mega user = you\[at]example.com pass = PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH \f[R] .fi .PP 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 \f[C]rclone config\f[R] instead of manually editing the configuration file. .PP 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 the file. .PP When token-based authentication are used, the configuration file must be writable, because rclone needs to update the tokens inside it. .PP 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. .PP 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. .SS --contimeout=TIME .PP Set the connection timeout. This should be in go time format which looks like \f[C]5s\f[R] for 5 seconds, \f[C]10m\f[R] for 10 minutes, or \f[C]3h30m\f[R]. .PP 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 \f[C]1m\f[R] by default. .SS --copy-dest=DIR .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] DIR is checked in addition to the destination for files. If a file identical to the source is found that file is server-side copied from DIR to the destination. This is useful for incremental backup. .PP 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. .PP See \f[C]--compare-dest\f[R] and \f[C]--backup-dir\f[R]. .SS --dedupe-mode MODE .PP Mode to run dedupe command in. One of \f[C]interactive\f[R], \f[C]skip\f[R], \f[C]first\f[R], \f[C]newest\f[R], \f[C]oldest\f[R], \f[C]rename\f[R]. The default is \f[C]interactive\f[R]. .PD 0 .P .PD See the dedupe command for more information as to what these options mean. .SS --default-time TIME .PP If a file or directory does have a modification time rclone can read then rclone will display this fixed time instead. .PP The default is \f[C]2000-01-01 00:00:00 UTC\f[R]. This can be configured in any of the ways shown in the time or duration options. .PP For example \f[C]--default-time 2020-06-01\f[R] to set the default time to the 1st of June 2020 or \f[C]--default-time 0s\f[R] to set the default time to the time rclone started up. .SS --disable FEATURE,FEATURE,... .PP This disables a comma separated list of optional features. For example to disable server-side move and server-side copy use: .IP .nf \f[C] --disable move,copy \f[R] .fi .PP The features can be put in any case. .PP To see a list of which features can be disabled use: .IP .nf \f[C] --disable help \f[R] .fi .PP The features a remote has can be seen in JSON format with: .IP .nf \f[C] rclone backend features remote: \f[R] .fi .PP 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. .PP Note that some features can be set to \f[C]true\f[R] if they are \f[C]true\f[R]/\f[C]false\f[R] feature flag features by prefixing them with \f[C]!\f[R]. For example the \f[C]CaseInsensitive\f[R] feature can be forced to \f[C]false\f[R] with \f[C]--disable CaseInsensitive\f[R] and forced to \f[C]true\f[R] with \f[C]--disable \[aq]!CaseInsensitive\[aq]\f[R]. In general it isn\[aq]t a good idea doing this but it may be useful in extremis. .PP (Note that \f[C]!\f[R] is a shell command which you will need to escape with single quotes or a backslash on unix like platforms.) .PP 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). .SS --disable-http2 .PP 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). .SS --dscp VALUE .PP 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. .PP 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)). .PP For example, if you configured QoS on router to handle LE properly. Running: .IP .nf \f[C] rclone copy --dscp LE from:/from to:/to \f[R] .fi .PP would make the priority lower than usual internet flows. .PP This option has no effect on Windows (see golang/go#42728 (https://github.com/golang/go/issues/42728)). .SS -n, --dry-run .PP 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 \f[C]sync\f[R] command which deletes files in the destination. .SS --expect-continue-timeout=TIME .PP This specifies the amount of time to wait for a server\[aq]s first response headers after fully writing the request headers if the request has an \[dq]Expect: 100-continue\[dq] header. Not all backends support using this. .PP 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. .PP The default is \f[C]1s\f[R]. Set to \f[C]0\f[R] to disable. .SS --error-on-no-transfer .PP By default, rclone will exit with return code 0 if there were no errors. .PP 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. .PP NB: Enabling this option turns a usually non-fatal error into a potentially fatal one - please check and adjust your scripts accordingly! .SS --fix-case .PP 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 \f[C]hello.txt\f[R] to \f[C]HELLO.txt\f[R] will normally result in the dest filename remaining \f[C]HELLO.txt\f[R]. If \f[C]--fix-case\f[R] is set, then \f[C]HELLO.txt\f[R] will be renamed to \f[C]hello.txt\f[R] to match the source. .PP NB: - directory names with incorrect casing will also be fixed - \f[C]--fix-case\f[R] will be ignored if \f[C]--immutable\f[R] is set - using \f[C]--local-case-sensitive\f[R] instead is not advisable; it will cause \f[C]HELLO.txt\f[R] to get deleted! - the old dest filename must not be excluded by filters. Be especially careful with \f[C]--files-from\f[R] (https://rclone.org/filtering/#files-from-read-list-of-source-file-names), which does not respect \f[C]--ignore-case\f[R] (https://rclone.org/filtering/#ignore-case-make-searches-case-insensitive)! - on remotes that do not support server-side move, \f[C]--fix-case\f[R] will require downloading the file and re-uploading it. To avoid this, do not use \f[C]--fix-case\f[R]. .SS --fs-cache-expire-duration=TIME .PP When using rclone via the API rclone caches created remotes for 5 minutes by default in the \[dq]fs cache\[dq]. This means that if you do repeated actions on the same remote then rclone won\[aq]t have to build it again from scratch, which makes it more efficient. .PP This flag sets the time that the remotes are cached for. If you set it to \f[C]0\f[R] (or negative) then rclone won\[aq]t cache the remotes at all. .PP Note that if you use some flags, eg \f[C]--backup-dir\f[R] and if this is set to \f[C]0\f[R] rclone may build two remotes (one for the source or destination and one for the \f[C]--backup-dir\f[R] where it may have only built one before. .SS --fs-cache-expire-interval=TIME .PP This controls how often rclone checks for cached remotes to expire. See the \f[C]--fs-cache-expire-duration\f[R] documentation above for more info. The default is 60s, set to 0 to disable expiry. .SS --header .PP Add an HTTP header for all transactions. The flag can be repeated to add multiple headers. .PP If you want to add headers only for uploads use \f[C]--header-upload\f[R] and if you want to add headers only for downloads use \f[C]--header-download\f[R]. .PP This flag is supported for all HTTP based backends even those not supported by \f[C]--header-upload\f[R] and \f[C]--header-download\f[R] so may be used as a workaround for those with care. .IP .nf \f[C] rclone ls remote:test --header \[dq]X-Rclone: Foo\[dq] --header \[dq]X-LetMeIn: Yes\[dq] \f[R] .fi .SS --header-download .PP Add an HTTP header for all download transactions. The flag can be repeated to add multiple headers. .IP .nf \f[C] rclone sync --interactive s3:test/src \[ti]/dst --header-download \[dq]X-Amz-Meta-Test: Foo\[dq] --header-download \[dq]X-Amz-Meta-Test2: Bar\[dq] \f[R] .fi .PP See the GitHub issue here (https://github.com/rclone/rclone/issues/59) for currently supported backends. .SS --header-upload .PP Add an HTTP header for all upload transactions. The flag can be repeated to add multiple headers. .IP .nf \f[C] rclone sync --interactive \[ti]/src s3:test/dst --header-upload \[dq]Content-Disposition: attachment; filename=\[aq]cool.html\[aq]\[dq] --header-upload \[dq]X-Amz-Meta-Test: FooBar\[dq] \f[R] .fi .PP See the GitHub issue here (https://github.com/rclone/rclone/issues/59) for currently supported backends. .SS --human-readable .PP Rclone commands output values for sizes (e.g. number of bytes) and counts (e.g. number of files) either as \f[I]raw\f[R] numbers, or in \f[I]human-readable\f[R] format. .PP 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. \f[C]Ki\f[R] for kibi. Used with byte unit, \f[C]1 KiB\f[R] means 1024 Byte. In list type of output, only the unit prefix appended to the value (e.g. \f[C]9.762Ki\f[R]), while in more textual output the full unit is shown (e.g. \f[C]9.762 KiB\f[R]). For counts the SI standard notation is used, e.g. prefix \f[C]k\f[R] for kilo. Used with file counts, \f[C]1k\f[R] means 1000 files. .PP The various list (https://rclone.org/commands/rclone_ls/) commands output raw numbers by default. Option \f[C]--human-readable\f[R] will make them output values in human-readable format instead (with the short unit prefix). .PP The about (https://rclone.org/commands/rclone_about/) command outputs human-readable by default, with a command-specific option \f[C]--full\f[R] to output the raw numbers instead. .PP Command size (https://rclone.org/commands/rclone_size/) outputs both human-readable and raw numbers in the same output. .PP The tree (https://rclone.org/commands/rclone_tree/) command also considers \f[C]--human-readable\f[R], 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. \f[C]K\f[R] instead of \f[C]Ki\f[R]. The reason for this is that it relies on an external library. .PP The interactive command ncdu (https://rclone.org/commands/rclone_ncdu/) shows human-readable by default, and responds to key \f[C]u\f[R] for toggling human-readable format. .SS --ignore-case-sync .PP 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. .SS --ignore-checksum .PP Normally rclone will check that the checksums of transferred files match, and give an error \[dq]corrupted on transfer\[dq] if they don\[aq]t. .PP You can use this option to skip that check. You should only use it if you have had the \[dq]corrupted on transfer\[dq] error message and you are sure you might want to transfer potentially corrupted data. .SS --ignore-existing .PP Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files. .PP While this isn\[aq]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. .PP When performing a \f[C]move\f[R]/\f[C]moveto\f[R] command, this flag will leave skipped files in the source location unchanged when a file with the same name exists on the destination. .SS --ignore-size .PP 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 \f[C]--checksum\f[R] is set then it only checks the checksum. .PP It will also cause rclone to skip verifying the sizes are the same after transfer. .PP 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). .SS -I, --ignore-times .PP Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination. .PP Normally rclone would skip any files that have the same modification time and are the same size (or have the same checksum if using \f[C]--checksum\f[R]). .SS --immutable .PP Treat source and destination files as immutable and disallow modification. .PP 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 \f[C]Source and destination exist but do not match: immutable file modified\f[R]. .PP Note that only commands which transfer files (e.g. \f[C]sync\f[R], \f[C]copy\f[R], \f[C]move\f[R]) are affected by this behavior, and only modification is disallowed. Files may still be deleted explicitly (e.g. \f[C]delete\f[R], \f[C]purge\f[R]) or implicitly (e.g. \f[C]sync\f[R], \f[C]move\f[R]). Use \f[C]copy --immutable\f[R] if it is desired to avoid deletion as well as modification. .PP 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. .SS --inplace .PP The \f[C]--inplace\f[R] flag changes the behaviour of rclone when uploading files to some backends (backends with the \f[C]PartialUploads\f[R] feature flag set) such as: .IP \[bu] 2 local .IP \[bu] 2 ftp .IP \[bu] 2 sftp .IP \[bu] 2 pcloud .PP Without \f[C]--inplace\f[R] (the default) rclone will first upload to a temporary file with an extension like this, where \f[C]XXXXXX\f[R] represents a hash of the source file\[aq]s fingerprint and \f[C].partial\f[R] is --partial-suffix value (\f[C].partial\f[R] by default). .IP .nf \f[C] original-file-name.XXXXXX.partial \f[R] .fi .PP (rclone will make sure the final name is no longer than 100 characters by truncating the \f[C]original-file-name\f[R] part if necessary). .PP When the upload is complete, rclone will rename the \f[C].partial\f[R] file to the correct name, overwriting any existing file at that point. If the upload fails then the \f[C].partial\f[R] file will be deleted. .PP 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. .PP If the \f[C]--inplace\f[R] flag is supplied, rclone will upload directly to the final name without creating a \f[C].partial\f[R] file. .PP 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. .PP Note that on the local file system if you don\[aq]t use \f[C]--inplace\f[R] hard links (Unix only) will be broken. And if you do use \f[C]--inplace\f[R] you won\[aq]t be able to update in use executables. .PP Note also that versions of rclone prior to v1.63.0 behave as if the \f[C]--inplace\f[R] flag is always supplied. .SS -i, --interactive .PP This flag can be used to tell rclone that you wish a manual confirmation before destructive operations. .PP It is \f[B]recommended\f[R] that you use this flag while learning rclone especially with \f[C]rclone sync\f[R]. .PP For example .IP .nf \f[C] $ rclone delete --interactive /tmp/dir rclone: delete \[dq]important-file.txt\[dq]? 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 \f[R] .fi .PP The options mean .IP \[bu] 2 \f[C]y\f[R]: \f[B]Yes\f[R], this operation should go ahead. You can also press Return for this to happen. You\[aq]ll be asked every time unless you choose \f[C]s\f[R] or \f[C]!\f[R]. .IP \[bu] 2 \f[C]n\f[R]: \f[B]No\f[R], do not do this operation. You\[aq]ll be asked every time unless you choose \f[C]s\f[R] or \f[C]!\f[R]. .IP \[bu] 2 \f[C]s\f[R]: \f[B]Skip\f[R] 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\[aq]ll be prompted for them. .IP \[bu] 2 \f[C]!\f[R]: \f[B]Do all\f[R] the following operations with no more questions. Useful if you\[aq]ve decided that you don\[aq]t mind rclone doing that kind of operation. This takes effect until rclone exits . If there are any different kind of operations you\[aq]ll be prompted for them. .IP \[bu] 2 \f[C]q\f[R]: \f[B]Quit\f[R] rclone now, just in case! .SS --leave-root .PP During rmdirs it will not remove root directory, even if it\[aq]s empty. .SS --links / -l .PP Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows). .PP If you supply this flag then rclone will copy symbolic links from any supported backend backend, and store them as text files, with a \f[C].rclonelink\f[R] suffix in the destination. .PP The text file will contain the target of the symbolic link. .PP The \f[C]--links\f[R] / \f[C]-l\f[R] flag enables this feature for all supported backends and the VFS. There are individual flags for just enabling it for the VFS \f[C]--vfs-links\f[R] and the local backend \f[C]--local-links\f[R] if required. .SS --log-file=FILE .PP Log all of rclone\[aq]s output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the \f[C]-v\f[R] flag. See the Logging section for more info. .PP If FILE exists then rclone will append to it. .PP Note that if you are using the \f[C]logrotate\f[R] program to manage rclone\[aq]s logs, then you should use the \f[C]copytruncate\f[R] option as rclone doesn\[aq]t have a signal to rotate logs. .SS --log-format LIST .PP Comma separated list of log format options. Accepted options are \f[C]date\f[R], \f[C]time\f[R], \f[C]microseconds\f[R], \f[C]pid\f[R], \f[C]longfile\f[R], \f[C]shortfile\f[R], \f[C]UTC\f[R]. Any other keywords will be silently ignored. \f[C]pid\f[R] will tag log messages with process identifier which useful with \f[C]rclone mount --daemon\f[R]. Other accepted options are explained in the go documentation (https://pkg.go.dev/log#pkg-constants). The default log format is \[dq]\f[C]date\f[R],\f[C]time\f[R]\[dq]. .SS --log-level LEVEL .PP This sets the log level for rclone. The default log level is \f[C]NOTICE\f[R]. .PP \f[C]DEBUG\f[R] is equivalent to \f[C]-vv\f[R]. It outputs lots of debug info - useful for bug reports and really finding out what rclone is doing. .PP \f[C]INFO\f[R] is equivalent to \f[C]-v\f[R]. It outputs information about each transfer and prints stats once a minute by default. .PP \f[C]NOTICE\f[R] 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. .PP \f[C]ERROR\f[R] is equivalent to \f[C]-q\f[R]. It only outputs error messages. .SS --use-json-log .PP This switches the log format to JSON for rclone. The fields of json log are level, msg, source, time. .SS --low-level-retries NUMBER .PP This controls the number of low level retries rclone does. .PP 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 \f[C]-v\f[R] flag. .PP This shouldn\[aq]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 \f[C]--retries\f[R] flag) quicker. .PP Disable low level retries with \f[C]--low-level-retries 1\f[R]. .SS --max-backlog=N .PP This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred. .PP 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. .PP Setting this large allows rclone to calculate how many files are pending more accurately, give a more accurate estimated finish time and make \f[C]--order-by\f[R] work more accurately. .PP Setting this small will make rclone more synchronous to the listings of the remote which may be desirable. .PP Setting this to a negative number will make the backlog as large as possible. .SS --max-delete=N .PP 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. .SS --max-delete-size=SIZE .PP Rclone will stop deleting files when the total size of deletions has reached the size specified. It defaults to off. .PP If that limit is exceeded then a fatal error will be generated and rclone will stop the operation in progress. .SS --max-depth=N .PP This modifies the recursion depth for all the commands except purge. .PP So if you do \f[C]rclone --max-depth 1 ls remote:path\f[R] you will see only the files in the top level directory. Using \f[C]--max-depth 2\f[R] means you will see all the files in first two directory levels and so on. .PP For historical reasons the \f[C]lsd\f[R] command defaults to using a \f[C]--max-depth\f[R] of 1 - you can override this with the command line flag. .PP You can use this command to disable recursion (with \f[C]--max-depth 1\f[R]). .PP Note that if you use this with \f[C]sync\f[R] and \f[C]--delete-excluded\f[R] the files not recursed through are considered excluded and will be deleted on the destination. Test first with \f[C]--dry-run\f[R] if you are not sure what will happen. .SS --max-duration=TIME .PP Rclone will stop transferring when it has run for the duration specified. Defaults to off. .PP When the limit is reached all transfers will stop immediately. Use \f[C]--cutoff-mode\f[R] to modify this behaviour. .PP Rclone will exit with exit code 10 if the duration limit is reached. .SS --max-transfer=SIZE .PP Rclone will stop transferring when it has reached the size specified. Defaults to off. .PP When the limit is reached all transfers will stop immediately. Use \f[C]--cutoff-mode\f[R] to modify this behaviour. .PP Rclone will exit with exit code 8 if the transfer limit is reached. .SS --cutoff-mode=hard|soft|cautious .PP This modifies the behavior of \f[C]--max-transfer\f[R] and \f[C]--max-duration\f[R] Defaults to \f[C]--cutoff-mode=hard\f[R]. .PP Specifying \f[C]--cutoff-mode=hard\f[R] will stop transferring immediately when Rclone reaches the limit. .PP Specifying \f[C]--cutoff-mode=soft\f[R] will stop starting new transfers when Rclone reaches the limit. .PP Specifying \f[C]--cutoff-mode=cautious\f[R] will try to prevent Rclone from reaching the limit. Only applicable for \f[C]--max-transfer\f[R] .SS -M, --metadata .PP 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 for more info. .SS --metadata-mapper SpaceSepList .PP If you supply the parameter \f[C]--metadata-mapper /path/to/program\f[R] then rclone will use that program to map metadata from source object to destination object. .PP 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 \f[C]\[dq]\f[R], if you want a literal \f[C]\[dq]\f[R] in an argument then enclose the argument in \f[C]\[dq]\f[R] and double the \f[C]\[dq]\f[R]. See CSV encoding (https://godoc.org/encoding/csv) for more info. .IP .nf \f[C] --metadata-mapper \[dq]python bin/test_metadata_mapper.py\[dq] --metadata-mapper \[aq]python bin/test_metadata_mapper.py \[dq]argument with a space\[dq]\[aq] --metadata-mapper \[aq]python bin/test_metadata_mapper.py \[dq]argument with \[dq]\[dq]two\[dq]\[dq] quotes\[dq]\[aq] \f[R] .fi .PP 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. .PP The program\[aq]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. .PP Input to the program (via STDIN) might look like this. This provides some context for the \f[C]Metadata\f[R] which may be important. .IP \[bu] 2 \f[C]SrcFs\f[R] is the config string for the remote that the object is currently on. .IP \[bu] 2 \f[C]SrcFsType\f[R] is the name of the source backend. .IP \[bu] 2 \f[C]DstFs\f[R] is the config string for the remote that the object is being copied to .IP \[bu] 2 \f[C]DstFsType\f[R] is the name of the destination backend. .IP \[bu] 2 \f[C]Remote\f[R] is the path of the object relative to the root. .IP \[bu] 2 \f[C]Size\f[R], \f[C]MimeType\f[R], \f[C]ModTime\f[R] are attributes of the object. .IP \[bu] 2 \f[C]IsDir\f[R] is \f[C]true\f[R] if this is a directory (not yet implemented). .IP \[bu] 2 \f[C]ID\f[R] is the source \f[C]ID\f[R] of the object if known. .IP \[bu] 2 \f[C]Metadata\f[R] is the backend specific metadata as described in the backend docs. .IP .nf \f[C] { \[dq]SrcFs\[dq]: \[dq]gdrive:\[dq], \[dq]SrcFsType\[dq]: \[dq]drive\[dq], \[dq]DstFs\[dq]: \[dq]newdrive:user\[dq], \[dq]DstFsType\[dq]: \[dq]onedrive\[dq], \[dq]Remote\[dq]: \[dq]test.txt\[dq], \[dq]Size\[dq]: 6, \[dq]MimeType\[dq]: \[dq]text/plain; charset=utf-8\[dq], \[dq]ModTime\[dq]: \[dq]2022-10-11T17:53:10.286745272+01:00\[dq], \[dq]IsDir\[dq]: false, \[dq]ID\[dq]: \[dq]xyz\[dq], \[dq]Metadata\[dq]: { \[dq]btime\[dq]: \[dq]2022-10-11T16:53:11Z\[dq], \[dq]content-type\[dq]: \[dq]text/plain; charset=utf-8\[dq], \[dq]mtime\[dq]: \[dq]2022-10-11T17:53:10.286745272+01:00\[dq], \[dq]owner\[dq]: \[dq]user1\[at]domain1.com\[dq], \[dq]permissions\[dq]: \[dq]...\[dq], \[dq]description\[dq]: \[dq]my nice file\[dq], \[dq]starred\[dq]: \[dq]false\[dq] } } \f[R] .fi .PP The program should then modify the input as desired and send it to STDOUT. The returned \f[C]Metadata\f[R] 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: .IP .nf \f[C] { \[dq]Metadata\[dq]: { \[dq]btime\[dq]: \[dq]2022-10-11T16:53:11Z\[dq], \[dq]content-type\[dq]: \[dq]text/plain; charset=utf-8\[dq], \[dq]mtime\[dq]: \[dq]2022-10-11T17:53:10.286745272+01:00\[dq], \[dq]owner\[dq]: \[dq]user1\[at]domain2.com\[dq], \[dq]permissions\[dq]: \[dq]...\[dq], \[dq]description\[dq]: \[dq]my nice file [migrated from domain1]\[dq], \[dq]starred\[dq]: \[dq]false\[dq] } } \f[R] .fi .PP Metadata can be removed here too. .PP An example python program might look something like this to implement the above transformations. .IP .nf \f[C] import sys, json i = json.load(sys.stdin) metadata = i[\[dq]Metadata\[dq]] # Add tag to description if \[dq]description\[dq] in metadata: metadata[\[dq]description\[dq]] += \[dq] [migrated from domain1]\[dq] else: metadata[\[dq]description\[dq]] = \[dq][migrated from domain1]\[dq] # Modify owner if \[dq]owner\[dq] in metadata: metadata[\[dq]owner\[dq]] = metadata[\[dq]owner\[dq]].replace(\[dq]domain1.com\[dq], \[dq]domain2.com\[dq]) o = { \[dq]Metadata\[dq]: metadata } json.dump(o, sys.stdout, indent=\[dq]\[rs]t\[dq]) \f[R] .fi .PP 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). .PP If you want to see the input to the metadata mapper and the output returned from it in the log you can use \f[C]-vv --dump mapper\f[R]. .PP See the metadata section for more info. .SS --metadata-set key=value .PP Add metadata \f[C]key\f[R] = \f[C]value\f[R] when uploading. This can be repeated as many times as required. See the metadata section for more info. .SS --modify-window=TIME .PP 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. .PP The default is \f[C]1ns\f[R] 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 \f[C]1s\f[R] by default. .PP This command line flag allows you to override that computed default. .SS --multi-thread-write-buffer-size=SIZE .PP When transferring with multiple threads, rclone will buffer SIZE bytes in memory before writing to disk for each thread. .PP 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. .PP Nevertheless, the default of \f[C]128k\f[R] should be fine for almost all use cases, so before changing it ensure that network is not really your bottleneck. .PP 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. .SS --multi-thread-chunk-size=SizeSuffix .PP Normally the chunk size for multi thread transfers is set by the backend. However some backends such as \f[C]local\f[R] and \f[C]smb\f[R] (which implement \f[C]OpenWriterAt\f[R] but not \f[C]OpenChunkWriter\f[R]) don\[aq]t have a natural chunk size. .PP In this case the value of this option is used (default 64Mi). .SS --multi-thread-cutoff=SIZE .PP When transferring files above SIZE to capable backends, rclone will use multiple threads to transfer the file (default 256M). .PP Capable backends are marked in the overview (https://rclone.org/overview/#optional-features) as \f[C]MultithreadUpload\f[R]. (They need to implement either the \f[C]OpenWriterAt\f[R] or \f[C]OpenChunkWriter\f[R] internal interfaces). These include include, \f[C]local\f[R], \f[C]s3\f[R], \f[C]azureblob\f[R], \f[C]b2\f[R], \f[C]oracleobjectstorage\f[R] and \f[C]smb\f[R] at the time of writing. .PP On the local disk, rclone preallocates the file (using \f[C]fallocate(FALLOC_FL_KEEP_SIZE)\f[R] on unix or \f[C]NTSetInformationFile\f[R] 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\[aq]t create fragmented or sparse files and there won\[aq]t be any assembly time at the end of the transfer. .PP The number of threads used to transfer is controlled by \f[C]--multi-thread-streams\f[R]. .PP Use \f[C]-vv\f[R] if you wish to see info about the threads. .PP This will work with the \f[C]sync\f[R]/\f[C]copy\f[R]/\f[C]move\f[R] commands and friends \f[C]copyto\f[R]/\f[C]moveto\f[R]. Multi thread transfers will be used with \f[C]rclone mount\f[R] and \f[C]rclone serve\f[R] if \f[C]--vfs-cache-mode\f[R] is set to \f[C]writes\f[R] or above. .PP \f[B]NB\f[R] that this \f[B]only\f[R] works with supported backends as the destination but will work with any backend as the source. .PP \f[B]NB\f[R] that multi-thread copies are disabled for local to local copies as they are faster without unless \f[C]--multi-thread-streams\f[R] is set explicitly. .PP \f[B]NB\f[R] 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 \f[C]--local-no-sparse\f[R] to disable sparse files (which may cause long delays at the start of transfers) or disable multi-thread transfers with \f[C]--multi-thread-streams 0\f[R] .SS --multi-thread-streams=N .PP When using multi thread transfers (see above \f[C]--multi-thread-cutoff\f[R]) this sets the number of streams to use. Set to \f[C]0\f[R] to disable multi thread transfers (Default 4). .PP If the backend has a \f[C]--backend-upload-concurrency\f[R] setting (eg \f[C]--s3-upload-concurrency\f[R]) then this setting will be used as the number of transfers instead if it is larger than the value of \f[C]--multi-thread-streams\f[R] or \f[C]--multi-thread-streams\f[R] isn\[aq]t set. .SS --no-check-dest .PP The \f[C]--no-check-dest\f[R] can be used with \f[C]move\f[R] or \f[C]copy\f[R] and it causes rclone not to check the destination at all when copying files. .PP This means that: .IP \[bu] 2 the destination is not listed minimising the API calls .IP \[bu] 2 files are always transferred .IP \[bu] 2 this can cause duplicates on remotes which allow it (e.g. Google Drive) .IP \[bu] 2 \f[C]--retries 1\f[R] is recommended otherwise you\[aq]ll transfer everything again on a retry .PP This flag is useful to minimise the transactions if you know that none of the files are on the destination. .PP This is a specialized flag which should be ignored by most users! .SS --no-gzip-encoding .PP Don\[aq]t set \f[C]Accept-Encoding: gzip\f[R]. This means that rclone won\[aq]t ask the server for compressed files automatically. Useful if you\[aq]ve set the server to return files with \f[C]Content-Encoding: gzip\f[R] but you uploaded compressed files. .PP There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone. .SS --no-traverse .PP The \f[C]--no-traverse\f[R] flag controls whether the destination file system is traversed when using the \f[C]copy\f[R] or \f[C]move\f[R] commands. \f[C]--no-traverse\f[R] is not compatible with \f[C]sync\f[R] and will be ignored if you supply it with \f[C]sync\f[R]. .PP 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 \f[C]--no-traverse\f[R] will stop rclone listing the destination and save time. .PP 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\[aq]t changed and won\[aq]t need copying then you shouldn\[aq]t use \f[C]--no-traverse\f[R]. .PP See rclone copy (https://rclone.org/commands/rclone_copy/) for an example of how to use it. .SS --no-unicode-normalization .PP Don\[aq]t normalize unicode characters in filenames during the sync routine. .PP 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. .PP Using this flag will disable that functionality, treating each unicode character as unique. For example, by default e\[u0301] and \['e] will be normalized into the same character. With \f[C]--no-unicode-normalization\f[R] they will be treated as unique characters. .SS --no-update-modtime .PP When using this flag, rclone won\[aq]t update modification times of remote files if they are incorrect as it would normally. .PP This can be used if the remote is being synced with another tool also (e.g. the Google Drive client). .SS --no-update-dir-modtime .PP When using this flag, rclone won\[aq]t update modification times of remote directories if they are incorrect as it would normally. .SS --order-by string .PP The \f[C]--order-by\f[R] flag controls the order in which files in the backlog are processed in \f[C]rclone sync\f[R], \f[C]rclone copy\f[R] and \f[C]rclone move\f[R]. .PP The order by string is constructed like this. The first part describes what aspect is being measured: .IP \[bu] 2 \f[C]size\f[R] - order by the size of the files .IP \[bu] 2 \f[C]name\f[R] - order by the full path of the files .IP \[bu] 2 \f[C]modtime\f[R] - order by the modification date of the files .PP This can have a modifier appended with a comma: .IP \[bu] 2 \f[C]ascending\f[R] or \f[C]asc\f[R] - order so that the smallest (or oldest) is processed first .IP \[bu] 2 \f[C]descending\f[R] or \f[C]desc\f[R] - order so that the largest (or newest) is processed first .IP \[bu] 2 \f[C]mixed\f[R] - order so that the smallest is processed first for some threads and the largest for others .PP If the modifier is \f[C]mixed\f[R] then it can have an optional percentage (which defaults to \f[C]50\f[R]), e.g. \f[C]size,mixed,25\f[R] 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 \f[C]mixed\f[R] 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. .PP If no modifier is supplied then the order is \f[C]ascending\f[R]. .PP For example .IP \[bu] 2 \f[C]--order-by size,desc\f[R] - send the largest files first .IP \[bu] 2 \f[C]--order-by modtime,ascending\f[R] - send the oldest files first .IP \[bu] 2 \f[C]--order-by name\f[R] - send the files with alphabetically by path first .PP If the \f[C]--order-by\f[R] flag is not supplied or it is supplied with an empty string then the default ordering will be used which is as scanned. With \f[C]--checkers 1\f[R] this is mostly alphabetical, however with the default \f[C]--checkers 8\f[R] it is somewhat random. .SS Limitations .PP The \f[C]--order-by\f[R] flag does not do a separate pass over the data. This means that it may transfer some files out of the order specified if .IP \[bu] 2 there are no files in the backlog or the source has not been fully scanned yet .IP \[bu] 2 there are more than --max-backlog files in the backlog .PP Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of \f[C]--order-by\f[R] as being more of a best efforts flag rather than a perfect ordering. .PP If you want perfect ordering then you will need to specify --check-first which will find all the files which need transferring first before transferring any. .SS --partial-suffix .PP When --inplace is not used, it causes rclone to use the \f[C]--partial-suffix\f[R] as suffix for temporary files. .PP Suffix length limit is 16 characters. .PP The default is \f[C].partial\f[R]. .SS --password-command SpaceSepList .PP 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 \f[C]RCLONE_CONFIG_PASS\f[R] variable. It is also used when setting the config password for the first time. .PP 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 \f[C]\[dq]\f[R], if you want a literal \f[C]\[dq]\f[R] in an argument then enclose the argument in \f[C]\[dq]\f[R] and double the \f[C]\[dq]\f[R]. See CSV encoding (https://godoc.org/encoding/csv) for more info. .PP Eg .IP .nf \f[C] --password-command \[dq]echo hello\[dq] --password-command \[aq]echo \[dq]hello with space\[dq]\[aq] --password-command \[aq]echo \[dq]hello with \[dq]\[dq]quotes\[dq]\[dq] and space\[dq]\[aq] \f[R] .fi .PP Note that when changing the configuration password the environment variable \f[C]RCLONE_PASSWORD_CHANGE=1\f[R] will be set. This can be used to distinguish initial decryption of the config file from the new password. .PP See the Configuration Encryption for more info. .PP See a Windows PowerShell example on the Wiki (https://github.com/rclone/rclone/wiki/Windows-Powershell-use-rclone-password-command-for-Config-file-password). .SS -P, --progress .PP This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer. .PP 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. .PP Normally this is updated every 500mS but this period can be overridden with the \f[C]--stats\f[R] flag. .PP This can be used with the \f[C]--stats-one-line\f[R] flag for a simpler display. .PP To change the display length of filenames (for different terminal widths), see the \f[C]--stats-file-name-length\f[R] option. The default output is formatted for 80 character wide terminals. .PP Note: On Windows until this bug (https://github.com/Azure/go-ansiterm/issues/26) is fixed all non-ASCII characters will be replaced with \f[C].\f[R] when \f[C]--progress\f[R] is in use. .SS --progress-terminal-title .PP This flag, when used with \f[C]-P/--progress\f[R], will print the string \f[C]ETA: %s\f[R] to the terminal title. .SS -q, --quiet .PP This flag will limit rclone\[aq]s output to error messages only. .SS --refresh-times .PP The \f[C]--refresh-times\f[R] flag can be used to update modification times of existing files when they are out of sync on backends which don\[aq]t support hashes. .PP This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them. .PP This flag is \f[B]only\f[R] useful for destinations which don\[aq]t support hashes (e.g. \f[C]crypt\f[R]). .PP This can be used any of the sync commands \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R]. .PP To use this flag you will need to be doing a modification time sync (so not using \f[C]--size-only\f[R] or \f[C]--checksum\f[R]). The flag will have no effect when using \f[C]--size-only\f[R] or \f[C]--checksum\f[R]. .PP 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 \f[C]crypt\f[R] backend) then rclone will update the timestamp. .PP Note that some remotes can\[aq]t set the modification time without re-uploading the file so this flag is less useful on them. .PP Normally if you are doing a modification time sync rclone will update modification times without \f[C]--refresh-times\f[R] provided that the remote supports checksums \f[B]and\f[R] 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. .SS --retries int .PP Retry the entire sync if it fails this many times it fails (default 3). .PP Some remotes can be unreliable and a few retries help pick up the files which didn\[aq]t get transferred because of errors. .PP Disable retries with \f[C]--retries 1\f[R]. .SS --retries-sleep=TIME .PP This sets the interval between each retry specified by \f[C]--retries\f[R] .PP The default is \f[C]0\f[R]. Use \f[C]0\f[R] to disable. .SS --server-side-across-configs .PP Allow server-side operations (e.g. copy or move) to work across different configurations. .PP 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. .PP Note that this isn\[aq]t enabled by default because it isn\[aq]t easy for rclone to tell if it will work between any two configurations. .SS --size-only .PP 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. .PP This can be useful transferring files from Dropbox which have been modified by the desktop sync client which doesn\[aq]t set checksums of modification times in the same way as rclone. .SS --stats=TIME .PP Commands which transfer data (\f[C]sync\f[R], \f[C]copy\f[R], \f[C]copyto\f[R], \f[C]move\f[R], \f[C]moveto\f[R]) will print data transfer stats at regular intervals to show their progress. .PP This sets the interval. .PP The default is \f[C]1m\f[R]. Use \f[C]0\f[R] to disable. .PP If you set the stats interval then all commands can show stats. This can be useful when running other commands, \f[C]check\f[R] or \f[C]mount\f[R] for example. .PP Stats are logged at \f[C]INFO\f[R] level by default which means they won\[aq]t show at default log level \f[C]NOTICE\f[R]. Use \f[C]--stats-log-level NOTICE\f[R] or \f[C]-v\f[R] to make them show. See the Logging section for more info on log levels. .PP Note that on macOS you can send a SIGINFO (which is normally ctrl-T in the terminal) to make the stats print immediately. .SS --stats-file-name-length integer .PP By default, the \f[C]--stats\f[R] output will truncate file names and paths longer than 40 characters. This is equivalent to providing \f[C]--stats-file-name-length 40\f[R]. Use \f[C]--stats-file-name-length 0\f[R] to disable any truncation of file names printed by stats. .SS --stats-log-level string .PP Log level to show \f[C]--stats\f[R] output at. This can be \f[C]DEBUG\f[R], \f[C]INFO\f[R], \f[C]NOTICE\f[R], or \f[C]ERROR\f[R]. The default is \f[C]INFO\f[R]. This means at the default level of logging which is \f[C]NOTICE\f[R] the stats won\[aq]t show - if you want them to then use \f[C]--stats-log-level NOTICE\f[R]. See the Logging section for more info on log levels. .SS --stats-one-line .PP When this is specified, rclone condenses the stats into a single line showing the most important stats only. .SS --stats-one-line-date .PP When this is specified, rclone enables the single-line stats and prepends the display with a date string. The default is \f[C]2006/01/02 15:04:05 -\f[R] .SS --stats-one-line-date-format .PP 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. .SS --stats-unit=bits|bytes .PP By default, data transfer rates will be printed in bytes per second. .PP This option allows the data rate to be printed in bits per second. .PP Data transfer volume will still be reported in bytes. .PP 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. .PP The default is \f[C]bytes\f[R]. .SS --suffix=SUFFIX .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] 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. .PP The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. .PP This is for use with files to add the suffix in the current directory or with \f[C]--backup-dir\f[R]. See \f[C]--backup-dir\f[R] for more info. .PP For example .IP .nf \f[C] rclone copy --interactive /path/to/local/file remote:current --suffix .bak \f[R] .fi .PP will copy \f[C]/path/to/local\f[R] to \f[C]remote:current\f[R], but for any files which would have been updated or deleted have .bak added. .PP If using \f[C]rclone sync\f[R] with \f[C]--suffix\f[R] and without \f[C]--backup-dir\f[R] then it is recommended to put a filter rule in excluding the suffix otherwise the \f[C]sync\f[R] will delete the backup files. .IP .nf \f[C] rclone sync --interactive /path/to/local/file remote:current --suffix .bak --exclude \[dq]*.bak\[dq] \f[R] .fi .SS --suffix-keep-extension .PP When using \f[C]--suffix\f[R], setting this causes rclone put the SUFFIX before the extension of the files that it backs up rather than after. .PP So let\[aq]s say we had \f[C]--suffix -2019-01-01\f[R], without the flag \f[C]file.txt\f[R] would be backed up to \f[C]file.txt-2019-01-01\f[R] and with the flag it would be backed up to \f[C]file-2019-01-01.txt\f[R]. This can be helpful to make sure the suffixed files can still be opened. .PP 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 \f[C]file.tar.gz\f[R] would be backed up to \f[C]file-2019-01-01.tar.gz\f[R] whereas \f[C]file.badextension.gz\f[R] would be backed up to \f[C]file.badextension-2019-01-01.gz\f[R]. .SS --syslog .PP On capable OSes (not Windows or Plan9) send all log output to syslog. .PP This can be useful for running rclone in a script or \f[C]rclone mount\f[R]. .SS --syslog-facility string .PP If using \f[C]--syslog\f[R] this sets the syslog facility (e.g. \f[C]KERN\f[R], \f[C]USER\f[R]). See \f[C]man syslog\f[R] for a list of possible facilities. The default facility is \f[C]DAEMON\f[R]. .SS --temp-dir=DIR .PP Specify the directory rclone will use for temporary files, to override the default. Make sure the directory exists and have accessible permissions. .PP By default the operating system\[aq]s temp directory will be used: - On Unix systems, \f[C]$TMPDIR\f[R] if non-empty, else \f[C]/tmp\f[R]. - On Windows, the first non-empty value from \f[C]%TMP%\f[R], \f[C]%TEMP%\f[R], \f[C]%USERPROFILE%\f[R], or the Windows directory. .PP When overriding the default with this option, the specified path will be set as value of environment variable \f[C]TMPDIR\f[R] on Unix systems and \f[C]TMP\f[R] and \f[C]TEMP\f[R] on Windows. .PP You can use the config paths (https://rclone.org/commands/rclone_config_paths/) command to see the current value. .SS --tpslimit float .PP Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second. .PP 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. .PP For example, to limit rclone to 10 transactions per second use \f[C]--tpslimit 10\f[R], or to 1 transaction every 2 seconds use \f[C]--tpslimit 0.5\f[R]. .PP 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). .PP This can be very useful for \f[C]rclone mount\f[R] to control the behaviour of applications using it. .PP 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. .PP See also \f[C]--tpslimit-burst\f[R]. .SS --tpslimit-burst int .PP Max burst of transactions for \f[C]--tpslimit\f[R] (default \f[C]1\f[R]). .PP Normally \f[C]--tpslimit\f[R] will do exactly the number of transaction per second specified. However if you supply \f[C]--tps-burst\f[R] then rclone can save up some transactions from when it was idle giving a burst of up to the parameter supplied. .PP For example if you provide \f[C]--tpslimit-burst 10\f[R] then if rclone has been idle for more than 10*\f[C]--tpslimit\f[R] then it can do 10 transactions very quickly before they are limited again. .PP This may be used to increase performance of \f[C]--tpslimit\f[R] without changing the long term average number of transactions per second. .SS --track-renames .PP By default, rclone doesn\[aq]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. .PP An rclone sync with \f[C]--track-renames\f[R] 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. .PP After the sync, rclone matches up the source only and destination only objects using the \f[C]--track-renames-strategy\f[R] specified and either renames the destination object or transfers the source and deletes the destination object. \f[C]--track-renames\f[R] is stateless like all of rclone\[aq]s syncs. .PP To use this flag the destination must support server-side copy or server-side move, and to use a hash based \f[C]--track-renames-strategy\f[R] (the default) the source and the destination must have a compatible hash. .PP 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. .PP Encrypted destinations are not currently supported by \f[C]--track-renames\f[R] if \f[C]--track-renames-strategy\f[R] includes \f[C]hash\f[R]. .PP Note that \f[C]--track-renames\f[R] is incompatible with \f[C]--no-traverse\f[R] and that it uses extra memory to keep track of all the rename candidates. .PP Note also that \f[C]--track-renames\f[R] is incompatible with \f[C]--delete-before\f[R] and will select \f[C]--delete-after\f[R] instead of \f[C]--delete-during\f[R]. .SS --track-renames-strategy (hash,modtime,leaf,size) .PP This option changes the file matching criteria for \f[C]--track-renames\f[R]. .PP The matching is controlled by a comma separated selection of these tokens: .IP \[bu] 2 \f[C]modtime\f[R] - the modification time of the file - not supported on all backends .IP \[bu] 2 \f[C]hash\f[R] - the hash of the file contents - not supported on all backends .IP \[bu] 2 \f[C]leaf\f[R] - the name of the file not including its directory name .IP \[bu] 2 \f[C]size\f[R] - the size of the file (this is always enabled) .PP The default option is \f[C]hash\f[R]. .PP Using \f[C]--track-renames-strategy modtime,leaf\f[R] would match files based on modification time, the leaf of the file name and the size only. .PP Using \f[C]--track-renames-strategy modtime\f[R] or \f[C]leaf\f[R] can enable \f[C]--track-renames\f[R] support for encrypted destinations. .PP Note that the \f[C]hash\f[R] strategy is not supported with encrypted destinations. .SS --delete-(before,during,after) .PP This option allows you to specify when files on your destination are deleted when you sync folders. .PP Specifying the value \f[C]--delete-before\f[R] will delete all files present on the destination, but not on the source \f[I]before\f[R] 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. .PP Specifying \f[C]--delete-during\f[R] will delete files while checking and uploading files. This is the fastest option and uses the least memory. .PP Specifying \f[C]--delete-after\f[R] (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 \f[C]not deleting files as there were IO errors\f[R]. .SS --fast-list .PP When doing anything which involves a directory listing (e.g. \f[C]sync\f[R], \f[C]copy\f[R], \f[C]ls\f[R] - in fact nearly every command), rclone has different strategies to choose from. .PP 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 \f[C]List\f[R], 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. .PP 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 \f[C]ListR\f[R] (https://rclone.org/overview/#listr). You can see in the storage system overview documentation\[aq]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\[aq]t be parallelized) depending on different parameters, and may require more memory if rclone has to keep the whole listing in memory. .PP Which listing strategy rclone picks for a given operation is complicated, but in general it tries to choose the best possible. It will prefer \f[C]ListR\f[R] in situations where it doesn\[aq]t need to store the listed files in memory, e.g. for unlimited recursive \f[C]ls\f[R] command variants. In other situations it will prefer \f[C]List\f[R], e.g. for \f[C]sync\f[R] and \f[C]copy\f[R], where it needs to keep the listed files in memory, and is performing operations on them where parallelization may be a huge advantage. .PP 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 \f[C]ListR\f[R] by disabling the feature, using the --disable option (\f[C]--disable ListR\f[R]), or you can allow rclone to use \f[C]ListR\f[R] where it would normally choose not to do so due to higher memory usage, using the \f[C]--fast-list\f[R] option. Rclone should always produce identical results either way. Using \f[C]--disable ListR\f[R] or \f[C]--fast-list\f[R] on a remote which doesn\[aq]t support \f[C]ListR\f[R] does nothing, rclone will just ignore it. .PP A rule of thumb is that if you pay for transactions and can fit your entire sync listing into memory, then \f[C]--fast-list\f[R] is recommended. If you have a very big sync to do, then don\[aq]t use \f[C]--fast-list\f[R], 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 \f[C]--fast-list\f[R]. .SS --timeout=TIME .PP This sets the IO idle timeout. If a transfer has started but then becomes idle for this long it is considered broken and disconnected. .PP The default is \f[C]5m\f[R]. Set to \f[C]0\f[R] to disable. .SS --transfers=N .PP 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. .PP The default is to run 4 file transfers in parallel. .PP Look at --multi-thread-streams if you would like to control single file transfers. .SS -u, --update .PP This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. .PP This can be useful in avoiding needless transfers when transferring to a remote which doesn\[aq]t support modification times directly (or when using \f[C]--use-server-modtime\f[R] to avoid extra API calls) as it is more accurate than a \f[C]--size-only\f[R] check and faster than using \f[C]--checksum\f[R]. On such remotes (or when using \f[C]--use-server-modtime\f[R]) the time checked will be the uploaded time. .PP If an existing destination file has a modification time older than the source file\[aq]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. .PP If an existing destination file has a modification time equal (within the computed modify window) to the source file\[aq]s, it will be updated if the sizes are different. The checksum will not be checked in this case unless the \f[C]--checksum\f[R] flag is provided. .PP In all other cases the file will not be updated. .PP Consider using the \f[C]--modify-window\f[R] 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. .SS --use-mmap .PP 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 \f[C]--buffer-size\f[R]). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with. .PP 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. .PP 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. .SS --use-server-modtime .PP 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. .PP Use this flag to disable the extra API call and rely instead on the server\[aq]s modified time. In cases such as a local to remote sync using \f[C]--update\f[R], 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. .PP Using this flag on a sync operation without also using \f[C]--update\f[R] 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. .SS -v, -vv, --verbose .PP With \f[C]-v\f[R] rclone will tell you about each file that is transferred and a small number of significant events. .PP With \f[C]-vv\f[R] rclone will become very verbose telling you about every file it considers and transfers. Please send bug reports with a log with this setting. .PP When setting verbosity as an environment variable, use \f[C]RCLONE_VERBOSE=1\f[R] or \f[C]RCLONE_VERBOSE=2\f[R] for \f[C]-v\f[R] and \f[C]-vv\f[R] respectively. .SS -V, --version .PP Prints the version number .SS SSL/TLS options .PP 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. .SS --ca-cert stringArray .PP This loads the PEM encoded certificate authority certificates and uses it to verify the certificates of the servers rclone connects to. .PP If you have generated certificates signed with a local CA then you will need this flag to connect to servers using those certificates. .SS --client-cert string .PP This loads the PEM encoded client side certificate. .PP This is used for mutual TLS authentication (https://en.wikipedia.org/wiki/Mutual_authentication). .PP The \f[C]--client-key\f[R] flag is required too when using this. .SS --client-key string .PP This loads the PEM encoded client side private key used for mutual TLS authentication. Used in conjunction with \f[C]--client-cert\f[R]. .SS --no-check-certificate=true/false .PP \f[C]--no-check-certificate\f[R] controls whether a client verifies the server\[aq]s certificate chain and host name. If \f[C]--no-check-certificate\f[R] 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. .PP This option defaults to \f[C]false\f[R]. .PP \f[B]This should be used only for testing.\f[R] .SS Configuration Encryption .PP Your configuration file contains information for logging in to your cloud services. This means that you should keep your \f[C]rclone.conf\f[R] file in a secure location. .PP If you are in an environment where that isn\[aq]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. .PP To add a password to your rclone configuration, execute \f[C]rclone config\f[R]. .IP .nf \f[C] >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> \f[R] .fi .PP Go into \f[C]s\f[R], Set configuration password: .IP .nf \f[C] 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> \f[R] .fi .PP 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. .PP There is no way to recover the configuration if you lose your password. .PP You can also use .IP \[bu] 2 rclone config encryption set (https://rclone.org/commands/rclone_config_encryption_set/) to set the config encryption directly .IP \[bu] 2 rclone config encryption remove (https://rclone.org/commands/rclone_config_encryption_remove/) to remove it .IP \[bu] 2 rclone config encryption check (https://rclone.org/commands/rclone_config_encryption_check/) to check that it is encrypted properly. .PP 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. .PP 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. .PP If it is safe in your environment, you can set the \f[C]RCLONE_CONFIG_PASS\f[R] environment variable to contain your password, in which case it will be used for decrypting the configuration. .PP You can set this for a session from a script. For unix like systems save this to a file called \f[C]set-rclone-password\f[R]: .IP .nf \f[C] #!/bin/echo Source this file don\[aq]t run it read -s RCLONE_CONFIG_PASS export RCLONE_CONFIG_PASS \f[R] .fi .PP Then source the file when you want to use it. From the shell you would do \f[C]source set-rclone-password\f[R]. It will then ask you for the password and set it in the environment variable. .PP 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 \f[C]--password-command=\[dq]...\[dq]\f[R] command line argument or via the \f[C]RCLONE_PASSWORD_COMMAND\f[R] environment variable. .PP One useful example of this is using the \f[C]passwordstore\f[R] application to retrieve the password: .IP .nf \f[C] export RCLONE_PASSWORD_COMMAND=\[dq]pass rclone/config\[dq] \f[R] .fi .PP If the \f[C]passwordstore\f[R] password manager holds the password for the rclone configuration, using the script method means the password is primarily protected by the \f[C]passwordstore\f[R] 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. .PP If you are running rclone inside a script, unless you are using the \f[C]--password-command\f[R] method, you might want to disable password prompts. To do that, pass the parameter \f[C]--ask-password=false\f[R] to rclone. This will make rclone fail instead of asking for a password if \f[C]RCLONE_CONFIG_PASS\f[R] doesn\[aq]t contain a valid password, and \f[C]--password-command\f[R] has not been supplied. .PP 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, 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. \f[C]completion\f[R]. 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: \f[C]rclone --config=\[dq]\[dq] ls .\f[R] .SS Configuration Encryption Cheatsheet .PP You can quickly apply a configuration encryption without plain-text at rest or transfer. Detailed instructions for popular OSes: .SS Mac .IP \[bu] 2 Generate and store a password .PP \f[C]security add-generic-password -a rclone -s config -w $(openssl rand -base64 40)\f[R] .IP \[bu] 2 Add the retrieval instruction to your .zprofile / .profile .PP \f[C]export RCLONE_PASSWORD_COMMAND=\[dq]/usr/bin/security find-generic-password -a rclone -s config -w\[dq]\f[R] .SS Linux .IP \[bu] 2 Prerequisite .PP Linux doesn\[aq]t come with a default password manager. Let\[aq]s install the \[dq]pass\[dq] utility using a package manager, e.g. \f[C]apt install pass\f[R], \f[C]yum install pass\f[R], etc. (https://www.passwordstore.org/#download); then initialize a password store: .PP \f[C]pass init rclone\f[R] .IP \[bu] 2 Generate and store a password .PP \f[C]echo $(openssl rand -base64 40) | pass insert -m rclone/config\f[R] .IP \[bu] 2 Add the retrieval instruction .PP \f[C]export RCLONE_PASSWORD_COMMAND=\[dq]/usr/bin/pass rclone/config\[dq]\f[R] .SS Windows .IP \[bu] 2 Generate and store a password .PP \f[C]New-Object -TypeName PSCredential -ArgumentList \[dq]rclone\[dq], (ConvertTo-SecureString -String ([System.Web.Security.Membership]::GeneratePassword(40, 10)) -AsPlainText -Force) | Export-Clixml -Path \[dq]rclone-credential.xml\[dq]\f[R] .IP \[bu] 2 Add the password retrieval instruction .PP \f[C][Environment]::SetEnvironmentVariable(\[dq]RCLONE_PASSWORD_COMMAND\[dq], \[dq][System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR((Import-Clixml -Path \[dq]rclone-credential.xml\[dq]).Password))\[dq])\f[R] .SS Encrypt the config file (all systems) .IP \[bu] 2 Execute \f[C]rclone config\f[R] -> \f[C]s\f[R] .IP \[bu] 2 Add/update the password from previous steps .SS Developer options .PP These options are useful when developing or debugging rclone. There are also some more remote specific options which aren\[aq]t documented here which are used for testing. These start with remote name e.g. \f[C]--drive-test-option\f[R] - see the docs for the remote in question. .SS --cpuprofile=FILE .PP Write CPU profile to file. This can be analysed with \f[C]go tool pprof\f[R]. .SS --dump flag,flag,flag .PP The \f[C]--dump\f[R] flag takes a comma separated list of flags to dump info about. .PP Note that some headers including \f[C]Accept-Encoding\f[R] as shown may not be correct in the request and the response may not show \f[C]Content-Encoding\f[R] 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. .PP The available flags are: .SS --dump headers .PP Dump HTTP headers with \f[C]Authorization:\f[R] lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only. .PP Use \f[C]--dump auth\f[R] if you do want the \f[C]Authorization:\f[R] headers. .SS --dump bodies .PP Dump HTTP headers and bodies - may contain sensitive info. Can be very verbose. Useful for debugging only. .PP Note that the bodies are buffered in memory so don\[aq]t use this for enormous files. .SS --dump requests .PP Like \f[C]--dump bodies\f[R] but dumps the request bodies and the response headers. Useful for debugging download problems. .SS --dump responses .PP Like \f[C]--dump bodies\f[R] but dumps the response bodies and the request headers. Useful for debugging upload problems. .SS --dump auth .PP Dump HTTP headers - will contain sensitive info such as \f[C]Authorization:\f[R] headers - use \f[C]--dump headers\f[R] to dump without \f[C]Authorization:\f[R] headers. Can be very verbose. Useful for debugging only. .SS --dump filters .PP Dump the filters to the output. Useful to see exactly what include and exclude options are filtering on. .SS --dump goroutines .PP This dumps a list of the running go-routines at the end of the command to standard output. .SS --dump openfiles .PP This dumps a list of the open files at the end of the command. It uses the \f[C]lsof\f[R] command to do that so you\[aq]ll need that installed to use it. .SS --dump mapper .PP This shows the JSON blobs being sent to the program supplied with \f[C]--metadata-mapper\f[R] and received from it. It can be useful for debugging the metadata mapper interface. .SS --memprofile=FILE .PP Write memory profile to file. This can be analysed with \f[C]go tool pprof\f[R]. .SS Filtering .PP For the filtering options .IP \[bu] 2 \f[C]--delete-excluded\f[R] .IP \[bu] 2 \f[C]--filter\f[R] .IP \[bu] 2 \f[C]--filter-from\f[R] .IP \[bu] 2 \f[C]--exclude\f[R] .IP \[bu] 2 \f[C]--exclude-from\f[R] .IP \[bu] 2 \f[C]--exclude-if-present\f[R] .IP \[bu] 2 \f[C]--include\f[R] .IP \[bu] 2 \f[C]--include-from\f[R] .IP \[bu] 2 \f[C]--files-from\f[R] .IP \[bu] 2 \f[C]--files-from-raw\f[R] .IP \[bu] 2 \f[C]--min-size\f[R] .IP \[bu] 2 \f[C]--max-size\f[R] .IP \[bu] 2 \f[C]--min-age\f[R] .IP \[bu] 2 \f[C]--max-age\f[R] .IP \[bu] 2 \f[C]--dump filters\f[R] .IP \[bu] 2 \f[C]--metadata-include\f[R] .IP \[bu] 2 \f[C]--metadata-include-from\f[R] .IP \[bu] 2 \f[C]--metadata-exclude\f[R] .IP \[bu] 2 \f[C]--metadata-exclude-from\f[R] .IP \[bu] 2 \f[C]--metadata-filter\f[R] .IP \[bu] 2 \f[C]--metadata-filter-from\f[R] .PP See the filtering section (https://rclone.org/filtering/). .SS Remote control .PP For the remote control options and for instructions on how to remote control rclone .IP \[bu] 2 \f[C]--rc\f[R] .IP \[bu] 2 and anything starting with \f[C]--rc-\f[R] .PP See the remote control section (https://rclone.org/rc/). .SS Logging .PP rclone has 4 levels of logging, \f[C]ERROR\f[R], \f[C]NOTICE\f[R], \f[C]INFO\f[R] and \f[C]DEBUG\f[R]. .PP 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. \f[C]rclone ls\f[R]). .PP By default, rclone will produce \f[C]Error\f[R] and \f[C]Notice\f[R] level messages. .PP If you use the \f[C]-q\f[R] flag, rclone will only produce \f[C]Error\f[R] messages. .PP If you use the \f[C]-v\f[R] flag, rclone will produce \f[C]Error\f[R], \f[C]Notice\f[R] and \f[C]Info\f[R] messages. .PP If you use the \f[C]-vv\f[R] flag, rclone will produce \f[C]Error\f[R], \f[C]Notice\f[R], \f[C]Info\f[R] and \f[C]Debug\f[R] messages. .PP You can also control the log levels with the \f[C]--log-level\f[R] flag. .PP If you use the \f[C]--log-file=FILE\f[R] option, rclone will redirect \f[C]Error\f[R], \f[C]Info\f[R] and \f[C]Debug\f[R] messages along with standard error to FILE. .PP If you use the \f[C]--syslog\f[R] flag then rclone will log to syslog and the \f[C]--syslog-facility\f[R] control which facility it uses. .PP 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. .SS Metrics .PP Rclone can publish metrics in the OpenMetrics/Prometheus format. .PP To enable the metrics endpoint, use the \f[C]--metrics-addr\f[R] flag. Metrics can also be published on the \f[C]--rc-addr\f[R] port if the \f[C]--rc\f[R] flag and \f[C]--rc-enable-metrics\f[R] flags are supplied or if using rclone rcd \f[C]--rc-enable-metrics\f[R] .PP Rclone provides extensive configuration options for the metrics HTTP endpoint. These settings are grouped under the Metrics section and have a prefix \f[C]--metrics-*\f[R]. .PP When metrics are enabled with \f[C]--rc-enable-metrics\f[R], they will be published on the same port as the rc API. In this case, the \f[C]--metrics-*\f[R] flags will be ignored, and the HTTP endpoint configuration will be managed by the \f[C]--rc-*\f[R] parameters. .SS Exit Code .PP 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. .PP 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. .PP 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 \f[C]-q\f[R]) 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. .SS List of exit codes .IP \[bu] 2 \f[C]0\f[R] - Success .IP \[bu] 2 \f[C]1\f[R] - Error not otherwise categorised .IP \[bu] 2 \f[C]2\f[R] - Syntax or usage error .IP \[bu] 2 \f[C]3\f[R] - Directory not found .IP \[bu] 2 \f[C]4\f[R] - File not found .IP \[bu] 2 \f[C]5\f[R] - Temporary error (one that more retries might fix) (Retry errors) .IP \[bu] 2 \f[C]6\f[R] - Less serious errors (like 461 errors from dropbox) (NoRetry errors) .IP \[bu] 2 \f[C]7\f[R] - Fatal error (one that more retries won\[aq]t fix, like account suspended) (Fatal errors) .IP \[bu] 2 \f[C]8\f[R] - Transfer exceeded - limit set by --max-transfer reached .IP \[bu] 2 \f[C]9\f[R] - Operation successful, but no files transferred (Requires \f[C]--error-on-no-transfer\f[R]) .IP \[bu] 2 \f[C]10\f[R] - Duration exceeded - limit set by --max-duration reached .SS Environment Variables .PP Rclone can be configured entirely using environment variables. These can be used to set defaults for options or config file entries. .SS Options .PP Every option in rclone can have its default set by environment variable. .PP To find the name of the environment variable, first, take the long option name, strip the leading \f[C]--\f[R], change \f[C]-\f[R] to \f[C]_\f[R], make upper case and prepend \f[C]RCLONE_\f[R]. .PP For example, to always set \f[C]--stats 5s\f[R], set the environment variable \f[C]RCLONE_STATS=5s\f[R]. If you set stats on the command line this will override the environment variable setting. .PP Or to always use the trash in drive \f[C]--drive-use-trash\f[R], set \f[C]RCLONE_DRIVE_USE_TRASH=true\f[R]. .PP Verbosity is slightly different, the environment variable equivalent of \f[C]--verbose\f[R] or \f[C]-v\f[R] is \f[C]RCLONE_VERBOSE=1\f[R], or for \f[C]-vv\f[R], \f[C]RCLONE_VERBOSE=2\f[R]. .PP The same parser is used for the options and the environment variables so they take exactly the same form. .PP The options set by environment variables can be seen with the \f[C]-vv\f[R] flag, e.g. \f[C]rclone version -vv\f[R]. .PP Options that can appear multiple times (type \f[C]stringArray\f[R]) 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 .PP .TS tab(@); lw(36.7n) lw(33.3n). T{ Environment Variable T}@T{ Equivalent options T} _ T{ \f[C]RCLONE_EXCLUDE=\[dq]*.jpg\[dq]\f[R] T}@T{ \f[C]--exclude \[dq]*.jpg\[dq]\f[R] T} T{ \f[C]RCLONE_EXCLUDE=\[dq]*.jpg,*.png\[dq]\f[R] T}@T{ \f[C]--exclude \[dq]*.jpg\[dq]\f[R] \f[C]--exclude \[dq]*.png\[dq]\f[R] T} T{ \f[C]RCLONE_EXCLUDE=\[aq]\[dq]*.jpg\[dq],\[dq]*.png\[dq]\[aq]\f[R] T}@T{ \f[C]--exclude \[dq]*.jpg\[dq]\f[R] \f[C]--exclude \[dq]*.png\[dq]\f[R] T} T{ \f[C]RCLONE_EXCLUDE=\[aq]\[dq]/directory with comma , in it /**\[dq]\[aq]\f[R] T}@T{ \[ga]--exclude \[dq]/directory with comma , in it /**\[dq] T} .TE .PP If \f[C]stringArray\f[R] options are defined as environment variables \f[B]and\f[R] options on the command line then all the values will be used. .SS Config file .PP 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. .PP To find the name of the environment variable, you need to set, take \f[C]RCLONE_CONFIG_\f[R] + name of remote + \f[C]_\f[R] + name of config file option and make it all uppercase. Note one implication here is the remote\[aq]s name must be convertible into a valid environment variable name, so it can only contain letters, digits, or the \f[C]_\f[R] (underscore) character. .PP For example, to configure an S3 remote named \f[C]mys3:\f[R] without a config file (using unix ways of setting environment variables): .IP .nf \f[C] $ 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: \f[R] .fi .PP Note that if you want to create a remote using environment variables you must create the \f[C]..._TYPE\f[R] variable as above. .PP 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. 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: .IP .nf \f[C] $ 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 \f[R] .fi .PP 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. .PP Note also that now rclone has connection strings, it is probably easier to use those instead which makes the above example .IP .nf \f[C] rclone lsd :s3,access_key_id=XXX,secret_access_key=XXX: \f[R] .fi .SS Precedence .PP The various different methods of backend configuration are read in this order and the first one with a value is used. .IP \[bu] 2 Parameters in connection strings, e.g. \f[C]myRemote,skip_links:\f[R] .IP \[bu] 2 Flag values as supplied on the command line, e.g. \f[C]--skip-links\f[R] .IP \[bu] 2 Remote specific environment vars, e.g. \f[C]RCLONE_CONFIG_MYREMOTE_SKIP_LINKS\f[R] (see above). .IP \[bu] 2 Backend-specific environment vars, e.g. \f[C]RCLONE_LOCAL_SKIP_LINKS\f[R]. .IP \[bu] 2 Backend generic environment vars, e.g. \f[C]RCLONE_SKIP_LINKS\f[R]. .IP \[bu] 2 Config file, e.g. \f[C]skip_links = true\f[R]. .IP \[bu] 2 Default values, e.g. \f[C]false\f[R] - these can\[aq]t be changed. .PP So if both \f[C]--skip-links\f[R] is supplied on the command line and an environment variable \f[C]RCLONE_LOCAL_SKIP_LINKS\f[R] is set, the command line flag will take preference. .PP The backend configurations set by environment variables can be seen with the \f[C]-vv\f[R] flag, e.g. \f[C]rclone about myRemote: -vv\f[R]. .PP For non backend configuration the order is as follows: .IP \[bu] 2 Flag values as supplied on the command line, e.g. \f[C]--stats 5s\f[R]. .IP \[bu] 2 Environment vars, e.g. \f[C]RCLONE_STATS=5s\f[R]. .IP \[bu] 2 Default values, e.g. \f[C]1m\f[R] - these can\[aq]t be changed. .SS Other environment variables .IP \[bu] 2 \f[C]RCLONE_CONFIG_PASS\f[R] set to contain your config file password (see Configuration Encryption section) .IP \[bu] 2 \f[C]HTTP_PROXY\f[R], \f[C]HTTPS_PROXY\f[R] and \f[C]NO_PROXY\f[R] (or the lowercase versions thereof). .RS 2 .IP \[bu] 2 \f[C]HTTPS_PROXY\f[R] takes precedence over \f[C]HTTP_PROXY\f[R] for https requests. .IP \[bu] 2 The environment values may be either a complete URL or a \[dq]host[:port]\[dq] for, in which case the \[dq]http\[dq] scheme is assumed. .RE .IP \[bu] 2 \f[C]USER\f[R] and \f[C]LOGNAME\f[R] 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 \f[C]$USER\f[R]. .IP \[bu] 2 \f[C]RCLONE_CONFIG_DIR\f[R] - rclone \f[B]sets\f[R] this variable for use in config files and sub processes to point to the directory holding the config file. .PP The options set by environment variables can be seen with the \f[C]-vv\f[R] and \f[C]--log-level=DEBUG\f[R] flags, e.g. \f[C]rclone version -vv\f[R]. .SH Configuring rclone on a remote / headless machine .PP Some of the configurations (those involving oauth2) require an Internet connected web browser. .PP If you are trying to set rclone up on a remote or headless box 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 two ways of doing it, described below. .SS Configuring using rclone authorize .PP On the headless box run \f[C]rclone\f[R] config but answer \f[C]N\f[R] to the \f[C]Use auto config?\f[R] question. .IP .nf \f[C] Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine 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 \[dq]onedrive\[dq] Then paste the result. Enter a value. config_token> \f[R] .fi .PP Then on your main desktop machine .IP .nf \f[C] rclone authorize \[dq]onedrive\[dq] If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Paste the following into your remote machine ---> SECRET_TOKEN <---End paste \f[R] .fi .PP Then back to the headless box, paste in the code .IP .nf \f[C] 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> \f[R] .fi .SS Configuring by copying the config file .PP Rclone stores all of its config in a single configuration file. This can easily be copied to configure a remote rclone. .PP So first configure rclone on your desktop machine with .IP .nf \f[C] rclone config \f[R] .fi .PP to set up the config file. .PP Find the config file by running \f[C]rclone config file\f[R], for example .IP .nf \f[C] $ rclone config file Configuration file is stored at: /home/user/.rclone.conf \f[R] .fi .PP Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and place it in the correct place (use \f[C]rclone config file\f[R] on the remote box to find out where). .SS Configuring using SSH Tunnel .PP Linux and MacOS users can utilize SSH Tunnel to redirect the headless box port 53682 to local machine by using the following command: .IP .nf \f[C] ssh -L localhost:53682:localhost:53682 username\[at]remote_server \f[R] .fi .PP Then on the headless box run \f[C]rclone config\f[R] and answer \f[C]Y\f[R] to the \f[C]Use auto config?\f[R] question. .IP .nf \f[C] Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes (default) n) No y/n> y \f[R] .fi .PP Then copy and paste the auth url \f[C]http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx\f[R] to the browser on your local machine, complete the auth and it is done. .SH Filtering, includes and excludes .PP Filter flags determine which files rclone \f[C]sync\f[R], \f[C]move\f[R], \f[C]ls\f[R], \f[C]lsl\f[R], \f[C]md5sum\f[R], \f[C]sha1sum\f[R], \f[C]size\f[R], \f[C]delete\f[R], \f[C]check\f[R] and similar commands apply to. .PP 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. .PP Rclone \f[C]purge\f[R] does not obey filters. .PP To test filters without risk of damage to data, apply them to \f[C]rclone ls\f[R], or with the \f[C]--dry-run\f[R] and \f[C]-vv\f[R] flags. .PP Rclone filter patterns can only be used in filter command line options, not in the specification of a remote. .PP E.g. \f[C]rclone copy \[dq]remote:dir*.jpg\[dq] /path/to/dir\f[R] does not have a filter effect. \f[C]rclone copy remote:dir /path/to/dir --include \[dq]*.jpg\[dq]\f[R] does. .PP \f[B]Important\f[R] Avoid mixing any two of \f[C]--include...\f[R], \f[C]--exclude...\f[R] or \f[C]--filter...\f[R] flags in an rclone command. The results might not be what you expect. Instead use a \f[C]--filter...\f[R] flag. .SS Patterns for matching path/file names .SS Pattern syntax .PP Here is a formal definition of the pattern syntax, examples are below. .PP Rclone matching rules follow a glob style: .IP .nf \f[C] * 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 != *, **, ?, \[rs], [, {, }) \[rs]c matches reserved character c (c = *, **, ?, \[rs], [, {, }) or character class \f[R] .fi .PP character-range: .IP .nf \f[C] c matches character c (c != \[rs], -, ]) \[rs]c matches reserved character c (c = \[rs], -, ]) lo - hi matches character c for lo <= c <= hi \f[R] .fi .PP pattern-list: .IP .nf \f[C] pattern { , pattern } comma-separated (without spaces) patterns \f[R] .fi .PP character classes (see Go regular expression reference (https://golang.org/pkg/regexp/syntax/)) include: .IP .nf \f[C] Named character classes (e.g. [\[rs]d], [\[ha]\[rs]d], [\[rs]D], [\[ha]\[rs]D]) Perl character classes (e.g. \[rs]s, \[rs]S, \[rs]w, \[rs]W) ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]]) \f[R] .fi .PP regexp for advanced users to insert a regular expression - see below for more info: .IP .nf \f[C] Any re2 regular expression not containing \[ga]}}\[ga] \f[R] .fi .PP If the filter pattern starts with a \f[C]/\f[R] then it only matches at the top level of the directory tree, \f[B]relative to the root of the remote\f[R] (not necessarily the root of the drive). If it does not start with \f[C]/\f[R] then it is matched starting at the \f[B]end of the path/file name\f[R] but it only matches a complete path element - it must match from a \f[C]/\f[R] separator or the beginning of the path/file. .IP .nf \f[C] file.jpg - matches \[dq]file.jpg\[dq] - matches \[dq]directory/file.jpg\[dq] - doesn\[aq]t match \[dq]afile.jpg\[dq] - doesn\[aq]t match \[dq]directory/afile.jpg\[dq] /file.jpg - matches \[dq]file.jpg\[dq] in the root directory of the remote - doesn\[aq]t match \[dq]afile.jpg\[dq] - doesn\[aq]t match \[dq]directory/file.jpg\[dq] \f[R] .fi .PP The top level of the remote might not be the top level of the drive. .PP E.g. for a Microsoft Windows local directory structure .IP .nf \f[C] F: \[u251C]\[u2500]\[u2500] bkp \[u251C]\[u2500]\[u2500] data \[br] \[u251C]\[u2500]\[u2500] excl \[br] \[br] \[u251C]\[u2500]\[u2500] 123.jpg \[br] \[br] \[u2514]\[u2500]\[u2500] 456.jpg \[br] \[u251C]\[u2500]\[u2500] incl \[br] \[br] \[u2514]\[u2500]\[u2500] document.pdf \f[R] .fi .PP To copy the contents of folder \f[C]data\f[R] into folder \f[C]bkp\f[R] excluding the contents of subfolder \f[C]excl\f[R]the following command treats \f[C]F:\[rs]data\f[R] and \f[C]F:\[rs]bkp\f[R] as top level for filtering. .PP \f[C]rclone copy F:\[rs]data\[rs] F:\[rs]bkp\[rs] --exclude=/excl/**\f[R] .PP \f[B]Important\f[R] Use \f[C]/\f[R] in path/file name patterns and not \f[C]\[rs]\f[R] even if running on Microsoft Windows. .PP Simple patterns are case sensitive unless the \f[C]--ignore-case\f[R] flag is used. .PP Without \f[C]--ignore-case\f[R] (default) .IP .nf \f[C] potato - matches \[dq]potato\[dq] - doesn\[aq]t match \[dq]POTATO\[dq] \f[R] .fi .PP With \f[C]--ignore-case\f[R] .IP .nf \f[C] potato - matches \[dq]potato\[dq] - matches \[dq]POTATO\[dq] \f[R] .fi .SS Using regular expressions in filter patterns .PP The syntax of filter patterns is glob style matching (like \f[C]bash\f[R] 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. .PP The regular expressions used are as defined in the Go regular expression reference (https://golang.org/pkg/regexp/syntax/). Regular expressions should be enclosed in \f[C]{{\f[R] \f[C]}}\f[R]. They will match only the last path segment if the glob doesn\[aq]t start with \f[C]/\f[R] 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, as it will instead check every path against the supplied regular expression(s). .PP Here is how the \f[C]{{regexp}}\f[R] is transformed into an full regular expression to match the entire path: .IP .nf \f[C] {{regexp}} becomes (\[ha]|/)(regexp)$ /{{regexp}} becomes \[ha](regexp)$ \f[R] .fi .PP Regexp syntax can be mixed with glob syntax, for example .IP .nf \f[C] *.{{jpe?g}} to match file.jpg, file.jpeg but not file.png \f[R] .fi .PP You can also use regexp flags - to set case insensitive, for example .IP .nf \f[C] *.{{(?i)jpg}} to match file.jpg, file.JPG but not file.png \f[R] .fi .PP Be careful with wildcards in regular expressions - you don\[aq]t want them to match path separators normally. To match any file name starting with \f[C]start\f[R] and ending with \f[C]end\f[R] write .IP .nf \f[C] {{start[\[ha]/]*end\[rs].jpg}} \f[R] .fi .PP Not .IP .nf \f[C] {{start.*end\[rs].jpg}} \f[R] .fi .PP Which will match a directory called \f[C]start\f[R] with a file called \f[C]end.jpg\f[R] in it as the \f[C].*\f[R] will match \f[C]/\f[R] characters. .PP Note that you can use \f[C]-vv --dump filters\f[R] to show the filter patterns in regexp format - rclone implements the glob patterns by transforming them into regular expressions. .SS Filter pattern examples .PP .TS tab(@); l l l l. T{ Description T}@T{ Pattern T}@T{ Matches T}@T{ Does not match T} _ T{ Wildcard T}@T{ \f[C]*.jpg\f[R] T}@T{ \f[C]/file.jpg\f[R] T}@T{ \f[C]/file.png\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.jpg\f[R] T}@T{ \f[C]/dir/file.png\f[R] T} T{ Rooted T}@T{ \f[C]/*.jpg\f[R] T}@T{ \f[C]/file.jpg\f[R] T}@T{ \f[C]/file.png\f[R] T} T{ T}@T{ T}@T{ \f[C]/file2.jpg\f[R] T}@T{ \f[C]/dir/file.jpg\f[R] T} T{ Alternates T}@T{ \f[C]*.{jpg,png}\f[R] T}@T{ \f[C]/file.jpg\f[R] T}@T{ \f[C]/file.gif\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.png\f[R] T}@T{ \f[C]/dir/file.gif\f[R] T} T{ Path Wildcard T}@T{ \f[C]dir/**\f[R] T}@T{ \f[C]/dir/anyfile\f[R] T}@T{ \f[C]file.png\f[R] T} T{ T}@T{ T}@T{ \f[C]/subdir/dir/subsubdir/anyfile\f[R] T}@T{ \f[C]/subdir/file.png\f[R] T} T{ Any Char T}@T{ \f[C]*.t?t\f[R] T}@T{ \f[C]/file.txt\f[R] T}@T{ \f[C]/file.qxt\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.tzt\f[R] T}@T{ \f[C]/dir/file.png\f[R] T} T{ Range T}@T{ \f[C]*.[a-z]\f[R] T}@T{ \f[C]/file.a\f[R] T}@T{ \f[C]/file.0\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.b\f[R] T}@T{ \f[C]/dir/file.1\f[R] T} T{ Escape T}@T{ \f[C]*.\[rs]?\[rs]?\[rs]?\f[R] T}@T{ \f[C]/file.???\f[R] T}@T{ \f[C]/file.abc\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.???\f[R] T}@T{ \f[C]/dir/file.def\f[R] T} T{ Class T}@T{ \f[C]*.\[rs]d\[rs]d\[rs]d\f[R] T}@T{ \f[C]/file.012\f[R] T}@T{ \f[C]/file.abc\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.345\f[R] T}@T{ \f[C]/dir/file.def\f[R] T} T{ Regexp T}@T{ \f[C]*.{{jpe?g}}\f[R] T}@T{ \f[C]/file.jpeg\f[R] T}@T{ \f[C]/file.png\f[R] T} T{ T}@T{ T}@T{ \f[C]/dir/file.jpg\f[R] T}@T{ \f[C]/dir/file.jpeeg\f[R] T} T{ Rooted Regexp T}@T{ \f[C]/{{.*\[rs].jpe?g}}\f[R] T}@T{ \f[C]/file.jpeg\f[R] T}@T{ \f[C]/file.png\f[R] T} T{ T}@T{ T}@T{ \f[C]/file.jpg\f[R] T}@T{ \f[C]/dir/file.jpg\f[R] T} .TE .SS How filter rules are applied to files .PP Rclone path/file name filters are made up of one or more of the following flags: .IP \[bu] 2 \f[C]--include\f[R] .IP \[bu] 2 \f[C]--include-from\f[R] .IP \[bu] 2 \f[C]--exclude\f[R] .IP \[bu] 2 \f[C]--exclude-from\f[R] .IP \[bu] 2 \f[C]--filter\f[R] .IP \[bu] 2 \f[C]--filter-from\f[R] .PP There can be more than one instance of individual flags. .PP 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. .PP 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. .PP Multiple instances of the same flag are processed from left to right according to their position in the command line. .PP To mix up the order of processing includes and excludes use \f[C]--filter...\f[R] flags. .PP Within \f[C]--include-from\f[R], \f[C]--exclude-from\f[R] and \f[C]--filter-from\f[R] flags rules are processed from top to bottom of the referenced file. .PP If there is an \f[C]--include\f[R] or \f[C]--include-from\f[R] flag specified, rclone implies a \f[C]- **\f[R] rule which it adds to the bottom of the internal rule list. Specifying a \f[C]+\f[R] rule with a \f[C]--filter...\f[R] flag does not imply that rule. .PP 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. .PP If rclone does not find a match, after testing against all rules (including the implied rule if appropriate), the path/file name is included. .PP Any path/file included at that stage is processed by the rclone command. .PP \f[C]--files-from\f[R] and \f[C]--files-from-raw\f[R] flags over-ride and cannot be combined with other filter options. .PP To see the internal combined rule list, in regular expression form, for a command add the \f[C]--dump filters\f[R] flag. Running an rclone command with \f[C]--dump filters\f[R] and \f[C]-vv\f[R] 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/) .SS How filter rules are applied to directories .PP 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 \f[C]directory/*\f[R] or recursively by \f[C]directory/**\f[R]. .PP Directory filter rules are defined with a closing \f[C]/\f[R] separator. .PP E.g. \f[C]/directory/subdirectory/\f[R] is an rclone directory filter rule. .PP 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. .PP If any regular expression filters are in use, then no directory recursion optimisation is possible, as rclone must check every path against the supplied regular expression(s). .PP Directory recursion optimisation occurs if either: .IP \[bu] 2 A source remote does not support the rclone \f[C]ListR\f[R] primitive. local, sftp, Microsoft OneDrive and WebDAV do not support \f[C]ListR\f[R]. Google Drive and most bucket type storage do. Full list (https://rclone.org/overview/#optional-features) .IP \[bu] 2 On other remotes (those that support \f[C]ListR\f[R]), if the rclone command is not naturally recursive, and provided it is not run with the \f[C]--fast-list\f[R] flag. \f[C]ls\f[R], \f[C]lsf -R\f[R] and \f[C]size\f[R] are naturally recursive but \f[C]sync\f[R], \f[C]copy\f[R] and \f[C]move\f[R] are not. .IP \[bu] 2 Whenever the \f[C]--disable ListR\f[R] flag is applied to an rclone command. .PP 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 \f[C]--dump filters\f[R] flag. .PP E.g. for an include rule .IP .nf \f[C] /a/*.jpg \f[R] .fi .PP Rclone implies the directory include rule .IP .nf \f[C] /a/ \f[R] .fi .PP 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. .PP E.g. \f[C]rclone ls remote: --include /directory/\f[R] will not match any files. Because it is an \f[C]--include\f[R] option the \f[C]--exclude **\f[R] rule is implied, and the \f[C]/directory/\f[R] pattern serves only to optimise access to the remote by ignoring everything outside of that directory. .PP E.g. \f[C]rclone ls remote: --filter-from filter-list.txt\f[R] with a file \f[C]filter-list.txt\f[R]: .IP .nf \f[C] - /dir1/ - /dir2/ + *.pdf - ** \f[R] .fi .PP All files in directories \f[C]dir1\f[R] or \f[C]dir2\f[R] or their subdirectories are completely excluded from the listing. Only files of suffix \f[C]pdf\f[R] in the root of \f[C]remote:\f[R] or its subdirectories are listed. The \f[C]- **\f[R] rule prevents listing of any path/files not previously matched by the rules above. .PP Option \f[C]exclude-if-present\f[R] creates a directory exclude rule based on the presence of a file in a directory and takes precedence over other rclone directory filter rules. .PP When using pattern list syntax, if a pattern item contains either \f[C]/\f[R] or \f[C]**\f[R], then rclone will not able to imply a directory filter rule from this pattern list. .PP E.g. for an include rule .IP .nf \f[C] {dir1/**,dir2/**} \f[R] .fi .PP Rclone will match files below directories \f[C]dir1\f[R] or \f[C]dir2\f[R] only, but will not be able to use this filter to exclude a directory \f[C]dir3\f[R] from being traversed. .PP Directory recursion optimisation may affect performance, but normally not the result. One exception to this is sync operations with option \f[C]--create-empty-src-dirs\f[R], where any traversed empty directories will be created. With the pattern list example \f[C]{dir1/**,dir2/**}\f[R] above, this would create an empty directory \f[C]dir3\f[R] on destination (when it exists on source). Changing the filter to \f[C]{dir1,dir2}/**\f[R], or splitting it into two include rules \f[C]--include dir1/** --include dir2/**\f[R], will match the same files while also filtering directories, with the result that an empty directory \f[C]dir3\f[R] will no longer be created. .SS \f[C]--exclude\f[R] - Exclude files matching pattern .PP Excludes path/file names from an rclone command based on a single exclude rule. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP \f[C]--exclude\f[R] should not be used with \f[C]--include\f[R], \f[C]--include-from\f[R], \f[C]--filter\f[R] or \f[C]--filter-from\f[R] flags. .PP \f[C]--exclude\f[R] has no effect when combined with \f[C]--files-from\f[R] or \f[C]--files-from-raw\f[R] flags. .PP E.g. \f[C]rclone ls remote: --exclude *.bak\f[R] excludes all .bak files from listing. .PP E.g. \f[C]rclone size remote: --exclude \[dq]/dir/**\[dq]\f[R] returns the total size of all files on \f[C]remote:\f[R] excluding those in root directory \f[C]dir\f[R] and sub directories. .PP E.g. on Microsoft Windows \f[C]rclone ls remote: --exclude \[dq]*\[rs][{JP,KR,HK}\[rs]]*\[dq]\f[R] lists the files in \f[C]remote:\f[R] without \f[C][JP]\f[R] or \f[C][KR]\f[R] or \f[C][HK]\f[R] in their name. Quotes prevent the shell from interpreting the \f[C]\[rs]\f[R] characters.\f[C]\[rs]\f[R] characters escape the \f[C][\f[R] and \f[C]]\f[R] so an rclone filter treats them literally rather than as a character-range. The \f[C]{\f[R] and \f[C]}\f[R] define an rclone pattern list. For other operating systems single quotes are required ie \f[C]rclone ls remote: --exclude \[aq]*\[rs][{JP,KR,HK}\[rs]]*\[aq]\f[R] .SS \f[C]--exclude-from\f[R] - Read exclude patterns from file .PP 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. .PP For an example \f[C]exclude-file.txt\f[R]: .IP .nf \f[C] # a sample exclude rule file *.bak file2.jpg \f[R] .fi .PP \f[C]rclone ls remote: --exclude-from exclude-file.txt\f[R] lists the files on \f[C]remote:\f[R] except those named \f[C]file2.jpg\f[R] or with a suffix \f[C].bak\f[R]. That is equivalent to \f[C]rclone ls remote: --exclude file2.jpg --exclude \[dq]*.bak\[dq]\f[R]. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP The \f[C]--exclude-from\f[R] flag is useful where multiple exclude filter rules are applied to an rclone command. .PP \f[C]--exclude-from\f[R] should not be used with \f[C]--include\f[R], \f[C]--include-from\f[R], \f[C]--filter\f[R] or \f[C]--filter-from\f[R] flags. .PP \f[C]--exclude-from\f[R] has no effect when combined with \f[C]--files-from\f[R] or \f[C]--files-from-raw\f[R] flags. .PP \f[C]--exclude-from\f[R] followed by \f[C]-\f[R] reads filter rules from standard input. .SS \f[C]--include\f[R] - Include files matching pattern .PP Adds a single include rule based on path/file names to an rclone command. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP \f[C]--include\f[R] has no effect when combined with \f[C]--files-from\f[R] or \f[C]--files-from-raw\f[R] flags. .PP \f[C]--include\f[R] implies \f[C]--exclude **\f[R] at the end of an rclone internal filter list. Therefore if you mix \f[C]--include\f[R] and \f[C]--include-from\f[R] flags with \f[C]--exclude\f[R], \f[C]--exclude-from\f[R], \f[C]--filter\f[R] or \f[C]--filter-from\f[R], you must use include rules for all the files you want in the include statement. For more flexibility use the \f[C]--filter-from\f[R] flag. .PP E.g. \f[C]rclone ls remote: --include \[dq]*.{png,jpg}\[dq]\f[R] lists the files on \f[C]remote:\f[R] with suffix \f[C].png\f[R] and \f[C].jpg\f[R]. All other files are excluded. .PP E.g. multiple rclone copy commands can be combined with \f[C]--include\f[R] and a pattern-list. .IP .nf \f[C] rclone copy /vol1/A remote:A rclone copy /vol1/B remote:B \f[R] .fi .PP is equivalent to: .IP .nf \f[C] rclone copy /vol1 remote: --include \[dq]{A,B}/**\[dq] \f[R] .fi .PP E.g. \f[C]rclone ls remote:/wheat --include \[dq]??[\[ha][:punct:]]*\[dq]\f[R] lists the files \f[C]remote:\f[R] directory \f[C]wheat\f[R] (and subdirectories) whose third character is not punctuation. This example uses an ASCII character class (https://golang.org/pkg/regexp/syntax/). .SS \f[C]--include-from\f[R] - Read include patterns from file .PP 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. .PP For an example \f[C]include-file.txt\f[R]: .IP .nf \f[C] # a sample include rule file *.jpg file2.avi \f[R] .fi .PP \f[C]rclone ls remote: --include-from include-file.txt\f[R] lists the files on \f[C]remote:\f[R] with name \f[C]file2.avi\f[R] or suffix \f[C].jpg\f[R]. That is equivalent to \f[C]rclone ls remote: --include file2.avi --include \[dq]*.jpg\[dq]\f[R]. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP The \f[C]--include-from\f[R] flag is useful where multiple include filter rules are applied to an rclone command. .PP \f[C]--include-from\f[R] implies \f[C]--exclude **\f[R] at the end of an rclone internal filter list. Therefore if you mix \f[C]--include\f[R] and \f[C]--include-from\f[R] flags with \f[C]--exclude\f[R], \f[C]--exclude-from\f[R], \f[C]--filter\f[R] or \f[C]--filter-from\f[R], you must use include rules for all the files you want in the include statement. For more flexibility use the \f[C]--filter-from\f[R] flag. .PP \f[C]--include-from\f[R] has no effect when combined with \f[C]--files-from\f[R] or \f[C]--files-from-raw\f[R] flags. .PP \f[C]--include-from\f[R] followed by \f[C]-\f[R] reads filter rules from standard input. .SS \f[C]--filter\f[R] - Add a file-filtering rule .PP Specifies path/file names to an rclone command, based on a single include or exclude rule, in \f[C]+\f[R] or \f[C]-\f[R] format. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP \f[C]--filter +\f[R] differs from \f[C]--include\f[R]. In the case of \f[C]--include\f[R] rclone implies an \f[C]--exclude *\f[R] rule which it adds to the bottom of the internal rule list. \f[C]--filter...+\f[R] does not imply that rule. .PP \f[C]--filter\f[R] has no effect when combined with \f[C]--files-from\f[R] or \f[C]--files-from-raw\f[R] flags. .PP \f[C]--filter\f[R] should not be used with \f[C]--include\f[R], \f[C]--include-from\f[R], \f[C]--exclude\f[R] or \f[C]--exclude-from\f[R] flags. .PP E.g. \f[C]rclone ls remote: --filter \[dq]- *.bak\[dq]\f[R] excludes all \f[C].bak\f[R] files from a list of \f[C]remote:\f[R]. .SS \f[C]--filter-from\f[R] - Read filtering patterns from a file .PP 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 \f[C]+\f[R] and exclude rules with \f[C]-\f[R]. \f[C]!\f[R] clears existing rules. Rules are processed in the order they are defined. .PP This flag can be repeated. See above for the order filter flags are processed in. .PP Arrange the order of filter rules with the most restrictive first and work down. .PP Lines starting with # or ; are ignored, and can be used to write comments. Inline comments are not supported. \f[I]Use \f[CI]-vv --dump filters\f[I] to see how they appear in the final regexp.\f[R] .PP E.g. for \f[C]filter-file.txt\f[R]: .IP .nf \f[C] # 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 - * \f[R] .fi .PP \f[C]rclone ls remote: --filter-from filter-file.txt\f[R] lists the path/files on \f[C]remote:\f[R] including all \f[C]jpg\f[R] and \f[C]png\f[R] files, excluding any matching \f[C]secret*.jpg\f[R] and including \f[C]file2.avi\f[R]. It also includes everything in the directory \f[C]dir\f[R] at the root of \f[C]remote\f[R], except \f[C]remote:dir/Trash\f[R] which it excludes. Everything else is excluded. .PP E.g. for an alternative \f[C]filter-file.txt\f[R]: .IP .nf \f[C] - secret*.jpg + *.jpg + *.png + file2.avi - * \f[R] .fi .PP Files \f[C]file1.jpg\f[R], \f[C]file3.png\f[R] and \f[C]file2.avi\f[R] are listed whilst \f[C]secret17.jpg\f[R] and files without the suffix \f[C].jpg\f[R] or \f[C].png\f[R] are excluded. .PP E.g. for an alternative \f[C]filter-file.txt\f[R]: .IP .nf \f[C] + *.jpg + *.gif ! + 42.doc - * \f[R] .fi .PP Only file 42.doc is listed. Prior rules are cleared by the \f[C]!\f[R]. .SS \f[C]--files-from\f[R] - Read list of source-file names .PP 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. .PP Other filter flags (\f[C]--include\f[R], \f[C]--include-from\f[R], \f[C]--exclude\f[R], \f[C]--exclude-from\f[R], \f[C]--filter\f[R] and \f[C]--filter-from\f[R]) are ignored when \f[C]--files-from\f[R] is used. .PP \f[C]--files-from\f[R] expects a list of files as its input. Leading or trailing whitespace is stripped from the input lines. Lines starting with \f[C]#\f[R] or \f[C];\f[R] are ignored. .PP \f[C]--files-from\f[R] followed by \f[C]-\f[R] reads the list of files from standard input. .PP Rclone commands with a \f[C]--files-from\f[R] flag traverse the remote, treating the names in \f[C]--files-from\f[R] as a set of filters. .PP If the \f[C]--no-traverse\f[R] and \f[C]--files-from\f[R] 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 \f[C]--files-from\f[R] list and a remote containing many files. .PP Rclone commands do not error if any names in the \f[C]--files-from\f[R] file are missing from the source remote. .PP The \f[C]--files-from\f[R] 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. .PP Paths within the \f[C]--files-from\f[R] file are interpreted as starting with the root specified in the rclone command. Leading \f[C]/\f[R] separators are ignored. See --files-from-raw if you need the input to be processed in a raw manner. .PP E.g. for a file \f[C]files-from.txt\f[R]: .IP .nf \f[C] # comment file1.jpg subdir/file2.jpg \f[R] .fi .PP \f[C]rclone copy --files-from files-from.txt /home/me/pics remote:pics\f[R] copies the following, if they exist, and only those files. .IP .nf \f[C] /home/me/pics/file1.jpg \[->] remote:pics/file1.jpg /home/me/pics/subdir/file2.jpg \[->] remote:pics/subdir/file2.jpg \f[R] .fi .PP E.g. to copy the following files referenced by their absolute paths: .IP .nf \f[C] /home/user1/42 /home/user1/dir/ford /home/user2/prefect \f[R] .fi .PP First find a common subdirectory - in this case \f[C]/home\f[R] and put the remaining files in \f[C]files-from.txt\f[R] with or without leading \f[C]/\f[R], e.g. .IP .nf \f[C] user1/42 user1/dir/ford user2/prefect \f[R] .fi .PP Then copy these to a remote: .IP .nf \f[C] rclone copy --files-from files-from.txt /home remote:backup \f[R] .fi .PP The three files are transferred as follows: .IP .nf \f[C] /home/user1/42 \[->] remote:backup/user1/important /home/user1/dir/ford \[->] remote:backup/user1/dir/file /home/user2/prefect \[->] remote:backup/user2/stuff \f[R] .fi .PP Alternatively if \f[C]/\f[R] is chosen as root \f[C]files-from.txt\f[R] will be: .IP .nf \f[C] /home/user1/42 /home/user1/dir/ford /home/user2/prefect \f[R] .fi .PP The copy command will be: .IP .nf \f[C] rclone copy --files-from files-from.txt / remote:backup \f[R] .fi .PP Then there will be an extra \f[C]home\f[R] directory on the remote: .IP .nf \f[C] /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 \f[R] .fi .SS \f[C]--files-from-raw\f[R] - Read list of source-file names without any processing .PP This flag is the same as \f[C]--files-from\f[R] except that input is read in a raw manner. Lines with leading / trailing whitespace, and lines starting with \f[C];\f[R] or \f[C]#\f[R] 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 \f[C]--files-from-raw\f[R]. .SS \f[C]--ignore-case\f[R] - make searches case insensitive .PP By default, rclone filter patterns are case sensitive. The \f[C]--ignore-case\f[R] flag makes all of the filters patterns on the command line case insensitive. .PP E.g. \f[C]--include \[dq]zaphod.txt\[dq]\f[R] does not match a file \f[C]Zaphod.txt\f[R]. With \f[C]--ignore-case\f[R] a match is made. .SS Quoting shell metacharacters .PP Rclone commands with filter patterns containing shell metacharacters may not as work as expected in your shell and may require quoting. .PP E.g. linux, OSX (\f[C]*\f[R] metacharacter) .IP \[bu] 2 \f[C]--include \[rs]*.jpg\f[R] .IP \[bu] 2 \f[C]--include \[aq]*.jpg\[aq]\f[R] .IP \[bu] 2 \f[C]--include=\[aq]*.jpg\[aq]\f[R] .PP Microsoft Windows expansion is done by the command, not shell, so \f[C]--include *.jpg\f[R] does not require quoting. .PP If the rclone error \f[C]Command .... needs .... arguments maximum: you provided .... non flag arguments:\f[R] 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. .SS Other filters .SS \f[C]--min-size\f[R] - Don\[aq]t transfer any file smaller than this .PP Controls the minimum size file within the scope of an rclone command. Default units are \f[C]KiB\f[R] but abbreviations \f[C]B\f[R], \f[C]K\f[R], \f[C]M\f[R], \f[C]G\f[R], \f[C]T\f[R] or \f[C]P\f[R] are valid. .PP E.g. \f[C]rclone ls remote: --min-size 50k\f[R] lists files on \f[C]remote:\f[R] of 50 KiB size or larger. .PP See the size option docs (https://rclone.org/docs/#size-option) for more info. .SS \f[C]--max-size\f[R] - Don\[aq]t transfer any file larger than this .PP Controls the maximum size file within the scope of an rclone command. Default units are \f[C]KiB\f[R] but abbreviations \f[C]B\f[R], \f[C]K\f[R], \f[C]M\f[R], \f[C]G\f[R], \f[C]T\f[R] or \f[C]P\f[R] are valid. .PP E.g. \f[C]rclone ls remote: --max-size 1G\f[R] lists files on \f[C]remote:\f[R] of 1 GiB size or smaller. .PP See the size option docs (https://rclone.org/docs/#size-option) for more info. .SS \f[C]--max-age\f[R] - Don\[aq]t transfer any file older than this .PP Controls the maximum age of files within the scope of an rclone command. .PP \f[C]--max-age\f[R] applies only to files and not to directories. .PP E.g. \f[C]rclone ls remote: --max-age 2d\f[R] lists files on \f[C]remote:\f[R] of 2 days old or less. .PP See the time option docs (https://rclone.org/docs/#time-option) for valid formats. .SS \f[C]--min-age\f[R] - Don\[aq]t transfer any file younger than this .PP Controls the minimum age of files within the scope of an rclone command. (see \f[C]--max-age\f[R] for valid formats) .PP \f[C]--min-age\f[R] applies only to files and not to directories. .PP E.g. \f[C]rclone ls remote: --min-age 2d\f[R] lists files on \f[C]remote:\f[R] of 2 days old or more. .PP See the time option docs (https://rclone.org/docs/#time-option) for valid formats. .SS Other flags .SS \f[C]--delete-excluded\f[R] - Delete files on dest excluded from sync .PP \f[B]Important\f[R] this flag is dangerous to your data - use with \f[C]--dry-run\f[R] and \f[C]-v\f[R] first. .PP In conjunction with \f[C]rclone sync\f[R], \f[C]--delete-excluded\f[R] deletes any files on the destination which are excluded from the command. .PP E.g. the scope of \f[C]rclone sync --interactive A: B:\f[R] can be restricted: .IP .nf \f[C] rclone --min-size 50k --delete-excluded sync A: B: \f[R] .fi .PP All files on \f[C]B:\f[R] which are less than 50 KiB are deleted because they are excluded from the rclone sync command. .SS \f[C]--dump filters\f[R] - dump the filters to the output .PP Dumps the defined filters to standard output in regular expression format. .PP Useful for debugging. .SS Exclude directory based on a file .PP The \f[C]--exclude-if-present\f[R] 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. .PP This flag has a priority over other filter flags. .PP E.g. for the following directory structure: .IP .nf \f[C] dir1/file1 dir1/dir2/file2 dir1/dir2/dir3/file3 dir1/dir2/dir3/.ignore \f[R] .fi .PP The command \f[C]rclone ls --exclude-if-present .ignore dir1\f[R] does not list \f[C]dir3\f[R], \f[C]file3\f[R] or \f[C].ignore\f[R]. .SS Metadata filters .PP 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. .PP The metadata should be specified as \f[C]key=value\f[R] patterns. This may be wildcarded using the normal filter patterns or regular expressions. .PP For example if you wished to list only local files with a mode of \f[C]100664\f[R] you could do that with: .IP .nf \f[C] rclone lsf -M --files-only --metadata-include \[dq]mode=100664\[dq] . \f[R] .fi .PP Or if you wished to show files with an \f[C]atime\f[R], \f[C]mtime\f[R] or \f[C]btime\f[R] at a given date: .IP .nf \f[C] rclone lsf -M --files-only --metadata-include \[dq][abm]time=2022-12-16*\[dq] . \f[R] .fi .PP Like file filtering, metadata filtering only applies to files not to directories. .PP The filters can be applied using these flags. .IP \[bu] 2 \f[C]--metadata-include\f[R] - Include metadatas matching pattern .IP \[bu] 2 \f[C]--metadata-include-from\f[R] - Read metadata include patterns from file (use - to read from stdin) .IP \[bu] 2 \f[C]--metadata-exclude\f[R] - Exclude metadatas matching pattern .IP \[bu] 2 \f[C]--metadata-exclude-from\f[R] - Read metadata exclude patterns from file (use - to read from stdin) .IP \[bu] 2 \f[C]--metadata-filter\f[R] - Add a metadata filtering rule .IP \[bu] 2 \f[C]--metadata-filter-from\f[R] - Read metadata filtering patterns from a file (use - to read from stdin) .PP Each flag can be repeated. See the section on how filter rules are applied 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. .SS Common pitfalls .PP The most frequent filter support issues on the rclone forum (https://forum.rclone.org/) are: .IP \[bu] 2 Not using paths relative to the root of the remote .IP \[bu] 2 Not using \f[C]/\f[R] to match from the root of a remote .IP \[bu] 2 Not using \f[C]**\f[R] to match the contents of a directory .SH GUI (Experimental) .PP Rclone can serve a web based GUI (graphical user interface). This is somewhat experimental at the moment so things may be subject to change. .PP Run this command in a terminal and rclone will download and then display the GUI in a web browser. .IP .nf \f[C] rclone rcd --rc-web-gui \f[R] .fi .PP This will produce logs like this and rclone needs to continue to run to serve the GUI: .IP .nf \f[C] 2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/rclone/rclone-webui-react/releases/download/v0.0.6/currentbuild.zip 2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path : /home/USER/.cache/rclone/webgui/v0.0.6.zip] 2019/08/25 11:40:16 NOTICE: Unzipping 2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/ \f[R] .fi .PP This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI - see below for details. .PP If you wish to check for updates then you can add \f[C]--rc-web-gui-update\f[R] to the command line. .PP If you find your GUI broken, you may force it to update by add \f[C]--rc-web-gui-force-update\f[R]. .PP By default, rclone will open your browser. Add \f[C]--rc-web-gui-no-open-browser\f[R] to disable this feature. .SS Using the GUI .PP Once the GUI opens, you will be looking at the dashboard which has an overall overview. .PP On the left hand side you will see a series of view buttons you can click on: .IP \[bu] 2 Dashboard - main overview .IP \[bu] 2 Configs - examine and create new configurations .IP \[bu] 2 Explorer - view, download and upload files to the cloud storage systems .IP \[bu] 2 Backend - view or alter the backend config .IP \[bu] 2 Log out .PP (More docs and walkthrough video to come!) .SS How it works .PP When you run the \f[C]rclone rcd --rc-web-gui\f[R] this is what happens .IP \[bu] 2 Rclone starts but only runs the remote control API (\[dq]rc\[dq]). .IP \[bu] 2 The API is bound to localhost with an auto-generated username and password. .IP \[bu] 2 If the API bundle is missing then rclone will download it. .IP \[bu] 2 rclone will start serving the files from the API bundle over the same port as the API .IP \[bu] 2 rclone will open the browser with a \f[C]login_token\f[R] so it can log straight in. .SS Advanced use .PP The \f[C]rclone rcd\f[R] may use any of the flags documented on the rc page (https://rclone.org/rc/#supported-parameters). .PP The flag \f[C]--rc-web-gui\f[R] is shorthand for .IP \[bu] 2 Download the web GUI if necessary .IP \[bu] 2 Check we are using some authentication .IP \[bu] 2 \f[C]--rc-user gui\f[R] .IP \[bu] 2 \f[C]--rc-pass <random password>\f[R] .IP \[bu] 2 \f[C]--rc-serve\f[R] .PP These flags can be overridden as desired. .PP See also the rclone rcd documentation (https://rclone.org/commands/rclone_rcd/). .SS Example: Running a public GUI .PP For example the GUI could be served on a public port over SSL using an htpasswd file using the following flags: .IP \[bu] 2 \f[C]--rc-web-gui\f[R] .IP \[bu] 2 \f[C]--rc-addr :443\f[R] .IP \[bu] 2 \f[C]--rc-htpasswd /path/to/htpasswd\f[R] .IP \[bu] 2 \f[C]--rc-cert /path/to/ssl.crt\f[R] .IP \[bu] 2 \f[C]--rc-key /path/to/ssl.key\f[R] .SS Example: Running a GUI behind a proxy .PP If you want to run the GUI behind a proxy at \f[C]/rclone\f[R] you could use these flags: .IP \[bu] 2 \f[C]--rc-web-gui\f[R] .IP \[bu] 2 \f[C]--rc-baseurl rclone\f[R] .IP \[bu] 2 \f[C]--rc-htpasswd /path/to/htpasswd\f[R] .PP Or instead of htpasswd if you just want a single user and password: .IP \[bu] 2 \f[C]--rc-user me\f[R] .IP \[bu] 2 \f[C]--rc-pass mypassword\f[R] .SS Project .PP The GUI is being developed in the: rclone/rclone-webui-react repository (https://github.com/rclone/rclone-webui-react). .PP Bug reports and contributions are very welcome :-) .PP If you have questions then please ask them on the rclone forum (https://forum.rclone.org/). .SH Remote controlling rclone with its API .PP If rclone is run with the \f[C]--rc\f[R] flag then it starts an HTTP server which can be used to remote control rclone using its API. .PP You can either use the rc command to access the API or use HTTP directly. .PP If you just want to run a remote control then see the rcd (https://rclone.org/commands/rclone_rcd/) command. .SS Supported parameters .SS --rc .PP Flag to start the http server listen on remote requests. .SS --rc-addr=IP .PP IPaddress:Port or :Port to bind server to. (default \[dq]localhost:5572\[dq]). .SS --rc-cert=KEY .PP SSL PEM key (concatenation of certificate and CA certificate). .SS --rc-client-ca=PATH .PP Client certificate authority to verify clients with. .SS --rc-htpasswd=PATH .PP htpasswd file - if not provided no authentication is done. .SS --rc-key=PATH .PP TLS PEM private key file. .SS --rc-max-header-bytes=VALUE .PP Maximum size of request header (default 4096). .SS --rc-min-tls-version=VALUE .PP The minimum TLS version that is acceptable. Valid values are \[dq]tls1.0\[dq], \[dq]tls1.1\[dq], \[dq]tls1.2\[dq] and \[dq]tls1.3\[dq] (default \[dq]tls1.0\[dq]). .SS --rc-user=VALUE .PP User name for authentication. .SS --rc-pass=VALUE .PP Password for authentication. .SS --rc-realm=VALUE .PP Realm for authentication (default \[dq]rclone\[dq]). .SS --rc-server-read-timeout=DURATION .PP Timeout for server reading data (default 1h0m0s). .SS --rc-server-write-timeout=DURATION .PP Timeout for server writing data (default 1h0m0s). .SS --rc-serve .PP 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 .PP Default Off. .SS --rc-serve-no-modtime .PP Set this flag to skip reading the modification time (can speed things up). .PP Default Off. .SS --rc-files /path/to/directory .PP Path to local files to serve on the HTTP server. .PP 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. .PP If \f[C]--rc-user\f[R] or \f[C]--rc-pass\f[R] is set then the URL that is opened will have the authorization in the URL in the \f[C]http://user:pass\[at]localhost/\f[R] style. .PP Default Off. .SS --rc-enable-metrics .PP Enable OpenMetrics/Prometheus compatible endpoint at \f[C]/metrics\f[R]. 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 \f[C]--metrics-*\f[R] flags instead. .PP Default Off. .SS --rc-web-gui .PP Set this flag to serve the default web gui on the same port as rclone. .PP Default Off. .SS --rc-allow-origin .PP Set the allowed Access-Control-Allow-Origin for rc requests. .PP Can be used with --rc-web-gui if the rclone is running on different IP than the web-gui. .PP Default is IP address on which rc is running. .SS --rc-web-fetch-url .PP Set the URL to fetch the rclone-web-gui files from. .PP Default https://api.github.com/repos/rclone/rclone-webui-react/releases/latest. .SS --rc-web-gui-update .PP Set this flag to check and update rclone-webui-react from the rc-web-fetch-url. .PP Default Off. .SS --rc-web-gui-force-update .PP Set this flag to force update rclone-webui-react from the rc-web-fetch-url. .PP Default Off. .SS --rc-web-gui-no-open-browser .PP Set this flag to disable opening browser automatically when using web-gui. .PP Default Off. .SS --rc-job-expire-duration=DURATION .PP Expire finished async jobs older than DURATION (default 60s). .SS --rc-job-expire-interval=DURATION .PP Interval duration to check for expired async jobs (default 10s). .SS --rc-no-auth .PP 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 \f[C]operations/list\f[R] is denied as it involved creating a remote as is \f[C]sync/copy\f[R]. .PP If this is set then no authorisation will be required on the server to use these methods. The alternative is to use \f[C]--rc-user\f[R] and \f[C]--rc-pass\f[R] and use these credentials in the request. .PP Default Off. .SS --rc-baseurl .PP Prefix for URLs. .PP Default is root .SS --rc-template .PP User-specified template. .SS Accessing the remote control via the rclone rc command .PP Rclone itself implements the remote control protocol in its \f[C]rclone rc\f[R] command. .PP You can use it like this: .IP .nf \f[C] $ rclone rc rc/noop param1=one param2=two { \[dq]param1\[dq]: \[dq]one\[dq], \[dq]param2\[dq]: \[dq]two\[dq] } \f[R] .fi .PP If the remote is running on a different URL than the default \f[C]http://localhost:5572/\f[R], use the \f[C]--url\f[R] option to specify it: .IP .nf \f[C] $ rclone rc --url http://some.remote:1234/ rc/noop \f[R] .fi .PP Or, if the remote is listening on a Unix socket, use the \f[C]--unix-socket\f[R] option instead: .IP .nf \f[C] $ rclone rc --unix-socket /tmp/rclone.sock rc/noop \f[R] .fi .PP Run \f[C]rclone rc\f[R] 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. .SS JSON input .PP \f[C]rclone rc\f[R] also supports a \f[C]--json\f[R] flag which can be used to send more complicated input parameters. .IP .nf \f[C] $ rclone rc --json \[aq]{ \[dq]p1\[dq]: [1,\[dq]2\[dq],null,4], \[dq]p2\[dq]: { \[dq]a\[dq]:1, \[dq]b\[dq]:2 } }\[aq] rc/noop { \[dq]p1\[dq]: [ 1, \[dq]2\[dq], null, 4 ], \[dq]p2\[dq]: { \[dq]a\[dq]: 1, \[dq]b\[dq]: 2 } } \f[R] .fi .PP If the parameter being passed is an object then it can be passed as a JSON string rather than using the \f[C]--json\f[R] flag which simplifies the command line. .IP .nf \f[C] rclone rc operations/list fs=/tmp remote=test opt=\[aq]{\[dq]showHash\[dq]: true}\[aq] \f[R] .fi .PP Rather than .IP .nf \f[C] rclone rc operations/list --json \[aq]{\[dq]fs\[dq]: \[dq]/tmp\[dq], \[dq]remote\[dq]: \[dq]test\[dq], \[dq]opt\[dq]: {\[dq]showHash\[dq]: true}}\[aq] \f[R] .fi .SS Special parameters .PP The rc interface supports some special parameters which apply to \f[B]all\f[R] commands. These start with \f[C]_\f[R] to show they are different. .SS Running asynchronous jobs with _async = true .PP 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. .PP If \f[C]_async\f[R] has a true value when supplied to an rc call then it will return immediately with a job id and the task will be run in the background. The \f[C]job/status\f[R] 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. .PP It is recommended that potentially long running jobs, e.g. \f[C]sync/sync\f[R], \f[C]sync/copy\f[R], \f[C]sync/move\f[R], \f[C]operations/purge\f[R] are run with the \f[C]_async\f[R] flag to avoid any potential problems with the HTTP request and response timing out. .PP Starting a job with the \f[C]_async\f[R] flag: .IP .nf \f[C] $ rclone rc --json \[aq]{ \[dq]p1\[dq]: [1,\[dq]2\[dq],null,4], \[dq]p2\[dq]: { \[dq]a\[dq]:1, \[dq]b\[dq]:2 }, \[dq]_async\[dq]: true }\[aq] rc/noop { \[dq]jobid\[dq]: 2 } \f[R] .fi .PP Query the status to see if the job has finished. For more information on the meaning of these return parameters see the \f[C]job/status\f[R] call. .IP .nf \f[C] $ rclone rc --json \[aq]{ \[dq]jobid\[dq]:2 }\[aq] job/status { \[dq]duration\[dq]: 0.000124163, \[dq]endTime\[dq]: \[dq]2018-10-27T11:38:07.911245881+01:00\[dq], \[dq]error\[dq]: \[dq]\[dq], \[dq]finished\[dq]: true, \[dq]id\[dq]: 2, \[dq]output\[dq]: { \[dq]_async\[dq]: true, \[dq]p1\[dq]: [ 1, \[dq]2\[dq], null, 4 ], \[dq]p2\[dq]: { \[dq]a\[dq]: 1, \[dq]b\[dq]: 2 } }, \[dq]startTime\[dq]: \[dq]2018-10-27T11:38:07.911121728+01:00\[dq], \[dq]success\[dq]: true } \f[R] .fi .PP \f[C]job/list\f[R] can be used to show the running or recently completed jobs .IP .nf \f[C] $ rclone rc job/list { \[dq]jobids\[dq]: [ 2 ] } \f[R] .fi .SS Setting config flags with _config .PP If you wish to set config (the equivalent of the global flags) for the duration of an rc call only then pass in the \f[C]_config\f[R] parameter. .PP This should be in the same format as the \f[C]config\f[R] key returned by options/get. .PP For example, if you wished to run a sync with the \f[C]--checksum\f[R] parameter, you would pass this parameter in your JSON blob. .IP .nf \f[C] \[dq]_config\[dq]:{\[dq]CheckSum\[dq]: true} \f[R] .fi .PP If using \f[C]rclone rc\f[R] this could be passed as .IP .nf \f[C] rclone rc sync/sync ... _config=\[aq]{\[dq]CheckSum\[dq]: true}\[aq] \f[R] .fi .PP Any config parameters you don\[aq]t set will inherit the global defaults which were set with command line flags or environment variables. .PP Note that it is possible to set some values as strings or integers - see data types for more info. Here is an example setting the equivalent of \f[C]--buffer-size\f[R] in string or integer format. .IP .nf \f[C] \[dq]_config\[dq]:{\[dq]BufferSize\[dq]: \[dq]42M\[dq]} \[dq]_config\[dq]:{\[dq]BufferSize\[dq]: 44040192} \f[R] .fi .PP If you wish to check the \f[C]_config\f[R] assignment has worked properly then calling \f[C]options/local\f[R] will show what the value got set to. .SS Setting filter flags with _filter .PP If you wish to set filters for the duration of an rc call only then pass in the \f[C]_filter\f[R] parameter. .PP This should be in the same format as the \f[C]filter\f[R] key returned by options/get. .PP For example, if you wished to run a sync with these flags .IP .nf \f[C] --max-size 1M --max-age 42s --include \[dq]a\[dq] --include \[dq]b\[dq] \f[R] .fi .PP you would pass this parameter in your JSON blob. .IP .nf \f[C] \[dq]_filter\[dq]:{\[dq]MaxSize\[dq]:\[dq]1M\[dq], \[dq]IncludeRule\[dq]:[\[dq]a\[dq],\[dq]b\[dq]], \[dq]MaxAge\[dq]:\[dq]42s\[dq]} \f[R] .fi .PP If using \f[C]rclone rc\f[R] this could be passed as .IP .nf \f[C] rclone rc ... _filter=\[aq]{\[dq]MaxSize\[dq]:\[dq]1M\[dq], \[dq]IncludeRule\[dq]:[\[dq]a\[dq],\[dq]b\[dq]], \[dq]MaxAge\[dq]:\[dq]42s\[dq]}\[aq] \f[R] .fi .PP Any filter parameters you don\[aq]t set will inherit the global defaults which were set with command line flags or environment variables. .PP Note that it is possible to set some values as strings or integers - see data types for more info. Here is an example setting the equivalent of \f[C]--buffer-size\f[R] in string or integer format. .IP .nf \f[C] \[dq]_filter\[dq]:{\[dq]MinSize\[dq]: \[dq]42M\[dq]} \[dq]_filter\[dq]:{\[dq]MinSize\[dq]: 44040192} \f[R] .fi .PP If you wish to check the \f[C]_filter\f[R] assignment has worked properly then calling \f[C]options/local\f[R] will show what the value got set to. .SS Assigning operations to groups with _group = value .PP Each rc call has its own stats group for tracking its metrics. By default grouping is done by the composite group name from prefix \f[C]job/\f[R] and id of the job like so \f[C]job/1\f[R]. .PP If \f[C]_group\f[R] has a value then stats for that request will be grouped under that value. This allows caller to group stats under their own name. .PP Stats for specific group can be accessed by passing \f[C]group\f[R] to \f[C]core/stats\f[R]: .IP .nf \f[C] $ rclone rc --json \[aq]{ \[dq]group\[dq]: \[dq]job/1\[dq] }\[aq] core/stats { \[dq]speed\[dq]: 12345 ... } \f[R] .fi .SS Data types .PP When the API returns types, these will mostly be straight forward integer, string or boolean types. .PP However some of the types returned by the options/get call and taken by the options/set calls as well as the \f[C]vfsOpt\f[R], \f[C]mountOpt\f[R] and the \f[C]_config\f[R] parameters. .IP \[bu] 2 \f[C]Duration\f[R] - 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 \[dq]5s\[dq]. See the options section (https://rclone.org/docs/#options) for more info. .IP \[bu] 2 \f[C]Size\f[R] - 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 \[dq]10M\[dq]. See the options section (https://rclone.org/docs/#options) for more info. .IP \[bu] 2 Enumerated type (such as \f[C]CutoffMode\f[R], \f[C]DumpFlags\f[R], \f[C]LogLevel\f[R], \f[C]VfsCacheMode\f[R] - 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 \[dq]HARD\[dq] for \f[C]CutoffMode\f[R] or \f[C]DEBUG\f[R] for \f[C]LogLevel\f[R]. .IP \[bu] 2 \f[C]BandwidthSpec\f[R] - this will be set and returned as a string, eg \[dq]1M\[dq]. .SS Option blocks .PP The calls options/info (for the main config) and 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. .PP These consist of arrays of \f[C]Option\f[R] blocks. These have the following format. Each block describes a single option. .PP .TS tab(@); lw(13.6n) lw(11.7n) lw(19.4n) lw(25.3n). T{ Field T}@T{ Type T}@T{ Optional T}@T{ Description T} _ T{ Name T}@T{ string T}@T{ N T}@T{ name of the option in snake_case T} T{ FieldName T}@T{ string T}@T{ N T}@T{ name of the field used in the rc - if blank use Name T} T{ Help T}@T{ string T}@T{ N T}@T{ help, started with a single sentence on a single line T} T{ Groups T}@T{ string T}@T{ Y T}@T{ groups this option belongs to - comma separated string for options classification T} T{ Provider T}@T{ string T}@T{ Y T}@T{ set to filter on provider T} T{ Default T}@T{ any T}@T{ N T}@T{ default value, if set (and not to nil or \[dq]\[dq]) then Required does nothing T} T{ Value T}@T{ any T}@T{ N T}@T{ value to be set by flags T} T{ Examples T}@T{ Examples T}@T{ Y T}@T{ predefined values that can be selected from list (multiple-choice option) T} T{ ShortOpt T}@T{ string T}@T{ Y T}@T{ the short command line option for this T} T{ Hide T}@T{ Visibility T}@T{ N T}@T{ if non zero, this option is hidden from the configurator or the command line T} T{ Required T}@T{ bool T}@T{ N T}@T{ this option is required, meaning value cannot be empty unless there is a default T} T{ IsPassword T}@T{ bool T}@T{ N T}@T{ set if the option is a password T} T{ NoPrefix T}@T{ bool T}@T{ N T}@T{ set if the option for this should not use the backend prefix T} T{ Advanced T}@T{ bool T}@T{ N T}@T{ set if this is an advanced config option T} T{ Exclusive T}@T{ bool T}@T{ N T}@T{ set if the answer can only be one of the examples (empty string allowed unless Required or Default is set) T} T{ Sensitive T}@T{ bool T}@T{ N T}@T{ set if this option should be redacted when using \f[C]rclone config redacted\f[R] T} .TE .PP An example of this might be the \f[C]--log-level\f[R] flag. Note that the \f[C]Name\f[R] of the option becomes the command line flag with \f[C]_\f[R] replaced with \f[C]-\f[R]. .IP .nf \f[C] { \[dq]Advanced\[dq]: false, \[dq]Default\[dq]: 5, \[dq]DefaultStr\[dq]: \[dq]NOTICE\[dq], \[dq]Examples\[dq]: [ { \[dq]Help\[dq]: \[dq]\[dq], \[dq]Value\[dq]: \[dq]EMERGENCY\[dq] }, { \[dq]Help\[dq]: \[dq]\[dq], \[dq]Value\[dq]: \[dq]ALERT\[dq] }, ... ], \[dq]Exclusive\[dq]: true, \[dq]FieldName\[dq]: \[dq]LogLevel\[dq], \[dq]Groups\[dq]: \[dq]Logging\[dq], \[dq]Help\[dq]: \[dq]Log level DEBUG|INFO|NOTICE|ERROR\[dq], \[dq]Hide\[dq]: 0, \[dq]IsPassword\[dq]: false, \[dq]Name\[dq]: \[dq]log_level\[dq], \[dq]NoPrefix\[dq]: true, \[dq]Required\[dq]: true, \[dq]Sensitive\[dq]: false, \[dq]Type\[dq]: \[dq]LogLevel\[dq], \[dq]Value\[dq]: null, \[dq]ValueStr\[dq]: \[dq]NOTICE\[dq] }, \f[R] .fi .PP Note that the \f[C]Help\f[R] may be multiple lines separated by \f[C]\[rs]n\f[R]. The first line will always be a short sentence and this is the sentence shown when running \f[C]rclone help flags\f[R]. .SS Specifying remotes to work on .PP Remotes are specified with the \f[C]fs=\f[R], \f[C]srcFs=\f[R], \f[C]dstFs=\f[R] parameters depending on the command being used. .PP The parameters can be a string as per the rest of rclone, eg \f[C]s3:bucket/path\f[R] or \f[C]:sftp:/my/dir\f[R]. They can also be specified as JSON blobs. .PP 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: .IP \[bu] 2 \f[C]type\f[R] - set to \f[C]type\f[R] to specify a remote called \f[C]:type:\f[R] .IP \[bu] 2 \f[C]_name\f[R] - set to \f[C]name\f[R] to specify a remote called \f[C]name:\f[R] .IP \[bu] 2 \f[C]_root\f[R] - sets the root of the remote - may be empty .PP One of \f[C]_name\f[R] or \f[C]type\f[R] should normally be set. If the \f[C]local\f[R] backend is desired then \f[C]type\f[R] should be set to \f[C]local\f[R]. If \f[C]_root\f[R] isn\[aq]t specified then it defaults to the root of the remote. .PP For example this JSON is equivalent to \f[C]remote:/tmp\f[R] .IP .nf \f[C] { \[dq]_name\[dq]: \[dq]remote\[dq], \[dq]_root\[dq]: \[dq]/tmp\[dq] } \f[R] .fi .PP And this is equivalent to \f[C]:sftp,host=\[aq]example.com\[aq]:/tmp\f[R] .IP .nf \f[C] { \[dq]type\[dq]: \[dq]sftp\[dq], \[dq]host\[dq]: \[dq]example.com\[dq], \[dq]_root\[dq]: \[dq]/tmp\[dq] } \f[R] .fi .PP And this is equivalent to \f[C]/tmp/dir\f[R] .IP .nf \f[C] { type = \[dq]local\[dq], _root = \[dq]/tmp/dir\[dq] } \f[R] .fi .SS Supported commands .SS backend/command: Runs a backend command. .PP This takes the following parameters: .IP \[bu] 2 command - a string with the command name .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 arg - a list of arguments for the backend command .IP \[bu] 2 opt - a map of string to string of options .PP Returns: .IP \[bu] 2 result - result from the backend command .PP Example: .IP .nf \f[C] rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2 \f[R] .fi .PP Returns .IP .nf \f[C] { \[dq]result\[dq]: { \[dq]arg\[dq]: [ \[dq]path1\[dq], \[dq]path2\[dq] ], \[dq]name\[dq]: \[dq]noop\[dq], \[dq]opt\[dq]: { \[dq]blue\[dq]: \[dq]\[dq], \[dq]echo\[dq]: \[dq]yes\[dq] } } } \f[R] .fi .PP Note that this is the direct equivalent of using this \[dq]backend\[dq] command: .IP .nf \f[C] rclone backend noop . -o echo=yes -o blue path1 path2 \f[R] .fi .PP Note that arguments must be preceded by the \[dq]-a\[dq] flag .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more information. .PP \f[B]Authentication is required for this call.\f[R] .SS cache/expire: Purge a remote from cache .PP 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) .PP Eg .IP .nf \f[C] rclone rc cache/expire remote=path/to/sub/folder/ rclone rc cache/expire remote=/ withData=true \f[R] .fi .SS cache/fetch: Fetch file chunks .PP Ensure the specified file chunks are cached on disk. .PP 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] .PP 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 \[dq]-5:\[dq] represents the last 5 chunks of a file. .PP Some valid examples are: \[dq]:5,-5:\[dq] -> the first and last five chunks \[dq]0,-2\[dq] -> the first and the second last chunk \[dq]0:10\[dq] -> the first ten chunks .PP Any parameter with a key that starts with \[dq]file\[dq] can be used to specify files to fetch, e.g. .IP .nf \f[C] rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye \f[R] .fi .PP File names will automatically be encrypted when the a crypt remote is used on top of the cache. .SS cache/stats: Get cache stats .PP Show statistics for the cache remote. .SS config/create: create the config for a remote. .PP This takes the following parameters: .IP \[bu] 2 name - name of remote .IP \[bu] 2 parameters - a map of { \[dq]key\[dq]: \[dq]value\[dq] } pairs .IP \[bu] 2 type - type of the new remote .IP \[bu] 2 opt - a dictionary of options to control the configuration .RS 2 .IP \[bu] 2 obscure - declare passwords are plain and need obscuring .IP \[bu] 2 noObscure - declare passwords are already obscured and don\[aq]t need obscuring .IP \[bu] 2 nonInteractive - don\[aq]t interact with a user, return questions .IP \[bu] 2 continue - continue the config process with an answer .IP \[bu] 2 all - ask all the config questions not just the post config ones .IP \[bu] 2 state - state to restart with - used with continue .IP \[bu] 2 result - result to restart with - used with continue .RE .PP See the config create (https://rclone.org/commands/rclone_config_create/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/delete: Delete a remote in the config file. .PP Parameters: .IP \[bu] 2 name - name of remote to delete .PP See the config delete (https://rclone.org/commands/rclone_config_delete/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/dump: Dumps the config file. .PP Returns a JSON object: - key: value .PP Where keys are remote names and values are the config parameters. .PP See the config dump (https://rclone.org/commands/rclone_config_dump/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/get: Get a remote in the config file. .PP Parameters: .IP \[bu] 2 name - name of remote to get .PP See the config dump (https://rclone.org/commands/rclone_config_dump/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/listremotes: Lists the remotes in the config file and defined in environment variables. .PP Returns - remotes - array of remote names .PP See the listremotes (https://rclone.org/commands/rclone_listremotes/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/password: password the config for a remote. .PP This takes the following parameters: .IP \[bu] 2 name - name of remote .IP \[bu] 2 parameters - a map of { \[dq]key\[dq]: \[dq]value\[dq] } pairs .PP See the config password (https://rclone.org/commands/rclone_config_password/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/paths: Reads the config file path and other important paths. .PP Returns a JSON object with the following keys: .IP \[bu] 2 config: path to config file .IP \[bu] 2 cache: path to root of cache directory .IP \[bu] 2 temp: path to root of temporary directory .PP Eg .IP .nf \f[C] { \[dq]cache\[dq]: \[dq]/home/USER/.cache/rclone\[dq], \[dq]config\[dq]: \[dq]/home/USER/.rclone.conf\[dq], \[dq]temp\[dq]: \[dq]/tmp\[dq] } \f[R] .fi .PP See the config paths (https://rclone.org/commands/rclone_config_paths/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS config/providers: Shows how providers are configured in the config file. .PP Returns a JSON object: - providers - array of objects .PP See the config providers (https://rclone.org/commands/rclone_config_providers/) command for more information on the above. .PP Note that the Options blocks are in the same format as returned by \[dq]options/info\[dq]. They are described in the option blocks section. .PP \f[B]Authentication is required for this call.\f[R] .SS config/setpath: Set the path of the config file .PP Parameters: .IP \[bu] 2 path - path to the config file to use .PP \f[B]Authentication is required for this call.\f[R] .SS config/update: update the config for a remote. .PP This takes the following parameters: .IP \[bu] 2 name - name of remote .IP \[bu] 2 parameters - a map of { \[dq]key\[dq]: \[dq]value\[dq] } pairs .IP \[bu] 2 opt - a dictionary of options to control the configuration .RS 2 .IP \[bu] 2 obscure - declare passwords are plain and need obscuring .IP \[bu] 2 noObscure - declare passwords are already obscured and don\[aq]t need obscuring .IP \[bu] 2 nonInteractive - don\[aq]t interact with a user, return questions .IP \[bu] 2 continue - continue the config process with an answer .IP \[bu] 2 all - ask all the config questions not just the post config ones .IP \[bu] 2 state - state to restart with - used with continue .IP \[bu] 2 result - result to restart with - used with continue .RE .PP See the config update (https://rclone.org/commands/rclone_config_update/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS core/bwlimit: Set the bandwidth limit. .PP 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. .PP Eg .IP .nf \f[C] rclone rc core/bwlimit rate=off { \[dq]bytesPerSecond\[dq]: -1, \[dq]bytesPerSecondTx\[dq]: -1, \[dq]bytesPerSecondRx\[dq]: -1, \[dq]rate\[dq]: \[dq]off\[dq] } rclone rc core/bwlimit rate=1M { \[dq]bytesPerSecond\[dq]: 1048576, \[dq]bytesPerSecondTx\[dq]: 1048576, \[dq]bytesPerSecondRx\[dq]: 1048576, \[dq]rate\[dq]: \[dq]1M\[dq] } rclone rc core/bwlimit rate=1M:100k { \[dq]bytesPerSecond\[dq]: 1048576, \[dq]bytesPerSecondTx\[dq]: 1048576, \[dq]bytesPerSecondRx\[dq]: 131072, \[dq]rate\[dq]: \[dq]1M\[dq] } \f[R] .fi .PP If the rate parameter is not supplied then the bandwidth is queried .IP .nf \f[C] rclone rc core/bwlimit { \[dq]bytesPerSecond\[dq]: 1048576, \[dq]bytesPerSecondTx\[dq]: 1048576, \[dq]bytesPerSecondRx\[dq]: 1048576, \[dq]rate\[dq]: \[dq]1M\[dq] } \f[R] .fi .PP The format of the parameter is exactly the same as passed to --bwlimit except only one bandwidth may be specified. .PP In either case \[dq]rate\[dq] is returned as a human-readable string, and \[dq]bytesPerSecond\[dq] is returned as a number. .SS core/command: Run a rclone terminal command over rc. .PP This takes the following parameters: .IP \[bu] 2 command - a string with the command name. .IP \[bu] 2 arg - a list of arguments for the backend command. .IP \[bu] 2 opt - a map of string to string of options. .IP \[bu] 2 returnType - one of (\[dq]COMBINED_OUTPUT\[dq], \[dq]STREAM\[dq], \[dq]STREAM_ONLY_STDOUT\[dq], \[dq]STREAM_ONLY_STDERR\[dq]). .RS 2 .IP \[bu] 2 Defaults to \[dq]COMBINED_OUTPUT\[dq] if not set. .IP \[bu] 2 The STREAM returnTypes will write the output to the body of the HTTP message. .IP \[bu] 2 The COMBINED_OUTPUT will write the output to the \[dq]result\[dq] parameter. .RE .PP Returns: .IP \[bu] 2 result - result from the backend command. .RS 2 .IP \[bu] 2 Only set when using returnType \[dq]COMBINED_OUTPUT\[dq]. .RE .IP \[bu] 2 error - set if rclone exits with an error code. .IP \[bu] 2 returnType - one of (\[dq]COMBINED_OUTPUT\[dq], \[dq]STREAM\[dq], \[dq]STREAM_ONLY_STDOUT\[dq], \[dq]STREAM_ONLY_STDERR\[dq]). .PP Example: .IP .nf \f[C] rclone rc core/command command=ls -a mydrive:/ -o max-depth=1 rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 \f[R] .fi .PP Returns: .IP .nf \f[C] { \[dq]error\[dq]: false, \[dq]result\[dq]: \[dq]<Raw command line output>\[dq] } OR { \[dq]error\[dq]: true, \[dq]result\[dq]: \[dq]<Raw command line output>\[dq] } \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS core/du: Returns disk usage of a locally attached disk. .PP This returns the disk usage for the local directory passed in as dir. .PP If the directory is not passed in, it defaults to the directory pointed to by --cache-dir. .IP \[bu] 2 dir - string (optional) .PP Returns: .IP .nf \f[C] { \[dq]dir\[dq]: \[dq]/\[dq], \[dq]info\[dq]: { \[dq]Available\[dq]: 361769115648, \[dq]Free\[dq]: 361785892864, \[dq]Total\[dq]: 982141468672 } } \f[R] .fi .SS core/gc: Runs a garbage collection. .PP This tells the go runtime to do a garbage collection run. It isn\[aq]t necessary to call this normally, but it can be useful for debugging memory problems. .SS core/group-list: Returns list of stats. .PP This returns list of stats groups currently in memory. .PP Returns the following values: .IP .nf \f[C] { \[dq]groups\[dq]: an array of group names: [ \[dq]group1\[dq], \[dq]group2\[dq], ... ] } \f[R] .fi .SS core/memstats: Returns the memory statistics .PP 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 .PP The most interesting values for most people are: .IP \[bu] 2 HeapAlloc - this is the amount of memory rclone is actually using .IP \[bu] 2 HeapSys - this is the amount of memory rclone has obtained from the OS .IP \[bu] 2 Sys - this is the total amount of memory requested from the OS .RS 2 .IP \[bu] 2 It is virtual memory so may include unused memory .RE .SS core/obscure: Obscures a string passed in. .PP Pass a clear string and rclone will obscure it for the config file: - clear - string .PP Returns: - obscured - string .SS core/pid: Return PID of current process .PP This returns PID of current process. Useful for stopping rclone process. .SS core/quit: Terminates the app. .PP (Optional) Pass an exit code to be used for terminating the app: - exitCode - int .SS core/stats: Returns stats about current transfers. .PP This returns all available stats: .IP .nf \f[C] rclone rc core/stats \f[R] .fi .PP If group is not provided then summed up stats for all groups will be returned. .PP Parameters .IP \[bu] 2 group - name of the stats group (string) .PP Returns the following values: .IP .nf \f[C] { \[dq]bytes\[dq]: total transferred bytes since the start of the group, \[dq]checks\[dq]: number of files checked, \[dq]deletes\[dq] : number of files deleted, \[dq]elapsedTime\[dq]: time in floating point seconds since rclone was started, \[dq]errors\[dq]: number of errors, \[dq]eta\[dq]: estimated time in seconds until the group completes, \[dq]fatalError\[dq]: boolean whether there has been at least one fatal error, \[dq]lastError\[dq]: last error string, \[dq]renames\[dq] : number of files renamed, \[dq]retryError\[dq]: boolean showing whether there has been at least one non-NoRetryError, \[dq]serverSideCopies\[dq]: number of server side copies done, \[dq]serverSideCopyBytes\[dq]: number bytes server side copied, \[dq]serverSideMoves\[dq]: number of server side moves done, \[dq]serverSideMoveBytes\[dq]: number bytes server side moved, \[dq]speed\[dq]: average speed in bytes per second since start of the group, \[dq]totalBytes\[dq]: total number of bytes in the group, \[dq]totalChecks\[dq]: total number of checks in the group, \[dq]totalTransfers\[dq]: total number of transfers in the group, \[dq]transferTime\[dq] : total time spent on running jobs, \[dq]transfers\[dq]: number of transferred files, \[dq]transferring\[dq]: an array of currently active file transfers: [ { \[dq]bytes\[dq]: total transferred bytes for this file, \[dq]eta\[dq]: estimated time in seconds until file transfer completion \[dq]name\[dq]: name of the file, \[dq]percentage\[dq]: progress of the file transfer in percent, \[dq]speed\[dq]: average speed over the whole transfer in bytes per second, \[dq]speedAvg\[dq]: current speed in bytes per second as an exponentially weighted moving average, \[dq]size\[dq]: size of the file in bytes } ], \[dq]checking\[dq]: an array of names of currently active file checks [] } \f[R] .fi .PP Values for \[dq]transferring\[dq], \[dq]checking\[dq] and \[dq]lastError\[dq] are only assigned if data is available. The value for \[dq]eta\[dq] is null if an eta cannot be determined. .SS core/stats-delete: Delete stats group. .PP This deletes entire stats group. .PP Parameters .IP \[bu] 2 group - name of the stats group (string) .SS core/stats-reset: Reset stats. .PP This clears counters, errors and finished transfers for all stats or specific stats group if group is provided. .PP Parameters .IP \[bu] 2 group - name of the stats group (string) .SS core/transferred: Returns stats about completed transfers. .PP This returns stats about completed transfers: .IP .nf \f[C] rclone rc core/transferred \f[R] .fi .PP If group is not provided then completed transfers for all groups will be returned. .PP Note only the last 100 completed transfers are returned. .PP Parameters .IP \[bu] 2 group - name of the stats group (string) .PP Returns the following values: .IP .nf \f[C] { \[dq]transferred\[dq]: an array of completed transfers (including failed ones): [ { \[dq]name\[dq]: name of the file, \[dq]size\[dq]: size of the file in bytes, \[dq]bytes\[dq]: total transferred bytes for this file, \[dq]checked\[dq]: if the transfer is only checked (skipped, deleted), \[dq]timestamp\[dq]: integer representing millisecond unix epoch, \[dq]error\[dq]: string description of the error (empty if successful), \[dq]jobid\[dq]: id of the job that this transfer belongs to } ] } \f[R] .fi .SS core/version: Shows the current version of rclone and the go runtime. .PP This shows the current version of go and the go runtime: .IP \[bu] 2 version - rclone version, e.g. \[dq]v1.53.0\[dq] .IP \[bu] 2 decomposed - version number as [major, minor, patch] .IP \[bu] 2 isGit - boolean - true if this was compiled from the git version .IP \[bu] 2 isBeta - boolean - true if this is a beta version .IP \[bu] 2 os - OS in use as according to Go .IP \[bu] 2 arch - cpu architecture in use according to Go .IP \[bu] 2 goVersion - version of Go runtime in use .IP \[bu] 2 linking - type of rclone executable (static or dynamic) .IP \[bu] 2 goTags - space separated build tags or \[dq]none\[dq] .SS debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. .PP 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. .PP To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0. .PP After calling this you can use this to see the blocking profile: .IP .nf \f[C] go tool pprof http://localhost:5572/debug/pprof/block \f[R] .fi .PP Parameters: .IP \[bu] 2 rate - int .SS debug/set-gc-percent: Call runtime/debug.SetGCPercent for setting the garbage collection target percentage. .PP 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. .PP 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. .PP See https://pkg.go.dev/runtime/debug#SetMemoryLimit for more details. .PP Parameters: .IP \[bu] 2 gc-percent - int .SS debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. .PP 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. .PP 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.) .PP Once this is set you can look use this to profile the mutex contention: .IP .nf \f[C] go tool pprof http://localhost:5572/debug/pprof/mutex \f[R] .fi .PP Parameters: .IP \[bu] 2 rate - int .PP Results: .IP \[bu] 2 previousRate - int .SS debug/set-soft-memory-limit: Call runtime/debug.SetMemoryLimit for setting a soft memory limit for the runtime. .PP SetMemoryLimit provides the runtime with a soft memory limit. .PP 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). .PP 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). .PP A zero limit or a limit that\[aq]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. .PP 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. .PP 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. .PP 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. .PP Parameters: .IP \[bu] 2 mem-limit - int .SS fscache/clear: Clear the Fs cache. .PP 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. .PP 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. .PP \f[B]Authentication is required for this call.\f[R] .SS fscache/entries: Returns the number of entries in the fs cache. .PP This returns the number of entries in the fs cache. .PP Returns - entries - number of items in the cache .PP \f[B]Authentication is required for this call.\f[R] .SS job/list: Lists the IDs of the running jobs .PP Parameters: None. .PP Results: .IP \[bu] 2 executeId - string id of rclone executing (change after restart) .IP \[bu] 2 jobids - array of integer job ids (starting at 1 on each restart) .SS job/status: Reads the status of the job ID .PP Parameters: .IP \[bu] 2 jobid - id of the job (integer). .PP Results: .IP \[bu] 2 finished - boolean .IP \[bu] 2 duration - time in seconds that the job ran for .IP \[bu] 2 endTime - time the job finished (e.g. \[dq]2018-10-26T18:50:20.528746884+01:00\[dq]) .IP \[bu] 2 error - error from the job or empty string for no error .IP \[bu] 2 finished - boolean whether the job has finished or not .IP \[bu] 2 id - as passed in above .IP \[bu] 2 startTime - time the job started (e.g. \[dq]2018-10-26T18:50:20.528336039+01:00\[dq]) .IP \[bu] 2 success - boolean - true for success false otherwise .IP \[bu] 2 output - output of the job as would have been returned if called synchronously .IP \[bu] 2 progress - output of the progress related to the underlying job .SS job/stop: Stop the running job .PP Parameters: .IP \[bu] 2 jobid - id of the job (integer). .SS job/stopgroup: Stop all running jobs in a group .PP Parameters: .IP \[bu] 2 group - name of the group (string). .SS mount/listmounts: Show current mount points .PP This shows currently mounted points, which can be used for performing an unmount. .PP This takes no parameters and returns .IP \[bu] 2 mountPoints: list of current mount points .PP Eg .IP .nf \f[C] rclone rc mount/listmounts \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS mount/mount: Create a new mount point .PP rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. .PP If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 .PP This takes the following parameters: .IP \[bu] 2 fs - a remote path to be mounted (required) .IP \[bu] 2 mountPoint: valid path on the local machine (required) .IP \[bu] 2 mountType: one of the values (mount, cmount, mount2) specifies the mount implementation to use .IP \[bu] 2 mountOpt: a JSON object with Mount options in. .IP \[bu] 2 vfsOpt: a JSON object with VFS options in. .PP Example: .IP .nf \f[C] rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq] \f[R] .fi .PP The vfsOpt are as described in options/get and can be seen in the the \[dq]vfs\[dq] section when running and the mountOpt can be seen in the \[dq]mount\[dq] section: .IP .nf \f[C] rclone rc options/get \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS mount/types: Show all possible mount types .PP This shows all possible mount types and returns them as a list. .PP This takes no parameters and returns .IP \[bu] 2 mountTypes: list of mount types .PP The mount types are strings like \[dq]mount\[dq], \[dq]mount2\[dq], \[dq]cmount\[dq] and can be passed to mount/mount as the mountType parameter. .PP Eg .IP .nf \f[C] rclone rc mount/types \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS mount/unmount: Unmount selected active mount .PP rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. .PP This takes the following parameters: .IP \[bu] 2 mountPoint: valid path on the local machine where the mount was created (required) .PP Example: .IP .nf \f[C] rclone rc mount/unmount mountPoint=/home/<user>/mountPoint \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS mount/unmountall: Unmount all active mounts .PP rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. .PP This takes no parameters and returns error if unmount does not succeed. .PP Eg .IP .nf \f[C] rclone rc mount/unmountall \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS operations/about: Return the space used on the remote .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .PP The result is as returned from rclone about --json .PP See the about (https://rclone.org/commands/rclone_about/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/check: check the source and destination are the same .PP Checks the files in the source and destination match. It compares sizes and hashes and logs a report of files that don\[aq]t match. It doesn\[aq]t alter the source or destination. .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:\[dq] for the source, \[dq]/\[dq] for local filesystem .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive2:\[dq] for the destination, \[dq]/\[dq] for local filesystem .IP \[bu] 2 download - check by downloading rather than with hash .IP \[bu] 2 checkFileHash - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type .IP \[bu] 2 checkFileFs - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type .IP \[bu] 2 checkFileRemote - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type .IP \[bu] 2 oneWay - check one way only, source files must exist on remote .IP \[bu] 2 combined - make a combined report of changes (default false) .IP \[bu] 2 missingOnSrc - report all files missing from the source (default true) .IP \[bu] 2 missingOnDst - report all files missing from the destination (default true) .IP \[bu] 2 match - report all matching files (default false) .IP \[bu] 2 differ - report all non-matching files (default true) .IP \[bu] 2 error - report all files with errors (hashing or reading) (default true) .PP 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\[aq]t support hashes or if you really want to check all the data. .PP 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. .PP 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. .PP Returns: .IP \[bu] 2 success - true if no error, false otherwise .IP \[bu] 2 status - textual summary of check, OK or text string .IP \[bu] 2 hashType - hash used in check, may be missing .IP \[bu] 2 combined - array of strings of combined report of changes .IP \[bu] 2 missingOnSrc - array of strings of all files missing from the source .IP \[bu] 2 missingOnDst - array of strings of all files missing from the destination .IP \[bu] 2 match - array of strings of all matching files .IP \[bu] 2 differ - array of strings of all non-matching files .IP \[bu] 2 error - array of strings of all files with errors (hashing or reading) .PP \f[B]Authentication is required for this call.\f[R] .SS operations/cleanup: Remove trashed files in the remote or path .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .PP See the cleanup (https://rclone.org/commands/rclone_cleanup/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/copyfile: Copy a file from source remote to destination remote .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:\[dq] for the source, \[dq]/\[dq] for local filesystem .IP \[bu] 2 srcRemote - a path within that remote e.g. \[dq]file.txt\[dq] for the source .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive2:\[dq] for the destination, \[dq]/\[dq] for local filesystem .IP \[bu] 2 dstRemote - a path within that remote e.g. \[dq]file2.txt\[dq] for the destination .PP \f[B]Authentication is required for this call.\f[R] .SS operations/copyurl: Copy the URL to the object .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .IP \[bu] 2 url - string, URL to read from .IP \[bu] 2 autoFilename - boolean, set to true to retrieve destination file name from url .PP See the copyurl (https://rclone.org/commands/rclone_copyurl/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/delete: Remove files in the path .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .PP See the delete (https://rclone.org/commands/rclone_delete/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/deletefile: Remove the single file pointed to .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .PP See the deletefile (https://rclone.org/commands/rclone_deletefile/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/fsinfo: Return information about the remote .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .PP This returns info about the remote passed in; .IP .nf \f[C] { // optional features and whether they are available or not \[dq]Features\[dq]: { \[dq]About\[dq]: true, \[dq]BucketBased\[dq]: false, \[dq]BucketBasedRootOK\[dq]: false, \[dq]CanHaveEmptyDirectories\[dq]: true, \[dq]CaseInsensitive\[dq]: false, \[dq]ChangeNotify\[dq]: false, \[dq]CleanUp\[dq]: false, \[dq]Command\[dq]: true, \[dq]Copy\[dq]: false, \[dq]DirCacheFlush\[dq]: false, \[dq]DirMove\[dq]: true, \[dq]Disconnect\[dq]: false, \[dq]DuplicateFiles\[dq]: false, \[dq]GetTier\[dq]: false, \[dq]IsLocal\[dq]: true, \[dq]ListR\[dq]: false, \[dq]MergeDirs\[dq]: false, \[dq]MetadataInfo\[dq]: true, \[dq]Move\[dq]: true, \[dq]OpenWriterAt\[dq]: true, \[dq]PublicLink\[dq]: false, \[dq]Purge\[dq]: true, \[dq]PutStream\[dq]: true, \[dq]PutUnchecked\[dq]: false, \[dq]ReadMetadata\[dq]: true, \[dq]ReadMimeType\[dq]: false, \[dq]ServerSideAcrossConfigs\[dq]: false, \[dq]SetTier\[dq]: false, \[dq]SetWrapper\[dq]: false, \[dq]Shutdown\[dq]: false, \[dq]SlowHash\[dq]: true, \[dq]SlowModTime\[dq]: false, \[dq]UnWrap\[dq]: false, \[dq]UserInfo\[dq]: false, \[dq]UserMetadata\[dq]: true, \[dq]WrapFs\[dq]: false, \[dq]WriteMetadata\[dq]: true, \[dq]WriteMimeType\[dq]: false }, // Names of hashes available \[dq]Hashes\[dq]: [ \[dq]md5\[dq], \[dq]sha1\[dq], \[dq]whirlpool\[dq], \[dq]crc32\[dq], \[dq]sha256\[dq], \[dq]dropbox\[dq], \[dq]mailru\[dq], \[dq]quickxor\[dq] ], \[dq]Name\[dq]: \[dq]local\[dq], // Name as created \[dq]Precision\[dq]: 1, // Precision of timestamps in ns \[dq]Root\[dq]: \[dq]/\[dq], // Path as created \[dq]String\[dq]: \[dq]Local file system at /\[dq], // how the remote will appear in logs // Information about the system metadata for this backend \[dq]MetadataInfo\[dq]: { \[dq]System\[dq]: { \[dq]atime\[dq]: { \[dq]Help\[dq]: \[dq]Time of last access\[dq], \[dq]Type\[dq]: \[dq]RFC 3339\[dq], \[dq]Example\[dq]: \[dq]2006-01-02T15:04:05.999999999Z07:00\[dq] }, \[dq]btime\[dq]: { \[dq]Help\[dq]: \[dq]Time of file birth (creation)\[dq], \[dq]Type\[dq]: \[dq]RFC 3339\[dq], \[dq]Example\[dq]: \[dq]2006-01-02T15:04:05.999999999Z07:00\[dq] }, \[dq]gid\[dq]: { \[dq]Help\[dq]: \[dq]Group ID of owner\[dq], \[dq]Type\[dq]: \[dq]decimal number\[dq], \[dq]Example\[dq]: \[dq]500\[dq] }, \[dq]mode\[dq]: { \[dq]Help\[dq]: \[dq]File type and mode\[dq], \[dq]Type\[dq]: \[dq]octal, unix style\[dq], \[dq]Example\[dq]: \[dq]0100664\[dq] }, \[dq]mtime\[dq]: { \[dq]Help\[dq]: \[dq]Time of last modification\[dq], \[dq]Type\[dq]: \[dq]RFC 3339\[dq], \[dq]Example\[dq]: \[dq]2006-01-02T15:04:05.999999999Z07:00\[dq] }, \[dq]rdev\[dq]: { \[dq]Help\[dq]: \[dq]Device ID (if special file)\[dq], \[dq]Type\[dq]: \[dq]hexadecimal\[dq], \[dq]Example\[dq]: \[dq]1abc\[dq] }, \[dq]uid\[dq]: { \[dq]Help\[dq]: \[dq]User ID of owner\[dq], \[dq]Type\[dq]: \[dq]decimal number\[dq], \[dq]Example\[dq]: \[dq]500\[dq] } }, \[dq]Help\[dq]: \[dq]Textual help string\[rs]n\[dq] } } \f[R] .fi .PP This command does not have a command line equivalent so use this instead: .IP .nf \f[C] rclone rc --loopback operations/fsinfo fs=remote: \f[R] .fi .SS operations/hashsum: Produces a hashsum file for all the objects in the path. .PP 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. .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] for the source, \[dq]/\[dq] for local filesystem .RS 2 .IP \[bu] 2 this can point to a file and just that file will be returned in the listing. .RE .IP \[bu] 2 hashType - type of hash to be used .IP \[bu] 2 download - check by downloading rather than with hash (boolean) .IP \[bu] 2 base64 - output the hashes in base64 rather than hex (boolean) .PP 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\[aq]t support the given hash or if you really want to check all the data. .PP 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. .PP Returns: .IP \[bu] 2 hashsum - array of strings of the hashes .IP \[bu] 2 hashType - type of hash used .PP Example: .IP .nf \f[C] $ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true { \[dq]hashType\[dq]: \[dq]md5\[dq], \[dq]hashsum\[dq]: [ \[dq]WTSVLpuiXyJO_kGzJerRLg== backend-versions.sh\[dq], \[dq]v1b_OlWCJO9LtNq3EIKkNQ== bisect-go-rclone.sh\[dq], \[dq]VHbmHzHh4taXzgag8BAIKQ== bisect-rclone.sh\[dq], ] } \f[R] .fi .PP See the hashsum (https://rclone.org/commands/rclone_hashsum/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/list: List the given remote and path in JSON format .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .IP \[bu] 2 opt - a dictionary of options to control the listing (optional) .RS 2 .IP \[bu] 2 recurse - If set recurse directories .IP \[bu] 2 noModTime - If set return modification time .IP \[bu] 2 showEncrypted - If set show decrypted names .IP \[bu] 2 showOrigIDs - If set show the IDs for each item if known .IP \[bu] 2 showHash - If set return a dictionary of hashes .IP \[bu] 2 noMimeType - If set don\[aq]t show mime types .IP \[bu] 2 dirsOnly - If set only show directories .IP \[bu] 2 filesOnly - If set only show files .IP \[bu] 2 metadata - If set return metadata of objects also .IP \[bu] 2 hashTypes - array of strings of hash types to show if showHash set .RE .PP Returns: .IP \[bu] 2 list .RS 2 .IP \[bu] 2 This is an array of objects as described in the lsjson command .RE .PP See the lsjson (https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/mkdir: Make a destination directory or container .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .PP See the mkdir (https://rclone.org/commands/rclone_mkdir/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/movefile: Move a file from source remote to destination remote .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:\[dq] for the source, \[dq]/\[dq] for local filesystem .IP \[bu] 2 srcRemote - a path within that remote e.g. \[dq]file.txt\[dq] for the source .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive2:\[dq] for the destination, \[dq]/\[dq] for local filesystem .IP \[bu] 2 dstRemote - a path within that remote e.g. \[dq]file2.txt\[dq] for the destination .PP \f[B]Authentication is required for this call.\f[R] .SS operations/publiclink: Create or retrieve a public link to the given file or folder. .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .IP \[bu] 2 unlink - boolean - if set removes the link rather than adding it (optional) .IP \[bu] 2 expire - string - the expiry time of the link e.g. \[dq]1d\[dq] (optional) .PP Returns: .IP \[bu] 2 url - URL of the resource .PP See the link (https://rclone.org/commands/rclone_link/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/purge: Remove a directory or container and all of its contents .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .PP See the purge (https://rclone.org/commands/rclone_purge/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/rmdir: Remove an empty directory or container .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .PP See the rmdir (https://rclone.org/commands/rclone_rmdir/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/rmdirs: Remove all the empty directories in the path .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .IP \[bu] 2 leaveRoot - boolean, set to true not to delete the root .PP See the rmdirs (https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/settier: Changes storage tier or class on all files in the path .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .PP See the settier (https://rclone.org/commands/rclone_settier/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/settierfile: Changes storage tier or class on the single file pointed to .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .PP See the settierfile (https://rclone.org/commands/rclone_settierfile/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/size: Count the number of bytes and files in remote .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:path/to/dir\[dq] .PP Returns: .IP \[bu] 2 count - number of files .IP \[bu] 2 bytes - number of bytes in those files .PP See the size (https://rclone.org/commands/rclone_size/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/stat: Give information about the supplied file or directory .PP This takes the following parameters .IP \[bu] 2 fs - a remote name string eg \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote eg \[dq]dir\[dq] .IP \[bu] 2 opt - a dictionary of options to control the listing (optional) .RS 2 .IP \[bu] 2 see operations/list for the options .RE .PP The result is .IP \[bu] 2 item - an object as described in the lsjson command. Will be null if not found. .PP Note that if you are only interested in files then it is much more efficient to set the filesOnly flag in the options. .PP See the lsjson (https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples. .PP \f[B]Authentication is required for this call.\f[R] .SS operations/uploadfile: Upload file using multiform/form-data .PP This takes the following parameters: .IP \[bu] 2 fs - a remote name string e.g. \[dq]drive:\[dq] .IP \[bu] 2 remote - a path within that remote e.g. \[dq]dir\[dq] .IP \[bu] 2 each part in body represents a file to be uploaded .PP See the uploadfile (https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS options/blocks: List all the option blocks .PP Returns: - options - a list of the options block names .SS options/get: Get all the global options .PP Returns an object where keys are option block names and values are an object with the current option values in. .PP Parameters: .IP \[bu] 2 blocks: optional string of comma separated blocks to include .RS 2 .IP \[bu] 2 all are included if this is missing or \[dq]\[dq] .RE .PP 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 then use options/config and for _filter use options/filter. .PP This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. .SS options/info: Get info about all the global options .PP Returns an object where keys are option block names and values are an array of objects with info about each options. .PP Parameters: .IP \[bu] 2 blocks: optional string of comma separated blocks to include .RS 2 .IP \[bu] 2 all are included if this is missing or \[dq]\[dq] .RE .PP These objects are in the same format as returned by \[dq]config/providers\[dq]. They are described in the option blocks section. .SS options/local: Get the currently active config for this call .PP Returns an object with the keys \[dq]config\[dq] and \[dq]filter\[dq]. The \[dq]config\[dq] key contains the local config and the \[dq]filter\[dq] key contains the local filters. .PP 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 \[dq]_filter\[dq]. .PP This call is mostly useful for seeing if _config and _filter passing is working. .PP This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. .SS options/set: Set an option .PP Parameters: .IP \[bu] 2 option block name containing an object with .RS 2 .IP \[bu] 2 key: value .RE .PP Repeated as often as required. .PP 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. .PP For example: .PP This sets DEBUG level logs (-vv) (these can be set by number or string) .IP .nf \f[C] rclone rc options/set --json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: \[dq]DEBUG\[dq]}}\[aq] rclone rc options/set --json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] \f[R] .fi .PP And this sets INFO level logs (-v) .IP .nf \f[C] rclone rc options/set --json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: \[dq]INFO\[dq]}}\[aq] \f[R] .fi .PP And this sets NOTICE level logs (normal without -v) .IP .nf \f[C] rclone rc options/set --json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: \[dq]NOTICE\[dq]}}\[aq] \f[R] .fi .SS pluginsctl/addPlugin: Add a plugin using url .PP Used for adding a plugin to the webgui. .PP This takes the following parameters: .IP \[bu] 2 url - http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react). .PP Example: .PP rclone rc pluginsctl/addPlugin .PP \f[B]Authentication is required for this call.\f[R] .SS pluginsctl/getPluginsForType: Get plugins with type criteria .PP This shows all possible plugins by a mime type. .PP This takes the following parameters: .IP \[bu] 2 type - supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3). .IP \[bu] 2 pluginType - filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL). .PP Returns: .IP \[bu] 2 loadedPlugins - list of current production plugins. .IP \[bu] 2 testPlugins - list of temporarily loaded development plugins, usually running on a different server. .PP Example: .PP rclone rc pluginsctl/getPluginsForType type=video/mp4 .PP \f[B]Authentication is required for this call.\f[R] .SS pluginsctl/listPlugins: Get the list of currently loaded plugins .PP This allows you to get the currently enabled plugins and their details. .PP This takes no parameters and returns: .IP \[bu] 2 loadedPlugins - list of current production plugins. .IP \[bu] 2 testPlugins - list of temporarily loaded development plugins, usually running on a different server. .PP E.g. .PP rclone rc pluginsctl/listPlugins .PP \f[B]Authentication is required for this call.\f[R] .SS pluginsctl/listTestPlugins: Show currently loaded test plugins .PP Allows listing of test plugins with the rclone.test set to true in package.json of the plugin. .PP This takes no parameters and returns: .IP \[bu] 2 loadedTestPlugins - list of currently available test plugins. .PP E.g. .IP .nf \f[C] rclone rc pluginsctl/listTestPlugins \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS pluginsctl/removePlugin: Remove a loaded plugin .PP This allows you to remove a plugin using it\[aq]s name. .PP This takes parameters: .IP \[bu] 2 name - name of the plugin in the format \f[C]author\f[R]/\f[C]plugin_name\f[R]. .PP E.g. .PP rclone rc pluginsctl/removePlugin name=rclone/video-plugin .PP \f[B]Authentication is required for this call.\f[R] .SS pluginsctl/removeTestPlugin: Remove a test plugin .PP This allows you to remove a plugin using it\[aq]s name. .PP This takes the following parameters: .IP \[bu] 2 name - name of the plugin in the format \f[C]author\f[R]/\f[C]plugin_name\f[R]. .PP Example: .IP .nf \f[C] rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react \f[R] .fi .PP \f[B]Authentication is required for this call.\f[R] .SS rc/error: This returns an error .PP This returns an error with the input as part of its error string. Useful for testing error handling. .SS rc/list: List all the registered remote control commands .PP This lists all the registered remote control commands as a JSON map in the commands response. .SS rc/noop: Echo the input to the output parameters .PP 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. .SS rc/noopauth: Echo the input to the output parameters requiring auth .PP 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. .PP \f[B]Authentication is required for this call.\f[R] .SS sync/bisync: Perform bidirectional synchronization between two paths. .PP This takes the following parameters .IP \[bu] 2 path1 - a remote directory string e.g. \f[C]drive:path1\f[R] .IP \[bu] 2 path2 - a remote directory string e.g. \f[C]drive:path2\f[R] .IP \[bu] 2 dryRun - dry-run mode .IP \[bu] 2 resync - performs the resync run .IP \[bu] 2 checkAccess - abort if RCLONE_TEST files are not found on both filesystems .IP \[bu] 2 checkFilename - file name for checkAccess (default: RCLONE_TEST) .IP \[bu] 2 maxDelete - abort sync if percentage of deleted files is above this threshold (default: 50) .IP \[bu] 2 force - Bypass maxDelete safety check and run the sync .IP \[bu] 2 checkSync - \f[C]true\f[R] by default, \f[C]false\f[R] disables comparison of final listings, \f[C]only\f[R] will skip sync, only compare listings from the last run .IP \[bu] 2 createEmptySrcDirs - Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) .IP \[bu] 2 removeEmptyDirs - remove empty directories at the final cleanup step .IP \[bu] 2 filtersFile - read filtering patterns from a file .IP \[bu] 2 ignoreListingChecksum - Do not use checksums for listings .IP \[bu] 2 resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync. Use at your own risk! .IP \[bu] 2 workdir - server directory for history files (default: \f[C]\[ti]/.cache/rclone/bisync\f[R]) .IP \[bu] 2 backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote. .IP \[bu] 2 backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote. .IP \[bu] 2 noCleanup - retain working files .PP See bisync command help (https://rclone.org/commands/rclone_bisync/) and full bisync description (https://rclone.org/bisync/) for more information. .PP \f[B]Authentication is required for this call.\f[R] .SS sync/copy: copy a directory from source remote to destination remote .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:src\[dq] for the source .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive:dst\[dq] for the destination .IP \[bu] 2 createEmptySrcDirs - create empty src directories on destination if set .PP See the copy (https://rclone.org/commands/rclone_copy/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS sync/move: move a directory from source remote to destination remote .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:src\[dq] for the source .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive:dst\[dq] for the destination .IP \[bu] 2 createEmptySrcDirs - create empty src directories on destination if set .IP \[bu] 2 deleteEmptySrcDirs - delete empty src directories if set .PP See the move (https://rclone.org/commands/rclone_move/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS sync/sync: sync a directory from source remote to destination remote .PP This takes the following parameters: .IP \[bu] 2 srcFs - a remote name string e.g. \[dq]drive:src\[dq] for the source .IP \[bu] 2 dstFs - a remote name string e.g. \[dq]drive:dst\[dq] for the destination .IP \[bu] 2 createEmptySrcDirs - create empty src directories on destination if set .PP See the sync (https://rclone.org/commands/rclone_sync/) command for more information on the above. .PP \f[B]Authentication is required for this call.\f[R] .SS vfs/forget: Forget files or directories in the directory cache. .PP This forgets the paths in the directory cache causing them to be re-read from the remote when needed. .PP If no paths are passed in then it will forget all the paths in the directory cache. .IP .nf \f[C] rclone rc vfs/forget \f[R] .fi .PP 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. .IP .nf \f[C] rclone rc vfs/forget file=hello file2=goodbye dir=home/junk \f[R] .fi .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS vfs/list: List active VFSes. .PP This lists the active VFSes. .PP It returns a list under the key \[dq]vfses\[dq] where the values are the VFS names that could be passed to the other VFS commands in the \[dq]fs\[dq] parameter. .SS vfs/poll-interval: Get the status or update the value of the poll-interval option. .PP Without any parameter given this returns the current status of the poll-interval setting. .PP 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. .IP .nf \f[C] rclone rc vfs/poll-interval interval=5m \f[R] .fi .PP 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. .PP The new poll-interval value will only be active when the timeout is not reached. .PP If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote. .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS vfs/queue: Queue info for a VFS. .PP This returns info about the upload queue for the selected VFS. .PP This is only useful if \f[C]--vfs-cache-mode\f[R] > off. If you call it when the \f[C]--vfs-cache-mode\f[R] is off, it will return an empty result. .IP .nf \f[C] { \[dq]queued\[dq]: // an array of files queued for upload [ { \[dq]name\[dq]: \[dq]file\[dq], // string: name (full path) of the file, \[dq]id\[dq]: 123, // integer: id of this item in the queue, \[dq]size\[dq]: 79, // integer: size of the file in bytes \[dq]expiry\[dq]: 1.5 // float: time until file is eligible for transfer, lowest goes first \[dq]tries\[dq]: 1, // integer: number of times we have tried to upload \[dq]delay\[dq]: 5.0, // float: seconds between upload attempts \[dq]uploading\[dq]: false, // boolean: true if item is being uploaded }, ], } \f[R] .fi .PP The \f[C]expiry\f[R] time is the time until the file is eligible for being uploaded in floating point seconds. This may go negative. As rclone only transfers \f[C]--transfers\f[R] files at once, only the lowest \f[C]--transfers\f[R] expiry times will have \f[C]uploading\f[R] as \f[C]true\f[R]. So there may be files with negative expiry times for which \f[C]uploading\f[R] is \f[C]false\f[R]. .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS vfs/queue-set-expiry: Set the expiry time for an item queued for upload. .PP Use this to adjust the \f[C]expiry\f[R] time for an item in the upload queue. You will need to read the \f[C]id\f[R] of the item using \f[C]vfs/queue\f[R] before using this call. .PP You can then set \f[C]expiry\f[R] 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. .PP Setting the \f[C]expiry\f[R] of an item which has already has started uploading will have no effect - the item will carry on being uploaded. .PP This will return an error if called with \f[C]--vfs-cache-mode\f[R] off or if the \f[C]id\f[R] passed is not found. .PP This takes the following parameters .IP \[bu] 2 \f[C]fs\f[R] - select the VFS in use (optional) .IP \[bu] 2 \f[C]id\f[R] - a numeric ID as returned from \f[C]vfs/queue\f[R] .IP \[bu] 2 \f[C]expiry\f[R] - a new expiry time as floating point seconds .IP \[bu] 2 \f[C]relative\f[R] - if set, expiry is to be treated as relative to the current expiry (optional, boolean) .PP This returns an empty result on success, or an error. .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS vfs/refresh: Refresh the directory cache. .PP This reads the directories for the specified paths and freshens the directory cache. .PP If no paths are passed in then it will refresh the root directory. .IP .nf \f[C] rclone rc vfs/refresh \f[R] .fi .PP Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, e.g. .IP .nf \f[C] rclone rc vfs/refresh dir=home/junk dir2=data/misc \f[R] .fi .PP If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled. .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS vfs/stats: Stats for a VFS. .PP This returns stats for the selected VFS. .IP .nf \f[C] { // Status of the disk cache - only present if --vfs-cache-mode > off \[dq]diskCache\[dq]: { \[dq]bytesUsed\[dq]: 0, \[dq]erroredFiles\[dq]: 0, \[dq]files\[dq]: 0, \[dq]hashType\[dq]: 1, \[dq]outOfSpace\[dq]: false, \[dq]path\[dq]: \[dq]/home/user/.cache/rclone/vfs/local/mnt/a\[dq], \[dq]pathMeta\[dq]: \[dq]/home/user/.cache/rclone/vfsMeta/local/mnt/a\[dq], \[dq]uploadsInProgress\[dq]: 0, \[dq]uploadsQueued\[dq]: 0 }, \[dq]fs\[dq]: \[dq]/mnt/a\[dq], \[dq]inUse\[dq]: 1, // Status of the in memory metadata cache \[dq]metadataCache\[dq]: { \[dq]dirs\[dq]: 1, \[dq]files\[dq]: 0 }, // Options as returned by options/get \[dq]opt\[dq]: { \[dq]CacheMaxAge\[dq]: 3600000000000, // ... \[dq]WriteWait\[dq]: 1000000000 } } \f[R] .fi .PP This command takes an \[dq]fs\[dq] 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 \[dq]fs\[dq] parameter must be supplied. .SS Accessing the remote control via HTTP .PP Rclone implements a simple HTTP based protocol. .PP 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. .PP All calls must made using POST. .PP The input objects can be supplied using URL parameters, POST parameters or by supplying \[dq]Content-Type: application/json\[dq] and a JSON blob in the body. There are examples of these below using \f[C]curl\f[R]. .PP The response will be a JSON blob in the body of the response. This is formatted to be reasonably human-readable. .SS Error returns .PP 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. .IP .nf \f[C] { \[dq]error\[dq]: \[dq]Expecting string value for key \[rs]\[dq]remote\[rs]\[dq] (was float64)\[dq], \[dq]input\[dq]: { \[dq]fs\[dq]: \[dq]/tmp\[dq], \[dq]remote\[dq]: 3 }, \[dq]status\[dq]: 400 \[dq]path\[dq]: \[dq]operations/rmdir\[dq], } \f[R] .fi .PP 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 .SS CORS .PP The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested \[dq]Access-Control-Request-Headers\[dq] back. .SS Using POST with URL parameters only .IP .nf \f[C] curl -X POST \[aq]http://localhost:5572/rc/noop?potato=1&sausage=2\[aq] \f[R] .fi .PP Response .IP .nf \f[C] { \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } \f[R] .fi .PP Here is what an error response looks like: .IP .nf \f[C] curl -X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] \f[R] .fi .IP .nf \f[C] { \[dq]error\[dq]: \[dq]arbitrary error on input map[potato:1 sausage:2]\[dq], \[dq]input\[dq]: { \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } } \f[R] .fi .PP Note that curl doesn\[aq]t return errors to the shell unless you use the \f[C]-f\f[R] option .IP .nf \f[C] $ curl -f -X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] curl: (22) The requested URL returned error: 400 Bad Request $ echo $? 22 \f[R] .fi .SS Using POST with a form .IP .nf \f[C] curl --data \[dq]potato=1\[dq] --data \[dq]sausage=2\[dq] http://localhost:5572/rc/noop \f[R] .fi .PP Response .IP .nf \f[C] { \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } \f[R] .fi .PP Note that you can combine these with URL parameters too with the POST parameters taking precedence. .IP .nf \f[C] curl --data \[dq]potato=1\[dq] --data \[dq]sausage=2\[dq] \[dq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[dq] \f[R] .fi .PP Response .IP .nf \f[C] { \[dq]potato\[dq]: \[dq]1\[dq], \[dq]rutabaga\[dq]: \[dq]3\[dq], \[dq]sausage\[dq]: \[dq]4\[dq] } \f[R] .fi .SS Using POST with a JSON blob .IP .nf \f[C] curl -H \[dq]Content-Type: application/json\[dq] -X POST -d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] http://localhost:5572/rc/noop \f[R] .fi .PP response .IP .nf \f[C] { \[dq]password\[dq]: \[dq]xyz\[dq], \[dq]username\[dq]: \[dq]xyz\[dq] } \f[R] .fi .PP This can be combined with URL parameters too if required. The JSON blob takes precedence. .IP .nf \f[C] curl -H \[dq]Content-Type: application/json\[dq] -X POST -d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] \[aq]http://localhost:5572/rc/noop?rutabaga=3&potato=4\[aq] \f[R] .fi .IP .nf \f[C] { \[dq]potato\[dq]: 2, \[dq]rutabaga\[dq]: \[dq]3\[dq], \[dq]sausage\[dq]: 1 } \f[R] .fi .SS Debugging rclone with pprof .PP If you use the \f[C]--rc\f[R] flag this will also enable the use of the go profiling tools on the same port. .PP To use these, first install go (https://golang.org/doc/install). .SS Debugging memory use .PP To profile rclone\[aq]s memory use you can run: .IP .nf \f[C] go tool pprof -web http://localhost:5572/debug/pprof/heap \f[R] .fi .PP This should open a page in your browser showing what is using what memory. .PP You can also use the \f[C]-text\f[R] flag to produce a textual summary .IP .nf \f[C] $ 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 \f[R] .fi .SS Debugging go routine leaks .PP Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected. .PP See all active go routines using .IP .nf \f[C] curl http://localhost:5572/debug/pprof/goroutine?debug=1 \f[R] .fi .PP Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. .SS Other profiles to look at .PP You can see a summary of profiles available at http://localhost:5572/debug/pprof/ .PP Here is how to use some of them: .IP \[bu] 2 Memory: \f[C]go tool pprof http://localhost:5572/debug/pprof/heap\f[R] .IP \[bu] 2 Go routines: \f[C]curl http://localhost:5572/debug/pprof/goroutine?debug=1\f[R] .IP \[bu] 2 30-second CPU profile: \f[C]go tool pprof http://localhost:5572/debug/pprof/profile\f[R] .IP \[bu] 2 5-second execution trace: \f[C]wget http://localhost:5572/debug/pprof/trace?seconds=5\f[R] .IP \[bu] 2 Goroutine blocking profile .RS 2 .IP \[bu] 2 Enable first with: \f[C]rclone rc debug/set-block-profile-rate rate=1\f[R] (docs) .IP \[bu] 2 \f[C]go tool pprof http://localhost:5572/debug/pprof/block\f[R] .RE .IP \[bu] 2 Contended mutexes: .RS 2 .IP \[bu] 2 Enable first with: \f[C]rclone rc debug/set-mutex-profile-fraction rate=1\f[R] (docs) .IP \[bu] 2 \f[C]go tool pprof http://localhost:5572/debug/pprof/mutex\f[R] .RE .PP 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\[aq]s blog post on profiling go programs (https://blog.golang.org/profiling-go-programs). .PP The profiling hook is zero overhead unless it is used (https://stackoverflow.com/q/26545159/164234). .SH Overview of cloud storage systems .PP Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through. .SS Features .PP Here is an overview of the major features of each cloud storage system. .PP .TS tab(@); l c c c c c c. T{ Name T}@T{ Hash T}@T{ ModTime T}@T{ Case Insensitive T}@T{ Duplicate Files T}@T{ MIME Type T}@T{ Metadata T} _ T{ 1Fichier T}@T{ Whirlpool T}@T{ - T}@T{ No T}@T{ Yes T}@T{ R T}@T{ - T} T{ Akamai Netstorage T}@T{ MD5, SHA256 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R T}@T{ - T} T{ Amazon S3 (or S3 compatible) T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ RWU T} T{ Backblaze B2 T}@T{ SHA1 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ Box T}@T{ SHA1 T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ Citrix ShareFile T}@T{ MD5 T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ Cloudinary T}@T{ MD5 T}@T{ R T}@T{ No T}@T{ Yes T}@T{ - T}@T{ - T} T{ Dropbox T}@T{ DBHASH \[S1] T}@T{ R T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ Enterprise File Fabric T}@T{ - T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ R/W T}@T{ - T} T{ Files.com T}@T{ MD5, CRC32 T}@T{ DR/W T}@T{ Yes T}@T{ No T}@T{ R T}@T{ - T} T{ FTP T}@T{ - T}@T{ R/W \[S1]\[u2070] T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Gofile T}@T{ MD5 T}@T{ DR/W T}@T{ No T}@T{ Yes T}@T{ R T}@T{ - T} T{ Google Cloud Storage T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ Google Drive T}@T{ MD5, SHA1, SHA256 T}@T{ DR/W T}@T{ No T}@T{ Yes T}@T{ R/W T}@T{ DRWU T} T{ Google Photos T}@T{ - T}@T{ - T}@T{ No T}@T{ Yes T}@T{ R T}@T{ - T} T{ HDFS T}@T{ - T}@T{ R/W T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ HiDrive T}@T{ HiDrive \[S1]\[S2] T}@T{ R/W T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ HTTP T}@T{ - T}@T{ R T}@T{ No T}@T{ No T}@T{ R T}@T{ - T} T{ iCloud Drive T}@T{ - T}@T{ R T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Internet Archive T}@T{ MD5, SHA1, CRC32 T}@T{ R/W \[S1]\[S1] T}@T{ No T}@T{ No T}@T{ - T}@T{ RWU T} T{ Jottacloud T}@T{ MD5 T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ R T}@T{ RW T} T{ Koofr T}@T{ MD5 T}@T{ - T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ Linkbox T}@T{ - T}@T{ R T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Mail.ru Cloud T}@T{ Mailru \[u2076] T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ Mega T}@T{ - T}@T{ - T}@T{ No T}@T{ Yes T}@T{ - T}@T{ - T} T{ Memory T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Microsoft Azure Blob Storage T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ Microsoft Azure Files Storage T}@T{ MD5 T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ R/W T}@T{ - T} T{ Microsoft OneDrive T}@T{ QuickXorHash \[u2075] T}@T{ DR/W T}@T{ Yes T}@T{ No T}@T{ R T}@T{ DRW T} T{ OpenDrive T}@T{ MD5 T}@T{ R/W T}@T{ Yes T}@T{ Partial \[u2078] T}@T{ - T}@T{ - T} T{ OpenStack Swift T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ Oracle Object Storage T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ pCloud T}@T{ MD5, SHA1 \[u2077] T}@T{ R/W T}@T{ No T}@T{ No T}@T{ W T}@T{ - T} T{ PikPak T}@T{ MD5 T}@T{ R T}@T{ No T}@T{ No T}@T{ R T}@T{ - T} T{ Pixeldrain T}@T{ SHA256 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R T}@T{ RW T} T{ premiumize.me T}@T{ - T}@T{ - T}@T{ Yes T}@T{ No T}@T{ R T}@T{ - T} T{ put.io T}@T{ CRC-32 T}@T{ R/W T}@T{ No T}@T{ Yes T}@T{ R T}@T{ - T} T{ Proton Drive T}@T{ SHA1 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R T}@T{ - T} T{ QingStor T}@T{ MD5 T}@T{ - \[u2079] T}@T{ No T}@T{ No T}@T{ R/W T}@T{ - T} T{ Quatrix by Maytech T}@T{ - T}@T{ R/W T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Seafile T}@T{ - T}@T{ - T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ SFTP T}@T{ MD5, SHA1 \[S2] T}@T{ DR/W T}@T{ Depends T}@T{ No T}@T{ - T}@T{ - T} T{ Sia T}@T{ - T}@T{ - T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ SMB T}@T{ - T}@T{ R/W T}@T{ Yes T}@T{ No T}@T{ - T}@T{ - T} T{ SugarSync T}@T{ - T}@T{ - T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Storj T}@T{ - T}@T{ R T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ Uloz.to T}@T{ MD5, SHA256 \[S1]\[S3] T}@T{ - T}@T{ No T}@T{ Yes T}@T{ - T}@T{ - T} T{ Uptobox T}@T{ - T}@T{ - T}@T{ No T}@T{ Yes T}@T{ - T}@T{ - T} T{ WebDAV T}@T{ MD5, SHA1 \[S3] T}@T{ R \[u2074] T}@T{ Depends T}@T{ No T}@T{ - T}@T{ - T} T{ Yandex Disk T}@T{ MD5 T}@T{ R/W T}@T{ No T}@T{ No T}@T{ R T}@T{ - T} T{ Zoho WorkDrive T}@T{ - T}@T{ - T}@T{ No T}@T{ No T}@T{ - T}@T{ - T} T{ The local filesystem T}@T{ All T}@T{ DR/W T}@T{ Depends T}@T{ No T}@T{ - T}@T{ DRWU T} .TE .PP \[S1] Dropbox supports its own custom hash (https://www.dropbox.com/developers/reference/content-hash). This is an SHA256 sum of all the 4 MiB block SHA256s. .PP \[S2] SFTP supports checksums if the same login has shell access and \f[C]md5sum\f[R] or \f[C]sha1sum\f[R] as well as \f[C]echo\f[R] are in the remote\[aq]s PATH. .PP \[S3] WebDAV supports hashes when used with Fastmail Files, Owncloud and Nextcloud only. .PP \[u2074] WebDAV supports modtimes when used with Fastmail Files, Owncloud and Nextcloud only. .PP \[u2075] QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash) is Microsoft\[aq]s own hash. .PP \[u2076] Mail.ru uses its own modified SHA1 hash .PP \[u2077] pCloud only supports SHA1 (not MD5) in its EU region .PP \[u2078] Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with \f[C]rclone\f[R]. It may be that this is a mistake or an unsupported feature. .PP \[u2079] QingStor does not support SetModTime for objects bigger than 5 GiB. .PP \[S1]\[u2070] FTP supports modtimes for the major FTP servers, and also others if they advertised required protocol extensions. See this (https://rclone.org/ftp/#modification-times) for more details. .PP \[S1]\[S1] Internet Archive requires option \f[C]wait_archive\f[R] to be set to a non-zero value for full modtime support. .PP \[S1]\[S2] HiDrive supports its own custom hash (https://static.hidrive.com/dev/0001). It combines SHA1 sums for each 4 KiB block hierarchically to a single top-level sum. .PP \[S1]\[S3] Uloz.to provides server-calculated MD5 hash upon file upload. MD5 and SHA256 hashes are client-calculated and stored as metadata fields. .SS Hash .PP 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 \f[C]--checksum\f[R] flag in syncs and in the \f[C]check\f[R] command. .PP To use the verify checksums when transferring between cloud storage systems they must support a common hash type. .SS ModTime .PP 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 \f[C]--checksum\f[R] flag). Ideally it should also be possible to change the timestamp of an existing file without having to re-upload it. .PP .TS tab(@); lw(19.4n) lw(50.6n). T{ Key T}@T{ Explanation T} _ T{ \f[C]-\f[R] T}@T{ ModTimes not supported - times likely the upload time T} T{ \f[C]R\f[R] T}@T{ ModTimes supported on files but can\[aq]t be changed without re-upload T} T{ \f[C]R/W\f[R] T}@T{ Read and Write ModTimes fully supported on files T} T{ \f[C]DR\f[R] T}@T{ ModTimes supported on files and directories but can\[aq]t be changed without re-upload T} T{ \f[C]DR/W\f[R] T}@T{ Read and Write ModTimes fully supported on files and directories T} .TE .PP Storage systems with a \f[C]-\f[R] 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). .PP Storage systems with a \f[C]R\f[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 (\f[C]SetModTime\f[R] operation) without re-uploading, possibly not even without deleting existing first. Some operations in rclone, such as \f[C]copy\f[R] and \f[C]sync\f[R] commands, will automatically check for \f[C]SetModTime\f[R] support and re-upload if necessary to keep the modification times in sync. Other commands will not work without \f[C]SetModTime\f[R] support, e.g. \f[C]touch\f[R] command on an existing file will fail, and changes to modification time only on a files in a \f[C]mount\f[R] will be silently ignored. .PP Storage systems with \f[C]R/W\f[R] (for read/write) in the ModTime column, means they do also support modtime-only operations. .PP Storage systems with \f[C]D\f[R] in the ModTime column means that the following symbols apply to directories as well as files. .SS Case Insensitive .PP If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, e.g. \f[C]file.txt\f[R] and \f[C]FILE.txt\f[R]. If a cloud storage system is case insensitive then that isn\[aq]t possible. .PP 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. .PP The local filesystem and SFTP may or may not be case sensitive depending on OS. .IP \[bu] 2 Windows - usually case insensitive, though case is preserved .IP \[bu] 2 OSX - usually case insensitive, though it is possible to format case sensitive .IP \[bu] 2 Linux - usually case sensitive, but there are case insensitive file systems (e.g. FAT formatted USB keys) .PP Most of the time this doesn\[aq]t cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems. .SS Duplicate files .PP If a cloud storage system allows duplicate files then it can have two objects with the same name. .PP This confuses rclone greatly when syncing - use the \f[C]rclone dedupe\f[R] command to rename or remove duplicates. .SS Restricted filenames .PP Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When \f[C]rclone\f[R] 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. .PP This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently. .PP The name shown by \f[C]rclone\f[R] to the user or during log output will only contain a minimal set of replaced characters to ensure correct formatting and not necessarily the actual name used on the cloud storage. .PP This transformation is reversed when downloading a file or parsing \f[C]rclone\f[R] arguments. For example, when uploading a file named \f[C]my file?.txt\f[R] to Onedrive, it will be displayed as \f[C]my file?.txt\f[R] on the console, but stored as \f[C]my file\[uFF1F].txt\f[R] to Onedrive (the \f[C]?\f[R] gets replaced by the similar looking \f[C]\[uFF1F]\f[R] character, the so-called \[dq]fullwidth question mark\[dq]). The reverse transformation allows to read a file \f[C]unusual/name.txt\f[R] from Google Drive, by passing the name \f[C]unusual\[uFF0F]name.txt\f[R] on the command line (the \f[C]/\f[R] needs to be replaced by the similar looking \f[C]\[uFF0F]\f[R] character). .SS Caveats .PP 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. .PP On Windows, the characters \f[C]:\f[R], \f[C]*\f[R] and \f[C]?\f[R] 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 \f[C]\[uFF0A]\f[R], \f[C]\[uFF1F]\f[R] and \f[C]\[uFF1A]\f[R] when downloading to Windows, and back again when uploading. This way files with names that are not allowed on Windows can still be stored. .PP 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 \f[C]Test\[uFF1A]1.jpg\f[R], where \f[C]\[uFF1A]\f[R] is the Unicode fullwidth colon symbol, and use rclone to upload it to Google Drive, which supports regular \f[C]:\f[R] (halfwidth question mark), rclone will replace the fullwidth \f[C]:\f[R] with the halfwidth \f[C]:\f[R] and store the file as \f[C]Test:1.jpg\f[R] in Google Drive. Since both Windows and Google Drive allows the name \f[C]Test\[uFF1A]1.jpg\f[R], it would probably be better if rclone just kept the name as is in this case. .PP With the opposite situation; if you have a file named \f[C]Test:1.jpg\f[R], in your Google Drive, e.g. uploaded from a Linux system where \f[C]:\f[R] 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 \f[C]Test\[uFF1A]1.jpg\f[R]. The original filename is not legal on Windows, due to the \f[C]:\f[R], 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 \f[I]different\f[R] file named \f[C]Test\[uFF1A]1.jpg\f[R] on Windows, and then use rclone to copy either way. Rclone will then treat the file originally named \f[C]Test:1.jpg\f[R] on Google Drive and the file originally named \f[C]Test\[uFF1A]1.jpg\f[R] on Windows as the same file, and replace the contents from one with the other. .PP Its virtually impossible to handle all cases like these correctly in all situations, but by customizing the encoding option, 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. .PP (Windows was used as an example of a file system with many restricted characters, and Google drive a storage system with few.) .SS Default restricted characters .PP The table below shows the characters that are replaced by default. .PP When a replacement character is found in a filename, this character will be escaped with the \f[C]\[u201B]\f[R] character to avoid ambiguous file names. (e.g. a file named \f[C]\[u2400].txt\f[R] would shown as \f[C]\[u201B]\[u2400].txt\f[R]) .PP Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend. .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ SOH T}@T{ 0x01 T}@T{ \[u2401] T} T{ STX T}@T{ 0x02 T}@T{ \[u2402] T} T{ ETX T}@T{ 0x03 T}@T{ \[u2403] T} T{ EOT T}@T{ 0x04 T}@T{ \[u2404] T} T{ ENQ T}@T{ 0x05 T}@T{ \[u2405] T} T{ ACK T}@T{ 0x06 T}@T{ \[u2406] T} T{ BEL T}@T{ 0x07 T}@T{ \[u2407] T} T{ BS T}@T{ 0x08 T}@T{ \[u2408] T} T{ HT T}@T{ 0x09 T}@T{ \[u2409] T} T{ LF T}@T{ 0x0A T}@T{ \[u240A] T} T{ VT T}@T{ 0x0B T}@T{ \[u240B] T} T{ FF T}@T{ 0x0C T}@T{ \[u240C] T} T{ CR T}@T{ 0x0D T}@T{ \[u240D] T} T{ SO T}@T{ 0x0E T}@T{ \[u240E] T} T{ SI T}@T{ 0x0F T}@T{ \[u240F] T} T{ DLE T}@T{ 0x10 T}@T{ \[u2410] T} T{ DC1 T}@T{ 0x11 T}@T{ \[u2411] T} T{ DC2 T}@T{ 0x12 T}@T{ \[u2412] T} T{ DC3 T}@T{ 0x13 T}@T{ \[u2413] T} T{ DC4 T}@T{ 0x14 T}@T{ \[u2414] T} T{ NAK T}@T{ 0x15 T}@T{ \[u2415] T} T{ SYN T}@T{ 0x16 T}@T{ \[u2416] T} T{ ETB T}@T{ 0x17 T}@T{ \[u2417] T} T{ CAN T}@T{ 0x18 T}@T{ \[u2418] T} T{ EM T}@T{ 0x19 T}@T{ \[u2419] T} T{ SUB T}@T{ 0x1A T}@T{ \[u241A] T} T{ ESC T}@T{ 0x1B T}@T{ \[u241B] T} T{ FS T}@T{ 0x1C T}@T{ \[u241C] T} T{ GS T}@T{ 0x1D T}@T{ \[u241D] T} T{ RS T}@T{ 0x1E T}@T{ \[u241E] T} T{ US T}@T{ 0x1F T}@T{ \[u241F] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} T{ DEL T}@T{ 0x7F T}@T{ \[u2421] T} .TE .PP The default encoding will also encode these file names as they are problematic with many cloud storage systems. .PP .TS tab(@); l c. T{ File name T}@T{ Replacement T} _ T{ \&. T}@T{ \[uFF0E] T} T{ \&.. T}@T{ \[uFF0E]\[uFF0E] T} .TE .SS Invalid UTF-8 bytes .PP Some backends only support a sequence of well formed UTF-8 bytes as file or directory names. .PP 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 \f[C]0xFE\f[R] will be encoded as \f[C]\[u201B]FE\f[R]. .PP 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. .SS Encoding option .PP Most backends have an encoding option, specified as a flag \f[C]--backend-encoding\f[R] where \f[C]backend\f[R] is the name of the backend, or as a config parameter \f[C]encoding\f[R] (you\[aq]ll need to select the Advanced config in \f[C]rclone config\f[R] to see it). .PP This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above). .PP However this can be incorrect in some scenarios, for example if you have a Windows file system with Unicode fullwidth characters \f[C]\[uFF0A]\f[R], \f[C]\[uFF1F]\f[R] or \f[C]\[uFF1A]\f[R], that you want to remain as those characters on the remote rather than being translated to regular (halfwidth) \f[C]*\f[R], \f[C]?\f[R] and \f[C]:\f[R]. .PP The \f[C]--backend-encoding\f[R] flags allow you to change that. You can disable the encoding completely with \f[C]--backend-encoding Raw\f[R] or set \f[C]encoding = Raw\f[R] in the config file. .PP 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. \f[C]--local-encoding \[dq]help\[dq]\f[R]. The command \f[C]rclone help flags encoding\f[R] will show you the defaults for the backends. .PP .TS tab(@); lw(21.7n) lw(24.1n) lw(24.1n). T{ Encoding T}@T{ Characters T}@T{ Encoded as T} _ T{ Asterisk T}@T{ \f[C]*\f[R] T}@T{ \f[C]\[uFF0A]\f[R] T} T{ BackQuote T}@T{ \f[C]\[ga]\f[R] T}@T{ \f[C]\[uFF40]\f[R] T} T{ BackSlash T}@T{ \f[C]\[rs]\f[R] T}@T{ \f[C]\[uFF3C]\f[R] T} T{ Colon T}@T{ \f[C]:\f[R] T}@T{ \f[C]\[uFF1A]\f[R] T} T{ CrLf T}@T{ CR 0x0D, LF 0x0A T}@T{ \f[C]\[u240D]\f[R], \f[C]\[u240A]\f[R] T} T{ Ctl T}@T{ All control characters 0x00-0x1F T}@T{ \f[C]\[u2400]\[u2401]\[u2402]\[u2403]\[u2404]\[u2405]\[u2406]\[u2407]\[u2408]\[u2409]\[u240A]\[u240B]\[u240C]\[u240D]\[u240E]\[u240F]\[u2410]\[u2411]\[u2412]\[u2413]\[u2414]\[u2415]\[u2416]\[u2417]\[u2418]\[u2419]\[u241A]\[u241B]\[u241C]\[u241D]\[u241E]\[u241F]\f[R] T} T{ Del T}@T{ DEL 0x7F T}@T{ \f[C]\[u2421]\f[R] T} T{ Dollar T}@T{ \f[C]$\f[R] T}@T{ \f[C]\[uFF04]\f[R] T} T{ Dot T}@T{ \f[C].\f[R] or \f[C]..\f[R] as entire string T}@T{ \f[C]\[uFF0E]\f[R], \f[C]\[uFF0E]\[uFF0E]\f[R] T} T{ DoubleQuote T}@T{ \f[C]\[dq]\f[R] T}@T{ \f[C]\[uFF02]\f[R] T} T{ Exclamation T}@T{ \f[C]!\f[R] T}@T{ \f[C]\[uFF01]\f[R] T} T{ Hash T}@T{ \f[C]#\f[R] T}@T{ \f[C]\[uFF03]\f[R] T} T{ InvalidUtf8 T}@T{ An invalid UTF-8 character (e.g. latin1) T}@T{ \f[C]\[uFFFD]\f[R] T} T{ LeftCrLfHtVt T}@T{ CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the left of a string T}@T{ \f[C]\[u240D]\f[R], \f[C]\[u240A]\f[R], \f[C]\[u2409]\f[R], \f[C]\[u240B]\f[R] T} T{ LeftPeriod T}@T{ \f[C].\f[R] on the left of a string T}@T{ \f[C].\f[R] T} T{ LeftSpace T}@T{ SPACE on the left of a string T}@T{ \f[C]\[u2420]\f[R] T} T{ LeftTilde T}@T{ \f[C]\[ti]\f[R] on the left of a string T}@T{ \f[C]\[uFF5E]\f[R] T} T{ LtGt T}@T{ \f[C]<\f[R], \f[C]>\f[R] T}@T{ \f[C]\[uFF1C]\f[R], \f[C]\[uFF1E]\f[R] T} T{ None \[S1] T}@T{ NUL 0x00 T}@T{ \[u2400] T} T{ Percent T}@T{ \f[C]%\f[R] T}@T{ \f[C]\[uFF05]\f[R] T} T{ Pipe T}@T{ | T}@T{ \f[C]\[uFF5C]\f[R] T} T{ Question T}@T{ \f[C]?\f[R] T}@T{ \f[C]\[uFF1F]\f[R] T} T{ RightCrLfHtVt T}@T{ CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string T}@T{ \f[C]\[u240D]\f[R], \f[C]\[u240A]\f[R], \f[C]\[u2409]\f[R], \f[C]\[u240B]\f[R] T} T{ RightPeriod T}@T{ \f[C].\f[R] on the right of a string T}@T{ \f[C].\f[R] T} T{ RightSpace T}@T{ SPACE on the right of a string T}@T{ \f[C]\[u2420]\f[R] T} T{ Semicolon T}@T{ \f[C];\f[R] T}@T{ \f[C]\[uFF1B]\f[R] T} T{ SingleQuote T}@T{ \f[C]\[aq]\f[R] T}@T{ \f[C]\[uFF07]\f[R] T} T{ Slash T}@T{ \f[C]/\f[R] T}@T{ \f[C]\[uFF0F]\f[R] T} T{ SquareBracket T}@T{ \f[C][\f[R], \f[C]]\f[R] T}@T{ \f[C]\[uFF3B]\f[R], \f[C]\[uFF3D]\f[R] T} .TE .PP \[S1] Encoding from NUL 0x00 to \[u2400] 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. .SS Encoding example: FTP .PP To take a specific example, the FTP backend\[aq]s default encoding is .IP .nf \f[C] --ftp-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] \f[R] .fi .PP However, let\[aq]s say the FTP server is running on Windows and can\[aq]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 .IP .nf \f[C] Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot \f[R] .fi .PP to the existing ones, giving: .IP .nf \f[C] Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace \f[R] .fi .PP This can be specified using the \f[C]--ftp-encoding\f[R] flag or using an \f[C]encoding\f[R] parameter in the config file. .SS Encoding example: Windows .PP As a nother example, take a Windows system where there is a file with name \f[C]Test\[uFF1A]1.jpg\f[R], where \f[C]\[uFF1A]\f[R] is the Unicode fullwidth colon symbol. When using rclone to copy this to a remote which supports \f[C]:\f[R], the regular (halfwidth) colon (such as Google Drive), you will notice that the file gets renamed to \f[C]Test:1.jpg\f[R]. .PP To avoid this you can change the set of characters rclone should convert for the local filesystem, using command-line argument \f[C]--local-encoding\f[R]. Rclone\[aq]s default behavior on Windows corresponds to .IP .nf \f[C] --local-encoding \[dq]Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot\[dq] \f[R] .fi .PP If you want to use fullwidth characters \f[C]\[uFF1A]\f[R], \f[C]\[uFF0A]\f[R] and \f[C]\[uFF1F]\f[R] in your filenames without rclone changing them when uploading to a remote, then set the same as the default value but without \f[C]Colon,Question,Asterisk\f[R]: .IP .nf \f[C] --local-encoding \[dq]Slash,LtGt,DoubleQuote,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot\[dq] \f[R] .fi .PP Alternatively, you can disable the conversion of any characters with \f[C]--local-encoding Raw\f[R]. .PP Instead of using command-line argument \f[C]--local-encoding\f[R], you may also set it as environment variable (https://rclone.org/docs/#environment-variables) \f[C]RCLONE_LOCAL_ENCODING\f[R], or configure (https://rclone.org/docs/#configure) a remote of type \f[C]local\f[R] in your config, and set the \f[C]encoding\f[R] option there. .PP The risk by doing this is that if you have a filename with the regular (halfwidth) \f[C]:\f[R], \f[C]*\f[R] and \f[C]?\f[R] 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. .SS MIME Type .PP MIME types (also known as media types) classify types of documents using a simple text classification, e.g. \f[C]text/html\f[R] or \f[C]application/pdf\f[R]. .PP Some cloud storage systems support reading (\f[C]R\f[R]) the MIME type of objects and some support writing (\f[C]W\f[R]) the MIME type of objects. .PP The MIME type can be important if you are serving files directly to HTTP from the storage system. .PP If you are copying from a remote which supports reading (\f[C]R\f[R]) to a remote which supports writing (\f[C]W\f[R]) then rclone will preserve the MIME types. Otherwise they will be guessed from the extension, or the remote itself may assign the MIME type. .SS Metadata .PP 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). .PP The levels of metadata support are .PP .TS tab(@); lw(19.4n) lw(50.6n). T{ Key T}@T{ Explanation T} _ T{ \f[C]R\f[R] T}@T{ Read only System Metadata on files only T} T{ \f[C]RW\f[R] T}@T{ Read and write System Metadata on files only T} T{ \f[C]RWU\f[R] T}@T{ Read and write System Metadata and read and write User Metadata on files only T} T{ \f[C]DR\f[R] T}@T{ Read only System Metadata on files and directories T} T{ \f[C]DRW\f[R] T}@T{ Read and write System Metadata on files and directories T} T{ \f[C]DRWU\f[R] T}@T{ Read and write System Metadata and read and write User Metadata on files and directories T} .TE .PP See the metadata docs (https://rclone.org/docs/#metadata) for more info. .SS Optional Features .PP All rclone remotes support a base command set. Other features depend upon backend-specific capabilities. .PP .TS tab(@); lw(14.4n) cw(3.6n) cw(3.1n) cw(3.1n) cw(4.6n) cw(4.6n) cw(3.6n) cw(7.2n) lw(9.8n) cw(7.2n) cw(3.6n) cw(5.1n). T{ Name T}@T{ Purge T}@T{ Copy T}@T{ Move T}@T{ DirMove T}@T{ CleanUp T}@T{ ListR T}@T{ StreamUpload T}@T{ MultithreadUpload T}@T{ LinkSharing T}@T{ About T}@T{ EmptyDir T} _ T{ 1Fichier T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T} T{ Akamai Netstorage T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Amazon S3 (or S3 compatible) T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T} T{ Backblaze B2 T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T} T{ Box T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Citrix ShareFile T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Dropbox T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Cloudinary T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ Enterprise File Fabric T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Files.com T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T} T{ FTP T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Gofile T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Google Cloud Storage T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ Google Drive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Google Photos T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ HDFS T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ HiDrive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ HTTP T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ iCloud Drive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ ImageKit T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Internet Archive T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T} T{ Jottacloud T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Koofr T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Mail.ru Cloud T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Mega T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Memory T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ Microsoft Azure Blob Storage T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T} T{ Microsoft Azure Files Storage T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ Microsoft OneDrive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes \[u2075] T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ OpenDrive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ OpenStack Swift T}@T{ Yes \[S1] T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T} T{ Oracle Object Storage T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T} T{ pCloud T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ PikPak T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Pixeldrain T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ premiumize.me T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ put.io T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ Proton Drive T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ QingStor T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ Quatrix by Maytech T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ Seafile T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ SFTP T}@T{ No T}@T{ Yes \[u2074] T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ Sia T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ SMB T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T} T{ SugarSync T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T} T{ Storj T}@T{ Yes \[S2] T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ No T} T{ Uloz.to T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T} T{ Uptobox T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T} T{ WebDAV T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes \[S3] T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ Yandex Disk T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ Yes T} T{ Zoho WorkDrive T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T} T{ The local filesystem T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ No T}@T{ Yes T}@T{ Yes T}@T{ No T}@T{ Yes T}@T{ Yes T} .TE .PP \[S1] Note Swift implements this in order to delete directory markers but it doesn\[aq]t actually have a quicker way of deleting files other than deleting them individually. .PP \[S2] Storj implements this efficiently only for entire buckets. If purging a directory inside a bucket, files are deleted individually. .PP \[S3] StreamUpload is not supported with Nextcloud .PP \[u2074] Use the \f[C]--sftp-copy-is-hardlink\f[R] flag to enable. .PP \[u2075] Use the \f[C]--onedrive-delta\f[R] flag to enable. .SS Purge .PP This deletes a directory quicker than just deleting all the files in the directory. .SS Copy .PP 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 \f[C]rclone copy\f[R] or \f[C]rclone move\f[R] if the remote doesn\[aq]t support \f[C]Move\f[R] directly. .PP If the server doesn\[aq]t support \f[C]Copy\f[R] directly then for copy operations the file is downloaded then re-uploaded. .SS Move .PP 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 \f[C]rclone move\f[R] if the server doesn\[aq]t support \f[C]DirMove\f[R]. .PP If the server isn\[aq]t capable of \f[C]Move\f[R] then rclone simulates it with \f[C]Copy\f[R] then delete. If the server doesn\[aq]t support \f[C]Copy\f[R] then rclone will download the file and re-upload it. .SS DirMove .PP This is used to implement \f[C]rclone move\f[R] to move a directory if possible. If it isn\[aq]t then it will use \f[C]Move\f[R] on each file (which falls back to \f[C]Copy\f[R] then download and upload - see \f[C]Move\f[R] section). .SS CleanUp .PP This is used for emptying the trash for a remote by \f[C]rclone cleanup\f[R]. .PP If the server can\[aq]t do \f[C]CleanUp\f[R] then \f[C]rclone cleanup\f[R] will return an error. .PP \[dd]\[dd] 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 .SS ListR .PP The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the \f[C]--fast-list\f[R] flag to work. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .SS StreamUpload .PP 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. \f[C]rclone rcat\f[R]. .SS MultithreadUpload .PP 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. .SS LinkSharing .PP Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don\[aq]t have an account on the particular cloud provider. .SS About .PP Rclone \f[C]about\f[R] prints quota information for a remote. Typical output includes bytes used, free, quota and in trash. .PP If a remote lacks about capability \f[C]rclone about remote:\f[R]returns an error. .PP Backends without about capability cannot determine free space for an rclone mount, or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP See rclone about command (https://rclone.org/commands/rclone_about/) .SS EmptyDir .PP The remote supports empty directories. See Limitations (https://rclone.org/bugs/#limitations) for details. Most Object/Bucket-based remotes do not support this. .SH Global Flags .PP This describes the global flags available to every rclone command split into groups. .SS Copy .PP Flags for anything which can copy a file. .IP .nf \f[C] --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\[aq]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 \[aq].rclonelink\[aq] 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) --no-check-dest Don\[aq]t check the destination, copy regardless --no-traverse Don\[aq]t traverse destination file system on copy --no-update-dir-modtime Don\[aq]t update directory modification times --no-update-modtime Don\[aq]t update destination modtime if files identical --order-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default \[dq].partial\[dq]) --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 \f[R] .fi .SS Sync .PP Flags used for sync commands. .IP .nf \f[C] --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 --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 \[dq]hash\[dq]) \f[R] .fi .SS Important .PP Important flags useful for most commands. .IP .nf \f[C] -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) \f[R] .fi .SS Check .PP Flags used for check commands. .IP .nf \f[C] --max-backlog int Maximum number of objects in sync or check backlog (default 10000) \f[R] .fi .SS Networking .PP Flags for general networking and HTTP stuff. .IP .nf \f[C] --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 --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 --no-check-certificate Do not verify the server SSL certificate (insecure) --no-gzip-encoding Don\[aq]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 \[dq]rclone/v1.69.2\[dq]) \f[R] .fi .SS Performance .PP Flags helpful for increasing performance. .IP .nf \f[C] --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) \f[R] .fi .SS Config .PP Flags for general configuration of rclone. .IP .nf \f[C] --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 \[dq]$HOME/.cache/rclone\[dq]) --color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO) --config string Config file (default \[dq]$HOME/.config/rclone/rclone.conf\[dq]) --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) --no-console Hide console window (supported on Windows only) --no-unicode-normalization Don\[aq]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 \[dq]/tmp\[dq]) --use-mmap Use mmap allocator (see docs) --use-server-modtime Use server modified time instead of object metadata \f[R] .fi .SS Debugging .PP Flags for developers. .IP .nf \f[C] --cpuprofile string Write cpu profile to file --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper --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 \f[R] .fi .SS Filter .PP Flags for filtering directory listings. .IP .nf \f[C] --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) -f, --filter stringArray Add a file filtering rule --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) --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) \f[R] .fi .SS Listing .PP Flags for listing directories. .IP .nf \f[C] --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 \f[R] .fi .SS Logging .PP Flags for logging and statistics. .IP .nf \f[C] --log-file string Log everything to this file --log-format string Comma separated list of log format options (default \[dq]date,time\[dq]) --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 (\[dq]), see https://golang.org/pkg/time/#Time.Format --stats-unit string Show data rate in stats as either \[aq]bits\[aq] or \[aq]bytes\[aq] per second (default \[dq]bytes\[dq]) --syslog Use Syslog for logging --syslog-facility string Facility for syslog, e.g. KERN,USER (default \[dq]DAEMON\[dq]) --use-json-log Use json log format -v, --verbose count Print lots more stuff (repeat for more) \f[R] .fi .SS Metadata .PP Flags to control metadata. .IP .nf \f[C] -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 \f[R] .fi .SS RC .PP Flags to control the Remote Control API. .IP .nf \f[C] --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 \[dq]tls1.0\[dq]) --rc-no-auth Don\[aq]t require auth for certain methods --rc-pass string Password for authentication --rc-realm string Realm for authentication --rc-salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --rc-serve Enable the serving of remote objects --rc-serve-no-modtime Don\[aq]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-web-fetch-url string URL to fetch the releases for webgui (default \[dq]https://api.github.com/repos/rclone/rclone-webui-react/releases/latest\[dq]) --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\[aq]t open the browser automatically --rc-web-gui-update Check and update to latest version of web gui \f[R] .fi .SS Metrics .PP Flags to control the Metrics HTTP endpoint.. .IP .nf \f[C] --metrics-addr stringArray IPaddress:Port or :Port to bind metrics 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 \[dq]tls1.0\[dq]) --metrics-pass string Password for authentication --metrics-realm string Realm for authentication --metrics-salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --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 --rc-enable-metrics Enable the Prometheus metrics path at the remote control server \f[R] .fi .SS Backend .PP Backend-only flags (these can be set in the config file also). .IP .nf \f[C] --alias-description string Description of the remote --alias-remote string Remote or path to alias --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\[aq]s client secrets --azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth --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\[aq]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\[aq]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\[aq]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\[aq]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-emulator Uses local storage emulator if provided as \[aq]true\[aq] --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\[aq]s client secrets --azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth --azurefiles-connection-string string Azure Files Connection String --azurefiles-description string Description of the remote --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\[aq]s password (obscured) --azurefiles-sas-url string SAS URL --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\[aq]s tenant. Also called its directory ID --azurefiles-upload-concurrency int Concurrency for multipart uploads (default 16) --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-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 \[dq]user\[dq]) --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 \[dq]$HOME/.cache/rclone/cache-backend\[dq]) --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 \[dq]$HOME/.cache/rclone/cache-backend\[dq]) --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 \[dq]md5\[dq]) --chunker-remote string Remote to chunk/unchunk --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-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 int GZIP compression level (-2 to 9) (default -1) --compress-mode string Compression mode (default \[dq]gzip\[dq]) --compress-ram-cache-limit SizeSuffix Some remotes don\[aq]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 \[dq]base32\[dq]) --crypt-filename-encryption string How to encrypt the filenames (default \[dq]standard\[dq]) --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\[aq]t be decrypted --crypt-suffix string If this is set it will override the default suffix of \[dq].bin\[dq] (default \[dq].bin\[dq]) --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 OAuth 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 \[dq]docx,xlsx,pptx,svg\[dq]) --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-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\[aq]s are greater, use drive v2 API to download (default off) --dropbox-auth-url string Auth server URL --dropbox-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s) --dropbox-batch-mode string Upload file batching sync|async|off (default \[dq]sync\[dq]) --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-impersonate string Impersonate this user when using a business account --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-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 --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-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-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\[aq]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 \[dq]$USER\[dq]) --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 Endpoint for the service --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\[aq]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-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s) --gphotos-batch-mode string Upload file batching sync|async|off (default \[dq]sync\[dq]) --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 \[dq]https://api.hidrive.strato.com/2.1\[dq]) --hidrive-root-prefix string The root/parent folder for all paths (default \[dq]/\[dq]) --hidrive-scope-access string Access permissions that rclone should use when requesting access from HiDrive (default \[dq]rw\[dq]) --hidrive-scope-role string User-level that rclone should use when requesting access from HiDrive (default \[dq]user\[dq]) --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\[aq]t use HEAD requests --http-no-slash Set this if the site doesn\[aq]t end directories with / --http-url string URL of HTTP host to connect to --iclouddrive-apple-id string Apple ID --iclouddrive-client-id string Client id (default \[dq]d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d\[dq]) --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) --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. \[dq]tag1,tag2\[dq] --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\[aq]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 \[dq]https://s3.us.archive.org\[dq]) --internetarchive-front-endpoint string Host of InternetArchive Frontend (default \[dq]https://archive.org\[dq]) --internetarchive-secret-access-key string IAS3 Secret Key (password) --internetarchive-wait-archive Duration Timeout for waiting the server\[aq]s processing tasks (specifically archive and book_op) to finish (default 0s) --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,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\[aq]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-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-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the local backend --local-no-check-updated Don\[aq]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 \[dq]*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf\[dq]) --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-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 --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 \[dq]https\[dq]) --netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured) -x, --one-file-system Don\[aq]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 \[dq]auto\[dq]) --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 \[dq]anonymous\[dq]) --onedrive-link-type string Set the type of the links created by the link command (default \[dq]view\[dq]) --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 \[dq]global\[dq]) --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\[aq]s tenant. Also called its directory ID --onedrive-token string OAuth Access Token as a JSON blob --onedrive-token-url string Token server url --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 \[dq]\[ti]/.oci/config\[dq]) --oos-config-profile string Profile name inside the oci config file (default \[dq]Default\[dq]) --oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi) --oos-copy-timeout Duration Timeout for copy (default 1m0s) --oos-description string Description of the remote --oos-disable-checksum Don\[aq]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\[aq]t attempt to check the bucket exists or create it --oos-provider string Choose your Auth Provider (default \[dq]env_auth\[dq]) --oos-region string Object storage Region --oos-sse-customer-algorithm string If using SSE-C, the optional header that specifies \[dq]AES256\[dq] 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 \[dq]Standard\[dq]) --oos-upload-concurrency int Concurrency for multipart uploads (default 10) --oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) --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 \[dq]api.pcloud.com\[dq]) --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 \[dq]d0\[dq]) --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 5) --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 \[dq]Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0\[dq]) --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\[aq]s fine to leave (default \[dq]https://pixeldrain.com/api\[dq]) --pixeldrain-description string Description of the remote --pixeldrain-root-folder-id string Root of the filesystem to use (default \[dq]me\[dq]) --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 (default \[dq]macos-drive\[at]1.0.0-alpha.1+rclone\[dq]) --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-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 \[dq]4s\[dq]) --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 \[aq]transfers\[aq]*\[aq]minimal_chunk_size\[aq] (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-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\[aq]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-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-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\[aq]t attempt to check the bucket exists or create it --s3-no-head If set, don\[aq]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-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-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-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-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-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 (\[aq]true\[aq] if the account has 2FA enabled) --seafile-create-library Should rclone create a library if it doesn\[aq]t exist --seafile-description string Description of the remote --seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) --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-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-description string Description of the remote --sftp-disable-concurrent-reads If set don\[aq]t use concurrent reads --sftp-disable-concurrent-writes If set don\[aq]t use concurrent writes --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available --sftp-host string SSH host to connect to --sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference --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-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 sha1 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 \[dq]sftp\[dq]) --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 \[dq]$USER\[dq]) --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 \[dq]http://127.0.0.1:9980\[dq]) --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 \[dq]Sia-Agent\[dq]) --skip-links Don\[aq]t warn about skipped symlinks --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 \[dq]WORKGROUP\[dq]) --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\[aq]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-pass string SMB password (obscured) --smb-port int SMB port number (default 445) --smb-spn string Service principal name --smb-user string SMB username (default \[dq]$USER\[dq]) --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 \[dq]existing\[dq]) --storj-satellite-address string Satellite address (default \[dq]us1.storj.io\[dq]) --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 \[dq]public\[dq]) --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\[aq]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 \[dq]epall\[dq]) --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 \[dq]epmfs\[dq]) --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 \[dq]ff\[dq]) --union-upstreams string List of space separated upstreams --uptobox-access-token string Your access token --uptobox-description string Description of the remote --uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot) --uptobox-private Set to make uploaded files private --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 --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-region string Zoho region to connect to --zoho-token string OAuth Access Token as a JSON blob --zoho-token-url string Token server url --zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi) \f[R] .fi .SH Docker Volume Plugin .SS Introduction .PP 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 \f[I]swarm stacks\f[R] across multiple cluster nodes. .PP Docker Volume Plugins (https://docs.docker.com/engine/extend/plugins_volume/) augment the default \f[C]local\f[R] volume driver included in Docker with stateful volumes shared across containers and hosts. Unlike local volumes, your data will \f[I]not\f[R] be deleted when such volume is removed. Plugins can run managed by the docker daemon, as a native system service (under systemd, \f[I]sysv\f[R] or \f[I]upstart\f[R]) 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. .SS Getting started .PP In the first example we will use the SFTP (https://rclone.org/sftp/) rclone volume with Docker engine on a standalone Ubuntu machine. .PP Start from installing Docker (https://docs.docker.com/engine/install/) on the host. .PP The \f[I]FUSE\f[R] driver is a prerequisite for rclone mounting and should be installed on host: .IP .nf \f[C] sudo apt-get -y install fuse3 \f[R] .fi .PP Create two directories required by rclone docker plugin: .IP .nf \f[C] sudo mkdir -p /var/lib/docker-plugins/rclone/config sudo mkdir -p /var/lib/docker-plugins/rclone/cache \f[R] .fi .PP Install the managed rclone docker plugin for your architecture (here \f[C]amd64\f[R]): .IP .nf \f[C] docker plugin install rclone/docker-volume-rclone:amd64 args=\[dq]-v\[dq] --alias rclone --grant-all-permissions docker plugin list \f[R] .fi .PP Create your SFTP volume (https://rclone.org/sftp/#standard-options): .IP .nf \f[C] 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 \f[R] .fi .PP Note that since all options are static, you don\[aq]t even have to run \f[C]rclone config\f[R] or create the \f[C]rclone.conf\f[R] file (but the \f[C]config\f[R] directory should still be present). In the simplest case you can use \f[C]localhost\f[R] as \f[I]hostname\f[R] and your SSH credentials as \f[I]username\f[R] and \f[I]password\f[R]. You can also change the remote path to your home directory on the host, for example \f[C]-o path=/home/username\f[R]. .PP Time to create a test container and mount the volume into it: .IP .nf \f[C] docker run --rm -it -v firstvolume:/mnt --workdir /mnt ubuntu:latest bash \f[R] .fi .PP If all goes well, you will enter the new container and change right to the mounted SFTP remote. You can type \f[C]ls\f[R] to list the mounted directory or otherwise play with it. Type \f[C]exit\f[R] when you are done. The container will stop but the volume will stay, ready to be reused. When it\[aq]s not needed anymore, remove it: .IP .nf \f[C] docker volume list docker volume remove firstvolume \f[R] .fi .PP Now let us try \f[B]something more elaborate\f[R]: Google Drive (https://rclone.org/drive/) volume on multi-node Docker Swarm. .PP You should start from installing Docker and FUSE, creating plugin directories and installing rclone plugin on \f[I]every\f[R] swarm node. Then setup the Swarm (https://docs.docker.com/engine/swarm/swarm-mode/). .PP 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/). .PP Run rclone config (https://rclone.org/commands/rclone_config_create/) on \f[I]another\f[R] machine equipped with \f[I]web browser\f[R] and graphical user interface. Create the Google Drive remote (https://rclone.org/drive/#standard-options). When done, transfer the resulting \f[C]rclone.conf\f[R] to the Swarm cluster and save as \f[C]/var/lib/docker-plugins/rclone/config/rclone.conf\f[R] on \f[I]every\f[R] 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: .IP .nf \f[C] [gdrive] type = drive scope = drive drive_id = 1234567... root_folder_id = 0Abcd... token = {\[dq]access_token\[dq]:...} \f[R] .fi .PP Now create the file named \f[C]example.yml\f[R] with a swarm stack description like this: .IP .nf \f[C] version: \[aq]3\[aq] services: heimdall: image: linuxserver/heimdall:latest ports: [8080:80] volumes: [configdata:/config] volumes: configdata: driver: rclone driver_opts: remote: \[aq]gdrive:heimdall\[aq] allow_other: \[aq]true\[aq] vfs_cache_mode: full poll_interval: 0 \f[R] .fi .PP and run the stack: .IP .nf \f[C] docker stack deploy example -c ./example.yml \f[R] .fi .PP After a few seconds docker will spread the parsed stack description over cluster, create the \f[C]example_heimdall\f[R] service on port \f[I]8080\f[R], run service containers on one or more cluster nodes and request the \f[C]example_configdata\f[R] volume from rclone plugins on the node hosts. You can use the following commands to confirm results: .IP .nf \f[C] docker service ls docker service ps example_heimdall docker volume ls \f[R] .fi .PP Point your browser to \f[C]http://cluster.host.address:8080\f[R] and play with the service. Stop it with \f[C]docker stack remove example\f[R] when you are done. Note that the \f[C]example_configdata\f[R] 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 \f[C]docker volume remove example_configdata\f[R] command on every node. .SS Creating Volumes via CLI .PP Volumes can be created with docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/). Here are a few examples: .IP .nf \f[C] 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 \f[R] .fi .PP Note the \f[C]-d rclone\f[R] flag that tells docker to request volume from the rclone driver. This works even if you installed managed driver by its full name \f[C]rclone/docker-volume-rclone\f[R] because you provided the \f[C]--alias rclone\f[R] option. .PP Volumes can be inspected as follows: .IP .nf \f[C] docker volume list docker volume inspect vol1 \f[R] .fi .SS Volume Configuration .PP Rclone flags and volume options are set via the \f[C]-o\f[R] flag to the \f[C]docker volume create\f[R] command. They include backend-specific parameters as well as mount and \f[I]VFS\f[R] options. Also there are a few special \f[C]-o\f[R] options: \f[C]remote\f[R], \f[C]fs\f[R], \f[C]type\f[R], \f[C]path\f[R], \f[C]mount-type\f[R] and \f[C]persist\f[R]. .PP \f[C]remote\f[R] 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 \f[C]fs\f[R] to prevent confusion with the \f[I]remote\f[R] parameter of such backends as \f[I]crypt\f[R] or \f[I]alias\f[R]. .PP The \f[C]remote=:backend:dir/subdir\f[R] syntax can be used to create on-the-fly (config-less) remotes (https://rclone.org/docs/#backend-path-to-dir), while the \f[C]type\f[R] and \f[C]path\f[R] options provide a simpler alternative for this. Using two split options .IP .nf \f[C] -o type=backend -o path=dir/subdir \f[R] .fi .PP is equivalent to the combined syntax .IP .nf \f[C] -o remote=:backend:dir/subdir \f[R] .fi .PP but is arguably easier to parameterize in scripts. The \f[C]path\f[R] part is optional. .PP 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 \f[C]--\f[R] CLI prefix. Optionally you can use underscores instead of dashes in option names. For example, \f[C]--vfs-cache-mode full\f[R] becomes \f[C]-o vfs-cache-mode=full\f[R] or \f[C]-o vfs_cache_mode=full\f[R]. Boolean CLI flags without value will gain the \f[C]true\f[R] value, e.g. \f[C]--allow-other\f[R] becomes \f[C]-o allow-other=true\f[R] or \f[C]-o allow_other=true\f[R]. .PP Please note that you can provide parameters only for the backend immediately referenced by the backend type of mounted \f[C]remote\f[R]. If this is a wrapping backend like \f[I]alias, chunker or crypt\f[R], 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 \f[C]rclone.conf\f[R] or configure plugin arguments (see below). .SS Special Volume Options .PP \f[C]mount-type\f[R] determines the mount method and in general can be one of: \f[C]mount\f[R], \f[C]cmount\f[R], or \f[C]mount2\f[R]. This can be aliased as \f[C]mount_type\f[R]. It should be noted that the managed rclone docker plugin currently does not support the \f[C]cmount\f[R] method and \f[C]mount2\f[R] is rarely needed. This option defaults to the first found method, which is usually \f[C]mount\f[R] so you generally won\[aq]t need it. .PP \f[C]persist\f[R] is a reserved boolean (true/false) option. In future it will allow to persist on-the-fly remotes in the plugin \f[C]rclone.conf\f[R] file. .SS Connection Strings .PP The \f[C]remote\f[R] 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 \f[C]-o\f[R] backend options with one \f[I]syntactic difference\f[R]. Inside connection string the backend prefix must be dropped from parameter names but in the \f[C]-o param=value\f[R] array it must be present. For instance, compare the following option array .IP .nf \f[C] -o remote=:sftp:/home -o sftp-host=localhost \f[R] .fi .PP with equivalent connection string: .IP .nf \f[C] -o remote=:sftp,host=localhost:/home \f[R] .fi .PP This difference exists because flag options \f[C]-o key=val\f[R] include not only backend parameters but also mount/VFS flags and possibly other settings. Also it allows to discriminate the \f[C]remote\f[R] option from the \f[C]crypt-remote\f[R] (or similarly named backend parameters) and arguably simplifies scripting due to clearer value substitution. .SS Using with Swarm or Compose .PP Both \f[I]Docker Swarm\f[R] and \f[I]Docker Compose\f[R] use YAML (http://yaml.org/spec/1.2/spec.html)-formatted text files to describe groups (stacks) of containers, their properties, networks and volumes. \f[I]Compose\f[R] uses the compose v2 (https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference) format, \f[I]Swarm\f[R] 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). .PP Volumes are described by the children of the top-level \f[C]volumes:\f[R] node. Each of them should be named after its volume and have at least two elements, the self-explanatory \f[C]driver: rclone\f[R] value and the \f[C]driver_opts:\f[R] structure playing the same role as \f[C]-o key=val\f[R] CLI flags: .IP .nf \f[C] volumes: volume_name_1: driver: rclone driver_opts: remote: \[aq]gdrive:\[aq] allow_other: \[aq]true\[aq] vfs_cache_mode: full token: \[aq]{\[dq]type\[dq]: \[dq]borrower\[dq], \[dq]expires\[dq]: \[dq]2021-12-31\[dq]}\[aq] poll_interval: 0 \f[R] .fi .PP Notice a few important details: - YAML prefers \f[C]_\f[R] in option names instead of \f[C]-\f[R]. - YAML treats single and double quotes interchangeably. Simple strings and integers can be left unquoted. - Boolean values must be quoted like \f[C]\[aq]true\[aq]\f[R] or \f[C]\[dq]false\[dq]\f[R] because these two words are reserved by YAML. - The filesystem string is keyed with \f[C]remote\f[R] (or with \f[C]fs\f[R]). Normally you can omit quotes here, but if the string ends with colon, you \f[B]must\f[R] quote it like \f[C]remote: \[dq]storage_box:\[dq]\f[R]. - 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. .SS Installing as Managed Plugin .PP 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). .PP Rclone volume plugin requires \f[B]Docker Engine >= 19.03.15\f[R] .PP The plugin requires presence of two directories on the host before it can be installed. Note that plugin will \f[B]not\f[R] create them automatically. By default they must exist on host at the following locations (though you can tweak the paths): - \f[C]/var/lib/docker-plugins/rclone/config\f[R] is reserved for the \f[C]rclone.conf\f[R] config file and \f[B]must\f[R] exist even if it\[aq]s empty and the config file is not present. - \f[C]/var/lib/docker-plugins/rclone/cache\f[R] holds the plugin state file as well as optional VFS caches. .PP You can install managed plugin (https://docs.docker.com/engine/reference/commandline/plugin_install/) with default settings as follows: .IP .nf \f[C] docker plugin install rclone/docker-volume-rclone:amd64 --grant-all-permissions --alias rclone \f[R] .fi .PP The \f[C]:amd64\f[R] part of the image specification after colon is called a \f[I]tag\f[R]. Usually you will want to install the latest plugin for your architecture. In this case the tag will just name it, like \f[C]amd64\f[R] above. The following plugin architectures are currently available: - \f[C]amd64\f[R] - \f[C]arm64\f[R] - \f[C]arm-v7\f[R] .PP Sometimes you might want a concrete plugin version, not the latest one. Then you should use image tag in the form \f[C]:ARCHITECTURE-VERSION\f[R]. For example, to install plugin version \f[C]v1.56.2\f[R] on architecture \f[C]arm64\f[R] you will use tag \f[C]arm64-1.56.2\f[R] (note the removed \f[C]v\f[R]) so the full image specification becomes \f[C]rclone/docker-volume-rclone:arm64-1.56.2\f[R]. .PP We also provide the \f[C]latest\f[R] plugin tag, but since docker does not support multi-architecture plugins as of the time of this writing, this tag is currently an \f[B]alias for \f[CB]amd64\f[B]\f[R]. By convention the \f[C]latest\f[R] tag is the default one and can be omitted, thus both \f[C]rclone/docker-volume-rclone:latest\f[R] and just \f[C]rclone/docker-volume-rclone\f[R] will refer to the latest plugin release for the \f[C]amd64\f[R] platform. .PP Also the \f[C]amd64\f[R] part can be omitted from the versioned rclone plugin tags. For example, rclone image reference \f[C]rclone/docker-volume-rclone:amd64-1.56.2\f[R] can be abbreviated as \f[C]rclone/docker-volume-rclone:1.56.2\f[R] for convenience. However, for non-intel architectures you still have to use the full tag as \f[C]amd64\f[R] or \f[C]latest\f[R] will fail to start. .PP Managed plugin is in fact a special container running in a namespace separate from normal docker containers. Inside it runs the \f[C]rclone serve docker\f[R] 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. .PP You can tweak a few plugin settings after installation when it\[aq]s disabled (not in use), for instance: .IP .nf \f[C] docker plugin disable rclone docker plugin set rclone RCLONE_VERBOSE=2 config=/etc/rclone args=\[dq]--vfs-cache-mode=writes --allow-other\[dq] docker plugin enable rclone docker plugin inspect rclone \f[R] .fi .PP 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. .PP You can tweak the following settings: \f[C]args\f[R], \f[C]config\f[R], \f[C]cache\f[R], \f[C]HTTP_PROXY\f[R], \f[C]HTTPS_PROXY\f[R], \f[C]NO_PROXY\f[R] and \f[C]RCLONE_VERBOSE\f[R]. It\[aq]s \f[I]your\f[R] task to keep plugin settings in sync across swarm cluster nodes. .PP \f[C]args\f[R] sets command-line arguments for the \f[C]rclone serve docker\f[R] command (\f[I]none\f[R] 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 \f[C]args\f[R] value is empty. Use e.g. \f[C]args=\[dq]-v\[dq]\f[R] as a workaround. .PP \f[C]config=/host/dir\f[R] sets alternative host location for the config directory. Plugin will look for \f[C]rclone.conf\f[R] here. It\[aq]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 \f[C]rclone.conf\f[R]. You can also put stuff like private key files for SFTP remotes in this directory. Just note that it\[aq]s bind-mounted inside the plugin container at the predefined path \f[C]/data/config\f[R]. For example, if your key file is named \f[C]sftp-box1.key\f[R] on the host, the corresponding volume config option should read \f[C]-o sftp-key-file=/data/config/sftp-box1.key\f[R]. .PP \f[C]cache=/host/dir\f[R] sets alternative host location for the \f[I]cache\f[R] directory. The plugin will keep VFS caches here. Also it will create and maintain the \f[C]docker-plugin.state\f[R] 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. .PP \f[C]RCLONE_VERBOSE\f[R] sets plugin verbosity from \f[C]0\f[R] (errors only, by default) to \f[C]2\f[R] (debugging). Verbosity can be also tweaked via \f[C]args=\[dq]-v [-v] ...\[dq]\f[R]. 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 \f[I]errors\f[R] in the docker log but retain their actual level assigned by rclone in the encapsulated message string. .PP \f[C]HTTP_PROXY\f[R], \f[C]HTTPS_PROXY\f[R], \f[C]NO_PROXY\f[R] customize the plugin proxy settings. .PP You can set custom plugin options right when you install it, \f[I]in one go\f[R]: .IP .nf \f[C] docker plugin remove rclone docker plugin install rclone/docker-volume-rclone:amd64 \[rs] --alias rclone --grant-all-permissions \[rs] args=\[dq]-v --allow-other\[dq] config=/etc/rclone docker plugin inspect rclone \f[R] .fi .SS Healthchecks .PP The docker plugin volume protocol doesn\[aq]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: .IP .nf \f[C] services: my_service: image: my_image healthcheck: test: ls /path/to/rclone/mount || exit 1 interval: 1m timeout: 15s retries: 3 start_period: 15s \f[R] .fi .SS Running Plugin under Systemd .PP 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. .PP First, install rclone (https://rclone.org/install/). You can just run it (type \f[C]rclone serve docker\f[R] and hit enter) for the test. .PP Install \f[I]FUSE\f[R]: .IP .nf \f[C] sudo apt-get -y install fuse \f[R] .fi .PP 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). .PP Put them to the \f[C]/etc/systemd/system/\f[R] directory: .IP .nf \f[C] cp docker-volume-plugin.service /etc/systemd/system/ cp docker-volume-plugin.socket /etc/systemd/system/ \f[R] .fi .PP Please note that all commands in this section must be run as \f[I]root\f[R] but we omit \f[C]sudo\f[R] prefix for brevity. Now create directories required by the service: .IP .nf \f[C] mkdir -p /var/lib/docker-volumes/rclone mkdir -p /var/lib/docker-plugins/rclone/config mkdir -p /var/lib/docker-plugins/rclone/cache \f[R] .fi .PP Run the docker plugin service in the socket activated mode: .IP .nf \f[C] systemctl daemon-reload systemctl start docker-volume-rclone.service systemctl enable docker-volume-rclone.socket systemctl start docker-volume-rclone.socket systemctl restart docker \f[R] .fi .PP Or run the service directly: - run \f[C]systemctl daemon-reload\f[R] to let systemd pick up new config - run \f[C]systemctl enable docker-volume-rclone.service\f[R] to make the new service start automatically when you power on your machine. - run \f[C]systemctl start docker-volume-rclone.service\f[R] to start the service now. - run \f[C]systemctl restart docker\f[R] 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. .PP The two methods are equivalent from the user perspective, but I personally prefer socket activation. .SS Troubleshooting .PP You can see managed plugin settings (https://docs.docker.com/engine/extend/#debugging-plugins) with .IP .nf \f[C] docker plugin list docker plugin inspect rclone \f[R] .fi .PP Note that docker (including latest 20.10.7) will not show actual values of \f[C]args\f[R], just the defaults. .PP Use \f[C]journalctl --unit docker\f[R] to see managed plugin output as part of the docker daemon log. Note that docker reflects plugin lines as \f[I]errors\f[R] but their actual level can be seen from encapsulated message string. .PP You will usually install the latest version of managed plugin for your platform. Use the following commands to print the actual installed version: .IP .nf \f[C] PLUGID=$(docker plugin list --no-trunc | awk \[aq]/rclone/{print$1}\[aq]) sudo runc --root /run/docker/runtime-runc/plugins.moby exec $PLUGID rclone version \f[R] .fi .PP You can even use \f[C]runc\f[R] to run shell inside the plugin container: .IP .nf \f[C] sudo runc --root /run/docker/runtime-runc/plugins.moby exec --tty $PLUGID bash \f[R] .fi .PP Also you can use curl to check the plugin socket connectivity: .IP .nf \f[C] 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 \f[R] .fi .PP though this is rarely needed. .PP 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. \f[B]Note that all existing rclone docker volumes will probably have to be recreated.\f[R] This might be needed because a reinstall don\[aq]t cleanup existing state files to allow for easy restoration, as stated above. .IP .nf \f[C] 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 \f[R] .fi .SS Caveats .PP Finally I\[aq]d like to mention a \f[I]caveat with updating volume settings\f[R]. Docker CLI does not have a dedicated command like \f[C]docker volume update\f[R]. It may be tempting to invoke \f[C]docker volume create\f[R] with updated options on existing volume, but there is a gotcha. The command will do nothing, it won\[aq]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: .IP .nf \f[C] docker volume remove my_vol docker volume create my_vol -d rclone -o opt1=new_val1 ... \f[R] .fi .PP and verify that settings did update: .IP .nf \f[C] docker volume list docker volume inspect my_vol \f[R] .fi .PP If docker refuses to remove the volume, you should find containers or swarm services that use it and stop them first. .SS Bisync .PP \f[C]bisync\f[R] is \f[B]in beta\f[R] and is considered an \f[B]advanced command\f[R], so use with care. Make sure you have read and understood the entire manual (https://rclone.org/bisync) (especially the Limitations section) before using, or data loss can result. Questions can be asked in the Rclone Forum (https://forum.rclone.org/). .SS Getting started .IP \[bu] 2 Install rclone (https://rclone.org/install/) and setup your remotes. .IP \[bu] 2 Bisync will create its working directory at \f[C]\[ti]/.cache/rclone/bisync\f[R] on Linux, \f[C]/Users/yourusername/Library/Caches/rclone/bisync\f[R] on Mac, or \f[C]C:\[rs]Users\[rs]MyLogin\[rs]AppData\[rs]Local\[rs]rclone\[rs]bisync\f[R] on Windows. Make sure that this location is writable. .IP \[bu] 2 Run bisync with the \f[C]--resync\f[R] flag, specifying the paths to the local and remote sync directory roots. .IP \[bu] 2 For successive sync runs, leave off the \f[C]--resync\f[R] flag. (\f[B]Important!\f[R]) .IP \[bu] 2 Consider using a filters file for excluding unnecessary files and directories from the sync. .IP \[bu] 2 Consider setting up the --check-access feature for safety. .IP \[bu] 2 On Linux or Mac, consider setting up a crontab entry. bisync can safely run in concurrent cron jobs thanks to lock files it maintains. .PP For example, your first command might look like this: .IP .nf \f[C] 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 \f[R] .fi .PP If all looks good, run it again without \f[C]--dry-run\f[R]. After that, remove \f[C]--resync\f[R] as well. .PP Here is a typical run log (with timestamps removed for clarity): .IP .nf \f[C] rclone bisync /testdir/path1/ /testdir/path2/ --verbose INFO : Synching Path1 \[dq]/testdir/path1/\[dq] with Path2 \[dq]/testdir/path2/\[dq] 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 \[dq]/testdir/path1/\[dq] vs Path2 \[dq]/testdir/path2/\[dq] INFO : Bisync successful \f[R] .fi .SS Command line syntax .IP .nf \f[C] $ rclone bisync --help Usage: rclone bisync remote1:path1 remote2:path2 [flags] Positional arguments: Path1, Path2 Local path, or remote storage with \[aq]:\[aq] plus optional path. Type \[aq]rclone listremotes\[aq] 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 \[dq]true\[dq]) --compare string Comma-separated list of bisync-specific compare options ex. \[aq]size,modtime,checksum\[aq] (default: \[aq]size,modtime\[aq]) --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 \[dq]none\[dq]) --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: \[aq]conflict\[aq]) --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. Use at your own risk! -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 \[dq]none\[dq]) --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. \f[R] .fi .PP Arbitrary rclone flags may be specified on the bisync command line (https://rclone.org/commands/rclone_bisync/), for example \f[C]rclone bisync ./testdir/path1/ gdrive:testdir/path2/ --drive-skip-gdocs -v -v --timeout 10s\f[R] Note that interactions of various rclone flags with bisync process flow has not been fully tested yet. .SS Paths .PP Path1 and Path2 arguments may be references to any mix of local directory paths (absolute or relative), UNC paths (\f[C]//server/share/path\f[R]), Windows drive paths (with a drive letter and \f[C]:\f[R]) or configured remotes (https://rclone.org/docs/#syntax-of-remote-paths) with optional subdirectory paths. Cloud references are distinguished by having a \f[C]:\f[R] in the argument (see Windows support below). .PP Path1 and Path2 are treated equally, in that neither has priority for file changes (except during \f[C]--resync\f[R]), and access efficiency does not change whether a remote is on Path1 or Path2. .PP The listings in bisync working directory (default: \f[C]\[ti]/.cache/rclone/bisync\f[R]) 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.: \f[C]path_to_local_tree..dropbox_subdir.lst\f[R]. .PP Any empty directories after the sync on both the Path1 and Path2 filesystems are not deleted by default, unless \f[C]--create-empty-src-dirs\f[R] is specified. If the \f[C]--remove-empty-dirs\f[R] flag is specified, then both paths will have ALL empty directories purged as the last step in the process. .SS Command-line flags .SS --resync .PP 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. .PP The \f[C]--resync\f[R] sequence is roughly equivalent to the following (but see \f[C]--resync-mode\f[R] for other options): .IP .nf \f[C] rclone copy Path2 Path1 --ignore-existing [--create-empty-src-dirs] rclone copy Path1 Path2 [--create-empty-src-dirs] \f[R] .fi .PP 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. .PP When using \f[C]--resync\f[R], 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 \f[C]--resync-mode\f[R] flag.) Carefully evaluate deltas using --dry-run (https://rclone.org/flags/#non-backend-flags). .PP 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. .PP For a non-resync run, either path being empty (no files in the tree) fails with \f[C]Empty current PathN listing. Cannot sync to an empty directory: X.pathN.lst\f[R] This is a safety check that an unexpected empty path does not result in deleting \f[B]everything\f[R] in the other path. .PP Note that \f[C]--resync\f[R] implies \f[C]--resync-mode path1\f[R] unless a different \f[C]--resync-mode\f[R] is explicitly specified. It is not necessary to use both the \f[C]--resync\f[R] and \f[C]--resync-mode\f[R] flags -- either one is sufficient without the other. .PP \f[B]Note:\f[R] \f[C]--resync\f[R] (including \f[C]--resync-mode\f[R]) should only be used under three specific (rare) circumstances: 1. It is your \f[I]first\f[R] bisync run (between these two paths) 2. You\[aq]ve just made changes to your bisync settings (such as editing the contents of your \f[C]--filters-file\f[R]) 3. There was an error on the prior run, and as a result, bisync now requires \f[C]--resync\f[R] to recover .PP The rest of the time, you should \f[I]omit\f[R] \f[C]--resync\f[R]. The reason is because \f[C]--resync\f[R] will only \f[I]copy\f[R] (not \f[I]sync\f[R]) each side to the other. Therefore, if you included \f[C]--resync\f[R] 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\[aq]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. .PP If you find that frequent interruptions from #3 are an issue, rather than automatically running \f[C]--resync\f[R], the recommended alternative is to use the \f[C]--resilient\f[R], \f[C]--recover\f[R], and \f[C]--conflict-resolve\f[R] flags, (along with Graceful Shutdown mode, when needed) for a very robust \[dq]set-it-and-forget-it\[dq] bisync setup that can automatically bounce back from almost any interruption it might encounter. Consider adding something like the following: .IP .nf \f[C] --resilient --recover --max-lock 2m --conflict-resolve newer \f[R] .fi .SS --resync-mode CHOICE .PP In the event that a file differs on both sides during a \f[C]--resync\f[R], \f[C]--resync-mode\f[R] controls which version will overwrite the other. The supported options are similar to \f[C]--conflict-resolve\f[R]. For all of the following options, the version that is kept is referred to as the \[dq]winner\[dq], and the version that is overwritten (deleted) is referred to as the \[dq]loser\[dq]. The options are named after the \[dq]winner\[dq]: .IP \[bu] 2 \f[C]path1\f[R] - (the default) - the version from Path1 is unconditionally considered the winner (regardless of \f[C]modtime\f[R] and \f[C]size\f[R], if any). This can be useful if one side is more trusted or up-to-date than the other, at the time of the \f[C]--resync\f[R]. .IP \[bu] 2 \f[C]path2\f[R] - same as \f[C]path1\f[R], except the path2 version is considered the winner. .IP \[bu] 2 \f[C]newer\f[R] - the newer file (by \f[C]modtime\f[R]) 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 \f[C]rclone copy --update\f[R] in both directions.) .IP \[bu] 2 \f[C]older\f[R] - same as \f[C]newer\f[R], except the older file is considered the winner, and the newer file is considered the loser. .IP \[bu] 2 \f[C]larger\f[R] - the larger file (by \f[C]size\f[R]) is considered the winner (regardless of \f[C]modtime\f[R], if any). This can be a useful option for remotes without \f[C]modtime\f[R] support, or with the kinds of files (such as logs) that tend to grow but not shrink, over time. .IP \[bu] 2 \f[C]smaller\f[R] - the smaller file (by \f[C]size\f[R]) is considered the winner (regardless of \f[C]modtime\f[R], if any). .PP 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 \f[C]path1\f[R]. (For example, if \f[C]--resync-mode newer\f[R] is set, but one of the paths uses a remote that doesn\[aq]t support \f[C]modtime\f[R].) - If a winner can\[aq]t be determined because the chosen method\[aq]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 \f[C]--compare\f[R] methods in effect. (For example, if \f[C]--resync-mode newer\f[R] 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 \[dq]source\[dq] at that moment. (In practice, this gives a slight advantage to Path2, as the 2to1 copy comes before the 1to2 copy.) If the files \f[I]do not\f[R] 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 \f[I]only\f[R] on one side and not the other are \f[I]always\f[R] copied to the other, during \f[C]--resync\f[R] (this is one of the main differences between resync and non-resync runs.). - \f[C]--conflict-resolve\f[R], \f[C]--conflict-loser\f[R], and \f[C]--conflict-suffix\f[R] do not apply during \f[C]--resync\f[R], and unlike these flags, nothing is renamed during \f[C]--resync\f[R]. When a file differs on both sides during \f[C]--resync\f[R], one version always overwrites the other (much like in \f[C]rclone copy\f[R].) (Consider using \f[C]--backup-dir\f[R] to retain a backup of the losing version.) - Unlike for \f[C]--conflict-resolve\f[R], \f[C]--resync-mode none\f[R] is not a valid option (or rather, it will be interpreted as \[dq]no resync\[dq], unless \f[C]--resync\f[R] 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 \f[C]path1\f[R] and \f[C]path2\f[R] options typically produce a similar result.) - To maintain backward-compatibility, the \f[C]--resync\f[R] flag implies \f[C]--resync-mode path1\f[R] unless a different \f[C]--resync-mode\f[R] is explicitly specified. Similarly, all \f[C]--resync-mode\f[R] options (except \f[C]none\f[R]) imply \f[C]--resync\f[R], so it is not necessary to use both the \f[C]--resync\f[R] and \f[C]--resync-mode\f[R] flags simultaneously -- either one is sufficient without the other. .SS --check-access .PP Access check files are an additional safety measure against data loss. bisync will ensure it can find matching \f[C]RCLONE_TEST\f[R] files in the same places in the Path1 and Path2 filesystems. \f[C]RCLONE_TEST\f[R] files are not generated automatically. For \f[C]--check-access\f[R] to succeed, you must first either: \f[B]A)\f[R] Place one or more \f[C]RCLONE_TEST\f[R] files in both systems, or \f[B]B)\f[R] Set \f[C]--check-filename\f[R] to a filename already in use in various locations throughout your sync\[aq]d fileset. Recommended methods for \f[B]A)\f[R] include: * \f[C]rclone touch Path1/RCLONE_TEST\f[R] (create a new file) * \f[C]rclone copyto Path1/RCLONE_TEST Path2/RCLONE_TEST\f[R] (copy an existing file) * \f[C]rclone copy Path1/RCLONE_TEST Path2/RCLONE_TEST --include \[dq]RCLONE_TEST\[dq]\f[R] (copy multiple files at once, recursively) * create the files manually (outside of rclone) * run \f[C]bisync\f[R] once \f[I]without\f[R] \f[C]--check-access\f[R] 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). .PP Note that \f[C]--check-access\f[R] is still enforced on \f[C]--resync\f[R], so \f[C]bisync --resync --check-access\f[R] will not work as a method of initially setting the files (this is to ensure that bisync can\[aq]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).) .PP Time stamps and file contents for \f[C]RCLONE_TEST\f[R] files are not important, just the names and locations. If you have symbolic links in your sync tree it is recommended to place \f[C]RCLONE_TEST\f[R] 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 flag. .SS --check-filename .PP Name of the file(s) used in access health validation. The default \f[C]--check-filename\f[R] is \f[C]RCLONE_TEST\f[R]. One or more files having this filename must exist, synchronized between your source and destination filesets, in order for \f[C]--check-access\f[R] to succeed. See --check-access for additional details. .SS --compare .PP As of \f[C]v1.66\f[R], bisync fully supports comparing based on any combination of size, modtime, and checksum (lifting the prior restriction on backends without modtime support.) .PP By default (without the \f[C]--compare\f[R] flag), bisync inherits the same comparison options as \f[C]sync\f[R] (that is: \f[C]size\f[R] and \f[C]modtime\f[R] by default, unless modified with flags such as \f[C]--checksum\f[R] (https://rclone.org/docs/#c-checksum) or \f[C]--size-only\f[R].) .PP If the \f[C]--compare\f[R] flag is set, it will override these defaults. This can be useful if you wish to compare based on combinations not currently supported in \f[C]sync\f[R], such as comparing all three of \f[C]size\f[R] AND \f[C]modtime\f[R] AND \f[C]checksum\f[R] simultaneously (or just \f[C]modtime\f[R] AND \f[C]checksum\f[R]). .PP \f[C]--compare\f[R] takes a comma-separated list, with the currently supported values being \f[C]size\f[R], \f[C]modtime\f[R], and \f[C]checksum\f[R]. For example, if you want to compare size and checksum, but not modtime, you would do: .IP .nf \f[C] --compare size,checksum \f[R] .fi .PP Or if you want to compare all three: .IP .nf \f[C] --compare size,modtime,checksum \f[R] .fi .PP \f[C]--compare\f[R] overrides any conflicting flags. For example, if you set the conflicting flags \f[C]--compare checksum --size-only\f[R], \f[C]--size-only\f[R] will be ignored, and bisync will compare checksum and not size. To avoid confusion, it is recommended to use \f[I]either\f[R] \f[C]--compare\f[R] or the normal \f[C]sync\f[R] flags, but not both. .PP If \f[C]--compare\f[R] includes \f[C]checksum\f[R] and both remotes support checksums but have no hash types in common with each other, checksums will be considered \f[I]only\f[R] 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. .PP When comparing with \f[C]checksum\f[R] and/or \f[C]size\f[R] without \f[C]modtime\f[R], bisync cannot determine whether a file is \f[C]newer\f[R] or \f[C]older\f[R] -- only whether it is \f[C]changed\f[R] or \f[C]unchanged\f[R]. (If it is \f[C]changed\f[R] on both sides, bisync still does the standard equality-check to avoid declaring a sync conflict unless it absolutely has to.) .PP It is recommended to do a \f[C]--resync\f[R] when changing \f[C]--compare\f[R] 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.) .SS --ignore-listing-checksum .PP When \f[C]--checksum\f[R] or \f[C]--compare checksum\f[R] 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. \f[C]--ignore-listing-checksum\f[R] 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: .IP \[bu] 2 As of \f[C]v1.66\f[R], \f[C]--ignore-listing-checksum\f[R] is now automatically set when neither \f[C]--checksum\f[R] nor \f[C]--compare checksum\f[R] are in use (as the checksums would not be used for anything.) .IP \[bu] 2 \f[C]--ignore-listing-checksum\f[R] is NOT the same as \f[C]--ignore-checksum\f[R] (https://rclone.org/docs/#ignore-checksum), and you may wish to use one or the other, or both. In a nutshell: \f[C]--ignore-listing-checksum\f[R] controls whether checksums are considered when scanning for diffs, while \f[C]--ignore-checksum\f[R] controls whether checksums are considered during the copy/sync operations that follow, if there ARE diffs. .IP \[bu] 2 Unless \f[C]--ignore-listing-checksum\f[R] is passed, bisync currently computes hashes for one path \f[I]even when there\[aq]s no common hash with the other path\f[R] (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 \f[C]--checksum\f[R] or \f[C]--compare checksum\f[R] is set), even if they can\[aq]t be used to compare against the opposite side. .IP \[bu] 2 If you wish to ignore listing checksums \f[I]only\f[R] on remotes where they are slow to compute, consider using \f[C]--no-slow-hash\f[R] (or \f[C]--slow-hash-sync-only\f[R]) instead of \f[C]--ignore-listing-checksum\f[R]. .IP \[bu] 2 If \f[C]--ignore-listing-checksum\f[R] is used simultaneously with \f[C]--compare checksum\f[R] (or \f[C]--checksum\f[R]), 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.) .SS --no-slow-hash .PP On some remotes (notably \f[C]local\f[R]), 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 \f[C]drive\f[R]), they add practically no time at all. The \f[C]--no-slow-hash\f[R] flag will automatically skip checksums on remotes where they are slow, while still comparing them on others (assuming \f[C]--compare\f[R] includes \f[C]checksum\f[R].) 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. .SS --slow-hash-sync-only .PP Same as \f[C]--no-slow-hash\f[R], 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 \f[C]--resync\f[R]. 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\[aq]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 \f[C]modtime\f[R] or \f[C]size\f[R] change was detected. Keep in mind that this speed savings comes with a safety trade-off: if a file\[aq]s content were to change without a change to its \f[C]modtime\f[R] or \f[C]size\f[R], bisync would not detect it, and it would not be synced. .PP \f[C]--slow-hash-sync-only\f[R] is only useful if both remotes share a common hash type (if they don\[aq]t, bisync will automatically fall back to \f[C]--no-slow-hash\f[R].) Both \f[C]--no-slow-hash\f[R] and \f[C]--slow-hash-sync-only\f[R] have no effect without \f[C]--compare checksum\f[R] (or \f[C]--checksum\f[R]). .SS --download-hash .PP If \f[C]--download-hash\f[R] 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\[aq]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 \f[C]crypt\f[R] remote.) An additional advantage over methods like \f[C]cryptcheck\f[R] (https://rclone.org/commands/rclone_cryptcheck/) is that the original file is not required for comparison (for example, \f[C]--download-hash\f[R] can be used to bisync two different crypt remotes with different passwords.) .PP When \f[C]--download-hash\f[R] 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 \f[C]--no-slow-hash\f[R]. \f[C]--download-hash\f[R] is not suitable for Google Docs 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 \f[C]--download-hash\f[R] for files with a size less than 0. .PP See also: \f[C]Hasher\f[R] (https://rclone.org/hasher/) backend, \f[C]cryptcheck\f[R] (https://rclone.org/commands/rclone_cryptcheck/) command, \f[C]rclone check --download\f[R] (https://rclone.org/commands/rclone_check/) option, \f[C]md5sum\f[R] (https://rclone.org/commands/rclone_md5sum/) command .SS --max-delete .PP As a safety check, if greater than the \f[C]--max-delete\f[R] 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 \f[C]--max-delete\f[R] is \f[C]50%\f[R]. 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. \f[C]--max-delete 75\f[R] (allows up to 75% deletion), or use \f[C]--force\f[R] to bypass the check. .PP Also see the all files changed check. .SS --filters-file .PP By using rclone filter features you can exclude file types or directory sub-trees from the sync. See the bisync filters section and generic --filter-from (https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file) documentation. An example filters file contains filters for non-allowed files for syncing with Dropbox. .PP If you make changes to your filters file then bisync requires a run with \f[C]--resync\f[R]. 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. .PP To block this from happening, bisync calculates an MD5 hash of the filters file and stores the hash in a \f[C].md5\f[R] file in the same place as your filters file. On the next run with \f[C]--filters-file\f[R] set, bisync re-calculates the MD5 hash of the current filters file and compares it to the hash stored in the \f[C].md5\f[R] file. If they don\[aq]t match, the run aborts with a critical error and thus forces you to do a \f[C]--resync\f[R], likely avoiding a disaster. .SS --conflict-resolve CHOICE .PP In bisync, a \[dq]conflict\[dq] is a file that is \f[I]new\f[R] or \f[I]changed\f[R] on \f[I]both sides\f[R] (relative to the prior run) AND is \f[I]not currently identical\f[R] on both sides. \f[C]--conflict-resolve\f[R] controls how bisync handles such a scenario. The currently supported options are: .IP \[bu] 2 \f[C]none\f[R] - (the default) - do not attempt to pick a winner, keep and rename both files according to \f[C]--conflict-loser\f[R] and \f[C]--conflict-suffix\f[R] settings. For example, with the default settings, \f[C]file.txt\f[R] on Path1 is renamed \f[C]file.txt.conflict1\f[R] and \f[C]file.txt\f[R] on Path2 is renamed \f[C]file.txt.conflict2\f[R]. Both are copied to the opposite path during the run, so both sides end up with a copy of both files. (As \f[C]none\f[R] is the default, it is not necessary to specify \f[C]--conflict-resolve none\f[R] -- you can just omit the flag.) .IP \[bu] 2 \f[C]newer\f[R] - the newer file (by \f[C]modtime\f[R]) is considered the winner and is copied without renaming. The older file (the \[dq]loser\[dq]) is handled according to \f[C]--conflict-loser\f[R] and \f[C]--conflict-suffix\f[R] settings (either renamed or deleted.) For example, if \f[C]file.txt\f[R] on Path1 is newer than \f[C]file.txt\f[R] on Path2, the result on both sides (with other default settings) will be \f[C]file.txt\f[R] (winner from Path1) and \f[C]file.txt.conflict1\f[R] (loser from Path2). .IP \[bu] 2 \f[C]older\f[R] - same as \f[C]newer\f[R], except the older file is considered the winner, and the newer file is considered the loser. .IP \[bu] 2 \f[C]larger\f[R] - the larger file (by \f[C]size\f[R]) is considered the winner (regardless of \f[C]modtime\f[R], if any). .IP \[bu] 2 \f[C]smaller\f[R] - the smaller file (by \f[C]size\f[R]) is considered the winner (regardless of \f[C]modtime\f[R], if any). .IP \[bu] 2 \f[C]path1\f[R] - the version from Path1 is unconditionally considered the winner (regardless of \f[C]modtime\f[R] and \f[C]size\f[R], if any). This can be useful if one side is usually more trusted or up-to-date than the other. .IP \[bu] 2 \f[C]path2\f[R] - same as \f[C]path1\f[R], except the path2 version is considered the winner. .PP 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 \f[C]none\f[R]. (For example, if \f[C]--conflict-resolve newer\f[R] is set, but one of the paths uses a remote that doesn\[aq]t support \f[C]modtime\f[R].) - If a winner can\[aq]t be determined because the chosen method\[aq]s attribute is missing or equal, it will be ignored and fall back to \f[C]none\f[R]. (For example, if \f[C]--conflict-resolve newer\f[R] is set, but the Path1 and Path2 modtimes are identical, even if the sizes may differ.) - If the file\[aq]s content is currently identical on both sides, it is not considered a \[dq]conflict\[dq], 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 \f[C]--resync\f[R], as there is no \[dq]prior run\[dq] to speak of (but see \f[C]--resync-mode\f[R] for similar options.) .SS --conflict-loser CHOICE .PP \f[C]--conflict-loser\f[R] determines what happens to the \[dq]loser\[dq] of a sync conflict (when \f[C]--conflict-resolve\f[R] determines a winner) or to both files (when there is no winner.) The currently supported options are: .IP \[bu] 2 \f[C]num\f[R] - (the default) - auto-number the conflicts by automatically appending the next available number to the \f[C]--conflict-suffix\f[R], in chronological order. For example, with the default settings, the first conflict for \f[C]file.txt\f[R] will be renamed \f[C]file.txt.conflict1\f[R]. If \f[C]file.txt.conflict1\f[R] already exists, \f[C]file.txt.conflict2\f[R] will be used instead (etc., up to a maximum of 9223372036854775807 conflicts.) .IP \[bu] 2 \f[C]pathname\f[R] - rename the conflicts according to which side they came from, which was the default behavior prior to \f[C]v1.66\f[R]. For example, with \f[C]--conflict-suffix path\f[R], \f[C]file.txt\f[R] from Path1 will be renamed \f[C]file.txt.path1\f[R], and \f[C]file.txt\f[R] from Path2 will be renamed \f[C]file.txt.path2\f[R]. If two non-identical suffixes are provided (ex. \f[C]--conflict-suffix cloud,local\f[R]), the trailing digit is omitted. Importantly, note that with \f[C]pathname\f[R], there is no auto-numbering beyond \f[C]2\f[R], so if \f[C]file.txt.path2\f[R] somehow already exists, it will be overwritten. Using a dynamic date variable in your \f[C]--conflict-suffix\f[R] (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 \f[C]file.txt.path1\f[R] on both sides, and those edits were different, the result would be \f[C]file.txt.path1.path1\f[R] and \f[C]file.txt.path1.path2\f[R] (in addition to \f[C]file.txt.path2\f[R].) .IP \[bu] 2 \f[C]delete\f[R] - keep the winner only and delete the loser, instead of renaming it. If a winner cannot be determined (see \f[C]--conflict-resolve\f[R] for details on how this could happen), \f[C]delete\f[R] is ignored and the default \f[C]num\f[R] is used instead (i.e. both versions are kept and renamed, and neither is deleted.) \f[C]delete\f[R] is inherently the most destructive option, so use it only with care. .PP For all of the above options, note that if a winner cannot be determined (see \f[C]--conflict-resolve\f[R] for details on how this could happen), or if \f[C]--conflict-resolve\f[R] is not in use, \f[I]both\f[R] files will be renamed. .SS --conflict-suffix STRING[,STRING] .PP \f[C]--conflict-suffix\f[R] controls the suffix that is appended when bisync renames a \f[C]--conflict-loser\f[R] (default: \f[C]conflict\f[R]). \f[C]--conflict-suffix\f[R] 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, \f[C]--conflict-suffix dropboxconflict,laptopconflict\f[R]) .PP With \f[C]--conflict-loser num\f[R], a number is always appended to the suffix. With \f[C]--conflict-loser pathname\f[R], a number is appended only when one suffix is specified (or when two identical suffixes are specified.) i.e. with \f[C]--conflict-loser pathname\f[R], all of the following would produce exactly the same result: .IP .nf \f[C] --conflict-suffix path --conflict-suffix path,path --conflict-suffix path1,path2 \f[R] .fi .PP Suffixes may be as short as 1 character. By default, the suffix is appended after any other extensions (ex. \f[C]file.jpg.conflict1\f[R]), however, this can be changed with the \f[C]--suffix-keep-extension\f[R] (https://rclone.org/docs/#suffix-keep-extension) flag (i.e. to instead result in \f[C]file.conflict1.jpg\f[R]). .PP \f[C]--conflict-suffix\f[R] supports several \f[I]dynamic date variables\f[R] 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: .IP .nf \f[C] --conflict-suffix {DateOnly}-conflict // result: myfile.txt.2006-01-02-conflict1 \f[R] .fi .PP All of the formats described here (https://pkg.go.dev/time#pkg-constants) and here (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 \f[C]{MacFriendlyTime}\f[R] (or just \f[C]{mac}\f[R]) option is supported, which results in \f[C]2006-01-02 0304PM\f[R]. .PP Note that \f[C]--conflict-suffix\f[R] is entirely separate from rclone\[aq]s main \f[C]--sufix\f[R] (https://rclone.org/docs/#suffix-suffix) flag. This is intentional, as users may wish to use both flags simultaneously, if also using \f[C]--backup-dir\f[R]. .PP Finally, note that the default in bisync prior to \f[C]v1.66\f[R] was to rename conflicts with \f[C]..path1\f[R] and \f[C]..path2\f[R] (with two periods, and \f[C]path\f[R] instead of \f[C]conflict\f[R].) 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: .IP .nf \f[C] [--conflict-resolve none] --conflict-loser pathname --conflict-suffix .path \f[R] .fi .SS --check-sync .PP Enabled by default, the check-sync function checks that all of the same files exist in both the Path1 and Path2 history listings. This \f[I]check-sync\f[R] 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. .PP 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 \f[C]--check-sync=false\f[R] will disable it and may significantly reduce the sync run times for very large numbers of files. .PP The check may be run manually with \f[C]--check-sync=only\f[R]. It runs only the integrity check and terminates without actually syncing. .PP Note that currently, \f[C]--check-sync\f[R] \f[B]only checks listing snapshots and NOT the actual files on the remotes.\f[R] 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 \f[I]each other\f[R] at the end of a bisync run, it is \f[I]expected\f[R] 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. .PP For a robust integrity check of the current state of the remotes (as opposed to just their listing snapshots), consider using \f[C]check\f[R] (or \f[C]cryptcheck\f[R] (https://rclone.org/commands/rclone_cryptcheck/), if at least one path is a \f[C]crypt\f[R] remote) instead of \f[C]--check-sync\f[R], keeping in mind that differences are expected if files changed during or after your last bisync run. .PP For example, a possible sequence could look like this: .IP "1." 3 Normally scheduled bisync run: .IP .nf \f[C] 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 \f[R] .fi .IP "2." 3 Periodic independent integrity check (perhaps scheduled nightly or weekly): .IP .nf \f[C] rclone check -MvPc Path1 Path2 --filter-from /path/to/filters.txt \f[R] .fi .IP "3." 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: .IP .nf \f[C] rclone sync Path1 Path2 --filter-from /path/to/filters.txt --create-empty-src-dirs -MPc -v \f[R] .fi .PP (or switch Path1 and Path2 to make Path2 the source-of-truth) .PP Or, if neither side is totally up-to-date, you could run a \f[C]--resync\f[R] to bring them back into agreement (but remember that this could cause deleted files to re-appear.) .PP *Note also that \f[C]rclone check\f[R] 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 \f[C]rclone sync\f[R] command with \f[C]--dry-run\f[R] added. .PP See also: Concurrent modifications, \f[C]--resilient\f[R] .SS --resilient .PP \f[B]\f[BI]Caution: this is an experimental feature. Use at your own risk!\f[B]\f[R] .PP By default, most errors or interruptions will cause bisync to abort and require \f[C]--resync\f[R] 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\[aq]t actually necessary, like for certain less-serious errors that might resolve themselves on the next run. When \f[C]--resilient\f[R] is specified, bisync tries its best to recover and self-correct, and only requires \f[C]--resync\f[R] as a last resort when a human\[aq]s involvement is absolutely necessary. The intended use case is for running bisync as a background process (such as via scheduled cron). .PP When using \f[C]--resilient\f[R] 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 \f[C]--resync\f[R] first. Examples of such retryable errors include access test failures, missing listing files, and filter change detections. These safety features will still prevent the \f[I]current\f[R] run from proceeding -- the difference is that if conditions have improved by the time of the \f[I]next\f[R] run, that next run will be allowed to proceed. Certain more serious errors will still enforce a \f[C]--resync\f[R] lockout, even in \f[C]--resilient\f[R] mode, to prevent data loss. .PP Behavior of \f[C]--resilient\f[R] may change in a future version. (See also: \f[C]--recover\f[R], \f[C]--max-lock\f[R], Graceful Shutdown) .SS --recover .PP If \f[C]--recover\f[R] 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 \f[C]--resync\f[R]. Bisync is able to recover robustly by keeping one \[dq]backup\[dq] 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 \[dq]new or changed on both sides\[dq], but in most cases this is not a problem, as bisync will simply do its usual \[dq]equality check\[dq] and learn that no action needs to be taken on these files, since they are already identical on both sides. .PP 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\[aq]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, \f[C]--recover\f[R] 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\[aq]s \[dq]Graceful Shutdown\[dq] mode (triggered by sending \f[C]SIGINT\f[R] or \f[C]Ctrl+C\f[R]), when you have the choice, instead of forcing a sudden termination. .PP \f[C]--recover\f[R] and \f[C]--resilient\f[R] are similar, but distinct -- the main difference is that \f[C]--resilient\f[R] is about \f[I]retrying\f[R], while \f[C]--recover\f[R] is about \f[I]recovering\f[R]. Most users will probably want both. \f[C]--resilient\f[R] allows retrying when bisync has chosen to abort itself due to safety features such as failing \f[C]--check-access\f[R] or detecting a filter change. \f[C]--resilient\f[R] does not cover external interruptions such as a user shutting down their computer in the middle of a sync -- that is what \f[C]--recover\f[R] is for. .SS --max-lock .PP Bisync uses lock files 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, \f[C]--max-lock\f[R] 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. \f[C]--max-lock\f[R] can be any duration \f[C]2m\f[R] or greater (or \f[C]0\f[R] to disable). If set, lock files older than this will be considered \[dq]expired\[dq], and future runs will be allowed to disregard them and proceed. (Note that the \f[C]--max-lock\f[R] duration must be set by the process that left the lock file -- not the later one interpreting it.) .PP If set, bisync will also \[dq]renew\[dq] these lock files every \f[C]--max-lock minus one minute\f[R] throughout a run, for extra safety. (For example, with \f[C]--max-lock 5m\f[R], 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 \f[I]expired\f[R] lock file you may find was left there by an interrupted run, not one that is still running and just taking awhile. .PP If \f[C]--max-lock\f[R] is \f[C]0\f[R] or not set, the default is that lock files will never expire, and will block future runs (of these same two bisync paths) indefinitely. .PP For maximum resilience from disruptions, consider setting a relatively short duration like \f[C]--max-lock 2m\f[R] along with \f[C]--resilient\f[R] and \f[C]--recover\f[R], and a relatively frequent cron schedule. The result will be a very robust \[dq]set-it-and-forget-it\[dq] bisync run that can automatically bounce back from almost any interruption it might encounter, without requiring the user to get involved and run a \f[C]--resync\f[R]. (See also: Graceful Shutdown mode) .SS --backup-dir1 and --backup-dir2 .PP As of \f[C]v1.66\f[R], \f[C]--backup-dir\f[R] (https://rclone.org/docs/#backup-dir-dir) is supported in bisync. Because \f[C]--backup-dir\f[R] must be a non-overlapping path on the same remote, Bisync has introduced new \f[C]--backup-dir1\f[R] and \f[C]--backup-dir2\f[R] flags to support separate backup-dirs for \f[C]Path1\f[R] and \f[C]Path2\f[R] (bisyncing between different remotes with \f[C]--backup-dir\f[R] would not otherwise be possible.) \f[C]--backup-dir1\f[R] and \f[C]--backup-dir2\f[R] can use different remotes from each other, but \f[C]--backup-dir1\f[R] must use the same remote as \f[C]Path1\f[R], and \f[C]--backup-dir2\f[R] must use the same remote as \f[C]Path2\f[R]. Each backup directory must not overlap its respective bisync Path without being excluded by a filter rule. .PP The standard \f[C]--backup-dir\f[R] 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 \f[C]--backup-dir1\f[R] and \f[C]--backup-dir2\f[R] are set, they will override \f[C]--backup-dir\f[R]. .PP Example: .IP .nf \f[C] 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 \f[R] .fi .PP In this example, if the user deletes a file in \f[C]/Users/someuser/some/local/path/Bisync\f[R], bisync will propagate the delete to the other side by moving the corresponding file from \f[C]gdrive:Bisync\f[R] to \f[C]gdrive:BackupDir\f[R]. If the user deletes a file from \f[C]gdrive:Bisync\f[R], bisync moves it from \f[C]/Users/someuser/some/local/path/Bisync\f[R] to \f[C]/Users/someuser/some/local/path/BackupDir\f[R]. .PP In the event of a rename due to a sync conflict, the rename is not considered a delete, unless a previous conflict with the same name already exists and would get overwritten. .PP See also: \f[C]--suffix\f[R] (https://rclone.org/docs/#suffix-suffix), \f[C]--suffix-keep-extension\f[R] (https://rclone.org/docs/#suffix-keep-extension) .SS Operation .SS Runtime flow details .PP bisync retains the listings of the \f[C]Path1\f[R] and \f[C]Path2\f[R] filesystems from the prior run. On each successive run it will: .IP \[bu] 2 list files on \f[C]path1\f[R] and \f[C]path2\f[R], and check for changes on each side. Changes include \f[C]New\f[R], \f[C]Newer\f[R], \f[C]Older\f[R], and \f[C]Deleted\f[R] files. .IP \[bu] 2 Propagate changes on \f[C]path1\f[R] to \f[C]path2\f[R], and vice-versa. .SS Safety measures .IP \[bu] 2 Lock file prevents multiple simultaneous runs when taking a while. This can be particularly useful if bisync is run by cron scheduler. .IP \[bu] 2 Handle change conflicts non-destructively by creating \f[C].conflict1\f[R], \f[C].conflict2\f[R], etc. file versions, according to \f[C]--conflict-resolve\f[R], \f[C]--conflict-loser\f[R], and \f[C]--conflict-suffix\f[R] settings. .IP \[bu] 2 File system access health check using \f[C]RCLONE_TEST\f[R] files (see the \f[C]--check-access\f[R] flag). .IP \[bu] 2 Abort on excessive deletes - protects against a failed listing being interpreted as all the files were deleted. See the \f[C]--max-delete\f[R] and \f[C]--force\f[R] flags. .IP \[bu] 2 If something evil happens, bisync goes into a safe state to block damage by later runs. (See Error Handling) .SS Normal sync checks .PP .TS tab(@); lw(8.4n) lw(28.4n) lw(15.7n) lw(17.5n). T{ Type T}@T{ Description T}@T{ Result T}@T{ Implementation T} _ T{ Path2 new T}@T{ File is new on Path2, does not exist on Path1 T}@T{ Path2 version survives T}@T{ \f[C]rclone copy\f[R] Path2 to Path1 T} T{ Path2 newer T}@T{ File is newer on Path2, unchanged on Path1 T}@T{ Path2 version survives T}@T{ \f[C]rclone copy\f[R] Path2 to Path1 T} T{ Path2 deleted T}@T{ File is deleted on Path2, unchanged on Path1 T}@T{ File is deleted T}@T{ \f[C]rclone delete\f[R] Path1 T} T{ Path1 new T}@T{ File is new on Path1, does not exist on Path2 T}@T{ Path1 version survives T}@T{ \f[C]rclone copy\f[R] Path1 to Path2 T} T{ Path1 newer T}@T{ File is newer on Path1, unchanged on Path2 T}@T{ Path1 version survives T}@T{ \f[C]rclone copy\f[R] Path1 to Path2 T} T{ Path1 older T}@T{ File is older on Path1, unchanged on Path2 T}@T{ \f[I]Path1 version survives\f[R] T}@T{ \f[C]rclone copy\f[R] Path1 to Path2 T} T{ Path2 older T}@T{ File is older on Path2, unchanged on Path1 T}@T{ \f[I]Path2 version survives\f[R] T}@T{ \f[C]rclone copy\f[R] Path2 to Path1 T} T{ Path1 deleted T}@T{ File no longer exists on Path1 T}@T{ File is deleted T}@T{ \f[C]rclone delete\f[R] Path2 T} .TE .SS Unusual sync checks .PP .TS tab(@); lw(17.2n) lw(21.0n) lw(19.4n) lw(12.4n). T{ Type T}@T{ Description T}@T{ Result T}@T{ Implementation T} _ T{ Path1 new/changed AND Path2 new/changed AND Path1 == Path2 T}@T{ File is new/changed on Path1 AND new/changed on Path2 AND Path1 version is currently identical to Path2 T}@T{ No change T}@T{ None T} T{ Path1 new AND Path2 new T}@T{ File is new on Path1 AND new on Path2 (and Path1 version is NOT identical to Path2) T}@T{ Conflicts handled according to \f[C]--conflict-resolve\f[R] & \f[C]--conflict-loser\f[R] settings T}@T{ default: \f[C]rclone copy\f[R] renamed \f[C]Path2.conflict2\f[R] file to Path1, \f[C]rclone copy\f[R] renamed \f[C]Path1.conflict1\f[R] file to Path2 T} T{ Path2 newer AND Path1 changed T}@T{ File is newer on Path2 AND also changed (newer/older/size) on Path1 (and Path1 version is NOT identical to Path2) T}@T{ Conflicts handled according to \f[C]--conflict-resolve\f[R] & \f[C]--conflict-loser\f[R] settings T}@T{ default: \f[C]rclone copy\f[R] renamed \f[C]Path2.conflict2\f[R] file to Path1, \f[C]rclone copy\f[R] renamed \f[C]Path1.conflict1\f[R] file to Path2 T} T{ Path2 newer AND Path1 deleted T}@T{ File is newer on Path2 AND also deleted on Path1 T}@T{ Path2 version survives T}@T{ \f[C]rclone copy\f[R] Path2 to Path1 T} T{ Path2 deleted AND Path1 changed T}@T{ File is deleted on Path2 AND changed (newer/older/size) on Path1 T}@T{ Path1 version survives T}@T{ \f[C]rclone copy\f[R] Path1 to Path2 T} T{ Path1 deleted AND Path2 changed T}@T{ File is deleted on Path1 AND changed (newer/older/size) on Path2 T}@T{ Path2 version survives T}@T{ \f[C]rclone copy\f[R] Path2 to Path1 T} .TE .PP As of \f[C]rclone v1.64\f[R], bisync is now better at detecting \f[I]false positive\f[R] 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 \f[I]identical\f[R] (using the same underlying function as \f[C]check\f[R].) 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 \f[C]--resync\f[R] is no longer required, so long as the same change has been made on both sides. .SS All files changed check .PP If \f[I]all\f[R] prior existing files on either of the filesystems have changed (e.g. timestamps have changed due to changing the system\[aq]s timezone) then bisync will abort without making any changes. Any new files are not considered for this check. You could use \f[C]--force\f[R] to force the sync (whichever side has the changed timestamp files wins). Alternately, a \f[C]--resync\f[R] may be used (Path1 versions will be pushed to Path2). Consider the situation carefully and perhaps use \f[C]--dry-run\f[R] before you commit to the changes. .SS Modification times .PP 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 \f[I]not\f[R] 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 \f[C]--compare\f[R] for details. .SS Error handling .PP 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 \f[C]--resync\f[R] again. .PP It is recommended to use \f[C]--resync --dry-run --verbose\f[R] initially and \f[I]carefully\f[R] review what changes will be made before running the \f[C]--resync\f[R] without \f[C]--dry-run\f[R]. .PP Most of these events come up due to an error status from an internal call. On such a critical error the \f[C]{...}.path1.lst\f[R] and \f[C]{...}.path2.lst\f[R] listing files are renamed to extension \f[C].lst-err\f[R], which blocks any future bisync runs (since the normal \f[C].lst\f[R] files are not found). Bisync keeps them under \f[C]bisync\f[R] subdirectory of the rclone cache directory, typically at \f[C]${HOME}/.cache/rclone/bisync/\f[R] on Linux. .PP Some errors are considered temporary and re-running the bisync is not blocked. The \f[I]critical return\f[R] blocks further bisync runs. .PP See also: \f[C]--resilient\f[R], \f[C]--recover\f[R], \f[C]--max-lock\f[R], Graceful Shutdown .SS Lock file .PP When bisync is running, a lock file is created in the bisync working directory, typically at \f[C]\[ti]/.cache/rclone/bisync/PATH1..PATH2.lck\f[R] on Linux. If bisync should crash or hang, the lock file will remain in place and block any further runs of bisync \f[I]for the same paths\f[R]. Delete the lock file as part of debugging the situation. The lock file effectively blocks follow-on (e.g., scheduled by \f[I]cron\f[R]) runs when the prior invocation is taking a long time. The lock file contains \f[I]PID\f[R] 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 \f[C]--max-lock\f[R] flag. .PP \f[B]Note\f[R] that while concurrent bisync runs are allowed, \f[I]be very cautious\f[R] that there is no overlap in the trees being synched between concurrent runs, lest there be replicated files, deleted files and general mayhem. .SS Exit codes .PP \f[C]rclone bisync\f[R] returns the following codes to calling program: - \f[C]0\f[R] on a successful run, - \f[C]1\f[R] for a non-critical failing run (a rerun may be successful), - \f[C]2\f[R] on syntax or usage error, - \f[C]7\f[R] for a critically aborted run (requires a \f[C]--resync\f[R] to recover). .PP See also the section about exit codes (https://rclone.org/docs/#exit-code) in main docs. .SS Graceful Shutdown .PP Bisync has a \[dq]Graceful Shutdown\[dq] mode which is activated by sending \f[C]SIGINT\f[R] or pressing \f[C]Ctrl+C\f[R] 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 \f[C]-vP\f[R] flags you will see constant status updates and a final confirmation of whether or not the graceful shutdown was successful. .PP At any point during the \[dq]Graceful Shutdown\[dq] sequence, a second \f[C]SIGINT\f[R] or \f[C]Ctrl+C\f[R] 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 \f[C]--recover\f[R] mode, otherwise you will need to do a \f[C]--resync\f[R]. .PP If you plan to use Graceful Shutdown mode, it is recommended to use \f[C]--resilient\f[R] and \f[C]--recover\f[R], and it is important to NOT use \f[C]--inplace\f[R] (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 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 \f[C]--max-lock\f[R].) .SS Limitations .SS Supported backends .PP Bisync is considered \f[I]BETA\f[R] and has been tested with the following backends: - Local filesystem - Google Drive - Dropbox - OneDrive - S3 - SFTP - Yandex Disk - Crypt .PP It has not been fully tested with other services yet. If it works, or sorta works, please let us know and we\[aq]ll update the list. Run the test suite to check for proper operation as described below. .PP The first release of \f[C]rclone bisync\f[R] required both underlying backends to support modification times, and refused to run otherwise. This limitation has been lifted as of \f[C]v1.66\f[R], as bisync now supports comparing checksum and/or size instead of (or in addition to) modtime. See \f[C]--compare\f[R] for details. .SS Concurrent modifications .PP When using \f[B]Local, FTP or SFTP\f[R] remotes with \f[C]--inplace\f[R] (https://rclone.org/docs/#inplace), rclone does not create \f[I]temporary\f[R] 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 \f[I]omit\f[R] \f[C]--inplace\f[R]. .PP Files that \f[B]change during\f[R] a bisync run may result in data loss. Prior to \f[C]rclone v1.66\f[R], this was commonly seen in highly dynamic environments, where the filesystem was getting hammered by running processes during the sync. As of \f[C]rclone v1.66\f[R], bisync was redesigned to use a \[dq]snapshot\[dq] 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\[aq]s being read/written by bisync (same as would happen in \f[C]rclone sync\f[R].) (See also: \f[C]--ignore-checksum\f[R] (https://rclone.org/docs/#ignore-checksum), \f[C]--local-no-check-updated\f[R] (https://rclone.org/local/#local-no-check-updated)) .SS Empty directories .PP By default, new/deleted empty directories on one path are \f[I]not\f[R] propagated to the other side. This is because bisync (and rclone) natively works on files, not directories. However, this can be changed with the \f[C]--create-empty-src-dirs\f[R] flag, which works in much the same way as in \f[C]sync\f[R] (https://rclone.org/commands/rclone_sync/) and \f[C]copy\f[R] (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: * \f[C]--create-empty-src-dirs\f[R] is not compatible with \f[C]--remove-empty-dirs\f[R]. Use only one or the other (or neither). * It is not recommended to switch back and forth between \f[C]--create-empty-src-dirs\f[R] and the default (no \f[C]--create-empty-src-dirs\f[R]) without running \f[C]--resync\f[R]. This is because it may appear as though all directories (not just the empty ones) were created/deleted, when actually you\[aq]ve just toggled between making them visible/invisible to bisync. It looks scarier than it is, but it\[aq]s still probably best to stick to one or the other, and use \f[C]--resync\f[R] when you need to switch. .SS Renamed directories .PP 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. .PP A recommended solution is to use \f[C]--track-renames\f[R] (https://rclone.org/docs/#track-renames), which is now supported in bisync as of \f[C]rclone v1.66\f[R]. Note that \f[C]--track-renames\f[R] is not available during \f[C]--resync\f[R], as \f[C]--resync\f[R] does not delete anything (\f[C]--track-renames\f[R] only supports \f[C]sync\f[R], not \f[C]copy\f[R].) .PP Otherwise, the most effective and efficient method of renaming a directory is to rename it to the same name on both sides. (As of \f[C]rclone v1.64\f[R], a \f[C]--resync\f[R] is no longer required after doing so, as bisync will automatically detect that Path1 and Path2 are in agreement.) .SS \f[C]--fast-list\f[R] used by default .PP Unlike most other rclone commands, bisync uses \f[C]--fast-list\f[R] (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 \f[I]without\f[R] \f[C]--fast-list\f[R], 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 \f[C]--fast-list\f[R] is to add \f[C]--disable ListR\f[R] to all bisync commands. The default behavior may change in a future version. .SS Case (and unicode) sensitivity .PP As of \f[C]v1.66\f[R], 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 \f[C]rclone sync\f[R]. See the following options (all of which are supported by bisync) to control this behavior more granularly: - \f[C]--fix-case\f[R] (https://rclone.org/docs/#fix-case) - \f[C]--ignore-case-sync\f[R] (https://rclone.org/docs/#ignore-case-sync) - \f[C]--no-unicode-normalization\f[R] (https://rclone.org/docs/#no-unicode-normalization) - \f[C]--local-unicode-normalization\f[R] (https://rclone.org/local/#local-unicode-normalization) and \f[C]--local-case-sensitive\f[R] (https://rclone.org/local/#local-case-sensitive) (caution: these are normally not what you want.) .PP Note that in the (probably rare) event that \f[C]--fix-case\f[R] 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 \f[C]--fix-case\f[R] (Path2 will be renamed to match it). .SS Windows support .PP Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on Windows GitHub runners. .PP Drive letters are allowed, including drive letters mapped to network drives (\f[C]rclone bisync J:\[rs]localsync GDrive:\f[R]). If a drive letter is omitted, the shell current drive is the default. Drive letters are a single character follows by \f[C]:\f[R], so cloud names must be more than one character long. .PP Absolute paths (with or without a drive letter), and relative paths (with or without a drive letter) are supported. .PP Working directory is created at \f[C]C:\[rs]Users\[rs]MyLogin\[rs]AppData\[rs]Local\[rs]rclone\[rs]bisync\f[R]. .PP Note that bisync output may show a mix of forward \f[C]/\f[R] and back \f[C]\[rs]\f[R] slashes. .PP Be careful of case independent directory and file naming on Windows vs. case dependent Linux .SS Filtering .PP See filtering documentation (https://rclone.org/filtering/) for how filter rules are written and interpreted. .PP Bisync\[aq]s \f[C]--filters-file\f[R] flag slightly extends the rclone\[aq]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 \f[I]only one\f[R] \f[C]--filters-file\f[R]. The \f[C]--include*\f[R], \f[C]--exclude*\f[R], and \f[C]--filter\f[R] flags are also supported. .SS How to filter directories .PP Filtering portions of the directory tree is a critical feature for syncing. .PP 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 \f[C]C:\[rs]Users\[rs]MyLogin\[rs]AppData\[rs]\f[R] tree. - Directory trees containing files that are large, less important, or are getting thrashed continuously by ongoing processes. .PP 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 below. .SS Filters file writing guidelines .IP "1." 3 Begin with excluding directory trees: .RS 4 .IP \[bu] 2 e.g. \[ga]- /AppData/\[ga] .IP \[bu] 2 \f[C]**\f[R] on the end is not necessary. Once a given directory level is excluded then everything beneath it won\[aq]t be looked at by rclone. .IP \[bu] 2 Exclude such directories that are unneeded, are big, dynamically thrashed, or where there may be access permission issues. .IP \[bu] 2 Excluding such dirs first will make rclone operations (much) faster. .IP \[bu] 2 Specific files may also be excluded, as with the Dropbox exclusions example below. .RE .IP "2." 3 Decide if it\[aq]s easier (or cleaner) to: .RS 4 .IP \[bu] 2 Include select directories and therefore \f[I]exclude everything else\f[R] -- or -- .IP \[bu] 2 Exclude select directories and therefore \f[I]include everything else\f[R] .RE .IP "3." 3 Include select directories: .RS 4 .IP \[bu] 2 Add lines like: \[ga]+ /Documents/PersonalFiles/**\[ga] to select which directories to include in the sync. .IP \[bu] 2 \f[C]**\f[R] on the end specifies to include the full depth of the specified tree. .IP \[bu] 2 With Include-style filters, files at the Path1/Path2 root are not included. They may be included with \[ga]+ /*\[ga]. .IP \[bu] 2 Place RCLONE_TEST files within these included directory trees. They will only be looked for in these directory trees. .IP \[bu] 2 Finish by excluding everything else by adding \[ga]- **\[ga] at the end of the filters file. .IP \[bu] 2 Disregard step 4. .RE .IP "4." 3 Exclude select directories: .RS 4 .IP \[bu] 2 Add more lines like in step 1. For example: \f[C]-/Desktop/tempfiles/\f[R], or \[ga]- /testdir/\f[C]. Again, a\f[R]**\[ga] on the end is not necessary. .IP \[bu] 2 Do \f[I]not\f[R] add a \[ga]- **\[ga] in the file. Without this line, everything will be included that has not been explicitly excluded. .IP \[bu] 2 Disregard step 3. .RE .PP A few rules for the syntax of a filter file expanding on filtering documentation (https://rclone.org/filtering/): .IP \[bu] 2 Lines may start with spaces and tabs - rclone strips leading whitespace. .IP \[bu] 2 If the first non-whitespace character is a \f[C]#\f[R] then the line is a comment and will be ignored. .IP \[bu] 2 Blank lines are ignored. .IP \[bu] 2 The first non-whitespace character on a filter line must be a \f[C]+\f[R] or \f[C]-\f[R]. .IP \[bu] 2 Exactly 1 space is allowed between the \f[C]+/-\f[R] and the path term. .IP \[bu] 2 Only forward slashes (\f[C]/\f[R]) are used in path terms, even on Windows. .IP \[bu] 2 The rest of the line is taken as the path term. Trailing whitespace is taken literally, and probably is an error. .SS Example include-style filters for Windows user directories .PP This Windows \f[I]include-style\f[R] example is based on the sync root (Path1) set to \f[C]C:\[rs]Users\[rs]MyLogin\f[R]. The strategy is to select specific directories to be synched with a network drive (Path2). .IP \[bu] 2 \[ga]- /AppData/\[ga] excludes an entire tree of Windows stored stuff that need not be synched. In my case, AppData has >11 GB of stuff I don\[aq]t care about, and there are some subdirectories beneath AppData that are not accessible to my user login, resulting in bisync critical aborts. .IP \[bu] 2 Windows creates cache files starting with both upper and lowercase \f[C]NTUSER\f[R] at \f[C]C:\[rs]Users\[rs]MyLogin\f[R]. These files may be dynamic, locked, and are generally \f[I]don\[aq]t care\f[R]. .IP \[bu] 2 There are just a few directories with \f[I]my\f[R] data that I do want synched, in the form of \[ga]+ /\f[C]. By selecting only the directory trees I want to avoid the dozen plus directories that various apps make at\f[R]C:\[ga]. .IP \[bu] 2 Include files in the root of the sync point, \f[C]C:\[rs]Users\[rs]MyLogin\f[R], by adding the \[ga]+ /*\[ga] line. .IP \[bu] 2 This is an Include-style filters file, therefore it ends with \[ga]- **\[ga] which excludes everything not explicitly included. .IP .nf \f[C] - /AppData/ - NTUSER* - ntuser* + /Documents/Family/** + /Documents/Sketchup/** + /Documents/Microcapture_Photo/** + /Documents/Microcapture_Video/** + /Desktop/** + /Pictures/** + /* - ** \f[R] .fi .PP Note also that Windows implements several \[dq]library\[dq] links such as \f[C]C:\[rs]Users\[rs]MyLogin\[rs]My Documents\[rs]My Music\f[R] pointing to \f[C]C:\[rs]Users\[rs]MyLogin\[rs]Music\f[R]. rclone sees these as links, so you must add \f[C]--links\f[R] 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\[aq]t include the rclone \f[C]--links\f[R] flag, but then you get lots of \f[C]Can\[aq]t follow symlink\&...\f[R] noise from rclone about not following the links. This noise can be quashed by adding \f[C]--quiet\f[R] to the bisync command line. .SS Example exclude-style filters files for use with Dropbox .IP \[bu] 2 Dropbox disallows syncing the listed temporary and configuration/data files. The \[ga]- \[ga] filters exclude these files where ever they may occur in the sync tree. Consider adding similar exclusions for file types you don\[aq]t need to sync, such as core dump and software build files. .IP \[bu] 2 bisync testing creates \f[C]/testdir/\f[R] at the top level of the sync tree, and usually deletes the tree after the test. If a normal sync should run while the \f[C]/testdir/\f[R] tree exists the \f[C]--check-access\f[R] phase may fail due to unbalanced RCLONE_TEST files. The \[ga]- /testdir/\[ga] filter blocks this tree from being synched. You don\[aq]t need this exclusion if you are not doing bisync development testing. .IP \[bu] 2 Everything else beneath the Path1/Path2 root will be synched. .IP \[bu] 2 RCLONE_TEST files may be placed anywhere within the tree, including the root. .SS Example filters file for Dropbox .IP .nf \f[C] # 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\[aq]t sync some files so filter them away here. # See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing - .dropbox.attr - \[ti]*.tmp - \[ti]$* - .\[ti]* - desktop.ini - .dropbox # Used for bisync testing, so excluded from normal runs - /testdir/ # Other example filters #- /TiBU/ #- /Photos/ \f[R] .fi .SS How --check-access handles filters .PP At the start of a bisync run, listings are gathered for Path1 and Path2 while using the user\[aq]s \f[C]--filters-file\f[R]. During the check access phase, bisync scans these listings for \f[C]RCLONE_TEST\f[R] files. Any \f[C]RCLONE_TEST\f[R] files hidden by the \f[C]--filters-file\f[R] are \f[I]not\f[R] in the listings and thus not checked during the check access phase. .SS Troubleshooting .SS Reading bisync logs .PP Here are two normal runs. The first one has a newer file on the remote. The second has no deltas between local and remote. .IP .nf \f[C] 2021/05/16 00:24:38 INFO : Synching Path1 \[dq]/path/to/local/tree/\[dq] with Path2 \[dq]dropbox:/\[dq] 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 \[dq]/path/to/local/tree/\[dq] vs Path2 \[dq]dropbox:/\[dq] 2021/05/16 00:24:38 INFO : Bisync successful 2021/05/16 00:36:52 INFO : Synching Path1 \[dq]/path/to/local/tree/\[dq] with Path2 \[dq]dropbox:/\[dq] 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 \[dq]/path/to/local/tree/\[dq] vs Path2 \[dq]dropbox:/\[dq] 2021/05/16 00:36:52 INFO : Bisync successful \f[R] .fi .SS Dry run oddity .PP The \f[C]--dry-run\f[R] 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 \f[C]--dry-run\f[R] enabled those copies don\[aq]t happen, which leads to the attempted delete on Path2, blocked again by --dry-run: \f[C]... Not deleting as --dry-run\f[R]. .PP This whole confusing situation is an artifact of the \f[C]--dry-run\f[R] 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. .SS Retries .PP Rclone has built-in retries. If you run with \f[C]--verbose\f[R] you\[aq]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 \f[C]Bisync successful\f[R] and not \f[C]Bisync critical error\f[R] or \f[C]Bisync aborted\f[R] then the run was successful, and you can ignore the error messages. .PP The following run shows an intermittent fail. Lines \f[I]5\f[R] and _6- are low-level messages. Line \f[I]6\f[R] is a bubbled-up \f[I]warning\f[R] message, conveying the error. Rclone normally retries failing commands, so there may be numerous such messages in the log. .PP Since there are no final error/warning messages on line \f[I]7\f[R], rclone has recovered from failure after a retry, and the overall sync was successful. .IP .nf \f[C] 1: 2021/05/14 00:44:12 INFO : Synching Path1 \[dq]/path/to/local/tree\[dq] with Path2 \[dq]dropbox:\[dq] 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 \f[R] .fi .PP This log shows a \f[I]Critical failure\f[R] which requires a \f[C]--resync\f[R] to recover from. See the Runtime Error Handling section. .IP .nf \f[C] 2021/05/12 00:49:40 INFO : Google drive root \[aq]\[aq]: Waiting for checks to finish 2021/05/12 00:49:40 INFO : Google drive root \[aq]\[aq]: Waiting for transfers to finish 2021/05/12 00:49:40 INFO : Google drive root \[aq]\[aq]: 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. \f[R] .fi .SS Denied downloads of \[dq]infected\[dq] or \[dq]abusive\[dq] files .PP Google Drive has a filter for certain file types (\f[C].exe\f[R], \f[C].apk\f[R], et cetera) that by default cannot be copied from Google Drive to the local filesystem. If you are having problems, run with \f[C]--verbose\f[R] to see specifically which files are generating complaints. If the error is \f[C]This file has been identified as malware or spam and cannot be downloaded\f[R], consider using the flag --drive-acknowledge-abuse (https://rclone.org/drive/#drive-acknowledge-abuse). .SS Google Docs (and other files of unknown size) .PP As of \f[C]v1.66\f[R], 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 \f[C]rclone sync\f[R]. When bisyncing drive with non-drive backends, the drive -> non-drive direction is controlled by \f[C]--drive-export-formats\f[R] (https://rclone.org/drive/#drive-export-formats) (default \f[C]\[dq]docx,xlsx,pptx,svg\[dq]\f[R]) and the non-drive -> drive direction is controlled by \f[C]--drive-import-formats\f[R] (https://rclone.org/drive/#drive-import-formats) (default none.) .PP For example, with the default export/import formats, a Google Sheet on the drive side will be synced to an \f[C].xlsx\f[R] file on the non-drive side. In the reverse direction, \f[C].xlsx\f[R] files with filenames that match an existing Google Sheet will be synced to that Google Sheet, while \f[C].xlsx\f[R] files that do NOT match an existing Google Sheet will be copied to drive as normal \f[C].xlsx\f[R] files (without conversion to Sheets, although the Google Drive web browser UI may still give you the option to open it as one.) .PP If \f[C]--drive-import-formats\f[R] is set (it\[aq]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\[aq]s probably not what you want! .PP To bisync Google Docs as URL shortcut links (in a manner similar to \[dq]Drive for Desktop\[dq]), use: \f[C]--drive-export-formats url\f[R] (or alternatives (https://rclone.org/drive/#exportformats:~:text=available%20Google%20Documents.-,Extension,macOS,-Standard%20options).) .PP 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 \f[C].url\f[R] file on the non-drive side that does not match an existing Google Doc, bisyncing it will just result in copying the literal \f[C].url\f[R] 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. .PP 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 \f[C]--drive-import-formats\f[R].) .PP Lastly, take note that all Google Docs on the drive side have a size of \f[C]-1\f[R] and no checksum. Therefore, they cannot be reliably synced with the \f[C]--checksum\f[R] or \f[C]--size-only\f[R] flags. (To be exact: they will still get created/deleted, and bisync\[aq]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 \f[C]--checksum\f[R] or \f[C]--size-only\f[R]. .PP To ignore Google Docs entirely, use \f[C]--drive-skip-gdocs\f[R] (https://rclone.org/drive/#drive-skip-gdocs). .SS Usage examples .SS Cron .PP 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 \f[I]Task Scheduler\f[R], on Linux you can use \f[I]Cron\f[R] which is described below. .PP The 1st example runs a sync every 5 minutes between a local directory and an OwnCloud server, with output logged to a runlog file: .IP .nf \f[C] # 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 \f[R] .fi .PP See crontab syntax (https://www.man7.org/linux/man-pages/man1/crontab.1p.html#INPUT_FILES) for the details of crontab time interval expressions. .PP If you run \f[C]rclone bisync\f[R] 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 \f[C]>>\f[R]) and stderr (via \f[C]2>&1\f[R]) to a log file. .IP .nf \f[C] 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 \f[R] .fi .SS Sharing an encrypted folder tree between hosts .PP bisync can keep a local folder in sync with a cloud service, but what if you have some highly sensitive files to be synched? .PP Usage of a cloud service is for exchanging both routine and sensitive personal files between one\[aq]s home network, one\[aq]s personal notebook when on the road, and with one\[aq]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\[aq]d to Dropbox, and then set up an bisync for this local crypt directory to a directory outside of the main sync tree. .SS Linux server setup .IP \[bu] 2 \f[C]/path/to/DBoxroot\f[R] is the root of my local sync tree. There are numerous subdirectories. .IP \[bu] 2 \f[C]/path/to/DBoxroot/crypt\f[R] is the root subdirectory for files that are encrypted. This local directory target is setup as an rclone crypt remote named \f[C]Dropcrypt:\f[R]. See rclone.conf snippet below. .IP \[bu] 2 \f[C]/path/to/my/unencrypted/files\f[R] is the root of my sensitive files - not encrypted, not within the tree synched to Dropbox. .IP \[bu] 2 To sync my local unencrypted files with the encrypted Dropbox versions I manually run \f[C]bisync /path/to/my/unencrypted/files DropCrypt:\f[R]. 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. .IP \[bu] 2 \f[C]bisync /path/to/DBoxroot Dropbox:\f[R] runs periodically via cron, keeping my full local sync tree in sync with Dropbox. .SS Windows notebook setup .IP \[bu] 2 The Dropbox client runs keeping the local tree \f[C]C:\[rs]Users\[rs]MyLogin\[rs]Dropbox\f[R] always in sync with Dropbox. I could have used \f[C]rclone bisync\f[R] instead. .IP \[bu] 2 A separate directory tree at \f[C]C:\[rs]Users\[rs]MyLogin\[rs]Documents\[rs]DropLocal\f[R] hosts the tree of unencrypted files/folders. .IP \[bu] 2 To sync my local unencrypted files with the encrypted Dropbox versions I manually run the following command: \f[C]rclone bisync C:\[rs]Users\[rs]MyLogin\[rs]Documents\[rs]DropLocal Dropcrypt:\f[R]. .IP \[bu] 2 The Dropbox client then syncs the changes with Dropbox. .SS rclone.conf snippet .IP .nf \f[C] [Dropbox] type = dropbox \&... [Dropcrypt] type = crypt remote = /path/to/DBoxroot/crypt # on the Linux server remote = C:\[rs]Users\[rs]MyLogin\[rs]Dropbox\[rs]crypt # on the Windows notebook filename_encryption = standard directory_name_encryption = true password = ... \&... \f[R] .fi .SS Testing .PP 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. .PP Bisync has a dedicated test framework implemented in the \f[C]bisync_test.go\f[R] file located in the rclone source tree. The test suite is based on the \f[C]go test\f[R] command. Series of tests are stored in subdirectories below the \f[C]cmd/bisync/testdata\f[R] directory. Individual tests can be invoked by their directory name, e.g. \f[C]go test . -case basic -remote local -remote2 gdrive: -v\f[R] .PP 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. .SS Test command syntax .IP .nf \f[C] 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 \[ga]test_\[ga] prefix and replace \[ga]_\[ga] by \[ga]-\[ga] in test name for convenience. If not \[ga]all\[ga], the name(s) should map to a directory under \[ga]./cmd/bisync/testdata\[ga]. Use \[ga]all\[ga] to run all tests (default: all) -remote PATH1 \[ga]local\[ga] or name of cloud service with \[ga]:\[ga] (default: local) -remote2 PATH2 \[ga]local\[ga] or name of cloud service with \[ga]:\[ga] (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 \[ga]-no-compare\[ga] and \[ga]-no-cleanup\[ga], 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 \f[R] .fi .PP Note: unlike rclone flags which must be prefixed by double dash (\f[C]--\f[R]), the test command flags can be equally prefixed by a single \f[C]-\f[R] or double dash. .SS Running tests .IP \[bu] 2 \f[C]go test . -case basic -remote local -remote2 local\f[R] runs the \f[C]test_basic\f[R] 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 \f[C].../workdir/test.log\f[R] file, which is finally compared to the golden copy. .IP \[bu] 2 The first argument after \f[C]go test\f[R] should be a relative name of the directory containing bisync source code. If you run tests right from there, the argument will be \f[C].\f[R] (current directory) as in most examples below. If you run bisync tests from the rclone source directory, the command should be \f[C]go test ./cmd/bisync ...\f[R]. .IP \[bu] 2 The test engine will mangle rclone output to ensure comparability with golden listings and logs. .IP \[bu] 2 Test scenarios are located in \f[C]./cmd/bisync/testdata\f[R]. The test \f[C]-case\f[R] argument should match the full name of a subdirectory under that directory. Every test subdirectory name on disk must start with \f[C]test_\f[R], this prefix can be omitted on command line for brevity. Also, underscores in the name can be replaced by dashes for convenience. .IP \[bu] 2 \f[C]go test . -remote local -remote2 local -case all\f[R] runs all tests. .IP \[bu] 2 Path1 and Path2 may either be the keyword \f[C]local\f[R] or may be names of configured cloud services. \f[C]go test . -remote gdrive: -remote2 dropbox: -case basic\f[R] will run the test between these two services, without transferring any files to the local filesystem. .IP \[bu] 2 Test run stdout and stderr console output may be directed to a file, e.g. \f[C]go test . -remote gdrive: -remote2 local -case all > runlog.txt 2>&1\f[R] .SS Test execution flow .IP "1." 3 The base setup in the \f[C]initial\f[R] 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). .IP "2." 3 The commands in the scenario.txt file are applied, with output directed to the \f[C]test.log\f[R] file in the test working directory. Typically, the first actual command in the \f[C]scenario.txt\f[R] file is to do a \f[C]--resync\f[R], which establishes the baseline \f[C]{...}.path1.lst\f[R] and \f[C]{...}.path2.lst\f[R] files in the test working directory (\f[C].../workdir/\f[R] relative to the temporary test directory). Various commands and listing snapshots are done within the test. .IP "3." 3 Finally, the contents of the test working directory are compared to the contents of the testcase\[aq]s golden directory. .SS Notes about testing .IP \[bu] 2 Test cases are in individual directories beneath \f[C]./cmd/bisync/testdata\f[R]. A command line reference to a test is understood to reference a directory beneath \f[C]testdata\f[R]. For example, \f[C]go test ./cmd/bisync -case dry-run -remote gdrive: -remote2 local\f[R] refers to the test case in \f[C]./cmd/bisync/testdata/test_dry_run\f[R]. .IP \[bu] 2 The test working directory is located at \f[C].../workdir\f[R] relative to a temporary test directory, usually under \f[C]/tmp\f[R] on Linux. .IP \[bu] 2 The local test sync tree is created at a temporary directory named like \f[C]bisync.XXX\f[R] under system temporary directory. .IP \[bu] 2 The remote test sync tree is located at a temporary directory under \f[C]<remote:>/bisync.XXX/\f[R]. .IP \[bu] 2 \f[C]path1\f[R] and/or \f[C]path2\f[R] subdirectories are created in a temporary directory under the respective local or cloud test remote. .IP \[bu] 2 By default, the Path1 and Path2 test dirs and workdir will be deleted after each test run. The \f[C]-no-cleanup\f[R] flag disables purging these directories when validating and debugging a given test. These directories will be flushed before running another test, independent of the \f[C]-no-cleanup\f[R] usage. .IP \[bu] 2 You will likely want to add \[ga]- /testdir/\f[C]to your normal bisync\f[R]--filters-file\f[C]so that normal syncs do not attempt to sync the test temporary directories, which may have\f[R]RCLONE_TEST\f[C]miscompares in some testcases which would otherwise trip the\f[R]--check-access\f[C]system. The\f[R]--check-access\f[C]mechanism is hard-coded to ignore\f[R]RCLONE_TEST\f[C]files beneath\f[R]bisync/testdata\[ga], so the test cases may reside on the synched tree even if there are check file mismatches in the test tree. .IP \[bu] 2 Some Dropbox tests can fail, notably printing the following message: \f[C]src and dst identical but can\[aq]t set mod time without deleting and re-uploading\f[R] This is expected and happens due to the way Dropbox handles modification times. You should use the \f[C]-refresh-times\f[R] test flag to make up for this. .IP \[bu] 2 If Dropbox tests hit request limit for you and print error message \f[C]too_many_requests/...: Too many requests or write operations.\f[R] then follow the Dropbox App ID instructions (https://rclone.org/dropbox/#get-your-own-dropbox-app-id). .SS Updating golden results .PP 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. .PP The \f[C]-golden\f[R] flag will store the \f[C]test.log\f[R] and \f[C]*.lst\f[R] 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. .PP 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 \f[C]go test ./cmd/bisync -remote local\f[R] 4. If some tests show log difference, recheck them individually, e.g.: \f[C]go test ./cmd/bisync -remote local -case basic\f[R] 5. If you are convinced with the difference, goldenize all tests at once: \f[C]go test ./cmd/bisync -remote local -golden\f[R] 6. Use word diff: \f[C]git diff --word-diff ./cmd/bisync/testdata/\f[R]. Please note that normal line-level diff is generally useless here. 7. Check the difference \f[I]carefully\f[R]! 8. Commit the change (\f[C]git commit\f[R]) \f[I]only\f[R] if you are sure. If unsure, save your code changes then wipe the log diffs from git: \f[C]git reset [--hard]\f[R]. .SS Structure of test scenarios .IP \[bu] 2 \f[C]<testname>/initial/\f[R] contains a tree of files that will be set as the initial condition on both Path1 and Path2 testdirs. .IP \[bu] 2 \f[C]<testname>/modfiles/\f[R] contains files that will be used to modify the Path1 and/or Path2 filesystems. .IP \[bu] 2 \f[C]<testname>/golden/\f[R] contains the expected content of the test working directory (\f[C]workdir\f[R]) at the completion of the testcase. .IP \[bu] 2 \f[C]<testname>/scenario.txt\f[R] 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 \f[C].../workdir/test.log\f[R] for comparison to the golden files. .SS Supported test commands .IP \[bu] 2 \f[C]test <some message>\f[R] Print the line to the console and to the \f[C]test.log\f[R]: \f[C]test sync is working correctly with options x, y, z\f[R] .IP \[bu] 2 \f[C]copy-listings <prefix>\f[R] Save a copy of all \f[C].lst\f[R] listings in the test working directory with the specified prefix: \f[C]save-listings exclude-pass-run\f[R] .IP \[bu] 2 \f[C]move-listings <prefix>\f[R] Similar to \f[C]copy-listings\f[R] but removes the source .IP \[bu] 2 \f[C]purge-children <dir>\f[R] 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. .IP \[bu] 2 \f[C]delete-file <file>\f[R] Delete a single file. .IP \[bu] 2 \f[C]delete-glob <dir> <pattern>\f[R] Delete a group of files located one level deep in the given directory with names matching a given glob pattern. .IP \[bu] 2 \f[C]touch-glob YYYY-MM-DD <dir> <pattern>\f[R] Change modification time on a group of files. .IP \[bu] 2 \f[C]touch-copy YYYY-MM-DD <source-file> <dest-dir>\f[R] Change file modification time then copy it to destination. .IP \[bu] 2 \f[C]copy-file <source-file> <dest-dir>\f[R] Copy a single file to given directory. .IP \[bu] 2 \f[C]copy-as <source-file> <dest-file>\f[R] Similar to above but destination must include both directory and the new file name at destination. .IP \[bu] 2 \f[C]copy-dir <src> <dst>\f[R] and \f[C]sync-dir <src> <dst>\f[R] Copy/sync a directory. Equivalent of \f[C]rclone copy\f[R] and \f[C]rclone sync\f[R]. .IP \[bu] 2 \f[C]list-dirs <dir>\f[R] Equivalent to \f[C]rclone lsf -R --dirs-only <dir>\f[R] .IP \[bu] 2 \f[C]bisync [options]\f[R] Runs bisync against \f[C]-remote\f[R] and \f[C]-remote2\f[R]. .SS Supported substitution terms .IP \[bu] 2 \f[C]{testdir/}\f[R] - the root dir of the testcase .IP \[bu] 2 \f[C]{datadir/}\f[R] - the \f[C]modfiles\f[R] dir under the testcase root .IP \[bu] 2 \f[C]{workdir/}\f[R] - the temporary test working directory .IP \[bu] 2 \f[C]{path1/}\f[R] - the root of the Path1 test directory tree .IP \[bu] 2 \f[C]{path2/}\f[R] - the root of the Path2 test directory tree .IP \[bu] 2 \f[C]{session}\f[R] - base name of the test listings .IP \[bu] 2 \f[C]{/}\f[R] - OS-specific path separator .IP \[bu] 2 \f[C]{spc}\f[R], \f[C]{tab}\f[R], \f[C]{eol}\f[R] - whitespace .IP \[bu] 2 \f[C]{chr:HH}\f[R] - raw byte with given hexadecimal code .PP Substitution results of the terms named like \f[C]{dir/}\f[R] will end with \f[C]/\f[R] (or backslash on Windows), so it is not necessary to include slash in the usage, for example \f[C]delete-file {path1/}file1.txt\f[R]. .SS Benchmarks .PP \f[I]This section is work in progress.\f[R] .PP Here are a few data points for scale, execution times, and memory usage. .PP The first set of data was taken between a local disk to Dropbox. The speedtest.net (https://speedtest.net) download speed was \[ti]170 Mbps, and upload speed was \[ti]10 Mbps. 500 files (\[ti]9.5 MB each) had been already synched. 50 files were added in a new directory, each \[ti]9.5 MB, \[ti]475 MB total. .PP .TS tab(@); lw(23.8n) lw(35.0n) lw(11.2n). T{ Change T}@T{ Operations and times T}@T{ Overall run time T} _ T{ 500 files synched (nothing to move) T}@T{ 1x listings for Path1 & Path2 T}@T{ 1.5 sec T} T{ 500 files synched with --check-access T}@T{ 1x listings for Path1 & Path2 T}@T{ 1.5 sec T} T{ 50 new files on remote T}@T{ Queued 50 copies down: 27 sec T}@T{ 29 sec T} T{ Moved local dir T}@T{ Queued 50 copies up: 410 sec, 50 deletes up: 9 sec T}@T{ 421 sec T} T{ Moved remote dir T}@T{ Queued 50 copies down: 31 sec, 50 deletes down: <1 sec T}@T{ 33 sec T} T{ Delete local dir T}@T{ Queued 50 deletes up: 9 sec T}@T{ 13 sec T} .TE .PP This next data is from a user\[aq]s application. They had \[ti]400GB of data over 1.96 million files being sync\[aq]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). .IP \[bu] 2 Loading the prior listing into memory (1.96 million files, listing file size 140 MB) took \[ti]30 sec and occupied about 1 GB of RAM. .IP \[bu] 2 Getting a fresh listing of the local file system (producing the 140 MB output file) took about XXX sec. .IP \[bu] 2 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. .IP \[bu] 2 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. .SS References .PP rclone\[aq]s bisync implementation was derived from the rclonesync-V2 (https://github.com/cjnaz/rclonesync-V2) project, including documentation and test mechanisms, with [\[at]cjnaz](https://github.com/cjnaz)\[aq]s full support and encouragement. .PP \f[C]rclone bisync\f[R] is similar in nature to a range of other projects: .IP \[bu] 2 unison (https://github.com/bcpierce00/unison) .IP \[bu] 2 syncthing (https://github.com/syncthing/syncthing) .IP \[bu] 2 cjnaz/rclonesync (https://github.com/cjnaz/rclonesync-V2) .IP \[bu] 2 ConorWilliams/rsinc (https://github.com/ConorWilliams/rsinc) .IP \[bu] 2 jwink3101/syncrclone (https://github.com/Jwink3101/syncrclone) .IP \[bu] 2 DavideRossi/upback (https://github.com/DavideRossi/upback) .PP Bisync adopts the differential synchronization technique, which is based on keeping history of changes performed by both synchronizing sides. See the \f[I]Dual Shadow Method\f[R] section in Neil Fraser\[aq]s article (https://neil.fraser.name/writing/sync/). .PP Also note a number of academic publications by Benjamin Pierce (http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization) about \f[I]Unison\f[R] and synchronization in general. .SS Changelog .SS \f[C]v1.69.1\f[R] .IP \[bu] 2 Fixed an issue causing listings to not capture concurrent modifications under certain conditions .SS \f[C]v1.68\f[R] .IP \[bu] 2 Fixed an issue affecting backends that round modtimes to a lower precision. .SS \f[C]v1.67\f[R] .IP \[bu] 2 Added integration tests against all backends. .SS \f[C]v1.66\f[R] .IP \[bu] 2 Copies and deletes are now handled in one operation instead of two .IP \[bu] 2 \f[C]--track-renames\f[R] and \f[C]--backup-dir\f[R] are now supported .IP \[bu] 2 Partial uploads known issue on \f[C]local\f[R]/\f[C]ftp\f[R]/\f[C]sftp\f[R] has been resolved (unless using \f[C]--inplace\f[R]) .IP \[bu] 2 Final listings are now generated from sync results, to avoid needing to re-list .IP \[bu] 2 Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes .IP \[bu] 2 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. .IP \[bu] 2 A few basic terminal colors are now supported, controllable with \f[C]--color\f[R] (https://rclone.org/docs/#color-when) (\f[C]AUTO\f[R]|\f[C]NEVER\f[R]|\f[C]ALWAYS\f[R]) .IP \[bu] 2 Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same \[dq]march\[dq] infrastructure as \f[C]check\f[R] and \f[C]sync\f[R], 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). .IP \[bu] 2 Fixed handling of unicode normalization and case insensitivity, support for \f[C]--fix-case\f[R] (https://rclone.org/docs/#fix-case), \f[C]--ignore-case-sync\f[R], \f[C]--no-unicode-normalization\f[R] .IP \[bu] 2 \f[C]--resync\f[R] is now much more efficient (especially for users of \f[C]--create-empty-src-dirs\f[R]) .IP \[bu] 2 Google Docs (and other files of unknown size) are now supported (with the same options as in \f[C]sync\f[R]) .IP \[bu] 2 Equality checks before a sync conflict rename now fall back to \f[C]cryptcheck\f[R] (when possible) or \f[C]--download\f[R], instead of of \f[C]--size-only\f[R], when \f[C]check\f[R] is not available. .IP \[bu] 2 Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags. .IP \[bu] 2 Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support. .IP \[bu] 2 Bisync now supports a \[dq]Graceful Shutdown\[dq] mode to cleanly cancel a run early without requiring \f[C]--resync\f[R]. .IP \[bu] 2 New \f[C]--recover\f[R] flag allows robust recovery in the event of interruptions, without requiring \f[C]--resync\f[R]. .IP \[bu] 2 A new \f[C]--max-lock\f[R] setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted. .IP \[bu] 2 Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new \f[C]--conflict-resolve\f[R], \f[C]--conflict-loser\f[R], and \f[C]--conflict-suffix\f[R] flags. .IP \[bu] 2 A new \f[C]--resync-mode\f[R] flag allows more control over which version of a file gets kept during a \f[C]--resync\f[R]. .IP \[bu] 2 Bisync now supports \f[C]--retries\f[R] (https://rclone.org/docs/#retries-int) and \f[C]--retries-sleep\f[R] (when \f[C]--resilient\f[R] is set.) .SS \f[C]v1.64\f[R] .IP \[bu] 2 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 .IP \[bu] 2 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 \f[C]--resync\f[R] to erroneously delete empty folders and duplicate files unique to Path2 .IP \[bu] 2 \f[C]--check-access\f[R] is now enforced during \f[C]--resync\f[R], 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) .IP \[bu] 2 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 .IP \[bu] 2 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) .IP \[bu] 2 Added support for \f[C]--create-empty-src-dirs\f[R] (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) .IP \[bu] 2 Added experimental \f[C]--resilient\f[R] 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) .IP \[bu] 2 Added new \f[C]--ignore-listing-checksum\f[R] 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 \f[C]--ignore-checksum\f[R] .IP \[bu] 2 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 .IP \[bu] 2 Documentation and testing improvements .SH Release signing .PP 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. .PP 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. .SS Release signing key .PP You may obtain the release signing key from: .IP \[bu] 2 From KEYS on this website - this file contains all past signing keys also. .IP \[bu] 2 The git repository hosted on GitHub - https://github.com/rclone/rclone/blob/master/docs/content/KEYS .IP \[bu] 2 \f[C]gpg --keyserver hkps://keys.openpgp.org --search nick\[at]craig-wood.com\f[R] .IP \[bu] 2 \f[C]gpg --keyserver hkps://keyserver.ubuntu.com --search nick\[at]craig-wood.com\f[R] .IP \[bu] 2 https://www.craig-wood.com/nick/pub/pgp-key.txt .PP After importing the key, verify that the fingerprint of one of the keys matches: \f[C]FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA\f[R] as this key is used for signing. .PP 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. .IP \[bu] 2 The source for this page on GitHub (https://github.com/rclone/rclone/blob/master/docs/content/release_signing.md). .IP \[bu] 2 Through DNS \f[C]dig key.rclone.org txt\f[R] .PP If you find anything that doesn\[aq]t not match, please contact the developers at once. .SS How to verify the release .PP In the release directory you will see the release files and some files called \f[C]MD5SUMS\f[R], \f[C]SHA1SUMS\f[R] and \f[C]SHA256SUMS\f[R]. .IP .nf \f[C] $ 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 \f[R] .fi .PP The \f[C]MD5SUMS\f[R], \f[C]SHA1SUMS\f[R] and \f[C]SHA256SUMS\f[R] contain hashes of the binary files in the release directory along with a signature. .PP For example: .IP .nf \f[C] $ 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----- \f[R] .fi .SS Download the files .PP The first step is to download the binary and SUMs file and verify that the SUMs you have downloaded match. Here we download \f[C]rclone-v1.63.1-windows-amd64.zip\f[R] - choose the binary (or binaries) appropriate to your architecture. We\[aq]ve also chosen the \f[C]SHA256SUMS\f[R] as these are the most secure. You could verify the other types of hash also for extra security. \f[C]rclone selfupdate\f[R] verifies just the \f[C]SHA256SUMS\f[R]. .IP .nf \f[C] $ 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 . \f[R] .fi .SS Verify the signatures .PP First verify the signatures on the SHA256 file. .PP Import the key. See above for ways to verify this key is correct. .IP .nf \f[C] $ gpg --keyserver keyserver.ubuntu.com --receive-keys FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: key 93935E02FF3B54FA: public key \[dq]Nick Craig-Wood <nick\[at]craig-wood.com>\[dq] imported gpg: Total number processed: 1 gpg: imported: 1 \f[R] .fi .PP Then check the signature: .IP .nf \f[C] $ gpg --verify SHA256SUMS gpg: Signature made Mon 17 Jul 2023 15:03:17 BST gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: Good signature from \[dq]Nick Craig-Wood <nick\[at]craig-wood.com>\[dq] [ultimate] \f[R] .fi .PP Verify the signature was good and is using the fingerprint shown above. .PP Repeat for \f[C]MD5SUMS\f[R] and \f[C]SHA1SUMS\f[R] if desired. .SS Verify the hashes .PP Now that we know the signatures on the hashes are OK we can verify the binaries match the hashes, completing the verification. .IP .nf \f[C] $ sha256sum -c SHA256SUMS 2>&1 | grep OK rclone-v1.63.1-windows-amd64.zip: OK \f[R] .fi .PP Or do the check with rclone .IP .nf \f[C] $ 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 \f[R] .fi .SS Verify signatures and hashes together .PP You can verify the signatures and hashes in one command line like this: .IP .nf \f[C] $ h=$(gpg --decrypt SHA256SUMS) && echo \[dq]$h\[dq] | sha256sum - -c --ignore-missing gpg: Signature made Mon 17 Jul 2023 15:03:17 BST gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA gpg: Good signature from \[dq]Nick Craig-Wood <nick\[at]craig-wood.com>\[dq] [ultimate] gpg: aka \[dq]Nick Craig-Wood <nick\[at]memset.com>\[dq] [unknown] rclone-v1.63.1-windows-amd64.zip: OK \f[R] .fi .SH 1Fichier .PP This is a backend for the 1fichier (https://1fichier.com) cloud storage service. Note that a Premium subscription is required to use the API. .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / 1Fichier \[rs] \[dq]fichier\[dq] [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 (\[dq]\[dq]). 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 \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your 1Fichier account .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your 1Fichier account .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to a 1Fichier directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Modification times and hashes .PP 1Fichier does not support modification times. It supports the Whirlpool hash algorithm. .SS Duplicated files .PP 1Fichier can have two files with exactly the same name and path (unlike a normal file system). .PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ $ T}@T{ 0x24 T}@T{ \[uFF04] T} T{ \[ga] T}@T{ 0x60 T}@T{ \[uFF40] T} T{ \[aq] T}@T{ 0x27 T}@T{ \[uFF07] T} .TE .PP 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: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to fichier (1Fichier). .SS --fichier-api-key .PP Your API Key, get it from https://1fichier.com/console/params.pl. .PP Properties: .IP \[bu] 2 Config: api_key .IP \[bu] 2 Env Var: RCLONE_FICHIER_API_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to fichier (1Fichier). .SS --fichier-shared-folder .PP If you want to download a shared folder, add this parameter. .PP Properties: .IP \[bu] 2 Config: shared_folder .IP \[bu] 2 Env Var: RCLONE_FICHIER_SHARED_FOLDER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --fichier-file-password .PP If you want to download a shared file that is password protected, add this parameter. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: file_password .IP \[bu] 2 Env Var: RCLONE_FICHIER_FILE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --fichier-folder-password .PP If you want to list the files in a shared folder that is password protected, add this parameter. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: folder_password .IP \[bu] 2 Env Var: RCLONE_FICHIER_FOLDER_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --fichier-cdn .PP Set if you wish to use CDN download links. .PP Properties: .IP \[bu] 2 Config: cdn .IP \[bu] 2 Env Var: RCLONE_FICHIER_CDN .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --fichier-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_FICHIER_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot .SS --fichier-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_FICHIER_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP \f[C]rclone about\f[R] is not supported by the 1Fichier backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH Alias .PP The \f[C]alias\f[R] remote provides a new name for another remote. .PP Paths may be as deep as required or a local path, e.g. \f[C]remote:directory/subdirectory\f[R] or \f[C]/directory/subdirectory\f[R]. .PP During the initial setup with \f[C]rclone config\f[R] you will specify the target remote. The target remote can either be a local path or another remote. .PP Subfolders can be used in target remote. Assume an alias remote named \f[C]backup\f[R] with the target \f[C]mydrive:private/backup\f[R]. Invoking \f[C]rclone mkdir backup:desktop\f[R] is exactly the same as invoking \f[C]rclone mkdir mydrive:private/backup/desktop\f[R]. .PP There will be no special handling of paths containing \f[C]..\f[R] segments. Invoking \f[C]rclone mkdir backup:../desktop\f[R] is exactly the same as invoking \f[C]rclone mkdir mydrive:private/backup/../desktop\f[R]. The empty path is not allowed as a remote. To alias the current directory use \f[C].\f[R] instead. .PP 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 \f[C]myDriveTrash\f[R] with the target remote \f[C]myDrive,trashed_only:\f[R] can be used to only show the trashed files in \f[C]myDrive\f[R]. .SS Configuration .PP Here is an example of how to make an alias called \f[C]remote\f[R] for local folder. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 \[rs] \[dq]alias\[dq] [snip] Storage> alias Remote or path to alias. Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], \[dq]myremote:\[dq] or \[dq]/local/path\[dq]. remote> /mnt/storage/backup Remote config Configuration complete. Options: - type: alias - remote: /mnt/storage/backup Keep this \[dq]remote\[dq] 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 \f[R] .fi .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level in \f[C]/mnt/storage/backup\f[R] .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in \f[C]/mnt/storage/backup\f[R] .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP Copy another local directory to the alias directory called source .IP .nf \f[C] rclone copy /home/source remote:source \f[R] .fi .SS Standard options .PP Here are the Standard options specific to alias (Alias for an existing remote). .SS --alias-remote .PP Remote or path to alias. .PP Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], \[dq]myremote:\[dq] or \[dq]/local/path\[dq]. .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_ALIAS_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to alias (Alias for an existing remote). .SS --alias-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_ALIAS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Amazon S3 Storage Providers .PP The S3 backend can be used with a number of different providers: .IP \[bu] 2 AWS S3 .IP \[bu] 2 Alibaba Cloud (Aliyun) Object Storage System (OSS) .IP \[bu] 2 Ceph .IP \[bu] 2 China Mobile Ecloud Elastic Object Storage (EOS) .IP \[bu] 2 Cloudflare R2 .IP \[bu] 2 Arvan Cloud Object Storage (AOS) .IP \[bu] 2 DigitalOcean Spaces .IP \[bu] 2 Dreamhost .IP \[bu] 2 GCS .IP \[bu] 2 Huawei OBS .IP \[bu] 2 IBM COS S3 .IP \[bu] 2 IDrive e2 .IP \[bu] 2 IONOS Cloud .IP \[bu] 2 Leviia Object Storage .IP \[bu] 2 Liara Object Storage .IP \[bu] 2 Linode Object Storage .IP \[bu] 2 Magalu Object Storage .IP \[bu] 2 Minio .IP \[bu] 2 Outscale .IP \[bu] 2 Petabox .IP \[bu] 2 Qiniu Cloud Object Storage (Kodo) .IP \[bu] 2 RackCorp Object Storage .IP \[bu] 2 Rclone Serve S3 .IP \[bu] 2 Scaleway .IP \[bu] 2 Seagate Lyve Cloud .IP \[bu] 2 SeaweedFS .IP \[bu] 2 Selectel .IP \[bu] 2 StackPath .IP \[bu] 2 Storj .IP \[bu] 2 Synology C2 Object Storage .IP \[bu] 2 Tencent Cloud Object Storage (COS) .IP \[bu] 2 Wasabi .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .PP Once you have made a remote (see the provider specific section above) you can use it like this: .PP See all buckets .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new bucket .IP .nf \f[C] rclone mkdir remote:bucket \f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] rclone ls remote:bucket \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:bucket \f[R] .fi .SS Configuration .PP 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. .PP First run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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, ... \[rs] \[dq]s3\[dq] [snip] Storage> s3 Choose your S3 provider. Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \[rs] \[dq]AWS\[dq] 2 / Ceph Object Storage \[rs] \[dq]Ceph\[dq] 3 / DigitalOcean Spaces \[rs] \[dq]DigitalOcean\[dq] 4 / Dreamhost DreamObjects \[rs] \[dq]Dreamhost\[dq] 5 / IBM COS S3 \[rs] \[dq]IBMCOS\[dq] 6 / Minio Object Storage \[rs] \[dq]Minio\[dq] 7 / Wasabi Object Storage \[rs] \[dq]Wasabi\[dq] 8 / Any other S3 compatible provider \[rs] \[dq]Other\[dq] 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 \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] 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. \[rs] \[dq]us-east-1\[dq] / US East (Ohio) Region 2 | Needs location constraint us-east-2. \[rs] \[dq]us-east-2\[dq] / US West (Oregon) Region 3 | Needs location constraint us-west-2. \[rs] \[dq]us-west-2\[dq] / US West (Northern California) Region 4 | Needs location constraint us-west-1. \[rs] \[dq]us-west-1\[dq] / Canada (Central) Region 5 | Needs location constraint ca-central-1. \[rs] \[dq]ca-central-1\[dq] / EU (Ireland) Region 6 | Needs location constraint EU or eu-west-1. \[rs] \[dq]eu-west-1\[dq] / EU (London) Region 7 | Needs location constraint eu-west-2. \[rs] \[dq]eu-west-2\[dq] / EU (Frankfurt) Region 8 | Needs location constraint eu-central-1. \[rs] \[dq]eu-central-1\[dq] / Asia Pacific (Singapore) Region 9 | Needs location constraint ap-southeast-1. \[rs] \[dq]ap-southeast-1\[dq] / Asia Pacific (Sydney) Region 10 | Needs location constraint ap-southeast-2. \[rs] \[dq]ap-southeast-2\[dq] / Asia Pacific (Tokyo) Region 11 | Needs location constraint ap-northeast-1. \[rs] \[dq]ap-northeast-1\[dq] / Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2. \[rs] \[dq]ap-northeast-2\[dq] / Asia Pacific (Mumbai) 13 | Needs location constraint ap-south-1. \[rs] \[dq]ap-south-1\[dq] / Asia Pacific (Hong Kong) Region 14 | Needs location constraint ap-east-1. \[rs] \[dq]ap-east-1\[dq] / South America (Sao Paulo) Region 15 | Needs location constraint sa-east-1. \[rs] \[dq]sa-east-1\[dq] 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. \[rs] \[dq]\[dq] 2 / US East (Ohio) Region. \[rs] \[dq]us-east-2\[dq] 3 / US West (Oregon) Region. \[rs] \[dq]us-west-2\[dq] 4 / US West (Northern California) Region. \[rs] \[dq]us-west-1\[dq] 5 / Canada (Central) Region. \[rs] \[dq]ca-central-1\[dq] 6 / EU (Ireland) Region. \[rs] \[dq]eu-west-1\[dq] 7 / EU (London) Region. \[rs] \[dq]eu-west-2\[dq] 8 / EU Region. \[rs] \[dq]EU\[dq] 9 / Asia Pacific (Singapore) Region. \[rs] \[dq]ap-southeast-1\[dq] 10 / Asia Pacific (Sydney) Region. \[rs] \[dq]ap-southeast-2\[dq] 11 / Asia Pacific (Tokyo) Region. \[rs] \[dq]ap-northeast-1\[dq] 12 / Asia Pacific (Seoul) \[rs] \[dq]ap-northeast-2\[dq] 13 / Asia Pacific (Mumbai) \[rs] \[dq]ap-south-1\[dq] 14 / Asia Pacific (Hong Kong) \[rs] \[dq]ap-east-1\[dq] 15 / South America (Sao Paulo) Region. \[rs] \[dq]sa-east-1\[dq] 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). \[rs] \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. \[rs] \[dq]public-read\[dq] / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 3 | Granting this on a bucket is generally not recommended. \[rs] \[dq]public-read-write\[dq] 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. \[rs] \[dq]authenticated-read\[dq] / 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. \[rs] \[dq]bucket-owner-read\[dq] / 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. \[rs] \[dq]bucket-owner-full-control\[dq] 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 \[rs] \[dq]\[dq] 2 / AES256 \[rs] \[dq]AES256\[dq] 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 \[rs] \[dq]\[dq] 2 / Standard storage class \[rs] \[dq]STANDARD\[dq] 3 / Reduced redundancy storage class \[rs] \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard Infrequent Access storage class \[rs] \[dq]STANDARD_IA\[dq] 5 / One Zone Infrequent Access storage class \[rs] \[dq]ONEZONE_IA\[dq] 6 / Glacier Flexible Retrieval storage class \[rs] \[dq]GLACIER\[dq] 7 / Glacier Deep Archive storage class \[rs] \[dq]DEEP_ARCHIVE\[dq] 8 / Intelligent-Tiering storage class \[rs] \[dq]INTELLIGENT_TIERING\[dq] 9 / Glacier Instant Retrieval storage class \[rs] \[dq]GLACIER_IR\[dq] 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 \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> \f[R] .fi .SS Modification times and hashes .SS Modification times .PP The modified time is stored as metadata on the object as \f[C]X-Amz-Meta-Mtime\f[R] as floating point since the epoch, accurate to 1 ns. .PP 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. .PP Note that reading this from the object takes an additional \f[C]HEAD\f[R] request as the metadata isn\[aq]t returned in object listings. .SS Hashes .PP For small objects which weren\[aq]t uploaded as multipart uploads (objects sized below \f[C]--s3-upload-cutoff\f[R] if uploaded with rclone) rclone uses the \f[C]ETag:\f[R] header as an MD5 checksum. .PP However for objects which were uploaded as multipart uploads or with server side encryption (SSE-AWS or SSE-C) the \f[C]ETag\f[R] header is no longer the MD5 sum of the data, so rclone adds an additional piece of metadata \f[C]X-Amz-Meta-Md5chksum\f[R] which is a base64 encoded MD5 hash (in the same format as is required for \f[C]Content-MD5\f[R]). You can use base64 -d and hexdump to check this value manually: .IP .nf \f[C] echo \[aq]VWTGdNx3LyXQDfA0e2Edxw==\[aq] | base64 -d | hexdump \f[R] .fi .PP or you can use \f[C]rclone check\f[R] to verify the hashes are OK. .PP For large objects, calculating this hash can take some time so the addition of this hash can be disabled with \f[C]--s3-disable-checksum\f[R]. This will mean that these objects do not have an MD5 checksum. .PP Note that reading this from the object takes an additional \f[C]HEAD\f[R] request as the metadata isn\[aq]t returned in object listings. .SS Reducing costs .SS Avoiding HEAD requests to read the modification time .PP 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). .PP 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. .PP The extra API calls can be avoided when syncing (using \f[C]rclone sync\f[R] or \f[C]rclone copy\f[R]) in a few different ways, each with its own tradeoffs. .IP \[bu] 2 \f[C]--size-only\f[R] .RS 2 .IP \[bu] 2 Only checks the size of files. .IP \[bu] 2 Uses no extra transactions. .IP \[bu] 2 If the file doesn\[aq]t change size then rclone won\[aq]t detect it has changed. .IP \[bu] 2 \f[C]rclone sync --size-only /path/to/source s3:bucket\f[R] .RE .IP \[bu] 2 \f[C]--checksum\f[R] .RS 2 .IP \[bu] 2 Checks the size and MD5 checksum of files. .IP \[bu] 2 Uses no extra transactions. .IP \[bu] 2 The most accurate detection of changes possible. .IP \[bu] 2 Will cause the source to read an MD5 checksum which, if it is a local disk, will cause lots of disk activity. .IP \[bu] 2 If the source and destination are both S3 this is the \f[B]recommended\f[R] flag to use for maximum efficiency. .IP \[bu] 2 \f[C]rclone sync --checksum /path/to/source s3:bucket\f[R] .RE .IP \[bu] 2 \f[C]--update --use-server-modtime\f[R] .RS 2 .IP \[bu] 2 Uses no extra transactions. .IP \[bu] 2 Modification time becomes the time the object was uploaded. .IP \[bu] 2 For many operations this is sufficient to determine if it needs uploading. .IP \[bu] 2 Using \f[C]--update\f[R] along with \f[C]--use-server-modtime\f[R], avoids the extra API call and uploads files whose local modification time is newer than the time it was last uploaded. .IP \[bu] 2 Files created with timestamps in the past will be missed by the sync. .IP \[bu] 2 \f[C]rclone sync --update --use-server-modtime /path/to/source s3:bucket\f[R] .RE .PP These flags can and should be used in combination with \f[C]--fast-list\f[R] - see below. .PP If using \f[C]rclone mount\f[R] or any command using the VFS (eg \f[C]rclone serve\f[R]) commands then you might want to consider using the VFS flag \f[C]--no-modtime\f[R] which will stop rclone reading the modification time for every object. You could also use \f[C]--use-server-modtime\f[R] if you are happy with the modification times of the objects being the time of upload. .SS Avoiding GET requests to read directory listings .PP Rclone\[aq]s default directory traversal is to process each directory individually. This takes one API call per directory. Using the \f[C]--fast-list\f[R] 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. .IP .nf \f[C] rclone sync --fast-list --checksum /path/to/source s3:bucket \f[R] .fi .PP \f[C]--fast-list\f[R] trades off API transactions for memory use. As a rough guide rclone uses 1k of memory per object stored, so using \f[C]--fast-list\f[R] on a sync of a million objects will use roughly 1 GiB of RAM. .PP If you are only copying a small number of files into a big repository then using \f[C]--no-traverse\f[R] is a good idea. This finds objects directly instead of through directory listings. You can do a \[dq]top-up\[dq] sync very cheaply by using \f[C]--max-age\f[R] and \f[C]--no-traverse\f[R] to copy only recent files, eg .IP .nf \f[C] rclone copy --max-age 24h --no-traverse /path/to/source s3:bucket \f[R] .fi .PP You\[aq]d then do a full \f[C]rclone sync\f[R] less often. .PP Note that \f[C]--fast-list\f[R] isn\[aq]t required in the top-up sync. .SS Avoiding HEAD requests after PUT .PP By default, rclone will HEAD every object it uploads. It does this to check the object got uploaded correctly. .PP You can disable this with the --s3-no-head option - see there for more details. .PP Setting this flag increases the chance for undetected upload failures. .SS Increasing performance .SS Using server-side copy .PP 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. .PP For rclone to use server-side copy, you must use the same remote for the source and destination. .IP .nf \f[C] rclone copy s3:source-bucket s3:destination-bucket \f[R] .fi .PP 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. .SS Increasing the rate of API requests .PP You can increase the rate of API requests to S3 by increasing the parallelism using \f[C]--transfers\f[R] and \f[C]--checkers\f[R] options. .PP 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. .PP 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. .IP .nf \f[C] rclone sync --transfers 200 --checkers 200 --checksum s3:source-bucket s3:destination-bucket \f[R] .fi .PP You will need to experiment with these values to find the optimal settings for your setup. .SS Data integrity .PP Rclone does its best to verify every part of an upload or download to the s3 provider using various hashes. .PP Every HTTP transaction to/from the provider has a \f[C]X-Amz-Content-Sha256\f[R] or a \f[C]Content-Md5\f[R] header to guard against corruption of the HTTP body. The HTTP Header is protected by the signature passed in the \f[C]Authorization\f[R] header. .PP All communications with the provider is done over https for encryption and additional error protection. .SS Single part uploads .IP \[bu] 2 Rclone uploads single part uploads with a \f[C]Content-Md5\f[R] using the MD5 hash read from the source. The provider checks this is correct on receipt of the data. .IP \[bu] 2 Rclone then does a HEAD request (disable with \f[C]--s3-no-head\f[R]) to read the \f[C]ETag\f[R] back which is the MD5 of the file and checks that with what it sent. .PP 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 \f[C]--s3-upload-cutoff 0\f[R] so all files are uploaded as multipart uploads. .SS Multipart uploads .PP For files above \f[C]--s3-upload-cutoff\f[R] rclone splits the file into multiple parts for upload. .IP \[bu] 2 Each part is protected with both an \f[C]X-Amz-Content-Sha256\f[R] and a \f[C]Content-Md5\f[R] .PP When rclone has finished the upload of all the parts it then completes the upload by sending: .IP \[bu] 2 The MD5 hash of each part .IP \[bu] 2 The number of parts .IP \[bu] 2 This info is all protected with a \f[C]X-Amz-Content-Sha256\f[R] .PP The provider checks the MD5 for all the parts it has received against what rclone sends and if it is good it returns OK. .PP Rclone then does a HEAD request (disable with \f[C]--s3-no-head\f[R]) 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). .PP If the source has an MD5 sum then rclone will attach the \f[C]X-Amz-Meta-Md5chksum\f[R] with it as the \f[C]ETag\f[R] for a multipart upload can\[aq]t easily be checked against the file as the chunk size must be known in order to calculate it. .SS Downloads .PP Rclone checks the MD5 hash of the data downloaded against either the ETag or the \f[C]X-Amz-Meta-Md5chksum\f[R] metadata (if present) which rclone uploads with multipart uploads. .SS Further checking .PP At each stage rclone and the provider are sending and checking hashes of \f[B]everything\f[R]. Rclone deliberately HEADs each object after upload to check it arrived safely for extra security. (You can disable this with \f[C]--s3-no-head\f[R]). .PP If you require further assurance that your data is intact you can use \f[C]rclone check\f[R] to check the hashes locally vs the remote. .PP And if you are feeling ultimately paranoid use \f[C]rclone check --download\f[R] which will download the files and check them against the local copies. (Note that this doesn\[aq]t use disk to do this - it streams them in memory). .SS Versions .PP When bucket versioning is enabled (this can be done with rclone with the \f[C]rclone backend versioning\f[R] 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. .PP Old versions of files, where available, are visible using the \f[C]--s3-versions\f[R] flag. .PP It is also possible to view a bucket as it was at a certain point in time, using the \f[C]--s3-version-at\f[R] 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. .PP If you wish to remove all the old versions then you can use the \f[C]rclone backend cleanup-hidden remote:bucket\f[R] 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. \f[C]rclone backend cleanup-hidden remote:bucket/path/to/stuff\f[R]. .PP When you \f[C]purge\f[R] a bucket, the current and the old versions will be deleted then the bucket will be deleted. .PP However \f[C]delete\f[R] will cause the current versions of the files to become hidden old versions. .PP Here is a session showing the listing and retrieval of an old version followed by a \f[C]cleanup\f[R] of the old versions. .PP Show current version and all the versions with \f[C]--s3-versions\f[R] flag. .IP .nf \f[C] $ 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 \f[R] .fi .PP Retrieve an old version .IP .nf \f[C] $ 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 \f[R] .fi .PP Clean up all the old versions and show that they\[aq]ve gone. .IP .nf \f[C] $ 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 \f[R] .fi .SS Versions naming caveat .PP When using \f[C]--s3-versions\f[R] flag rclone is relying on the file name to work out whether the objects are versions or not. Versions\[aq] names are created by inserting timestamp between file name and its extension. .IP .nf \f[C] 9 file.txt 8 file-v2023-07-17-161032-000.txt 16 file-v2023-06-15-141003-000.txt \f[R] .fi .PP If there are real files present with the same names as versions, then behaviour of \f[C]--s3-versions\f[R] can be unpredictable. .SS Cleanup .PP If you run \f[C]rclone cleanup s3:bucket\f[R] then it will remove all pending multipart uploads older than 24 hours. You can use the \f[C]--interactive\f[R]/\f[C]i\f[R] or \f[C]--dry-run\f[R] flag to see exactly what it will do. If you want more control over the expiry date then run \f[C]rclone backend cleanup s3:bucket -o max-age=1h\f[R] to expire all uploads older than one hour. You can use \f[C]rclone backend list-multipart-uploads s3:bucket\f[R] to see the pending multipart uploads. .SS Restricted filename characters .PP S3 allows any valid UTF-8 string as a key. .PP Invalid UTF-8 bytes will be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in XML. .PP The following characters are replaced since these are problematic when dealing with the REST API: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} .TE .PP The encoding will also encode these file names as they don\[aq]t seem to work with the SDK properly: .PP .TS tab(@); l c. T{ File name T}@T{ Replacement T} _ T{ \&. T}@T{ \[uFF0E] T} T{ \&.. T}@T{ \[uFF0E]\[uFF0E] T} .TE .SS Multipart uploads .PP rclone supports multipart uploads with S3 which means that it can upload files bigger than 5 GiB. .PP Note that files uploaded \f[I]both\f[R] with multipart upload \f[I]and\f[R] through crypt remotes do not have MD5 sums. .PP rclone switches from single part uploads to multipart uploads at the point specified by \f[C]--s3-upload-cutoff\f[R]. This can be a maximum of 5 GiB and a minimum of 0 (ie always upload multipart files). .PP The chunk sizes used in the multipart upload are specified by \f[C]--s3-chunk-size\f[R] and the number of chunks uploaded concurrently is specified by \f[C]--s3-upload-concurrency\f[R]. .PP Multipart uploads will use \f[C]--transfers\f[R] * \f[C]--s3-upload-concurrency\f[R] * \f[C]--s3-chunk-size\f[R] extra memory. Single part uploads to not use extra memory. .PP 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. .PP Increasing \f[C]--s3-upload-concurrency\f[R] will increase throughput (8 would be a sensible value) and increasing \f[C]--s3-chunk-size\f[R] 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. .SS Buckets and Regions .PP With Amazon S3 you can list buckets (\f[C]rclone lsd\f[R]) 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, \f[C]incorrect region, the bucket is not in \[aq]XXX\[aq] region\f[R]. .SS Authentication .PP There are a number of ways to supply \f[C]rclone\f[R] with a set of AWS credentials, with and without using the environment. .PP The different authentication methods are tried in this order: .IP \[bu] 2 Directly in the rclone configuration file (\f[C]env_auth = false\f[R] in the config file): .RS 2 .IP \[bu] 2 \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] are required. .IP \[bu] 2 \f[C]session_token\f[R] can be optionally set when using AWS STS. .RE .IP \[bu] 2 Runtime configuration (\f[C]env_auth = true\f[R] in the config file): .RS 2 .IP \[bu] 2 Export the following environment variables before running \f[C]rclone\f[R]: .RS 2 .IP \[bu] 2 Access Key ID: \f[C]AWS_ACCESS_KEY_ID\f[R] or \f[C]AWS_ACCESS_KEY\f[R] .IP \[bu] 2 Secret Access Key: \f[C]AWS_SECRET_ACCESS_KEY\f[R] or \f[C]AWS_SECRET_KEY\f[R] .IP \[bu] 2 Session Token: \f[C]AWS_SESSION_TOKEN\f[R] (optional) .RE .IP \[bu] 2 Or, use a named profile (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html): .RS 2 .IP \[bu] 2 Profile files are standard files used by AWS CLI tools .IP \[bu] 2 By default it will use the profile in your home directory (e.g. \f[C]\[ti]/.aws/credentials\f[R] on unix based systems) file and the \[dq]default\[dq] profile, to change set these environment variables or config keys: .RS 2 .IP \[bu] 2 \f[C]AWS_SHARED_CREDENTIALS_FILE\f[R] to control which file or the \f[C]shared_credentials_file\f[R] config key. .IP \[bu] 2 \f[C]AWS_PROFILE\f[R] to control which profile to use or the \f[C]profile\f[R] config key. .RE .RE .IP \[bu] 2 Or, run \f[C]rclone\f[R] in an ECS task with an IAM role (AWS only). .IP \[bu] 2 Or, run \f[C]rclone\f[R] on an EC2 instance with an IAM role (AWS only). .IP \[bu] 2 Or, run \f[C]rclone\f[R] in an EKS pod with an IAM role that is associated with a service account (AWS only). .IP \[bu] 2 Or, use process credentials (https://docs.aws.amazon.com/sdkref/latest/guide/feature-process-credentials.html) to read config from an external program. .RE .PP With \f[C]env_auth = true\f[R] 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 \f[C]aws\f[R] CLI tool does and the other AWS SDKs. .PP If none of these option actually end up providing \f[C]rclone\f[R] with AWS credentials then S3 interaction will be non-authenticated (see the anonymous access section for more info). .SS S3 Permissions .PP When using the \f[C]sync\f[R] subcommand of \f[C]rclone\f[R] the following minimum permissions are required to be available on the bucket being written to: .IP \[bu] 2 \f[C]ListBucket\f[R] .IP \[bu] 2 \f[C]DeleteObject\f[R] .IP \[bu] 2 \f[C]GetObject\f[R] .IP \[bu] 2 \f[C]PutObject\f[R] .IP \[bu] 2 \f[C]PutObjectACL\f[R] .IP \[bu] 2 \f[C]CreateBucket\f[R] (unless using s3-no-check-bucket) .PP When using the \f[C]lsd\f[R] subcommand, the \f[C]ListAllMyBuckets\f[R] permission is required. .PP Example policy: .IP .nf \f[C] { \[dq]Version\[dq]: \[dq]2012-10-17\[dq], \[dq]Statement\[dq]: [ { \[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Principal\[dq]: { \[dq]AWS\[dq]: \[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] }, \[dq]Action\[dq]: [ \[dq]s3:ListBucket\[dq], \[dq]s3:DeleteObject\[dq], \[dq]s3:GetObject\[dq], \[dq]s3:PutObject\[dq], \[dq]s3:PutObjectAcl\[dq] ], \[dq]Resource\[dq]: [ \[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], \[dq]arn:aws:s3:::BUCKET_NAME\[dq] ] }, { \[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Action\[dq]: \[dq]s3:ListAllMyBuckets\[dq], \[dq]Resource\[dq]: \[dq]arn:aws:s3:::*\[dq] } ] } \f[R] .fi .PP Notes on above: .IP "1." 3 This is a policy that can be used when creating bucket. It assumes that \f[C]USER_NAME\f[R] has been created. .IP "2." 3 The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket\[aq]s objects. .IP "3." 3 When using s3-no-check-bucket and the bucket already exists, the \f[C]\[dq]arn:aws:s3:::BUCKET_NAME\[dq]\f[R] doesn\[aq]t have to be included. .PP For reference, here\[aq]s an Ansible script (https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) that will generate one or more buckets that will work with \f[C]rclone sync\f[R]. .SS Key Management System (KMS) .PP If you are using server-side encryption with KMS then you must make sure rclone is configured with \f[C]server_side_encryption = aws:kms\f[R] otherwise you will find you can\[aq]t transfer small objects - these will create checksum errors. .SS Glacier and Glacier Deep Archive .PP 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. .IP .nf \f[C] 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file \f[R] .fi .PP 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 section below shows how to do this with rclone. .PP Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults. .SS Object-lock enabled S3 bucket .PP According to AWS\[aq]s documentation on S3 Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission): .RS .PP If you configure a default retention period on a bucket, requests to upload objects in such a bucket must include the Content-MD5 header. .RE .PP As mentioned in the Modification times and hashes section, small files that are not uploaded as multipart, use a different tag, causing the upload to fail. A simple solution is to set the \f[C]--s3-upload-cutoff 0\f[R] and force all the files to be uploaded as multipart. .SS Standard options .PP Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others). .SS --s3-provider .PP Choose your S3 provider. .PP Properties: .IP \[bu] 2 Config: provider .IP \[bu] 2 Env Var: RCLONE_S3_PROVIDER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]AWS\[dq] .RS 2 .IP \[bu] 2 Amazon Web Services (AWS) S3 .RE .IP \[bu] 2 \[dq]Alibaba\[dq] .RS 2 .IP \[bu] 2 Alibaba Cloud Object Storage System (OSS) formerly Aliyun .RE .IP \[bu] 2 \[dq]ArvanCloud\[dq] .RS 2 .IP \[bu] 2 Arvan Cloud Object Storage (AOS) .RE .IP \[bu] 2 \[dq]Ceph\[dq] .RS 2 .IP \[bu] 2 Ceph Object Storage .RE .IP \[bu] 2 \[dq]ChinaMobile\[dq] .RS 2 .IP \[bu] 2 China Mobile Ecloud Elastic Object Storage (EOS) .RE .IP \[bu] 2 \[dq]Cloudflare\[dq] .RS 2 .IP \[bu] 2 Cloudflare R2 Storage .RE .IP \[bu] 2 \[dq]DigitalOcean\[dq] .RS 2 .IP \[bu] 2 DigitalOcean Spaces .RE .IP \[bu] 2 \[dq]Dreamhost\[dq] .RS 2 .IP \[bu] 2 Dreamhost DreamObjects .RE .IP \[bu] 2 \[dq]GCS\[dq] .RS 2 .IP \[bu] 2 Google Cloud Storage .RE .IP \[bu] 2 \[dq]HuaweiOBS\[dq] .RS 2 .IP \[bu] 2 Huawei Object Storage Service .RE .IP \[bu] 2 \[dq]IBMCOS\[dq] .RS 2 .IP \[bu] 2 IBM COS S3 .RE .IP \[bu] 2 \[dq]IDrive\[dq] .RS 2 .IP \[bu] 2 IDrive e2 .RE .IP \[bu] 2 \[dq]IONOS\[dq] .RS 2 .IP \[bu] 2 IONOS Cloud .RE .IP \[bu] 2 \[dq]LyveCloud\[dq] .RS 2 .IP \[bu] 2 Seagate Lyve Cloud .RE .IP \[bu] 2 \[dq]Leviia\[dq] .RS 2 .IP \[bu] 2 Leviia Object Storage .RE .IP \[bu] 2 \[dq]Liara\[dq] .RS 2 .IP \[bu] 2 Liara Object Storage .RE .IP \[bu] 2 \[dq]Linode\[dq] .RS 2 .IP \[bu] 2 Linode Object Storage .RE .IP \[bu] 2 \[dq]Magalu\[dq] .RS 2 .IP \[bu] 2 Magalu Object Storage .RE .IP \[bu] 2 \[dq]Minio\[dq] .RS 2 .IP \[bu] 2 Minio Object Storage .RE .IP \[bu] 2 \[dq]Netease\[dq] .RS 2 .IP \[bu] 2 Netease Object Storage (NOS) .RE .IP \[bu] 2 \[dq]Outscale\[dq] .RS 2 .IP \[bu] 2 OUTSCALE Object Storage (OOS) .RE .IP \[bu] 2 \[dq]Petabox\[dq] .RS 2 .IP \[bu] 2 Petabox Object Storage .RE .IP \[bu] 2 \[dq]RackCorp\[dq] .RS 2 .IP \[bu] 2 RackCorp Object Storage .RE .IP \[bu] 2 \[dq]Rclone\[dq] .RS 2 .IP \[bu] 2 Rclone S3 Server .RE .IP \[bu] 2 \[dq]Scaleway\[dq] .RS 2 .IP \[bu] 2 Scaleway Object Storage .RE .IP \[bu] 2 \[dq]SeaweedFS\[dq] .RS 2 .IP \[bu] 2 SeaweedFS S3 .RE .IP \[bu] 2 \[dq]Selectel\[dq] .RS 2 .IP \[bu] 2 Selectel Object Storage .RE .IP \[bu] 2 \[dq]StackPath\[dq] .RS 2 .IP \[bu] 2 StackPath Object Storage .RE .IP \[bu] 2 \[dq]Storj\[dq] .RS 2 .IP \[bu] 2 Storj (S3 Compatible Gateway) .RE .IP \[bu] 2 \[dq]Synology\[dq] .RS 2 .IP \[bu] 2 Synology C2 Object Storage .RE .IP \[bu] 2 \[dq]TencentCOS\[dq] .RS 2 .IP \[bu] 2 Tencent Cloud Object Storage (COS) .RE .IP \[bu] 2 \[dq]Wasabi\[dq] .RS 2 .IP \[bu] 2 Wasabi Object Storage .RE .IP \[bu] 2 \[dq]Qiniu\[dq] .RS 2 .IP \[bu] 2 Qiniu Object Storage (Kodo) .RE .IP \[bu] 2 \[dq]Other\[dq] .RS 2 .IP \[bu] 2 Any other S3 compatible provider .RE .RE .SS --s3-env-auth .PP Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). .PP Only applies if access_key_id and secret_access_key is blank. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_S3_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Enter AWS credentials in the next step. .RE .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Get AWS credentials from the environment (env vars or IAM). .RE .RE .SS --s3-access-key-id .PP AWS Access Key ID. .PP Leave blank for anonymous access or runtime credentials. .PP Properties: .IP \[bu] 2 Config: access_key_id .IP \[bu] 2 Env Var: RCLONE_S3_ACCESS_KEY_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-secret-access-key .PP AWS Secret Access Key (password). .PP Leave blank for anonymous access or runtime credentials. .PP Properties: .IP \[bu] 2 Config: secret_access_key .IP \[bu] 2 Env Var: RCLONE_S3_SECRET_ACCESS_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-region .PP Region to connect to. .PP Properties: .IP \[bu] 2 Config: region .IP \[bu] 2 Env Var: RCLONE_S3_REGION .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]us-east-1\[dq] .RS 2 .IP \[bu] 2 The default endpoint - a good choice if you are unsure. .IP \[bu] 2 US Region, Northern Virginia, or Pacific Northwest. .IP \[bu] 2 Leave location constraint empty. .RE .IP \[bu] 2 \[dq]us-east-2\[dq] .RS 2 .IP \[bu] 2 US East (Ohio) Region. .IP \[bu] 2 Needs location constraint us-east-2. .RE .IP \[bu] 2 \[dq]us-west-1\[dq] .RS 2 .IP \[bu] 2 US West (Northern California) Region. .IP \[bu] 2 Needs location constraint us-west-1. .RE .IP \[bu] 2 \[dq]us-west-2\[dq] .RS 2 .IP \[bu] 2 US West (Oregon) Region. .IP \[bu] 2 Needs location constraint us-west-2. .RE .IP \[bu] 2 \[dq]ca-central-1\[dq] .RS 2 .IP \[bu] 2 Canada (Central) Region. .IP \[bu] 2 Needs location constraint ca-central-1. .RE .IP \[bu] 2 \[dq]eu-west-1\[dq] .RS 2 .IP \[bu] 2 EU (Ireland) Region. .IP \[bu] 2 Needs location constraint EU or eu-west-1. .RE .IP \[bu] 2 \[dq]eu-west-2\[dq] .RS 2 .IP \[bu] 2 EU (London) Region. .IP \[bu] 2 Needs location constraint eu-west-2. .RE .IP \[bu] 2 \[dq]eu-west-3\[dq] .RS 2 .IP \[bu] 2 EU (Paris) Region. .IP \[bu] 2 Needs location constraint eu-west-3. .RE .IP \[bu] 2 \[dq]eu-north-1\[dq] .RS 2 .IP \[bu] 2 EU (Stockholm) Region. .IP \[bu] 2 Needs location constraint eu-north-1. .RE .IP \[bu] 2 \[dq]eu-south-1\[dq] .RS 2 .IP \[bu] 2 EU (Milan) Region. .IP \[bu] 2 Needs location constraint eu-south-1. .RE .IP \[bu] 2 \[dq]eu-central-1\[dq] .RS 2 .IP \[bu] 2 EU (Frankfurt) Region. .IP \[bu] 2 Needs location constraint eu-central-1. .RE .IP \[bu] 2 \[dq]ap-southeast-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Singapore) Region. .IP \[bu] 2 Needs location constraint ap-southeast-1. .RE .IP \[bu] 2 \[dq]ap-southeast-2\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Sydney) Region. .IP \[bu] 2 Needs location constraint ap-southeast-2. .RE .IP \[bu] 2 \[dq]ap-northeast-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Tokyo) Region. .IP \[bu] 2 Needs location constraint ap-northeast-1. .RE .IP \[bu] 2 \[dq]ap-northeast-2\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Seoul). .IP \[bu] 2 Needs location constraint ap-northeast-2. .RE .IP \[bu] 2 \[dq]ap-northeast-3\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Osaka-Local). .IP \[bu] 2 Needs location constraint ap-northeast-3. .RE .IP \[bu] 2 \[dq]ap-south-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Mumbai). .IP \[bu] 2 Needs location constraint ap-south-1. .RE .IP \[bu] 2 \[dq]ap-east-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Hong Kong) Region. .IP \[bu] 2 Needs location constraint ap-east-1. .RE .IP \[bu] 2 \[dq]sa-east-1\[dq] .RS 2 .IP \[bu] 2 South America (Sao Paulo) Region. .IP \[bu] 2 Needs location constraint sa-east-1. .RE .IP \[bu] 2 \[dq]il-central-1\[dq] .RS 2 .IP \[bu] 2 Israel (Tel Aviv) Region. .IP \[bu] 2 Needs location constraint il-central-1. .RE .IP \[bu] 2 \[dq]me-south-1\[dq] .RS 2 .IP \[bu] 2 Middle East (Bahrain) Region. .IP \[bu] 2 Needs location constraint me-south-1. .RE .IP \[bu] 2 \[dq]af-south-1\[dq] .RS 2 .IP \[bu] 2 Africa (Cape Town) Region. .IP \[bu] 2 Needs location constraint af-south-1. .RE .IP \[bu] 2 \[dq]cn-north-1\[dq] .RS 2 .IP \[bu] 2 China (Beijing) Region. .IP \[bu] 2 Needs location constraint cn-north-1. .RE .IP \[bu] 2 \[dq]cn-northwest-1\[dq] .RS 2 .IP \[bu] 2 China (Ningxia) Region. .IP \[bu] 2 Needs location constraint cn-northwest-1. .RE .IP \[bu] 2 \[dq]us-gov-east-1\[dq] .RS 2 .IP \[bu] 2 AWS GovCloud (US-East) Region. .IP \[bu] 2 Needs location constraint us-gov-east-1. .RE .IP \[bu] 2 \[dq]us-gov-west-1\[dq] .RS 2 .IP \[bu] 2 AWS GovCloud (US) Region. .IP \[bu] 2 Needs location constraint us-gov-west-1. .RE .RE .SS --s3-endpoint .PP Endpoint for S3 API. .PP Leave blank if using AWS to use the default endpoint for the region. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_S3_ENDPOINT .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-location-constraint .PP Location constraint - must be set to match the Region. .PP Used when creating buckets only. .PP Properties: .IP \[bu] 2 Config: location_constraint .IP \[bu] 2 Env Var: RCLONE_S3_LOCATION_CONSTRAINT .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Empty for US Region, Northern Virginia, or Pacific Northwest .RE .IP \[bu] 2 \[dq]us-east-2\[dq] .RS 2 .IP \[bu] 2 US East (Ohio) Region .RE .IP \[bu] 2 \[dq]us-west-1\[dq] .RS 2 .IP \[bu] 2 US West (Northern California) Region .RE .IP \[bu] 2 \[dq]us-west-2\[dq] .RS 2 .IP \[bu] 2 US West (Oregon) Region .RE .IP \[bu] 2 \[dq]ca-central-1\[dq] .RS 2 .IP \[bu] 2 Canada (Central) Region .RE .IP \[bu] 2 \[dq]eu-west-1\[dq] .RS 2 .IP \[bu] 2 EU (Ireland) Region .RE .IP \[bu] 2 \[dq]eu-west-2\[dq] .RS 2 .IP \[bu] 2 EU (London) Region .RE .IP \[bu] 2 \[dq]eu-west-3\[dq] .RS 2 .IP \[bu] 2 EU (Paris) Region .RE .IP \[bu] 2 \[dq]eu-north-1\[dq] .RS 2 .IP \[bu] 2 EU (Stockholm) Region .RE .IP \[bu] 2 \[dq]eu-south-1\[dq] .RS 2 .IP \[bu] 2 EU (Milan) Region .RE .IP \[bu] 2 \[dq]EU\[dq] .RS 2 .IP \[bu] 2 EU Region .RE .IP \[bu] 2 \[dq]ap-southeast-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Singapore) Region .RE .IP \[bu] 2 \[dq]ap-southeast-2\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Sydney) Region .RE .IP \[bu] 2 \[dq]ap-northeast-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Tokyo) Region .RE .IP \[bu] 2 \[dq]ap-northeast-2\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Seoul) Region .RE .IP \[bu] 2 \[dq]ap-northeast-3\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Osaka-Local) Region .RE .IP \[bu] 2 \[dq]ap-south-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Mumbai) Region .RE .IP \[bu] 2 \[dq]ap-east-1\[dq] .RS 2 .IP \[bu] 2 Asia Pacific (Hong Kong) Region .RE .IP \[bu] 2 \[dq]sa-east-1\[dq] .RS 2 .IP \[bu] 2 South America (Sao Paulo) Region .RE .IP \[bu] 2 \[dq]il-central-1\[dq] .RS 2 .IP \[bu] 2 Israel (Tel Aviv) Region .RE .IP \[bu] 2 \[dq]me-south-1\[dq] .RS 2 .IP \[bu] 2 Middle East (Bahrain) Region .RE .IP \[bu] 2 \[dq]af-south-1\[dq] .RS 2 .IP \[bu] 2 Africa (Cape Town) Region .RE .IP \[bu] 2 \[dq]cn-north-1\[dq] .RS 2 .IP \[bu] 2 China (Beijing) Region .RE .IP \[bu] 2 \[dq]cn-northwest-1\[dq] .RS 2 .IP \[bu] 2 China (Ningxia) Region .RE .IP \[bu] 2 \[dq]us-gov-east-1\[dq] .RS 2 .IP \[bu] 2 AWS GovCloud (US-East) Region .RE .IP \[bu] 2 \[dq]us-gov-west-1\[dq] .RS 2 .IP \[bu] 2 AWS GovCloud (US) Region .RE .RE .SS --s3-acl .PP Canned ACL used when creating buckets and storing or copying objects. .PP This ACL is used for creating objects and if bucket_acl isn\[aq]t set, for creating buckets too. .PP For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl .PP Note that this ACL is applied when server-side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. .PP If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used. .PP Properties: .IP \[bu] 2 Config: acl .IP \[bu] 2 Env Var: RCLONE_S3_ACL .IP \[bu] 2 Provider: !Storj,Selectel,Synology,Cloudflare .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]default\[dq] .RS 2 .IP \[bu] 2 Owner gets Full_CONTROL. .IP \[bu] 2 No one else has access rights (default). .RE .IP \[bu] 2 \[dq]private\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 No one else has access rights (default). .RE .IP \[bu] 2 \[dq]public-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ access. .RE .IP \[bu] 2 \[dq]public-read-write\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ and WRITE access. .IP \[bu] 2 Granting this on a bucket is generally not recommended. .RE .IP \[bu] 2 \[dq]authenticated-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AuthenticatedUsers group gets READ access. .RE .IP \[bu] 2 \[dq]bucket-owner-read\[dq] .RS 2 .IP \[bu] 2 Object owner gets FULL_CONTROL. .IP \[bu] 2 Bucket owner gets READ access. .IP \[bu] 2 If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. .RE .IP \[bu] 2 \[dq]bucket-owner-full-control\[dq] .RS 2 .IP \[bu] 2 Both the object owner and the bucket owner get FULL_CONTROL over the object. .IP \[bu] 2 If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. .RE .IP \[bu] 2 \[dq]private\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 No one else has access rights (default). .IP \[bu] 2 This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS. .RE .IP \[bu] 2 \[dq]public-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ access. .IP \[bu] 2 This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS. .RE .IP \[bu] 2 \[dq]public-read-write\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ and WRITE access. .IP \[bu] 2 This acl is available on IBM Cloud (Infra), On-Premise IBM COS. .RE .IP \[bu] 2 \[dq]authenticated-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AuthenticatedUsers group gets READ access. .IP \[bu] 2 Not supported on Buckets. .IP \[bu] 2 This acl is available on IBM Cloud (Infra) and On-Premise IBM COS. .RE .RE .SS --s3-server-side-encryption .PP The server-side encryption algorithm used when storing this object in S3. .PP Properties: .IP \[bu] 2 Config: server_side_encryption .IP \[bu] 2 Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION .IP \[bu] 2 Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .IP \[bu] 2 \[dq]AES256\[dq] .RS 2 .IP \[bu] 2 AES256 .RE .IP \[bu] 2 \[dq]aws:kms\[dq] .RS 2 .IP \[bu] 2 aws:kms .RE .RE .SS --s3-sse-kms-key-id .PP If using KMS ID you must provide the ARN of Key. .PP Properties: .IP \[bu] 2 Config: sse_kms_key_id .IP \[bu] 2 Env Var: RCLONE_S3_SSE_KMS_KEY_ID .IP \[bu] 2 Provider: AWS,Ceph,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .IP \[bu] 2 \[dq]arn:aws:kms:us-east-1:*\[dq] .RS 2 .IP \[bu] 2 arn:aws:kms:* .RE .RE .SS --s3-storage-class .PP The storage class to use when storing new objects in S3. .PP Properties: .IP \[bu] 2 Config: storage_class .IP \[bu] 2 Env Var: RCLONE_S3_STORAGE_CLASS .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Default .RE .IP \[bu] 2 \[dq]STANDARD\[dq] .RS 2 .IP \[bu] 2 Standard storage class .RE .IP \[bu] 2 \[dq]REDUCED_REDUNDANCY\[dq] .RS 2 .IP \[bu] 2 Reduced redundancy storage class .RE .IP \[bu] 2 \[dq]STANDARD_IA\[dq] .RS 2 .IP \[bu] 2 Standard Infrequent Access storage class .RE .IP \[bu] 2 \[dq]ONEZONE_IA\[dq] .RS 2 .IP \[bu] 2 One Zone Infrequent Access storage class .RE .IP \[bu] 2 \[dq]GLACIER\[dq] .RS 2 .IP \[bu] 2 Glacier Flexible Retrieval storage class .RE .IP \[bu] 2 \[dq]DEEP_ARCHIVE\[dq] .RS 2 .IP \[bu] 2 Glacier Deep Archive storage class .RE .IP \[bu] 2 \[dq]INTELLIGENT_TIERING\[dq] .RS 2 .IP \[bu] 2 Intelligent-Tiering storage class .RE .IP \[bu] 2 \[dq]GLACIER_IR\[dq] .RS 2 .IP \[bu] 2 Glacier Instant Retrieval storage class .RE .RE .SS Advanced options .PP Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others). .SS --s3-bucket-acl .PP Canned ACL used when creating buckets. .PP For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl .PP Note that this ACL is applied when only when creating buckets. If it isn\[aq]t set then \[dq]acl\[dq] is used instead. .PP If the \[dq]acl\[dq] and \[dq]bucket_acl\[dq] are empty strings then no X-Amz-Acl: header is added and the default (private) will be used. .PP Properties: .IP \[bu] 2 Config: bucket_acl .IP \[bu] 2 Env Var: RCLONE_S3_BUCKET_ACL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]private\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 No one else has access rights (default). .RE .IP \[bu] 2 \[dq]public-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ access. .RE .IP \[bu] 2 \[dq]public-read-write\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AllUsers group gets READ and WRITE access. .IP \[bu] 2 Granting this on a bucket is generally not recommended. .RE .IP \[bu] 2 \[dq]authenticated-read\[dq] .RS 2 .IP \[bu] 2 Owner gets FULL_CONTROL. .IP \[bu] 2 The AuthenticatedUsers group gets READ access. .RE .RE .SS --s3-requester-pays .PP Enables requester pays option when interacting with S3 bucket. .PP Properties: .IP \[bu] 2 Config: requester_pays .IP \[bu] 2 Env Var: RCLONE_S3_REQUESTER_PAYS .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-sse-customer-algorithm .PP If using SSE-C, the server-side encryption algorithm used when storing this object in S3. .PP Properties: .IP \[bu] 2 Config: sse_customer_algorithm .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM .IP \[bu] 2 Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .IP \[bu] 2 \[dq]AES256\[dq] .RS 2 .IP \[bu] 2 AES256 .RE .RE .SS --s3-sse-customer-key .PP To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data. .PP Alternatively you can provide --sse-customer-key-base64. .PP Properties: .IP \[bu] 2 Config: sse_customer_key .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_KEY .IP \[bu] 2 Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --s3-sse-customer-key-base64 .PP If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data. .PP Alternatively you can provide --sse-customer-key. .PP Properties: .IP \[bu] 2 Config: sse_customer_key_base64 .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64 .IP \[bu] 2 Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --s3-sse-customer-key-md5 .PP If using SSE-C you may provide the secret encryption key MD5 checksum (optional). .PP If you leave it blank, this is calculated automatically from the sse_customer_key provided. .PP Properties: .IP \[bu] 2 Config: sse_customer_key_md5 .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 .IP \[bu] 2 Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --s3-upload-cutoff .PP Cutoff for switching to chunked upload. .PP Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_S3_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 200Mi .SS --s3-chunk-size .PP Chunk size to use for uploading. .PP When uploading files larger than upload_cutoff or files with unknown size (e.g. from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone mount\[dq] or google photos or google docs) they will be uploaded as multipart uploads using this chunk size. .PP Note that \[dq]--s3-upload-concurrency\[dq] chunks of this size are buffered in memory per transfer. .PP If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers. .PP Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit. .PP 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. .PP Increasing the chunk size decreases the accuracy of the progress statistics displayed with \[dq]-P\[dq] flag. Rclone treats chunk as sent when it\[aq]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. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_S3_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 5Mi .SS --s3-max-upload-parts .PP Maximum number of parts in a multipart upload. .PP This option defines the maximum number of multipart chunks to use when doing a multipart upload. .PP This can be useful if a service does not support the AWS S3 specification of 10,000 chunks. .PP Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit. .PP Properties: .IP \[bu] 2 Config: max_upload_parts .IP \[bu] 2 Env Var: RCLONE_S3_MAX_UPLOAD_PARTS .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 10000 .SS --s3-copy-cutoff .PP Cutoff for switching to multipart copy. .PP Any files larger than this that need to be server-side copied will be copied in chunks of this size. .PP The minimum is 0 and the maximum is 5 GiB. .PP Properties: .IP \[bu] 2 Config: copy_cutoff .IP \[bu] 2 Env Var: RCLONE_S3_COPY_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4.656Gi .SS --s3-disable-checksum .PP Don\[aq]t store MD5 checksum with object metadata. .PP 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. .PP Properties: .IP \[bu] 2 Config: disable_checksum .IP \[bu] 2 Env Var: RCLONE_S3_DISABLE_CHECKSUM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-shared-credentials-file .PP Path to the shared credentials file. .PP If env_auth = true then rclone can use a shared credentials file. .PP If this variable is empty rclone will look for the \[dq]AWS_SHARED_CREDENTIALS_FILE\[dq] env variable. If the env value is empty it will default to the current user\[aq]s home directory. .IP .nf \f[C] Linux/OSX: \[dq]$HOME/.aws/credentials\[dq] Windows: \[dq]%USERPROFILE%\[rs].aws\[rs]credentials\[dq] \f[R] .fi .PP Properties: .IP \[bu] 2 Config: shared_credentials_file .IP \[bu] 2 Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-profile .PP Profile to use in the shared credentials file. .PP If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file. .PP If empty it will default to the environment variable \[dq]AWS_PROFILE\[dq] or \[dq]default\[dq] if that environment variable is also not set. .PP Properties: .IP \[bu] 2 Config: profile .IP \[bu] 2 Env Var: RCLONE_S3_PROFILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-session-token .PP An AWS session token. .PP Properties: .IP \[bu] 2 Config: session_token .IP \[bu] 2 Env Var: RCLONE_S3_SESSION_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-upload-concurrency .PP Concurrency for multipart uploads and copies. .PP This is the number of chunks of the same file that are uploaded concurrently for multipart uploads and copies. .PP 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. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_S3_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 4 .SS --s3-force-path-style .PP If true use path style access if false use virtual hosted style. .PP 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/dev/UsingBucket.html#access-bucket-intro) for more info. .PP 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. .PP Note that if your bucket isn\[aq]t a valid DNS name, i.e. has \[aq].\[aq] or \[aq]_\[aq] in, you\[aq]ll need to set this to true. .PP Properties: .IP \[bu] 2 Config: force_path_style .IP \[bu] 2 Env Var: RCLONE_S3_FORCE_PATH_STYLE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --s3-v2-auth .PP If true use v2 authentication. .PP If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication. .PP Use this only if v4 signatures don\[aq]t work, e.g. pre Jewel/v10 CEPH. .PP Properties: .IP \[bu] 2 Config: v2_auth .IP \[bu] 2 Env Var: RCLONE_S3_V2_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-use-dual-stack .PP If true use AWS S3 dual-stack endpoint (IPv6 support). .PP See AWS Docs on Dualstack Endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html) .PP Properties: .IP \[bu] 2 Config: use_dual_stack .IP \[bu] 2 Env Var: RCLONE_S3_USE_DUAL_STACK .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-use-accelerate-endpoint .PP If true use the AWS S3 accelerated endpoint. .PP See: AWS S3 Transfer acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) .PP Properties: .IP \[bu] 2 Config: use_accelerate_endpoint .IP \[bu] 2 Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-leave-parts-on-error .PP If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. .PP It should be set to true for resuming uploads across different sessions. .PP WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. .PP Properties: .IP \[bu] 2 Config: leave_parts_on_error .IP \[bu] 2 Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-list-chunk .PP Size of listing chunk (response list for each ListObject S3 request). .PP This option is also known as \[dq]MaxKeys\[dq], \[dq]max-items\[dq], or \[dq]page-size\[dq] 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 \[dq]rgw list buckets max chunk\[dq] option. .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_S3_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1000 .SS --s3-list-version .PP Version of ListObjects to use: 1,2 or 0 for auto. .PP When S3 originally launched it only provided the ListObjects call to enumerate objects in a bucket. .PP However in May 2016 the ListObjectsV2 call was introduced. This is much higher performance and should be used if at all possible. .PP 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. .PP Properties: .IP \[bu] 2 Config: list_version .IP \[bu] 2 Env Var: RCLONE_S3_LIST_VERSION .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 0 .SS --s3-list-url-encode .PP Whether to url encode listings: true/false/unset .PP 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\[aq]s choice here. .PP Properties: .IP \[bu] 2 Config: list_url_encode .IP \[bu] 2 Env Var: RCLONE_S3_LIST_URL_ENCODE .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-no-check-bucket .PP If set, don\[aq]t attempt to check the bucket exists or create it. .PP This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. .PP 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. .PP Properties: .IP \[bu] 2 Config: no_check_bucket .IP \[bu] 2 Env Var: RCLONE_S3_NO_CHECK_BUCKET .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-no-head .PP If set, don\[aq]t HEAD uploaded objects to check integrity. .PP This can be useful when trying to minimise the number of transactions rclone does. .PP 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. .PP In particular it will assume: .IP \[bu] 2 the metadata, including modtime, storage class and content type was as uploaded .IP \[bu] 2 the size was as uploaded .PP It reads the following items from the response for a single part PUT: .IP \[bu] 2 the MD5SUM .IP \[bu] 2 The uploaded date .PP For multipart uploads these items aren\[aq]t read. .PP If an source object of unknown length is uploaded then rclone \f[B]will\f[R] do a HEAD request. .PP Setting this flag increases the chance for undetected upload failures, in particular an incorrect size, so it isn\[aq]t recommended for normal operation. In practice the chance of an undetected upload failure is very small even with this flag. .PP Properties: .IP \[bu] 2 Config: no_head .IP \[bu] 2 Env Var: RCLONE_S3_NO_HEAD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-no-head-object .PP If set, do not do HEAD before GET when getting objects. .PP Properties: .IP \[bu] 2 Config: no_head_object .IP \[bu] 2 Env Var: RCLONE_S3_NO_HEAD_OBJECT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_S3_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,InvalidUtf8,Dot .SS --s3-memory-pool-flush-time .PP How often internal memory buffer pools will be flushed. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_flush_time .IP \[bu] 2 Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --s3-memory-pool-use-mmap .PP Whether to use mmap buffers in internal memory pool. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_use_mmap .IP \[bu] 2 Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-disable-http2 .PP Disable usage of http2 for S3 backends. .PP 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. .PP See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631 .PP Properties: .IP \[bu] 2 Config: disable_http2 .IP \[bu] 2 Env Var: RCLONE_S3_DISABLE_HTTP2 .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-download-url .PP 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. .PP Properties: .IP \[bu] 2 Config: download_url .IP \[bu] 2 Env Var: RCLONE_S3_DOWNLOAD_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-directory-markers .PP Upload an empty object with a trailing slash when a new directory is created .PP Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with \[dq]/\[dq], to persist the folder. .PP Properties: .IP \[bu] 2 Config: directory_markers .IP \[bu] 2 Env Var: RCLONE_S3_DIRECTORY_MARKERS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-use-multipart-etag .PP Whether to use ETag in multipart uploads for verification .PP This should be true, false or left unset to use the default for the provider. .PP Properties: .IP \[bu] 2 Config: use_multipart_etag .IP \[bu] 2 Env Var: RCLONE_S3_USE_MULTIPART_ETAG .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-use-unsigned-payload .PP Whether to use an unsigned payload in PutObject .PP 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\[aq]t. .PP This should be true, false or left unset to use the default for the provider. .PP Properties: .IP \[bu] 2 Config: use_unsigned_payload .IP \[bu] 2 Env Var: RCLONE_S3_USE_UNSIGNED_PAYLOAD .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-use-presigned-request .PP Whether to use a presigned request or PutObject for single part uploads .PP If this is false rclone will use PutObject from the AWS SDK to upload an object. .PP 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\[aq]t be necessary except in exceptional circumstances or for testing. .PP Properties: .IP \[bu] 2 Config: use_presigned_request .IP \[bu] 2 Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-versions .PP Include old versions in directory listings. .PP Properties: .IP \[bu] 2 Config: versions .IP \[bu] 2 Env Var: RCLONE_S3_VERSIONS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-version-at .PP Show file versions as they were at the specified time. .PP The parameter should be a date, \[dq]2006-01-02\[dq], datetime \[dq]2006-01-02 15:04:05\[dq] or a duration for that long ago, eg \[dq]100d\[dq] or \[dq]1h\[dq]. .PP Note that when using this no file write operations are permitted, so you can\[aq]t upload files or delete them. .PP See the time option docs (https://rclone.org/docs/#time-option) for valid formats. .PP Properties: .IP \[bu] 2 Config: version_at .IP \[bu] 2 Env Var: RCLONE_S3_VERSION_AT .IP \[bu] 2 Type: Time .IP \[bu] 2 Default: off .SS --s3-version-deleted .PP Show deleted file markers when using versions. .PP 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. .PP Deleting a delete marker will reveal the previous version. .PP Deleted files will always show with a timestamp. .PP Properties: .IP \[bu] 2 Config: version_deleted .IP \[bu] 2 Env Var: RCLONE_S3_VERSION_DELETED .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-decompress .PP If set this will decompress gzip encoded objects. .PP It is possible to upload objects to S3 with \[dq]Content-Encoding: gzip\[dq] set. Normally rclone will download these files as compressed objects. .PP If this flag is set then rclone will decompress these files with \[dq]Content-Encoding: gzip\[dq] as they are received. This means that rclone can\[aq]t check the size and hash but the file contents will be decompressed. .PP Properties: .IP \[bu] 2 Config: decompress .IP \[bu] 2 Env Var: RCLONE_S3_DECOMPRESS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-might-gzip .PP Set this if the backend might gzip objects. .PP Normally providers will not alter objects when they are downloaded. If an object was not uploaded with \f[C]Content-Encoding: gzip\f[R] then it won\[aq]t be set on download. .PP However some providers may gzip objects even if they weren\[aq]t uploaded with \f[C]Content-Encoding: gzip\f[R] (eg Cloudflare). .PP A symptom of this would be receiving errors like .IP .nf \f[C] ERROR corrupted on transfer: sizes differ NNN vs MMM \f[R] .fi .PP 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. .PP 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\[aq]s choice here. .PP Properties: .IP \[bu] 2 Config: might_gzip .IP \[bu] 2 Env Var: RCLONE_S3_MIGHT_GZIP .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-use-accept-encoding-gzip .PP Whether to send \f[C]Accept-Encoding: gzip\f[R] header. .PP By default, rclone will append \f[C]Accept-Encoding: gzip\f[R] to the request to download compressed objects whenever possible. .PP However some providers such as Google Cloud Storage may alter the HTTP headers, breaking the signature of the request. .PP A symptom of this would be receiving errors like .IP .nf \f[C] SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided. \f[R] .fi .PP In this case, you might want to try disabling this option. .PP Properties: .IP \[bu] 2 Config: use_accept_encoding_gzip .IP \[bu] 2 Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-no-system-metadata .PP Suppress setting and reading of system metadata .PP Properties: .IP \[bu] 2 Config: no_system_metadata .IP \[bu] 2 Env Var: RCLONE_S3_NO_SYSTEM_METADATA .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-sts-endpoint .PP Endpoint for STS (deprecated). .PP Leave blank if using AWS to use the default endpoint for the region. .PP Properties: .IP \[bu] 2 Config: sts_endpoint .IP \[bu] 2 Env Var: RCLONE_S3_STS_ENDPOINT .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --s3-use-already-exists .PP Set if rclone should report BucketAlreadyExists errors on bucket creation. .PP At some point during the evolution of the s3 protocol, AWS started returning an \f[C]AlreadyOwnedByYou\f[R] error when attempting to create a bucket that the user already owned, rather than a \f[C]BucketAlreadyExists\f[R] error. .PP Unfortunately exactly what has been implemented by s3 clones is a little inconsistent, some return \f[C]AlreadyOwnedByYou\f[R], some return \f[C]BucketAlreadyExists\f[R] and some return no error at all. .PP This is important to rclone because it ensures the bucket exists by creating it on quite a lot of operations (unless \f[C]--s3-no-check-bucket\f[R] is used). .PP If rclone knows the provider can return \f[C]AlreadyOwnedByYou\f[R] or returns no error then it can report \f[C]BucketAlreadyExists\f[R] errors when the user attempts to create a bucket not owned by them. Otherwise rclone ignores the \f[C]BucketAlreadyExists\f[R] error which can lead to confusion. .PP This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. .PP Properties: .IP \[bu] 2 Config: use_already_exists .IP \[bu] 2 Env Var: RCLONE_S3_USE_ALREADY_EXISTS .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-use-multipart-uploads .PP Set if rclone should use multipart uploads. .PP You can change this if you want to disable the use of multipart uploads. This shouldn\[aq]t be necessary in normal operation. .PP This should be automatically set correctly for all providers rclone knows about - please make a bug report if not. .PP Properties: .IP \[bu] 2 Config: use_multipart_uploads .IP \[bu] 2 Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS .IP \[bu] 2 Type: Tristate .IP \[bu] 2 Default: unset .SS --s3-directory-bucket .PP Set to use AWS Directory Buckets .PP If you are using an AWS Directory Bucket then set this flag. .PP This will ensure no \f[C]Content-Md5\f[R] headers are sent and ensure \f[C]ETag\f[R] headers are not interpreted as MD5 sums. \f[C]X-Amz-Meta-Md5chksum\f[R] will be set on all objects whether single or multipart uploaded. .PP This also sets \f[C]no_check_bucket = true\f[R]. .PP Note that Directory Buckets do not support: .IP \[bu] 2 Versioning .IP \[bu] 2 \f[C]Content-Encoding: gzip\f[R] .PP Rclone limitations with Directory Buckets: .IP \[bu] 2 rclone does not support creating Directory Buckets with \f[C]rclone mkdir\f[R] .IP \[bu] 2 \&... or removing them with \f[C]rclone rmdir\f[R] yet .IP \[bu] 2 Directory Buckets do not appear when doing \f[C]rclone lsf\f[R] at the top level. .IP \[bu] 2 Rclone can\[aq]t remove auto created directories yet. In theory this should work with \f[C]directory_markers = true\f[R] but it doesn\[aq]t. .IP \[bu] 2 Directories don\[aq]t seem to appear in recursive (ListR) listings. .PP Properties: .IP \[bu] 2 Config: directory_bucket .IP \[bu] 2 Env Var: RCLONE_S3_DIRECTORY_BUCKET .IP \[bu] 2 Provider: AWS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --s3-sdk-log-mode .PP Set to debug the SDK .PP This can be set to a comma separated list of the following functions: .IP \[bu] 2 \f[C]Signing\f[R] .IP \[bu] 2 \f[C]Retries\f[R] .IP \[bu] 2 \f[C]Request\f[R] .IP \[bu] 2 \f[C]RequestWithBody\f[R] .IP \[bu] 2 \f[C]Response\f[R] .IP \[bu] 2 \f[C]ResponseWithBody\f[R] .IP \[bu] 2 \f[C]DeprecatedUsage\f[R] .IP \[bu] 2 \f[C]RequestEventMessage\f[R] .IP \[bu] 2 \f[C]ResponseEventMessage\f[R] .PP Use \f[C]Off\f[R] to disable and \f[C]All\f[R] to set all log levels. You will need to use \f[C]-vv\f[R] to see the debug level logs. .PP Properties: .IP \[bu] 2 Config: sdk_log_mode .IP \[bu] 2 Env Var: RCLONE_S3_SDK_LOG_MODE .IP \[bu] 2 Type: Bits .IP \[bu] 2 Default: Off .SS --s3-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_S3_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case. .PP Here are the possible system metadata items for the s3 backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ btime T}@T{ Time of file birth (creation) read from Last-Modified header T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ \f[B]Y\f[R] T} T{ cache-control T}@T{ Cache-Control header T}@T{ string T}@T{ no-cache T}@T{ N T} T{ content-disposition T}@T{ Content-Disposition header T}@T{ string T}@T{ inline T}@T{ N T} T{ content-encoding T}@T{ Content-Encoding header T}@T{ string T}@T{ gzip T}@T{ N T} T{ content-language T}@T{ Content-Language header T}@T{ string T}@T{ en-US T}@T{ N T} T{ content-type T}@T{ Content-Type header T}@T{ string T}@T{ text/plain T}@T{ N T} T{ mtime T}@T{ Time of last modification, read from rclone metadata T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ N T} T{ tier T}@T{ Tier of the object T}@T{ string T}@T{ GLACIER T}@T{ \f[B]Y\f[R] T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Backend commands .PP Here are the commands specific to the s3 backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS restore .PP Restore objects from GLACIER or INTELLIGENT-TIERING archive tier .IP .nf \f[C] rclone backend restore remote: [options] [<arguments>+] \f[R] .fi .PP 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. .PP Usage Examples: .IP .nf \f[C] 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 \f[R] .fi .PP This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags .IP .nf \f[C] rclone --interactive backend restore --include \[dq]*.txt\[dq] s3:bucket/path -o priority=Standard -o lifetime=1 \f[R] .fi .PP All the objects shown will be marked for restore, then .IP .nf \f[C] rclone backend restore --include \[dq]*.txt\[dq] s3:bucket/path -o priority=Standard -o lifetime=1 \f[R] .fi .PP 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. .IP .nf \f[C] [ { \[dq]Status\[dq]: \[dq]OK\[dq], \[dq]Remote\[dq]: \[dq]test.txt\[dq] }, { \[dq]Status\[dq]: \[dq]OK\[dq], \[dq]Remote\[dq]: \[dq]test/file4.txt\[dq] } ] \f[R] .fi .PP Options: .IP \[bu] 2 \[dq]description\[dq]: The optional description for the job. .IP \[bu] 2 \[dq]lifetime\[dq]: Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING storage .IP \[bu] 2 \[dq]priority\[dq]: Priority of restore: Standard|Expedited|Bulk .SS restore-status .PP Show the restore status for objects being restored from GLACIER or INTELLIGENT-TIERING storage .IP .nf \f[C] rclone backend restore-status remote: [options] [<arguments>+] \f[R] .fi .PP 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. .PP Usage Examples: .IP .nf \f[C] 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 \f[R] .fi .PP This command does not obey the filters. .PP It returns a list of status dictionaries. .IP .nf \f[C] [ { \[dq]Remote\[dq]: \[dq]file.txt\[dq], \[dq]VersionID\[dq]: null, \[dq]RestoreStatus\[dq]: { \[dq]IsRestoreInProgress\[dq]: true, \[dq]RestoreExpiryDate\[dq]: \[dq]2023-09-06T12:29:19+01:00\[dq] }, \[dq]StorageClass\[dq]: \[dq]GLACIER\[dq] }, { \[dq]Remote\[dq]: \[dq]test.pdf\[dq], \[dq]VersionID\[dq]: null, \[dq]RestoreStatus\[dq]: { \[dq]IsRestoreInProgress\[dq]: false, \[dq]RestoreExpiryDate\[dq]: \[dq]2023-09-06T12:29:19+01:00\[dq] }, \[dq]StorageClass\[dq]: \[dq]DEEP_ARCHIVE\[dq] }, { \[dq]Remote\[dq]: \[dq]test.gz\[dq], \[dq]VersionID\[dq]: null, \[dq]RestoreStatus\[dq]: { \[dq]IsRestoreInProgress\[dq]: true, \[dq]RestoreExpiryDate\[dq]: \[dq]null\[dq] }, \[dq]StorageClass\[dq]: \[dq]INTELLIGENT_TIERING\[dq] } ] \f[R] .fi .PP Options: .IP \[bu] 2 \[dq]all\[dq]: if set then show all objects, not just ones with restore status .SS list-multipart-uploads .PP List the unfinished multipart uploads .IP .nf \f[C] rclone backend list-multipart-uploads remote: [options] [<arguments>+] \f[R] .fi .PP This command lists the unfinished multipart uploads in JSON format. .IP .nf \f[C] rclone backend list-multipart s3:bucket/path/to/object \f[R] .fi .PP It returns a dictionary of buckets with values as lists of unfinished multipart uploads. .PP You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path. .IP .nf \f[C] { \[dq]rclone\[dq]: [ { \[dq]Initiated\[dq]: \[dq]2020-06-26T14:20:36Z\[dq], \[dq]Initiator\[dq]: { \[dq]DisplayName\[dq]: \[dq]XXX\[dq], \[dq]ID\[dq]: \[dq]arn:aws:iam::XXX:user/XXX\[dq] }, \[dq]Key\[dq]: \[dq]KEY\[dq], \[dq]Owner\[dq]: { \[dq]DisplayName\[dq]: null, \[dq]ID\[dq]: \[dq]XXX\[dq] }, \[dq]StorageClass\[dq]: \[dq]STANDARD\[dq], \[dq]UploadId\[dq]: \[dq]XXX\[dq] } ], \[dq]rclone-1000files\[dq]: [], \[dq]rclone-dst\[dq]: [] } \f[R] .fi .SS cleanup .PP Remove unfinished multipart uploads. .IP .nf \f[C] rclone backend cleanup remote: [options] [<arguments>+] \f[R] .fi .PP This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours. .PP Note that you can use --interactive/-i or --dry-run with this command to see what it would do. .IP .nf \f[C] rclone backend cleanup s3:bucket/path/to/object rclone backend cleanup -o max-age=7w s3:bucket/path/to/object \f[R] .fi .PP Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. .PP Options: .IP \[bu] 2 \[dq]max-age\[dq]: Max age of upload to delete .SS cleanup-hidden .PP Remove old versions of files. .IP .nf \f[C] rclone backend cleanup-hidden remote: [options] [<arguments>+] \f[R] .fi .PP This command removes any old hidden versions of files on a versions enabled bucket. .PP Note that you can use --interactive/-i or --dry-run with this command to see what it would do. .IP .nf \f[C] rclone backend cleanup-hidden s3:bucket/path/to/dir \f[R] .fi .SS versioning .PP Set/get versioning support for a bucket. .IP .nf \f[C] rclone backend versioning remote: [options] [<arguments>+] \f[R] .fi .PP This command sets versioning support if a parameter is passed and then returns the current versioning status for the bucket supplied. .IP .nf \f[C] rclone backend versioning s3:bucket # read status only rclone backend versioning s3:bucket Enabled rclone backend versioning s3:bucket Suspended \f[R] .fi .PP It may return \[dq]Enabled\[dq], \[dq]Suspended\[dq] or \[dq]Unversioned\[dq]. Note that once versioning has been enabled the status can\[aq]t be set back to \[dq]Unversioned\[dq]. .SS set .PP Set command for updating the config parameters. .IP .nf \f[C] rclone backend set remote: [options] [<arguments>+] \f[R] .fi .PP This set command can be used to update the config parameters for a running s3 backend. .PP Usage Examples: .IP .nf \f[C] 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 \f[R] .fi .PP The option keys are named as they are in the config file. .PP 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. .PP It doesn\[aq]t return anything. .SS Anonymous access to public buckets .PP If you want to use rclone to access a public bucket, configure with a blank \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. Your config should end up looking like this: .IP .nf \f[C] [anons3] type = s3 provider = AWS \f[R] .fi .PP Then use it as normal with the name of the public bucket, e.g. .IP .nf \f[C] rclone lsd anons3:1000genomes \f[R] .fi .PP You will be able to list and copy data but not upload it. .PP You can also do this entirely on the command line .IP .nf \f[C] rclone lsd :s3,provider=AWS:1000genomes \f[R] .fi .SS Providers .SS AWS S3 .PP This is the provider used as main example and described in the configuration section above. .SS AWS Directory Buckets .PP From rclone v1.69 Directory Buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) are supported. .PP You will need to set the \f[C]directory_buckets = true\f[R] config parameter or use \f[C]--s3-directory-buckets\f[R]. .PP Note that rclone cannot yet: .IP \[bu] 2 Create directory buckets .IP \[bu] 2 List directory buckets .PP See the --s3-directory-buckets flag for more info .SS AWS Snowball Edge .PP 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. .PP To use rclone with AWS Snowball Edge devices, configure as standard for an \[aq]S3 Compatible Service\[aq]. .PP If using rclone pre v1.59 be sure to set \f[C]upload_cutoff = 0\f[R] otherwise you will run into authentication header issues as the snowball device does not support query parameter based authentication. .PP With rclone v1.59 or later setting \f[C]upload_cutoff\f[R] should not be necessary. .PP eg. .IP .nf \f[C] [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 \f[R] .fi .SS Ceph .PP 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. .PP 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: .IP .nf \f[C] [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 = \f[R] .fi .PP 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 \f[C]--s3-upload-cutoff 0\f[R] or put this in the config file as \f[C]upload_cutoff 0\f[R] to work around a bug which causes uploading of small files to fail. .PP Note also that Ceph sometimes puts \f[C]/\f[R] 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 \f[C]/\f[R] escaped as \f[C]\[rs]/\f[R]. Make sure you only write \f[C]/\f[R] in the secret access key. .PP Eg the dump from Ceph looks something like this (irrelevant keys removed). .IP .nf \f[C] { \[dq]user_id\[dq]: \[dq]xxx\[dq], \[dq]display_name\[dq]: \[dq]xxxx\[dq], \[dq]keys\[dq]: [ { \[dq]user\[dq]: \[dq]xxx\[dq], \[dq]access_key\[dq]: \[dq]xxxxxx\[dq], \[dq]secret_key\[dq]: \[dq]xxxxxx\[rs]/xxxx\[dq] } ], } \f[R] .fi .PP Because this is a json dump, it is encoding the \f[C]/\f[R] as \f[C]\[rs]/\f[R], so if you use the secret key as \f[C]xxxxxx/xxxx\f[R] it will work fine. .SS Cloudflare R2 .PP 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. .PP Here is an example of making a Cloudflare R2 configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .PP Note that all buckets are private, and all are stored in the same \[dq]auto\[dq] region. It is necessary to use Cloudflare workers to share the content of a bucket publicly. .IP .nf \f[C] 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, StackPath, Storj, Synology, Tencent COS and Wasabi \[rs] (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 \[rs] (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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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\[aq]s data centers for low latency. \[rs] (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 \f[R] .fi .PP This will leave your config looking something like: .IP .nf \f[C] [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 \f[R] .fi .PP Now run \f[C]rclone lsf r2:\f[R] to see your buckets and \f[C]rclone lsf r2:bucket\f[R] to look within a bucket. .PP For R2 tokens with the \[dq]Object Read & Write\[dq] permission, you may also need to add \f[C]no_check_bucket = true\f[R] for object uploads to work correctly. .PP Note that Cloudflare decompresses files uploaded with \f[C]Content-Encoding: gzip\f[R] by default which is a deviation from what AWS does. If this is causing a problem then upload the files with \f[C]--header-upload \[dq]Cache-Control: no-transform\[dq]\f[R] .PP A consequence of this is that \f[C]Content-Encoding: gzip\f[R] will never appear in the metadata on Cloudflare. .SS Dreamhost .PP Dreamhost DreamObjects (https://www.dreamhost.com/cloud/storage/) is an object storage system based on CEPH. .PP 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: .IP .nf \f[C] [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 = \f[R] .fi .SS Google Cloud Storage .PP 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. .PP 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). .IP .nf \f[C] [gs] type = s3 provider = GCS access_key_id = your_access_key secret_access_key = your_secret_key endpoint = https://storage.googleapis.com \f[R] .fi .PP \f[B]Note\f[R] that \f[C]--s3-versions\f[R] does not work with GCS when it needs to do directory paging. Rclone will return the error: .IP .nf \f[C] s3 protocol error: received versions listing with IsTruncated set with no NextKeyMarker \f[R] .fi .PP This is Google bug #312292516 (https://issuetracker.google.com/u/0/issues/312292516). .SS DigitalOcean Spaces .PP 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. .PP To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the \[dq]Applications & API (https://cloud.digitalocean.com/settings/api/tokens)\[dq] page of the DigitalOcean control panel. They will be needed when prompted by \f[C]rclone config\f[R] for your \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. .PP When prompted for a \f[C]region\f[R] or \f[C]location_constraint\f[R], press enter to use the default value. The region must be included in the \f[C]endpoint\f[R] setting (e.g. \f[C]nyc3.digitaloceanspaces.com\f[R]). The default values can be used for other settings. .PP Going through the whole process of creating a new remote by running \f[C]rclone config\f[R], each prompt should be answered as shown below: .IP .nf \f[C] 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> \f[R] .fi .PP The resulting configuration file should look like: .IP .nf \f[C] [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 = \f[R] .fi .PP Once configured, you can create a new Space and begin copying files. For example: .IP .nf \f[C] rclone mkdir spaces:my-new-space rclone copy /path/to/files spaces:my-new-space \f[R] .fi .SS Huawei OBS .PP 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. .PP OBS provides an S3 interface, you can copy and modify the following configuration and add it to your rclone configuration file. .IP .nf \f[C] [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 \f[R] .fi .PP Or you can also configure via the interactive command line: .IP .nf \f[C] 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, ... \[rs] (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 \[rs] (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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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 \[rs] (af-south-1) 2 / AP-Bangkok \[rs] (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 \[rs] (obs.af-south-1.myhuaweicloud.com) 2 / AP-Bangkok \[rs] (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\[aq]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\[aq]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). \[rs] (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 \f[R] .fi .SS IBM COS (S3) .PP 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\[cq]s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage) .PP To configure access to IBM COS S3, follow the steps below: .IP "1." 3 Run rclone config and select n for a new remote. .IP .nf \f[C] 2018/02/14 14:13:11 NOTICE: Config file \[dq]C:\[rs]\[rs]Users\[rs]\[rs]a\[rs]\[rs].config\[rs]\[rs]rclone\[rs]\[rs]rclone.conf\[dq] 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 \f[R] .fi .IP "2." 3 Enter the name for the configuration .IP .nf \f[C] name> <YOUR NAME> \f[R] .fi .IP "3." 3 Select \[dq]s3\[dq] storage. .IP .nf \f[C] Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] \[dq]s3\[dq] [snip] Storage> s3 \f[R] .fi .IP "4." 3 Select IBM COS as the S3 Storage Provider. .IP .nf \f[C] 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 \[rs] \[dq]AWS\[dq] 2 / Choose this option to configure Storage to Ceph Systems \[rs] \[dq]Ceph\[dq] 3 / Choose this option to configure Storage to Dreamhost \[rs] \[dq]Dreamhost\[dq] 4 / Choose this option to the configure Storage to IBM COS S3 \[rs] \[dq]IBMCOS\[dq] 5 / Choose this option to the configure Storage to Minio \[rs] \[dq]Minio\[dq] Provider>4 \f[R] .fi .IP "5." 3 Enter the Access Key and Secret. .IP .nf \f[C] 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> <> \f[R] .fi .IP "6." 3 Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint address. .IP .nf \f[C] 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 \[rs] \[dq]s3-api.us-geo.objectstorage.softlayer.net\[dq] 2 / US Cross Region Dallas Endpoint \[rs] \[dq]s3-api.dal.us-geo.objectstorage.softlayer.net\[dq] 3 / US Cross Region Washington DC Endpoint \[rs] \[dq]s3-api.wdc-us-geo.objectstorage.softlayer.net\[dq] 4 / US Cross Region San Jose Endpoint \[rs] \[dq]s3-api.sjc-us-geo.objectstorage.softlayer.net\[dq] 5 / US Cross Region Private Endpoint \[rs] \[dq]s3-api.us-geo.objectstorage.service.networklayer.com\[dq] 6 / US Cross Region Dallas Private Endpoint \[rs] \[dq]s3-api.dal-us-geo.objectstorage.service.networklayer.com\[dq] 7 / US Cross Region Washington DC Private Endpoint \[rs] \[dq]s3-api.wdc-us-geo.objectstorage.service.networklayer.com\[dq] 8 / US Cross Region San Jose Private Endpoint \[rs] \[dq]s3-api.sjc-us-geo.objectstorage.service.networklayer.com\[dq] 9 / US Region East Endpoint \[rs] \[dq]s3.us-east.objectstorage.softlayer.net\[dq] 10 / US Region East Private Endpoint \[rs] \[dq]s3.us-east.objectstorage.service.networklayer.com\[dq] 11 / US Region South Endpoint [snip] 34 / Toronto Single Site Private Endpoint \[rs] \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] endpoint>1 \f[R] .fi .IP "7." 3 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 .IP .nf \f[C] 1 / US Cross Region Standard \[rs] \[dq]us-standard\[dq] 2 / US Cross Region Vault \[rs] \[dq]us-vault\[dq] 3 / US Cross Region Cold \[rs] \[dq]us-cold\[dq] 4 / US Cross Region Flex \[rs] \[dq]us-flex\[dq] 5 / US East Region Standard \[rs] \[dq]us-east-standard\[dq] 6 / US East Region Vault \[rs] \[dq]us-east-vault\[dq] 7 / US East Region Cold \[rs] \[dq]us-east-cold\[dq] 8 / US East Region Flex \[rs] \[dq]us-east-flex\[dq] 9 / US South Region Standard \[rs] \[dq]us-south-standard\[dq] 10 / US South Region Vault \[rs] \[dq]us-south-vault\[dq] [snip] 32 / Toronto Flex \[rs] \[dq]tor01-flex\[dq] location_constraint>1 \f[R] .fi .IP "9." 3 Specify a canned ACL. IBM Cloud (Storage) supports \[dq]public-read\[dq] and \[dq]private\[dq]. IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs. .IP .nf \f[C] 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 \[rs] \[dq]private\[dq] 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 \[rs] \[dq]public-read\[dq] 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 \[rs] \[dq]public-read-write\[dq] 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 \[rs] \[dq]authenticated-read\[dq] acl> 1 \f[R] .fi .IP "12." 4 Review the displayed configuration and accept to save the \[dq]remote\[dq] then quit. The config file should look like this .IP .nf \f[C] [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 \f[R] .fi .IP "13." 4 Execute rclone commands .IP .nf \f[C] 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 \f[R] .fi .SS IDrive e2 .PP Here is an example of making an IDrive e2 (https://www.idrive.com/e2/) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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, ... \[rs] (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 \[rs] (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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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\[aq]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\[aq]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). \[rs] (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \[rs] (public-read) / Owner gets FULL_CONTROL. 3 | The AllUsers group gets READ and WRITE access. | Granting this on a bucket is generally not recommended. \[rs] (public-read-write) / Owner gets FULL_CONTROL. 4 | The AuthenticatedUsers group gets READ access. \[rs] (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. \[rs] (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. \[rs] (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 \[dq]e2\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS IONOS Cloud .PP 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 \f[B]Manager resources\f[R] > \f[B]Object Storage Key Manager\f[R]. .PP Here is an example of a configuration. First, run \f[C]rclone config\f[R]. This will walk you through an interactive setup process. Type \f[C]n\f[R] to add the new remote, and then enter a name: .IP .nf \f[C] Enter name for new remote. name> ionos-fra \f[R] .fi .PP Type \f[C]s3\f[R] to choose the connection type: .IP .nf \f[C] 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, ... \[rs] (s3) [snip] Storage> s3 \f[R] .fi .PP Type \f[C]IONOS\f[R]: .IP .nf \f[C] 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 \[rs] (IONOS) [snip] provider> IONOS \f[R] .fi .PP Press Enter to choose the default option \f[C]Enter AWS credentials in the next step\f[R]: .IP .nf \f[C] 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (true) env_auth> \f[R] .fi .PP Enter your Access Key and Secret key. These can be retrieved in the Data Center Designer (https://dcd.ionos.com/), click on the menu \[lq]Manager resources\[rq] / \[dq]Object Storage Key Manager\[dq]. .IP .nf \f[C] 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 \f[R] .fi .PP Choose the region where your bucket is located: .IP .nf \f[C] 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 \[rs] (de) 2 / Berlin, Germany \[rs] (eu-central-2) 3 / Logrono, Spain \[rs] (eu-south-2) region> 2 \f[R] .fi .PP Choose the endpoint from the same region: .IP .nf \f[C] 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 \[rs] (s3-eu-central-1.ionoscloud.com) 2 / Berlin, Germany \[rs] (s3-eu-central-2.ionoscloud.com) 3 / Logrono, Spain \[rs] (s3-eu-south-2.ionoscloud.com) endpoint> 1 \f[R] .fi .PP Press Enter to choose the default option or choose the desired ACL setting: .IP .nf \f[C] 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\[aq]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\[aq]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). \[rs] (private) / Owner gets FULL_CONTROL. [snip] acl> \f[R] .fi .PP Press Enter to skip the advanced config: .IP .nf \f[C] Edit advanced config? y) Yes n) No (default) y/n> \f[R] .fi .PP Press Enter to save the configuration, and then \f[C]q\f[R] to quit the configuration process: .IP .nf \f[C] Configuration complete. Options: - type: s3 - provider: IONOS - access_key_id: YOUR_ACCESS_KEY - secret_access_key: YOUR_SECRET_KEY - endpoint: s3-eu-central-1.ionoscloud.com Keep this \[dq]ionos-fra\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Done! Now you can try some commands (for macOS, use \f[C]./rclone\f[R] instead of \f[C]rclone\f[R]). .IP "1)" 3 Create a bucket (the name must be unique within the whole IONOS S3) .IP .nf \f[C] rclone mkdir ionos-fra:my-bucket \f[R] .fi .IP "2)" 3 List available buckets .IP .nf \f[C] rclone lsd ionos-fra: \f[R] .fi .IP "4)" 3 Copy a file from local to remote .IP .nf \f[C] rclone copy /Users/file.txt ionos-fra:my-bucket \f[R] .fi .IP "3)" 3 List contents of a bucket .IP .nf \f[C] rclone ls ionos-fra:my-bucket \f[R] .fi .IP "5)" 3 Copy a file from remote to local .IP .nf \f[C] rclone copy ionos-fra:my-bucket/file.txt \f[R] .fi .SS Minio .PP Minio (https://minio.io/) is an object storage server built for cloud application developers and devops. .PP It is very easy to install and provides an S3 compatible server which can be used by rclone. .PP To use it, install Minio following the instructions here (https://docs.minio.io/docs/minio-quickstart-guide). .PP When it configures itself Minio will print something like this .IP .nf \f[C] Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 Region: us-east-1 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 Object API (Amazon S3 compatible): Go: https://docs.minio.io/docs/golang-client-quickstart-guide Java: https://docs.minio.io/docs/java-client-quickstart-guide Python: https://docs.minio.io/docs/python-client-quickstart-guide JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide Drive Capacity: 26 GiB Free, 165 GiB Total \f[R] .fi .PP These details need to go into \f[C]rclone config\f[R] like this. Note that it is important to put the region in as stated above. .IP .nf \f[C] env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> http://192.168.1.106:9000 location_constraint> server_side_encryption> \f[R] .fi .PP Which makes the config file look like this .IP .nf \f[C] [minio] type = s3 provider = Minio env_auth = false access_key_id = USWUXHGYZQYFYFFIT3RE secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us-east-1 endpoint = http://192.168.1.106:9000 location_constraint = server_side_encryption = \f[R] .fi .PP So once set up, for example, to copy files into a bucket .IP .nf \f[C] rclone copy /path/to/files minio:bucket \f[R] .fi .SS Outscale .PP OUTSCALE Object Storage (OOS) (https://en.outscale.com/storage/outscale-object-storage/) is an enterprise-grade, S3-compatible storage service provided by OUTSCALE, a brand of Dassault Syst\[`e]mes. For more information about OOS, see the official documentation (https://docs.outscale.com/en/userguide/OUTSCALE-Object-Storage-OOS.html). .PP Here is an example of an OOS configuration that you can paste into your rclone configuration file: .IP .nf \f[C] [outscale] type = s3 provider = Outscale env_auth = false access_key_id = ABCDEFGHIJ0123456789 secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX region = eu-west-2 endpoint = oos.eu-west-2.outscale.com acl = private \f[R] .fi .PP You can also run \f[C]rclone config\f[R] to go through the interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n \f[R] .fi .IP .nf \f[C] Enter name for new remote. name> outscale \f[R] .fi .IP .nf \f[C] Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] X / Amazon S3 Compliant Storage Providers including AWS, ...Outscale, ...and others \[rs] (s3) [snip] Storage> outscale \f[R] .fi .IP .nf \f[C] Option provider. Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / OUTSCALE Object Storage (OOS) \[rs] (Outscale) [snip] provider> Outscale \f[R] .fi .IP .nf \f[C] 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (true) env_auth> \f[R] .fi .IP .nf \f[C] 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> ABCDEFGHIJ0123456789 \f[R] .fi .IP .nf \f[C] 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> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \f[R] .fi .IP .nf \f[C] 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 / Paris, France \[rs] (eu-west-2) 2 / New Jersey, USA \[rs] (us-east-2) 3 / California, USA \[rs] (us-west-1) 4 / SecNumCloud, Paris, France \[rs] (cloudgouv-eu-west-1) 5 / Tokyo, Japan \[rs] (ap-northeast-1) region> 1 \f[R] .fi .IP .nf \f[C] Option endpoint. Endpoint for S3 API. Required when using an S3 clone. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Outscale EU West 2 (Paris) \[rs] (oos.eu-west-2.outscale.com) 2 / Outscale US east 2 (New Jersey) \[rs] (oos.us-east-2.outscale.com) 3 / Outscale EU West 1 (California) \[rs] (oos.us-west-1.outscale.com) 4 / Outscale SecNumCloud (Paris) \[rs] (oos.cloudgouv-eu-west-1.outscale.com) 5 / Outscale AP Northeast 1 (Japan) \[rs] (oos.ap-northeast-1.outscale.com) endpoint> 1 \f[R] .fi .IP .nf \f[C] 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\[aq]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\[aq]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). \[rs] (private) [snip] acl> 1 \f[R] .fi .IP .nf \f[C] Edit advanced config? y) Yes n) No (default) y/n> n \f[R] .fi .IP .nf \f[C] Configuration complete. Options: - type: s3 - provider: Outscale - access_key_id: ABCDEFGHIJ0123456789 - secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - endpoint: oos.eu-west-2.outscale.com Keep this \[dq]outscale\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Qiniu Cloud Object Storage (Kodo) .PP Qiniu Cloud Object Storage (Kodo) (https://www.qiniu.com/en/products/kodo), a completely independent-researched core technology which is proven by repeated customer experience has occupied absolute leading market leader position. Kodo can be widely applied to mass data management. .PP To configure access to Qiniu Kodo, follow the steps below: .IP "1." 3 Run \f[C]rclone config\f[R] and select \f[C]n\f[R] for a new remote. .IP .nf \f[C] rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n \f[R] .fi .IP "2." 3 Give the name of the configuration. For example, name it \[aq]qiniu\[aq]. .IP .nf \f[C] name> qiniu \f[R] .fi .IP "3." 3 Select \f[C]s3\f[R] storage. .IP .nf \f[C] Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] (s3) [snip] Storage> s3 \f[R] .fi .IP "4." 3 Select \f[C]Qiniu\f[R] provider. .IP .nf \f[C] Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \[rs] \[dq]AWS\[dq] [snip] 22 / Qiniu Object Storage (Kodo) \[rs] (Qiniu) [snip] provider> Qiniu \f[R] .fi .IP "5." 3 Enter your SecretId and SecretKey of Qiniu Kodo. .IP .nf \f[C] 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 (\[dq]false\[dq]). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). access_key_id> AKIDxxxxxxxxxx AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). secret_access_key> xxxxxxxxxxx \f[R] .fi .IP "6." 3 Select endpoint for Qiniu Kodo. This is the standard endpoint for different region. .IP .nf \f[C] / The default endpoint - a good choice if you are unsure. 1 | East China Region 1. | Needs location constraint cn-east-1. \[rs] (cn-east-1) / East China Region 2. 2 | Needs location constraint cn-east-2. \[rs] (cn-east-2) / North China Region 1. 3 | Needs location constraint cn-north-1. \[rs] (cn-north-1) / South China Region 1. 4 | Needs location constraint cn-south-1. \[rs] (cn-south-1) / North America Region. 5 | Needs location constraint us-north-1. \[rs] (us-north-1) / Southeast Asia Region 1. 6 | Needs location constraint ap-southeast-1. \[rs] (ap-southeast-1) / Northeast Asia Region 1. 7 | Needs location constraint ap-northeast-1. \[rs] (ap-northeast-1) [snip] endpoint> 1 Option endpoint. Endpoint for Qiniu Object Storage. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / East China Endpoint 1 \[rs] (s3-cn-east-1.qiniucs.com) 2 / East China Endpoint 2 \[rs] (s3-cn-east-2.qiniucs.com) 3 / North China Endpoint 1 \[rs] (s3-cn-north-1.qiniucs.com) 4 / South China Endpoint 1 \[rs] (s3-cn-south-1.qiniucs.com) 5 / North America Endpoint 1 \[rs] (s3-us-north-1.qiniucs.com) 6 / Southeast Asia Endpoint 1 \[rs] (s3-ap-southeast-1.qiniucs.com) 7 / Northeast Asia Endpoint 1 \[rs] (s3-ap-northeast-1.qiniucs.com) endpoint> 1 Option location_constraint. 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. Press Enter to leave empty. 1 / East China Region 1 \[rs] (cn-east-1) 2 / East China Region 2 \[rs] (cn-east-2) 3 / North China Region 1 \[rs] (cn-north-1) 4 / South China Region 1 \[rs] (cn-south-1) 5 / North America Region 1 \[rs] (us-north-1) 6 / Southeast Asia Region 1 \[rs] (ap-southeast-1) 7 / Northeast Asia Region 1 \[rs] (ap-northeast-1) location_constraint> 1 \f[R] .fi .IP "7." 3 Choose acl and storage class. .IP .nf \f[C] Note that this ACL is applied when server-side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \[rs] (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \[rs] (public-read) [snip] acl> 2 The storage class to use when storing new objects in Tencent COS. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Standard storage class \[rs] (STANDARD) 2 / Infrequent access storage mode \[rs] (LINE) 3 / Archive storage mode \[rs] (GLACIER) 4 / Deep archive storage mode \[rs] (DEEP_ARCHIVE) [snip] storage_class> 1 Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [qiniu] - type: s3 - provider: Qiniu - access_key_id: xxx - secret_access_key: xxx - region: cn-east-1 - endpoint: s3-cn-east-1.qiniucs.com - location_constraint: cn-east-1 - acl: public-read - storage_class: STANDARD -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== qiniu s3 \f[R] .fi .SS RackCorp .PP RackCorp Object Storage (https://www.rackcorp.com/storage/s3storage) is an S3 compatible object storage platform from your friendly cloud provider RackCorp. The service is fast, reliable, well priced and located in many strategic locations unserviced by others, to ensure you can maintain data sovereignty. .PP Before you can use RackCorp Object Storage, you\[aq]ll need to \[dq]sign up (https://www.rackcorp.com/signup)\[dq] for an account on our \[dq]portal (https://portal.rackcorp.com)\[dq]. Next you can create an \f[C]access key\f[R], a \f[C]secret key\f[R] and \f[C]buckets\f[R], in your location of choice with ease. These details are required for the next steps of configuration, when \f[C]rclone config\f[R] asks for your \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. .PP Your config should end up looking a bit like this: .IP .nf \f[C] [RCS3-demo-config] type = s3 provider = RackCorp env_auth = true access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = au-nsw endpoint = s3.rackcorp.com location_constraint = au-nsw \f[R] .fi .SS Rclone Serve S3 .PP Rclone can serve any remote over the S3 protocol. For details see the rclone serve s3 (https://rclone.org/commands/rclone_serve_s3/) documentation. .PP For example, to serve \f[C]remote:path\f[R] over s3, run the server like this: .IP .nf \f[C] rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path \f[R] .fi .PP This will be compatible with an rclone remote which is defined like this: .IP .nf \f[C] [serves3] type = s3 provider = Rclone endpoint = http://127.0.0.1:8080/ access_key_id = ACCESS_KEY_ID secret_access_key = SECRET_ACCESS_KEY use_multipart_uploads = false \f[R] .fi .PP Note that setting \f[C]use_multipart_uploads = false\f[R] is to work around a bug (https://rclone.org/commands/rclone_serve_s3/#bugs) which will be fixed in due course. .SS Scaleway .PP Scaleway (https://www.scaleway.com/object-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool. .PP Scaleway provides an S3 interface which can be configured for use with rclone like this: .IP .nf \f[C] [scaleway] type = s3 provider = Scaleway env_auth = false endpoint = s3.nl-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key = 1111111-2222-3333-44444-55555555555555 region = nl-ams location_constraint = nl-ams acl = private upload_cutoff = 5M chunk_size = 5M copy_cutoff = 5M \f[R] .fi .PP Scaleway Glacier (https://www.scaleway.com/en/glacier-cold-storage/) is the low-cost S3 Glacier alternative from Scaleway and it works the same way as on S3 by accepting the \[dq]GLACIER\[dq] \f[C]storage_class\f[R]. So you can configure your remote with the \f[C]storage_class = GLACIER\f[R] option to upload directly to Scaleway Glacier. Don\[aq]t forget that in this state you can\[aq]t read files back after, you will need to restore them to \[dq]STANDARD\[dq] storage_class first before being able to read them (see \[dq]restore\[dq] section above) .SS Seagate Lyve Cloud .PP Seagate Lyve Cloud (https://www.seagate.com/gb/en/services/cloud/storage/) is an S3 compatible object storage platform from Seagate (https://seagate.com/) intended for enterprise use. .PP Here is a config run through for a remote called \f[C]remote\f[R] - you may choose a different name of course. Note that to create an access key and secret key you will need to create a service account first. .IP .nf \f[C] $ rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote \f[R] .fi .PP Choose \f[C]s3\f[R] backend .IP .nf \f[C] 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, ... \[rs] (s3) [snip] Storage> s3 \f[R] .fi .PP Choose \f[C]LyveCloud\f[R] as S3 provider .IP .nf \f[C] Choose your S3 provider. Choose a number from below, or type in your own value. Press Enter to leave empty. [snip] XX / Seagate Lyve Cloud \[rs] (LyveCloud) [snip] provider> LyveCloud \f[R] .fi .PP Take the default (just press enter) to enter access key and secret in the config file. .IP .nf \f[C] 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (true) env_auth> \f[R] .fi .IP .nf \f[C] AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. access_key_id> XXX \f[R] .fi .IP .nf \f[C] AWS Secret Access Key (password). Leave blank for anonymous access or runtime credentials. Enter a value. Press Enter to leave empty. secret_access_key> YYY \f[R] .fi .PP Leave region blank .IP .nf \f[C] Region to connect to. Leave blank if you are using an S3 clone and you don\[aq]t have a region. Choose a number from below, or type in your own value. Press Enter to leave empty. / Use this if unsure. 1 | Will use v4 signatures and an empty region. \[rs] () / Use this only if v4 signatures don\[aq]t work. 2 | E.g. pre Jewel/v10 CEPH. \[rs] (other-v2-signature) region> \f[R] .fi .PP Choose an endpoint from the list .IP .nf \f[C] Endpoint for S3 API. Required when using an S3 clone. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Seagate Lyve Cloud US East 1 (Virginia) \[rs] (s3.us-east-1.lyvecloud.seagate.com) 2 / Seagate Lyve Cloud US West 1 (California) \[rs] (s3.us-west-1.lyvecloud.seagate.com) 3 / Seagate Lyve Cloud AP Southeast 1 (Singapore) \[rs] (s3.ap-southeast-1.lyvecloud.seagate.com) endpoint> 1 \f[R] .fi .PP Leave location constraint blank .IP .nf \f[C] 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> \f[R] .fi .PP Choose default ACL (\f[C]private\f[R]). .IP .nf \f[C] Canned ACL used when creating buckets and storing or copying objects. This ACL is used for creating objects and if bucket_acl isn\[aq]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\[aq]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). \[rs] (private) [snip] acl> \f[R] .fi .PP And the config file should end up looking like this: .IP .nf \f[C] [remote] type = s3 provider = LyveCloud access_key_id = XXX secret_access_key = YYY endpoint = s3.us-east-1.lyvecloud.seagate.com \f[R] .fi .SS SeaweedFS .PP SeaweedFS (https://github.com/chrislusf/seaweedfs/) is a distributed storage system for blobs, objects, files, and data lake, with O(1) disk seek and a scalable file metadata store. It has an S3 compatible object storage interface. SeaweedFS can also act as a gateway to remote S3 compatible object store (https://github.com/chrislusf/seaweedfs/wiki/Gateway-to-Remote-Object-Storage) to cache data and metadata with asynchronous write back, for fast local speed and minimize access cost. .PP Assuming the SeaweedFS are configured with \f[C]weed shell\f[R] as such: .IP .nf \f[C] > s3.bucket.create -name foo > s3.configure -access_key=any -secret_key=any -buckets=foo -user=me -actions=Read,Write,List,Tagging,Admin -apply { \[dq]identities\[dq]: [ { \[dq]name\[dq]: \[dq]me\[dq], \[dq]credentials\[dq]: [ { \[dq]accessKey\[dq]: \[dq]any\[dq], \[dq]secretKey\[dq]: \[dq]any\[dq] } ], \[dq]actions\[dq]: [ \[dq]Read:foo\[dq], \[dq]Write:foo\[dq], \[dq]List:foo\[dq], \[dq]Tagging:foo\[dq], \[dq]Admin:foo\[dq] ] } ] } \f[R] .fi .PP To use rclone with SeaweedFS, above configuration should end up with something like this in your config: .IP .nf \f[C] [seaweedfs_s3] type = s3 provider = SeaweedFS access_key_id = any secret_access_key = any endpoint = localhost:8333 \f[R] .fi .PP So once set up, for example to copy files into a bucket .IP .nf \f[C] rclone copy /path/to/files seaweedfs_s3:foo \f[R] .fi .SS Selectel .PP Selectel Cloud Storage (https://selectel.ru/services/cloud/storage/) is an S3 compatible storage system which features triple redundancy storage, automatic scaling, high availability and a comprehensive IAM system. .PP Selectel have a section on their website for configuring rclone (https://docs.selectel.ru/en/cloud/object-storage/tools/rclone/) which shows how to make the right API keys. .PP From rclone v1.69 Selectel is a supported operator - please choose the \f[C]Selectel\f[R] provider type. .PP Note that you should use \[dq]vHosted\[dq] access for the buckets (which is the recommended default), not \[dq]path style\[dq]. .PP You can use \f[C]rclone config\f[R] to make a new provider like this .IP .nf \f[C] 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> selectel 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 ..., Selectel, ... \[rs] (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 / Selectel Object Storage \[rs] (Selectel) [snip] provider> Selectel 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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 where your data stored. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / St. Petersburg \[rs] (ru-1) region> 1 Option endpoint. Endpoint for Selectel Object Storage. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Saint Petersburg \[rs] (s3.ru-1.storage.selcloud.ru) endpoint> 1 Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: s3 - provider: Selectel - access_key_id: ACCESS_KEY - secret_access_key: SECRET_ACCESS_KEY - region: ru-1 - endpoint: s3.ru-1.storage.selcloud.ru Keep this \[dq]selectel\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP And your config should end up looking like this: .IP .nf \f[C] [selectel] type = s3 provider = Selectel access_key_id = ACCESS_KEY secret_access_key = SECRET_ACCESS_KEY region = ru-1 endpoint = s3.ru-1.storage.selcloud.ru \f[R] .fi .SS Wasabi .PP Wasabi (https://wasabi.com) is a cloud-based object storage service for a broad range of applications and use cases. Wasabi is designed for individuals and organizations that require a high-performance, reliable, and secure data storage infrastructure at minimal cost. .PP Wasabi provides an S3 interface which can be configured for use with rclone like this. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password n/s> n name> wasabi 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, Minio, Liara) \[rs] \[dq]s3\[dq] [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 \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] 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. \[rs] \[dq]us-east-1\[dq] [snip] region> us-east-1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. endpoint> s3.wasabisys.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 US Region, Northern Virginia, or Pacific Northwest. \[rs] \[dq]\[dq] [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). \[rs] \[dq]private\[dq] [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 \[rs] \[dq]\[dq] 2 / AES256 \[rs] \[dq]AES256\[dq] 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 \[rs] \[dq]\[dq] 2 / Standard storage class \[rs] \[dq]STANDARD\[dq] 3 / Reduced redundancy storage class \[rs] \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard Infrequent Access storage class \[rs] \[dq]STANDARD_IA\[dq] storage_class> Remote config -------------------- [wasabi] env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = us-east-1 endpoint = s3.wasabisys.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 \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint = s3.wasabisys.com location_constraint = acl = server_side_encryption = storage_class = \f[R] .fi .SS Alibaba OSS .PP Here is an example of making an Alibaba Cloud (Aliyun) OSS (https://www.alibabacloud.com/product/oss/) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] \[dq]s3\[dq] [snip] Storage> s3 Choose your S3 provider. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \[rs] \[dq]AWS\[dq] 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun \[rs] \[dq]Alibaba\[dq] 3 / Ceph Object Storage \[rs] \[dq]Ceph\[dq] [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 (\[dq]false\[dq]). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). 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 (\[dq]\[dq]). secret_access_key> secretaccesskey Endpoint for OSS API. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / East China 1 (Hangzhou) \[rs] \[dq]oss-cn-hangzhou.aliyuncs.com\[dq] 2 / East China 2 (Shanghai) \[rs] \[dq]oss-cn-shanghai.aliyuncs.com\[dq] 3 / North China 1 (Qingdao) \[rs] \[dq]oss-cn-qingdao.aliyuncs.com\[dq] [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\[aq]t copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). \[rs] \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. \[rs] \[dq]public-read\[dq] / 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 (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Default \[rs] \[dq]\[dq] 2 / Standard storage class \[rs] \[dq]STANDARD\[dq] 3 / Archive storage mode. \[rs] \[dq]GLACIER\[dq] 4 / Infrequent access storage mode. \[rs] \[dq]STANDARD_IA\[dq] 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 \f[R] .fi .SS China Mobile Ecloud Elastic Object Storage (EOS) .PP 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: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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, ... \[rs] (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) \[rs] (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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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) \[rs] (eos-wuxi-1.cmecloud.cn) 2 / East China (Jinan) \[rs] (eos-jinan-1.cmecloud.cn) 3 / East China (Hangzhou) \[rs] (eos-ningbo-1.cmecloud.cn) 4 / East China (Shanghai-1) \[rs] (eos-shanghai-1.cmecloud.cn) 5 / Central China (Zhengzhou) \[rs] (eos-zhengzhou-1.cmecloud.cn) 6 / Central China (Changsha-1) \[rs] (eos-hunan-1.cmecloud.cn) 7 / Central China (Changsha-2) \[rs] (eos-zhuzhou-1.cmecloud.cn) 8 / South China (Guangzhou-2) \[rs] (eos-guangzhou-1.cmecloud.cn) 9 / South China (Guangzhou-3) \[rs] (eos-dongguan-1.cmecloud.cn) 10 / North China (Beijing-1) \[rs] (eos-beijing-1.cmecloud.cn) 11 / North China (Beijing-2) \[rs] (eos-beijing-2.cmecloud.cn) 12 / North China (Beijing-3) \[rs] (eos-beijing-4.cmecloud.cn) 13 / North China (Huhehaote) \[rs] (eos-huhehaote-1.cmecloud.cn) 14 / Southwest China (Chengdu) \[rs] (eos-chengdu-1.cmecloud.cn) 15 / Southwest China (Chongqing) \[rs] (eos-chongqing-1.cmecloud.cn) 16 / Southwest China (Guiyang) \[rs] (eos-guiyang-1.cmecloud.cn) 17 / Nouthwest China (Xian) \[rs] (eos-xian-1.cmecloud.cn) 18 / Yunnan China (Kunming) \[rs] (eos-yunnan.cmecloud.cn) 19 / Yunnan China (Kunming-2) \[rs] (eos-yunnan-2.cmecloud.cn) 20 / Tianjin China (Tianjin) \[rs] (eos-tianjin-1.cmecloud.cn) 21 / Jilin China (Changchun) \[rs] (eos-jilin-1.cmecloud.cn) 22 / Hubei China (Xiangyan) \[rs] (eos-hubei-1.cmecloud.cn) 23 / Jiangxi China (Nanchang) \[rs] (eos-jiangxi-1.cmecloud.cn) 24 / Gansu China (Lanzhou) \[rs] (eos-gansu-1.cmecloud.cn) 25 / Shanxi China (Taiyuan) \[rs] (eos-shanxi-1.cmecloud.cn) 26 / Liaoning China (Shenyang) \[rs] (eos-liaoning-1.cmecloud.cn) 27 / Hebei China (Shijiazhuang) \[rs] (eos-hebei-1.cmecloud.cn) 28 / Fujian China (Xiamen) \[rs] (eos-fujian-1.cmecloud.cn) 29 / Guangxi China (Nanning) \[rs] (eos-guangxi-1.cmecloud.cn) 30 / Anhui China (Huainan) \[rs] (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) \[rs] (wuxi1) 2 / East China (Jinan) \[rs] (jinan1) 3 / East China (Hangzhou) \[rs] (ningbo1) 4 / East China (Shanghai-1) \[rs] (shanghai1) 5 / Central China (Zhengzhou) \[rs] (zhengzhou1) 6 / Central China (Changsha-1) \[rs] (hunan1) 7 / Central China (Changsha-2) \[rs] (zhuzhou1) 8 / South China (Guangzhou-2) \[rs] (guangzhou1) 9 / South China (Guangzhou-3) \[rs] (dongguan1) 10 / North China (Beijing-1) \[rs] (beijing1) 11 / North China (Beijing-2) \[rs] (beijing2) 12 / North China (Beijing-3) \[rs] (beijing4) 13 / North China (Huhehaote) \[rs] (huhehaote1) 14 / Southwest China (Chengdu) \[rs] (chengdu1) 15 / Southwest China (Chongqing) \[rs] (chongqing1) 16 / Southwest China (Guiyang) \[rs] (guiyang1) 17 / Nouthwest China (Xian) \[rs] (xian1) 18 / Yunnan China (Kunming) \[rs] (yunnan) 19 / Yunnan China (Kunming-2) \[rs] (yunnan2) 20 / Tianjin China (Tianjin) \[rs] (tianjin1) 21 / Jilin China (Changchun) \[rs] (jilin1) 22 / Hubei China (Xiangyan) \[rs] (hubei1) 23 / Jiangxi China (Nanchang) \[rs] (jiangxi1) 24 / Gansu China (Lanzhou) \[rs] (gansu1) 25 / Shanxi China (Taiyuan) \[rs] (shanxi1) 26 / Liaoning China (Shenyang) \[rs] (liaoning1) 27 / Hebei China (Shijiazhuang) \[rs] (hebei1) 28 / Fujian China (Xiamen) \[rs] (fujian1) 29 / Guangxi China (Nanning) \[rs] (guangxi1) 30 / Anhui China (Huainan) \[rs] (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\[aq]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\[aq]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). \[rs] (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \[rs] (public-read) / Owner gets FULL_CONTROL. 3 | The AllUsers group gets READ and WRITE access. | Granting this on a bucket is generally not recommended. \[rs] (public-read-write) / Owner gets FULL_CONTROL. 4 | The AuthenticatedUsers group gets READ access. \[rs] (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 \[rs] () 2 / AES256 \[rs] (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 \[rs] () 2 / Standard storage class \[rs] (STANDARD) 3 / Archive storage mode \[rs] (GLACIER) 4 / Infrequent access storage mode \[rs] (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 \f[R] .fi .SS Leviia Cloud Object Storage .PP Leviia Object Storage (https://www.leviia.com/object-storage/), backup and secure your data in a 100% French cloud, independent of GAFAM.. .PP To configure access to Leviia, follow the steps below: .IP "1." 3 Run \f[C]rclone config\f[R] and select \f[C]n\f[R] for a new remote. .IP .nf \f[C] rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n \f[R] .fi .IP "2." 3 Give the name of the configuration. For example, name it \[aq]leviia\[aq]. .IP .nf \f[C] name> leviia \f[R] .fi .IP "3." 3 Select \f[C]s3\f[R] storage. .IP .nf \f[C] Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] (s3) [snip] Storage> s3 \f[R] .fi .IP "4." 3 Select \f[C]Leviia\f[R] provider. .IP .nf \f[C] Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \[rs] \[dq]AWS\[dq] [snip] 15 / Leviia Object Storage \[rs] (Leviia) [snip] provider> Leviia \f[R] .fi .IP "5." 3 Enter your SecretId and SecretKey of Leviia. .IP .nf \f[C] 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 (\[dq]false\[dq]). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). access_key_id> ZnIx.xxxxxxxxxxxxxxx AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). secret_access_key> xxxxxxxxxxx \f[R] .fi .IP "6." 3 Select endpoint for Leviia. .IP .nf \f[C] / The default endpoint 1 | Leviia. \[rs] (s3.leviia.com) [snip] endpoint> 1 \f[R] .fi .IP "7." 3 Choose acl. .IP .nf \f[C] Note that this ACL is applied when server-side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value / Owner gets FULL_CONTROL. 1 | No one else has access rights (default). \[rs] (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \[rs] (public-read) [snip] acl> 1 Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [leviia] - type: s3 - provider: Leviia - access_key_id: ZnIx.xxxxxxx - secret_access_key: xxxxxxxx - endpoint: s3.leviia.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 ==== ==== leviia s3 \f[R] .fi .SS Liara .PP Here is an example of making a Liara Object Storage (https://liara.ir/landing/object-storage) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password n/s> n name> Liara 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) \[rs] \[dq]s3\[dq] [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 \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] 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 1 | US Region, Northern Virginia, or Pacific Northwest. | Leave location constraint empty. \[rs] \[dq]us-east-1\[dq] [snip] region> Endpoint for S3 API. Leave blank if using Liara to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. endpoint> storage.iran.liara.space 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). \[rs] \[dq]private\[dq] [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 \[rs] \[dq]\[dq] 2 / AES256 \[rs] \[dq]AES256\[dq] 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 \[rs] \[dq]\[dq] 2 / Standard storage class \[rs] \[dq]STANDARD\[dq] storage_class> Remote config -------------------- [Liara] env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY endpoint = storage.iran.liara.space 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 \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [Liara] type = s3 provider = Liara env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint = storage.iran.liara.space location_constraint = acl = server_side_encryption = storage_class = \f[R] .fi .SS Linode .PP Here is an example of making a Linode Object Storage (https://www.linode.com/products/object-storage/) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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> linode 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, ...Linode, ...and others \[rs] (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 / Linode Object Storage \[rs] (Linode) [snip] provider> Linode 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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_ACCESS_KEY Option endpoint. Endpoint for Linode Object Storage API. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Amsterdam (Netherlands), nl-ams-1 \[rs] (nl-ams-1.linodeobjects.com) 2 / Atlanta, GA (USA), us-southeast-1 \[rs] (us-southeast-1.linodeobjects.com) 3 / Chennai (India), in-maa-1 \[rs] (in-maa-1.linodeobjects.com) 4 / Chicago, IL (USA), us-ord-1 \[rs] (us-ord-1.linodeobjects.com) 5 / Frankfurt (Germany), eu-central-1 \[rs] (eu-central-1.linodeobjects.com) 6 / Jakarta (Indonesia), id-cgk-1 \[rs] (id-cgk-1.linodeobjects.com) 7 / London 2 (Great Britain), gb-lon-1 \[rs] (gb-lon-1.linodeobjects.com) 8 / Los Angeles, CA (USA), us-lax-1 \[rs] (us-lax-1.linodeobjects.com) 9 / Madrid (Spain), es-mad-1 \[rs] (es-mad-1.linodeobjects.com) 10 / Melbourne (Australia), au-mel-1 \[rs] (au-mel-1.linodeobjects.com) 11 / Miami, FL (USA), us-mia-1 \[rs] (us-mia-1.linodeobjects.com) 12 / Milan (Italy), it-mil-1 \[rs] (it-mil-1.linodeobjects.com) 13 / Newark, NJ (USA), us-east-1 \[rs] (us-east-1.linodeobjects.com) 14 / Osaka (Japan), jp-osa-1 \[rs] (jp-osa-1.linodeobjects.com) 15 / Paris (France), fr-par-1 \[rs] (fr-par-1.linodeobjects.com) 16 / S\[~a]o Paulo (Brazil), br-gru-1 \[rs] (br-gru-1.linodeobjects.com) 17 / Seattle, WA (USA), us-sea-1 \[rs] (us-sea-1.linodeobjects.com) 18 / Singapore, ap-south-1 \[rs] (ap-south-1.linodeobjects.com) 19 / Singapore 2, sg-sin-1 \[rs] (sg-sin-1.linodeobjects.com) 20 / Stockholm (Sweden), se-sto-1 \[rs] (se-sto-1.linodeobjects.com) 21 / Washington, DC, (USA), us-iad-1 \[rs] (us-iad-1.linodeobjects.com) endpoint> 5 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\[aq]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\[aq]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). \[rs] (private) [snip] acl> Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: s3 - provider: Linode - access_key_id: ACCESS_KEY - secret_access_key: SECRET_ACCESS_KEY - endpoint: eu-central-1.linodeobjects.com Keep this \[dq]linode\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [linode] type = s3 provider = Linode access_key_id = ACCESS_KEY secret_access_key = SECRET_ACCESS_KEY endpoint = eu-central-1.linodeobjects.com \f[R] .fi .SS Magalu .PP Here is an example of making a Magalu Object Storage (https://magalu.cloud/object-storage/) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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> magalu 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, ...Magalu, ...and others \[rs] (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 / Magalu Object Storage \[rs] (Magalu) [snip] provider> Magalu 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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 endpoint. Endpoint for Magalu Object Storage API. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / S\[~a]o Paulo, SP (BR), br-se1 \[rs] (br-se1.magaluobjects.com) 2 / Fortaleza, CE (BR), br-ne1 \[rs] (br-ne1.magaluobjects.com) endpoint> 2 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\[aq]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\[aq]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). \[rs] (private) [snip] acl> Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: s3 - provider: magalu - access_key_id: ACCESS_KEY - secret_access_key: SECRET_ACCESS_KEY - endpoint: br-ne1.magaluobjects.com Keep this \[dq]magalu\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [magalu] type = s3 provider = Magalu access_key_id = ACCESS_KEY secret_access_key = SECRET_ACCESS_KEY endpoint = br-ne1.magaluobjects.com \f[R] .fi .SS ArvanCloud .PP 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. .PP ArvanCloud provides an S3 interface which can be configured for use with rclone like this. .IP .nf \f[C] 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) \[rs] \[dq]s3\[dq] [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 \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] 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. \[rs] \[dq]us-east-1\[dq] [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. \[rs] \[dq]\[dq] [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). \[rs] \[dq]private\[dq] [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 \[rs] \[dq]\[dq] 2 / AES256 \[rs] \[dq]AES256\[dq] 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 \[rs] \[dq]\[dq] 2 / Standard storage class \[rs] \[dq]STANDARD\[dq] 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 \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [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 = \f[R] .fi .SS Tencent COS .PP Tencent Cloud Object Storage (COS) (https://intl.cloud.tencent.com/product/cos) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost. .PP To configure access to Tencent COS, follow the steps below: .IP "1." 3 Run \f[C]rclone config\f[R] and select \f[C]n\f[R] for a new remote. .IP .nf \f[C] rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n \f[R] .fi .IP "2." 3 Give the name of the configuration. For example, name it \[aq]cos\[aq]. .IP .nf \f[C] name> cos \f[R] .fi .IP "3." 3 Select \f[C]s3\f[R] storage. .IP .nf \f[C] Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] \[dq]s3\[dq] [snip] Storage> s3 \f[R] .fi .IP "4." 3 Select \f[C]TencentCOS\f[R] provider. .IP .nf \f[C] Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3 \[rs] \[dq]AWS\[dq] [snip] 11 / Tencent Cloud Object Storage (COS) \[rs] \[dq]TencentCOS\[dq] [snip] provider> TencentCOS \f[R] .fi .IP "5." 3 Enter your SecretId and SecretKey of Tencent Cloud. .IP .nf \f[C] 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 (\[dq]false\[dq]). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). access_key_id> AKIDxxxxxxxxxx AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). secret_access_key> xxxxxxxxxxx \f[R] .fi .IP "6." 3 Select endpoint for Tencent COS. This is the standard endpoint for different region. .IP .nf \f[C] 1 / Beijing Region. \[rs] \[dq]cos.ap-beijing.myqcloud.com\[dq] 2 / Nanjing Region. \[rs] \[dq]cos.ap-nanjing.myqcloud.com\[dq] 3 / Shanghai Region. \[rs] \[dq]cos.ap-shanghai.myqcloud.com\[dq] 4 / Guangzhou Region. \[rs] \[dq]cos.ap-guangzhou.myqcloud.com\[dq] [snip] endpoint> 4 \f[R] .fi .IP "7." 3 Choose acl and storage class. .IP .nf \f[C] Note that this ACL is applied when server-side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Owner gets Full_CONTROL. No one else has access rights (default). \[rs] \[dq]default\[dq] [snip] acl> 1 The storage class to use when storing new objects in Tencent COS. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Default \[rs] \[dq]\[dq] [snip] storage_class> 1 Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [cos] type = s3 provider = TencentCOS env_auth = false access_key_id = xxx secret_access_key = xxx endpoint = cos.ap-guangzhou.myqcloud.com acl = default -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== cos s3 \f[R] .fi .SS Netease NOS .PP For Netease NOS configure as per the configurator \f[C]rclone config\f[R] setting the provider \f[C]Netease\f[R]. This will automatically set \f[C]force_path_style = false\f[R] which is necessary for it to run properly. .SS Petabox .PP Here is an example of making a Petabox (https://petabox.io/) configuration. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password n/s> n Enter name for new remote. name> My Petabox Storage 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, ... \[rs] \[dq]s3\[dq] [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 / Petabox Object Storage \[rs] (Petabox) [snip] provider> Petabox 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. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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 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 / US East (N. Virginia) \[rs] (us-east-1) 2 / Europe (Frankfurt) \[rs] (eu-central-1) 3 / Asia Pacific (Singapore) \[rs] (ap-southeast-1) 4 / Middle East (Bahrain) \[rs] (me-south-1) 5 / South America (S\[~a]o Paulo) \[rs] (sa-east-1) region> 1 Option endpoint. Endpoint for Petabox S3 Object Storage. Specify the endpoint from the same region. Choose a number from below, or type in your own value. 1 / US East (N. Virginia) \[rs] (s3.petabox.io) 2 / US East (N. Virginia) \[rs] (s3.us-east-1.petabox.io) 3 / Europe (Frankfurt) \[rs] (s3.eu-central-1.petabox.io) 4 / Asia Pacific (Singapore) \[rs] (s3.ap-southeast-1.petabox.io) 5 / Middle East (Bahrain) \[rs] (s3.me-south-1.petabox.io) 6 / South America (S\[~a]o Paulo) \[rs] (s3.sa-east-1.petabox.io) 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\[aq]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\[aq]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). \[rs] (private) / Owner gets FULL_CONTROL. 2 | The AllUsers group gets READ access. \[rs] (public-read) / Owner gets FULL_CONTROL. 3 | The AllUsers group gets READ and WRITE access. | Granting this on a bucket is generally not recommended. \[rs] (public-read-write) / Owner gets FULL_CONTROL. 4 | The AuthenticatedUsers group gets READ access. \[rs] (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. \[rs] (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. \[rs] (bucket-owner-full-control) acl> 1 Edit advanced config? y) Yes n) No (default) y/n> No Configuration complete. Options: - type: s3 - provider: Petabox - access_key_id: YOUR_ACCESS_KEY_ID - secret_access_key: YOUR_SECRET_ACCESS_KEY - region: us-east-1 - endpoint: s3.petabox.io Keep this \[dq]My Petabox Storage\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This will leave the config file looking like this. .IP .nf \f[C] [My Petabox Storage] type = s3 provider = Petabox access_key_id = YOUR_ACCESS_KEY_ID secret_access_key = YOUR_SECRET_ACCESS_KEY region = us-east-1 endpoint = s3.petabox.io \f[R] .fi .SS Storj .PP Storj is a decentralized cloud storage which can be used through its native protocol or an S3 compatible gateway. .PP The S3 compatible gateway is configured using \f[C]rclone config\f[R] with a type of \f[C]s3\f[R] and with a provider name of \f[C]Storj\f[R]. Here is an example run of the configurator. .IP .nf \f[C] Type of storage to configure. 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 boolean value (true or false). Press Enter for the default (false). 1 / Enter AWS credentials in the next step. \[rs] (false) 2 / Get AWS credentials from the environment (env vars or IAM). \[rs] (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> XXXX (as shown when creating the access grant) 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> XXXX (as shown when creating the access grant) Option endpoint. Endpoint of the Shared Gateway. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / EU1 Shared Gateway \[rs] (gateway.eu1.storjshare.io) 2 / US1 Shared Gateway \[rs] (gateway.us1.storjshare.io) 3 / Asia-Pacific Shared Gateway \[rs] (gateway.ap1.storjshare.io) endpoint> 1 (as shown when creating the access grant) Edit advanced config? y) Yes n) No (default) y/n> n \f[R] .fi .PP Note that s3 credentials are generated when you create an access grant (https://docs.storj.io/dcs/api-reference/s3-compatible-gateway#usage). .SS Backend quirks .IP \[bu] 2 \f[C]--chunk-size\f[R] is forced to be 64 MiB or greater. This will use more memory than the default of 5 MiB. .IP \[bu] 2 Server side copy is disabled as it isn\[aq]t currently supported in the gateway. .IP \[bu] 2 GetTier and SetTier are not supported. .SS Backend bugs .PP Due to issue #39 (https://github.com/storj/gateway-mt/issues/39) uploading multipart files via the S3 gateway causes them to lose their metadata. For rclone\[aq]s purpose this means that the modification time is not stored, nor is any MD5SUM (if one is available from the source). .PP This has the following consequences: .IP \[bu] 2 Using \f[C]rclone rcat\f[R] will fail as the medatada doesn\[aq]t match after upload .IP \[bu] 2 Uploading files with \f[C]rclone mount\f[R] will fail for the same reason .RS 2 .IP \[bu] 2 This can worked around by using \f[C]--vfs-cache-mode writes\f[R] or \f[C]--vfs-cache-mode full\f[R] or setting \f[C]--s3-upload-cutoff\f[R] large .RE .IP \[bu] 2 Files uploaded via a multipart upload won\[aq]t have their modtimes .RS 2 .IP \[bu] 2 This will mean that \f[C]rclone sync\f[R] will likely keep trying to upload files bigger than \f[C]--s3-upload-cutoff\f[R] .IP \[bu] 2 This can be worked around with \f[C]--checksum\f[R] or \f[C]--size-only\f[R] or setting \f[C]--s3-upload-cutoff\f[R] large .IP \[bu] 2 The maximum value for \f[C]--s3-upload-cutoff\f[R] is 5GiB though .RE .PP One general purpose workaround is to set \f[C]--s3-upload-cutoff 5G\f[R]. This means that rclone will upload files smaller than 5GiB as single parts. Note that this can be set in the config file with \f[C]upload_cutoff = 5G\f[R] or configured in the advanced settings. If you regularly transfer files larger than 5G then using \f[C]--checksum\f[R] or \f[C]--size-only\f[R] in \f[C]rclone sync\f[R] is the recommended workaround. .SS Comparison with the native protocol .PP Use the the native protocol to take advantage of client-side encryption as well as to achieve the best possible download performance. Uploads will be erasure-coded locally, thus a 1gb upload will result in 2.68gb of data being uploaded to storage nodes across the network. .PP Use this backend and the S3 compatible Hosted Gateway to increase upload performance and reduce the load on your systems and network. Uploads will be encrypted and erasure-coded server-side, thus a 1GB upload will result in only in 1GB of data being uploaded to storage nodes across the network. .PP For more detailed comparison please check the documentation of the storj backend. .SS Memory usage {memory} .PP The most common cause of rclone using lots of memory is a single directory with millions of files in. Despite s3 not really having the concepts of directories, rclone does the sync on a directory by directory basis to be compatible with normal filing systems. .PP Rclone loads each directory into memory as rclone objects. Each rclone object takes 0.5k-1k of memory, so approximately 1GB per 1,000,000 files, and the sync for that directory does not begin until it is entirely loaded in memory. So the sync can take a long time to start for large directories. .PP To sync a directory with 100,000,000 files in you would need approximately 100 GB of memory. At some point the amount of memory becomes difficult to provide so there is a workaround for this (https://github.com/rclone/rclone/wiki/Big-syncs-with-millions-of-files) which involves a bit of scripting. .PP At some point rclone will gain a sync mode which is effectively this workaround but built in to rclone. .SS Limitations .PP \f[C]rclone about\f[R] is not supported by the S3 backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SS Synology C2 Object Storage .PP Synology C2 Object Storage (https://c2.synology.com/en-global/object-storage/overview) provides a secure, S3-compatible, and cost-effective cloud storage solution without API request, download fees, and deletion penalty. .PP The S3 compatible gateway is configured using \f[C]rclone config\f[R] with a type of \f[C]s3\f[R] and with a provider name of \f[C]Synology\f[R]. Here is an example run of the configurator. .PP First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] 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.1 name> syno Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value XX / Amazon S3 Compliant Storage Providers including AWS, ... \[rs] \[dq]s3\[dq] Storage> s3 Choose your S3 provider. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 24 / Synology C2 Object Storage \[rs] (Synology) provider> Synology 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 (\[dq]false\[dq]). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step \[rs] \[dq]false\[dq] 2 / Get AWS credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (\[dq]\[dq]). 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 (\[dq]\[dq]). secret_access_key> secretaccesskey Region where your data stored. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Europe Region 1 \[rs] (eu-001) 2 / Europe Region 2 \[rs] (eu-002) 3 / US Region 1 \[rs] (us-001) 4 / US Region 2 \[rs] (us-002) 5 / Asia (Taiwan) \[rs] (tw-001) region > 1 Option endpoint. Endpoint for Synology C2 Object Storage API. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / EU Endpoint 1 \[rs] (eu-001.s3.synologyc2.net) 2 / US Endpoint 1 \[rs] (us-001.s3.synologyc2.net) 3 / TW Endpoint 1 \[rs] (tw-001.s3.synologyc2.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> Edit advanced config? (y/n) y) Yes n) No y/n> y Option no_check_bucket. If set, don\[aq]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. Enter a boolean value (true or false). Press Enter for the default (true). no_check_bucket> true Configuration complete. Options: - type: s3 - provider: Synology - region: eu-001 - endpoint: eu-001.s3.synologyc2.net - no_check_bucket: true Keep this \[dq]syno\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SH Backblaze B2 .PP B2 is Backblaze\[aq]s cloud storage system (https://www.backblaze.com/cloud-storage). .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .SS Configuration .PP Here is an example of making a b2 configuration. First run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. To authenticate you will either need your Account ID (a short hex number) and Master Application Key (a long hex number) OR an Application Key, which is the recommended method. See below for further details on generating and using an Application Key. .IP .nf \f[C] No remotes found, make a new one? n) New remote q) Quit config n/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Backblaze B2 \[rs] \[dq]b2\[dq] [snip] Storage> b2 Account ID or Application Key ID account> 123456789abc Application Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the service - leave blank normally. endpoint> Remote config Configuration complete. Options: - type: b2 - account: 123456789abc - key: 0123456789abcdef0123456789abcdef0123456789 - endpoint: Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all buckets .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Create a new bucket .IP .nf \f[C] rclone mkdir remote:bucket \f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] rclone ls remote:bucket \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:bucket \f[R] .fi .SS Application Keys .PP B2 supports multiple Application Keys for different access permission to B2 Buckets (https://www.backblaze.com/docs/cloud-storage-application-keys). .PP You can use these with rclone too; you will need to use rclone version 1.43 or later. .PP Follow Backblaze\[aq]s docs to create an Application Key with the required permission and add the \f[C]applicationKeyId\f[R] as the \f[C]account\f[R] and the \f[C]Application Key\f[R] itself as the \f[C]key\f[R]. .PP Note that you must put the \f[I]applicationKeyId\f[R] as the \f[C]account\f[R] \[en] you can\[aq]t use the master Account ID. If you try then B2 will return 401 errors. .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .SS Modification times .PP The modification time is stored as metadata on the object as \f[C]X-Bz-Info-src_last_modified_millis\f[R] as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time. .PP Modified times are used in syncing and are fully supported. Note that if a modification time needs to be updated on an object then it will create a new version of the object. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .PP Note that in 2020-05 Backblaze started allowing \ characters in file names. Rclone hasn\[aq]t changed its encoding as this could cause syncs to re-transfer files. If you want rclone not to replace \ then see the \f[C]--b2-encoding\f[R] flag below and remove the \f[C]BackSlash\f[R] from the string. This can be set in the config. .SS SHA1 checksums .PP The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process. .PP Large files (bigger than the limit in \f[C]--b2-upload-cutoff\f[R]) which are uploaded in chunks will store their SHA1 on the object as \f[C]X-Bz-Info-large_file_sha1\f[R] as recommended by Backblaze. .PP For a large file to be uploaded with an SHA1 checksum, the source needs to support SHA1 checksums. The local disk supports SHA1 checksums so large file transfers from local disk will have an SHA1. See the overview (https://rclone.org/overview/#features) for exactly which remotes support SHA1. .PP Sources which don\[aq]t support SHA1, in particular \f[C]crypt\f[R] will upload large files without SHA1 checksums. This may be fixed in the future (see #1767 (https://github.com/rclone/rclone/issues/1767)). .PP Files sizes below \f[C]--b2-upload-cutoff\f[R] will always have an SHA1 regardless of the source. .SS Transfers .PP Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about \f[C]--transfers 32\f[R] though higher numbers may be used for a slight speed improvement. The optimum number for you may vary depending on your hardware, how big the files are, how much you want to load your computer, etc. The default of \f[C]--transfers 4\f[R] is definitely too low for Backblaze B2 though. .PP Note that uploading big files (bigger than 200 MiB by default) will use a 96 MiB RAM buffer by default. There can be at most \f[C]--transfers\f[R] of these in use at any moment, so this sets the upper limit on the memory used. .SS Versions .PP The default setting of B2 is to keep old versions of files. This means when rclone uploads a new version of a file it creates a new version of it (https://www.backblaze.com/docs/cloud-storage-file-versions). Likewise when you delete a file, the old version will be marked hidden and still be available. .PP Whether B2 keeps old versions of files or not can be adjusted on a per bucket basis using the \[dq]Lifecycle settings\[dq] on the B2 control panel or when creating the bucket using the --b2-lifecycle flag or after creation using the rclone backend lifecycle command. .PP You may opt in to a \[dq]hard delete\[dq] of files with the \f[C]--b2-hard-delete\f[R] flag which permanently removes files on deletion instead of hiding them. .PP Old versions of files, where available, are visible using the \f[C]--b2-versions\f[R] flag. .PP It is also possible to view a bucket as it was at a certain point in time, using the \f[C]--b2-version-at\f[R] 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. .PP If you wish to remove all the old versions, and unfinished large file uploads, then you can use the \f[C]rclone cleanup remote:bucket\f[R] command which will delete all the old 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. \f[C]rclone cleanup remote:bucket/path/to/stuff\f[R]. .PP Note that \f[C]cleanup\f[R] will remove partially uploaded files from the bucket if they are more than a day old. If you want more control over the expiry date then run \f[C]rclone backend cleanup b2:bucket -o max-age=1h\f[R] to remove all unfinished large file uploads older than one hour, leaving old versions intact. .PP If you wish to remove all the old versions, leaving current files and unfinished large files intact, then you can use the \f[C]rclone backend cleanup-hidden remote:bucket\f[R] command. You can also supply a path and only old versions under that path will be deleted, e.g. \f[C]rclone backend cleanup-hidden remote:bucket/path/to/stuff\f[R]. .PP When you \f[C]purge\f[R] a bucket, the current and the old versions will be deleted then the bucket will be deleted. .PP However \f[C]delete\f[R] will cause the current versions of the files to become hidden old versions. .PP Here is a session showing the listing and retrieval of an old version followed by a \f[C]cleanup\f[R] of the old versions. .PP Show current version and all the versions with \f[C]--b2-versions\f[R] flag. .IP .nf \f[C] $ rclone -q ls b2:cleanup-test 9 one.txt $ rclone -q --b2-versions ls b2: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 \f[R] .fi .PP Retrieve an old version .IP .nf \f[C] $ rclone -q --b2-versions copy b2: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 \f[R] .fi .PP Clean up all the old versions and show that they\[aq]ve gone. .IP .nf \f[C] $ rclone -q cleanup b2:cleanup-test $ rclone -q ls b2:cleanup-test 9 one.txt $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt \f[R] .fi .SS Versions naming caveat .PP When using \f[C]--b2-versions\f[R] flag rclone is relying on the file name to work out whether the objects are versions or not. Versions\[aq] names are created by inserting timestamp between file name and its extension. .IP .nf \f[C] 9 file.txt 8 file-v2023-07-17-161032-000.txt 16 file-v2023-06-15-141003-000.txt \f[R] .fi .PP If there are real files present with the same names as versions, then behaviour of \f[C]--b2-versions\f[R] can be unpredictable. .SS Data usage .PP It is useful to know how many requests are sent to the server in different scenarios. .PP All copy commands send the following 4 requests: .IP .nf \f[C] /b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket /b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names \f[R] .fi .PP The \f[C]b2_list_file_names\f[R] request will be sent once for every 1k files in the remote path, providing the checksum and modification time of the listed files. As of version 1.33 issue #818 (https://github.com/rclone/rclone/issues/818) causes extra requests to be sent when using B2 with Crypt. When a copy operation does not require any files to be uploaded, no more requests will be sent. .PP Uploading files that do not require chunking, will send 2 requests per file upload: .IP .nf \f[C] /b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ \f[R] .fi .PP Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk: .IP .nf \f[C] /b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url /b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file \f[R] .fi .SS Versions .PP Versions can be viewed with the \f[C]--b2-versions\f[R] flag. When it is set rclone will show and act on older versions of files. For example .PP Listing without \f[C]--b2-versions\f[R] .IP .nf \f[C] $ rclone -q ls b2:cleanup-test 9 one.txt \f[R] .fi .PP And with .IP .nf \f[C] $ rclone -q --b2-versions ls b2: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 \f[R] .fi .PP Showing that the current version is unchanged but older versions can be seen. These have the UTC date that they were uploaded to the server to the nearest millisecond appended to them. .PP Note that when using \f[C]--b2-versions\f[R] no file write operations are permitted, so you can\[aq]t upload files or delete them. .SS B2 and rclone link .PP Rclone supports generating file share links for private B2 buckets. They can either be for a file for example: .IP .nf \f[C] \&./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx \f[R] .fi .PP or if run on a directory you will get: .IP .nf \f[C] \&./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx \f[R] .fi .PP you can then use the authorization token (the part of the url from the \f[C]?Authorization=\f[R] on) on any file path under that directory. For example: .IP .nf \f[C] https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx \f[R] .fi .SS Standard options .PP Here are the Standard options specific to b2 (Backblaze B2). .SS --b2-account .PP Account ID or Application Key ID. .PP Properties: .IP \[bu] 2 Config: account .IP \[bu] 2 Env Var: RCLONE_B2_ACCOUNT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --b2-key .PP Application Key. .PP Properties: .IP \[bu] 2 Config: key .IP \[bu] 2 Env Var: RCLONE_B2_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --b2-hard-delete .PP Permanently delete files on remote removal, otherwise hide files. .PP Properties: .IP \[bu] 2 Config: hard_delete .IP \[bu] 2 Env Var: RCLONE_B2_HARD_DELETE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS Advanced options .PP Here are the Advanced options specific to b2 (Backblaze B2). .SS --b2-endpoint .PP Endpoint for the service. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_B2_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --b2-test-mode .PP A flag string for X-Bz-Test-Mode header for debugging. .PP This is for debugging purposes only. Setting it to one of the strings below will cause b2 to return specific errors: .IP \[bu] 2 \[dq]fail_some_uploads\[dq] .IP \[bu] 2 \[dq]expire_some_account_authorization_tokens\[dq] .IP \[bu] 2 \[dq]force_cap_exceeded\[dq] .PP These will be set in the \[dq]X-Bz-Test-Mode\[dq] header which is documented in the b2 integrations checklist (https://www.backblaze.com/docs/cloud-storage-integration-checklist). .PP Properties: .IP \[bu] 2 Config: test_mode .IP \[bu] 2 Env Var: RCLONE_B2_TEST_MODE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --b2-versions .PP Include old versions in directory listings. .PP Note that when using this no file write operations are permitted, so you can\[aq]t upload files or delete them. .PP Properties: .IP \[bu] 2 Config: versions .IP \[bu] 2 Env Var: RCLONE_B2_VERSIONS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --b2-version-at .PP Show file versions as they were at the specified time. .PP Note that when using this no file write operations are permitted, so you can\[aq]t upload files or delete them. .PP Properties: .IP \[bu] 2 Config: version_at .IP \[bu] 2 Env Var: RCLONE_B2_VERSION_AT .IP \[bu] 2 Type: Time .IP \[bu] 2 Default: off .SS --b2-upload-cutoff .PP Cutoff for switching to chunked upload. .PP Files above this size will be uploaded in chunks of \[dq]--b2-chunk-size\[dq]. .PP This value should be set no larger than 4.657 GiB (== 5 GB). .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_B2_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 200Mi .SS --b2-copy-cutoff .PP Cutoff for switching to multipart copy. .PP Any files larger than this that need to be server-side copied will be copied in chunks of this size. .PP The minimum is 0 and the maximum is 4.6 GiB. .PP Properties: .IP \[bu] 2 Config: copy_cutoff .IP \[bu] 2 Env Var: RCLONE_B2_COPY_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4Gi .SS --b2-chunk-size .PP Upload chunk size. .PP When uploading large files, chunk the file into this size. .PP Must fit in memory. These chunks are buffered in memory and there might a maximum of \[dq]--transfers\[dq] chunks in progress at once. .PP 5,000,000 Bytes is the minimum size. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_B2_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 96Mi .SS --b2-upload-concurrency .PP Concurrency for multipart uploads. .PP This is the number of chunks of the same file that are uploaded concurrently. .PP Note that chunks are stored in memory and there may be up to \[dq]--transfers\[dq] * \[dq]--b2-upload-concurrency\[dq] chunks stored at once in memory. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_B2_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 4 .SS --b2-disable-checksum .PP Disable checksums for large (> upload cutoff) files. .PP Normally rclone will calculate the SHA1 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. .PP Properties: .IP \[bu] 2 Config: disable_checksum .IP \[bu] 2 Env Var: RCLONE_B2_DISABLE_CHECKSUM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --b2-download-url .PP Custom endpoint for downloads. .PP This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. Rclone works with private buckets by sending an \[dq]Authorization\[dq] header. If the custom endpoint rewrites the requests for authentication, e.g., in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze. .PP The URL provided here SHOULD have the protocol and SHOULD NOT have a trailing slash or specify the /file/bucket subpath as rclone will request files with \[dq]{download_url}/file/{bucket_name}/{path}\[dq]. .PP Example: > https://mysubdomain.mydomain.tld (No trailing \[dq]/\[dq], \[dq]file\[dq] or \[dq]bucket\[dq]) .PP Properties: .IP \[bu] 2 Config: download_url .IP \[bu] 2 Env Var: RCLONE_B2_DOWNLOAD_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --b2-download-auth-duration .PP Time before the public link authorization token will expire in s or suffix ms|s|m|h|d. .PP This is used in combination with \[dq]rclone link\[dq] for making files accessible to the public and sets the duration before the download authorization token will expire. .PP The minimum value is 1 second. The maximum value is one week. .PP Properties: .IP \[bu] 2 Config: download_auth_duration .IP \[bu] 2 Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1w .SS --b2-memory-pool-flush-time .PP How often internal memory buffer pools will be flushed. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_flush_time .IP \[bu] 2 Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --b2-memory-pool-use-mmap .PP Whether to use mmap buffers in internal memory pool. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_use_mmap .IP \[bu] 2 Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --b2-lifecycle .PP Set the number of days deleted files should be kept when creating a bucket. .PP On bucket creation, this parameter is used to create a lifecycle rule for the entire bucket. .PP If lifecycle is 0 (the default) it does not create a lifecycle rule so the default B2 behaviour applies. This is to create versions of files on delete and overwrite and to keep them indefinitely. .PP If lifecycle is >0 then it creates a single rule setting the number of days before a file that is deleted or overwritten is deleted permanently. This is known as daysFromHidingToDeleting in the b2 docs. .PP The minimum value for this parameter is 1 day. .PP You can also enable hard_delete in the config also which will mean deletions won\[aq]t cause versions but overwrites will still cause versions to be made. .PP See: rclone backend lifecycle for setting lifecycles after bucket creation. .PP Properties: .IP \[bu] 2 Config: lifecycle .IP \[bu] 2 Env Var: RCLONE_B2_LIFECYCLE .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 0 .SS --b2-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_B2_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS --b2-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_B2_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Backend commands .PP Here are the commands specific to the b2 backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS lifecycle .PP Read or set the lifecycle for a bucket .IP .nf \f[C] rclone backend lifecycle remote: [options] [<arguments>+] \f[R] .fi .PP This command can be used to read or set the lifecycle for a bucket. .PP Usage Examples: .PP To show the current lifecycle rules: .IP .nf \f[C] rclone backend lifecycle b2:bucket \f[R] .fi .PP This will dump something like this showing the lifecycle rules. .IP .nf \f[C] [ { \[dq]daysFromHidingToDeleting\[dq]: 1, \[dq]daysFromUploadingToHiding\[dq]: null, \[dq]daysFromStartingToCancelingUnfinishedLargeFiles\[dq]: null, \[dq]fileNamePrefix\[dq]: \[dq]\[dq] } ] \f[R] .fi .PP If there are no lifecycle rules (the default) then it will just return []. .PP To reset the current lifecycle rules: .IP .nf \f[C] rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30 rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1 \f[R] .fi .PP This will run and then print the new lifecycle rules as above. .PP Rclone only lets you set lifecycles for the whole bucket with the fileNamePrefix = \[dq]\[dq]. .PP You can\[aq]t disable versioning with B2. The best you can do is to set the daysFromHidingToDeleting to 1 day. You can enable hard_delete in the config also which will mean deletions won\[aq]t cause versions but overwrites will still cause versions to be made. .IP .nf \f[C] rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1 \f[R] .fi .PP See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules .PP Options: .IP \[bu] 2 \[dq]daysFromHidingToDeleting\[dq]: After a file has been hidden for this many days it is deleted. 0 is off. .IP \[bu] 2 \[dq]daysFromStartingToCancelingUnfinishedLargeFiles\[dq]: Cancels any unfinished large file versions after this many days .IP \[bu] 2 \[dq]daysFromUploadingToHiding\[dq]: This many days after uploading a file is hidden .SS cleanup .PP Remove unfinished large file uploads. .IP .nf \f[C] rclone backend cleanup remote: [options] [<arguments>+] \f[R] .fi .PP This command removes unfinished large file uploads of age greater than max-age, which defaults to 24 hours. .PP Note that you can use --interactive/-i or --dry-run with this command to see what it would do. .IP .nf \f[C] rclone backend cleanup b2:bucket/path/to/object rclone backend cleanup -o max-age=7w b2:bucket/path/to/object \f[R] .fi .PP Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. .PP Options: .IP \[bu] 2 \[dq]max-age\[dq]: Max age of upload to delete .SS cleanup-hidden .PP Remove old versions of files. .IP .nf \f[C] rclone backend cleanup-hidden remote: [options] [<arguments>+] \f[R] .fi .PP This command removes any old hidden versions of files. .PP Note that you can use --interactive/-i or --dry-run with this command to see what it would do. .IP .nf \f[C] rclone backend cleanup-hidden b2:bucket/path/to/dir \f[R] .fi .SS Limitations .PP \f[C]rclone about\f[R] is not supported by the B2 backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH Box .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box to use JWT authentication. \f[C]rclone config\f[R] walks you through it. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / Box \[rs] \[dq]box\[dq] [snip] Storage> box Box App Client Id - leave blank normally. client_id> Box App Client Secret - leave blank normally. client_secret> Box App config.json location Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). box_config_file> Box App Primary Access Token Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). access_token> Enter a string value. Press Enter for the default (\[dq]user\[dq]). Choose a number from below, or type in your own value 1 / Rclone should act on behalf of a user \[rs] \[dq]user\[dq] 2 / Rclone should act on behalf of a service account \[rs] \[dq]enterprise\[dq] box_sub_type> Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXXXXXXXXXXXXXXXXXXXXX Log in and authorize rclone for access Waiting for code... Got code Configuration complete. Options: - type: box - client_id: - client_secret: - token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]XXX\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this may require you to unblock it temporarily if you are running a host firewall. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Box .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your Box .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an Box directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Using rclone with an Enterprise account with SSO .PP If you have an \[dq]Enterprise\[dq] account type with Box with single sign on (SSO), you need to create a password to use Box with rclone. This can be done at your Enterprise Box account by going to Settings, \[dq]Account\[dq] Tab, and then set the password in the \[dq]Authentication\[dq] field. .PP Once you have done this, you can setup your Enterprise Box account using the same procedure detailed above in the, using the password you have just set. .SS Invalid refresh token .PP According to the box docs (https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): .RS .PP Each refresh_token is valid for one use in 60 days. .RE .PP This means that if you .IP \[bu] 2 Don\[aq]t use the box remote for 60 days .IP \[bu] 2 Copy the config file with a box refresh token in and use it in two places .IP \[bu] 2 Get an error on a token refresh .PP then rclone will return an error which includes the text \f[C]Invalid refresh token\f[R]. .PP To fix this you will need to use oauth2 again to update the refresh token. You can use the methods in the remote setup docs (https://rclone.org/remote_setup/), bearing in mind that if you use the copy the config file method, you should not use that remote on the computer you did the authentication on. .PP Here is how to do it. .IP .nf \f[C] $ rclone config Current remotes: Name Type ==== ==== remote box 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> e Choose a number from below, or type in an existing value 1 > remote remote> remote Configuration complete. Options: - type: box - token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2017-07-08T23:40:08.059167677+01:00\[dq]} Keep this \[dq]remote\[dq] remote? Edit remote Value \[dq]client_id\[dq] = \[dq]\[dq] Edit? (y/n)> y) Yes n) No y/n> n Value \[dq]client_secret\[dq] = \[dq]\[dq] Edit? (y/n)> y) Yes n) No y/n> n Remote config Already have a token - refresh? y) Yes n) No y/n> y 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configuration complete. Options: - type: box - token: {\[dq]access_token\[dq]:\[dq]YYY\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]YYY\[dq],\[dq]expiry\[dq]:\[dq]2017-07-23T12:22:29.259137901+01:00\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Modification times and hashes .PP Box allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP Box supports SHA1 type hashes, so you can use the \f[C]--checksum\f[R] flag. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} .TE .PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Transfers .PP For files above 50 MiB rclone will use a chunked transfer. Rclone will upload up to \f[C]--transfers\f[R] chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 8 MiB so increasing \f[C]--transfers\f[R] will increase memory use. .SS Deleting files .PP Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash. .PP Emptying the trash is supported via the rclone however cleanup command however this deletes every trashed file and folder individually so it may take a very long time. Emptying the trash via the WebUI does not have this limitation so it is advised to empty the trash via the WebUI. .SS Root folder ID .PP You can set the \f[C]root_folder_id\f[R] for rclone. This is the directory (identified by its \f[C]Folder ID\f[R]) that rclone considers to be the root of your Box drive. .PP Normally you will leave this blank and rclone will determine the correct root to use itself. .PP However you can set this to restrict rclone to a specific folder hierarchy. .PP In order to do this you will have to find the \f[C]Folder ID\f[R] of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the Box web interface. .PP So if the folder you want rclone to use has a URL which looks like \f[C]https://app.box.com/folder/11xxxxxxxxx8\f[R] in the browser, then you use \f[C]11xxxxxxxxx8\f[R] as the \f[C]root_folder_id\f[R] in the config. .SS Standard options .PP Here are the Standard options specific to box (Box). .SS --box-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_BOX_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_BOX_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-box-config-file .PP Box App config.json location .PP Leave blank normally. .PP Leading \f[C]\[ti]\f[R] will be expanded in the file name as will environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. .PP Properties: .IP \[bu] 2 Config: box_config_file .IP \[bu] 2 Env Var: RCLONE_BOX_BOX_CONFIG_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-access-token .PP Box App Primary Access Token .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: access_token .IP \[bu] 2 Env Var: RCLONE_BOX_ACCESS_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-box-sub-type .PP Properties: .IP \[bu] 2 Config: box_sub_type .IP \[bu] 2 Env Var: RCLONE_BOX_BOX_SUB_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]user\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]user\[dq] .RS 2 .IP \[bu] 2 Rclone should act on behalf of a user. .RE .IP \[bu] 2 \[dq]enterprise\[dq] .RS 2 .IP \[bu] 2 Rclone should act on behalf of a service account. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to box (Box). .SS --box-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_BOX_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_BOX_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_BOX_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_BOX_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --box-root-folder-id .PP Fill in for rclone to use a non root folder as its starting point. .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_BOX_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]0\[dq] .SS --box-upload-cutoff .PP Cutoff for switching to multipart upload (>= 50 MiB). .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_BOX_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 50Mi .SS --box-commit-retries .PP Max number of times to try committing a multipart file. .PP Properties: .IP \[bu] 2 Config: commit_retries .IP \[bu] 2 Env Var: RCLONE_BOX_COMMIT_RETRIES .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 100 .SS --box-list-chunk .PP Size of listing chunk 1-1000. .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_BOX_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1000 .SS --box-owned-by .PP Only show items owned by the login (email address) passed in. .PP Properties: .IP \[bu] 2 Config: owned_by .IP \[bu] 2 Env Var: RCLONE_BOX_OWNED_BY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-impersonate .PP Impersonate this user ID when using a service account. .PP Setting this flag allows rclone, when using a JWT service account, to act on behalf of another user by setting the as-user header. .PP The user ID is the Box identifier for a user. User IDs can found for any user via the GET /users endpoint, which is only available to admins, or by calling the GET /users/me endpoint with an authenticated user session. .PP See: https://developer.box.com/guides/authentication/jwt/as-user/ .PP Properties: .IP \[bu] 2 Config: impersonate .IP \[bu] 2 Env Var: RCLONE_BOX_IMPERSONATE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --box-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_BOX_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot .SS --box-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_BOX_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Note that Box is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP Box file names can\[aq]t have the \f[C]\[rs]\f[R] character in. rclone maps this to and from an identical looking unicode equivalent \f[C]\[uFF3C]\f[R] (U+FF3C Fullwidth Reverse Solidus). .PP Box only supports filenames up to 255 characters in length. .PP Box has API rate limits (https://developer.box.com/guides/api-calls/permissions-and-errors/rate-limits/) that sometimes reduce the speed of rclone. .PP \f[C]rclone about\f[R] is not supported by the Box backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SS Get your own Box App ID .PP Here is how to create your own Box App ID for rclone: .IP "1." 3 Go to the Box Developer Console (https://app.box.com/developers/console) and login, then click \f[C]My Apps\f[R] on the sidebar. Click \f[C]Create New App\f[R] and select \f[C]Custom App\f[R]. .IP "2." 3 In the first screen on the box that pops up, you can pretty much enter whatever you want. The \f[C]App Name\f[R] can be whatever. For \f[C]Purpose\f[R] choose automation to avoid having to fill out anything else. Click \f[C]Next\f[R]. .IP "3." 3 In the second screen of the creation screen, select \f[C]User Authentication (OAuth 2.0)\f[R]. Then click \f[C]Create App\f[R]. .IP "4." 3 You should now be on the \f[C]Configuration\f[R] tab of your new app. If not, click on it at the top of the webpage. Copy down \f[C]Client ID\f[R] and \f[C]Client Secret\f[R], you\[aq]ll need those for rclone. .IP "5." 3 Under \[dq]OAuth 2.0 Redirect URI\[dq], add \f[C]http://127.0.0.1:53682/\f[R] .IP "6." 3 For \f[C]Application Scopes\f[R], select \f[C]Read all files and folders stored in Box\f[R] and \f[C]Write all files and folders stored in box\f[R] (assuming you want to do both). Leave others unchecked. Click \f[C]Save Changes\f[R] at the top right. .SH Cache .PP The \f[C]cache\f[R] remote wraps another existing remote and stores file structure and its data for long running tasks like \f[C]rclone mount\f[R]. .SS Status .PP The cache backend code is working but it currently doesn\[aq]t have a maintainer so there are outstanding bugs (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren\[aq]t getting fixed. .PP The cache backend is due to be phased out in favour of the VFS caching layer eventually which is more tightly integrated into rclone. .PP Until this happens we recommend only using the cache backend if you find you can\[aq]t work without it. There are many docs online describing the use of the cache backend to minimize API hits and by-and-large these are out of date and the cache backend isn\[aq]t needed in those scenarios any more. .SS Configuration .PP To get started you just need to have an existing remote which can be configured with \f[C]cache\f[R]. .PP Here is an example of how to make a remote called \f[C]test-cache\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> test-cache Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Cache a remote \[rs] \[dq]cache\[dq] [snip] Storage> cache Remote to cache. Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). remote> local:/test Optional: The URL of the Plex server plex_url> http://127.0.0.1:32400 Optional: The username of the Plex user plex_username> dummyusername Optional: The password of the Plex user y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: The size of a chunk. Lower value good for slow connections but can affect seamless reading. Default: 5M Choose a number from below, or type in your own value 1 / 1 MiB \[rs] \[dq]1M\[dq] 2 / 5 MiB \[rs] \[dq]5M\[dq] 3 / 10 MiB \[rs] \[dq]10M\[dq] chunk_size> 2 How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don\[aq]t plan on changing the source FS from outside the cache. Accepted units are: \[dq]s\[dq], \[dq]m\[dq], \[dq]h\[dq]. Default: 5m Choose a number from below, or type in your own value 1 / 1 hour \[rs] \[dq]1h\[dq] 2 / 24 hours \[rs] \[dq]24h\[dq] 3 / 24 hours \[rs] \[dq]48h\[dq] info_age> 2 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. Default: 10G Choose a number from below, or type in your own value 1 / 500 MiB \[rs] \[dq]500M\[dq] 2 / 1 GiB \[rs] \[dq]1G\[dq] 3 / 10 GiB \[rs] \[dq]10G\[dq] chunk_total_size> 3 Remote config -------------------- [test-cache] remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age = 48h chunk_total_size = 10G \f[R] .fi .PP You can then use it like this, .PP List directories in top level of your drive .IP .nf \f[C] rclone lsd test-cache: \f[R] .fi .PP List all the files in your drive .IP .nf \f[C] rclone ls test-cache: \f[R] .fi .PP To start a cached mount .IP .nf \f[C] rclone mount --allow-other test-cache: /var/tmp/test-cache \f[R] .fi .SS Write Features .SS Offline uploading .PP In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a \f[C]cache-tmp-upload-path\f[R]. .PP A files goes through these states when using this feature: .IP "1." 3 An upload is started (usually by copying a file on the cache remote) .IP "2." 3 When the copy to the temporary location is complete the file is part of the cached remote and looks and behaves like any other file (reading included) .IP "3." 3 After \f[C]cache-tmp-wait-time\f[R] passes and the file is next in line, \f[C]rclone move\f[R] is used to move the file to the cloud provider .IP "4." 3 Reading the file still works during the upload but most modifications on it will be prohibited .IP "5." 3 Once the move is complete the file is unlocked for modifications as it becomes as any other regular file .IP "6." 3 If the file is being read through \f[C]cache\f[R] when it\[aq]s actually deleted from the temporary path then \f[C]cache\f[R] will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though) .PP Files are uploaded in sequence and only one file is uploaded at a time. Uploads will be stored in a queue and be processed based on the order they were added. The queue and the temporary storage is persistent across restarts but can be cleared on startup with the \f[C]--cache-db-purge\f[R] flag. .SS Write Support .PP Writes are supported through \f[C]cache\f[R]. One caveat is that a mounted cache remote does not add any retry or fallback mechanism to the upload operation. This will depend on the implementation of the wrapped remote. Consider using \f[C]Offline uploading\f[R] for reliable writes. .PP One special case is covered with \f[C]cache-writes\f[R] which will cache the file data at the same time as the upload when it is enabled making it available from the cache store immediately once the upload is finished. .SS Read Features .SS Multiple connections .PP To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the cloud provider for smaller file chunks and combines them together locally where they can be available almost immediately before the reader usually needs them. .PP This is similar to buffering when media files are played online. Rclone will stay around the current marker but always try its best to stay ahead and prepare the data before. .SS Plex Integration .PP There is a direct integration with Plex which allows cache to detect during reading if the file is in playback or not. This helps cache to adapt how it queries the cloud provider depending on what is needed for. .PP Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers. .PP This integration opens the doorway to additional performance improvements which will be explored in the near future. .PP \f[B]Note:\f[R] If Plex options are not configured, \f[C]cache\f[R] will function with its configured options without adapting any of its settings. .PP How to enable? Run \f[C]rclone config\f[R] and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled. .PP Affected settings: - \f[C]cache-workers\f[R]: \f[I]Configured value\f[R] during confirmed playback or \f[I]1\f[R] all the other times .SS Certificate Validation .PP When the Plex server is configured to only accept secure connections, it is possible to use \f[C].plex.direct\f[R] URLs to ensure certificate validation succeeds. These URLs are used by Plex internally to connect to the Plex server securely. .PP The format for these URLs is the following: .PP \f[C]https://ip-with-dots-replaced.server-hash.plex.direct:32400/\f[R] .PP The \f[C]ip-with-dots-replaced\f[R] part can be any IPv4 address, where the dots have been replaced with dashes, e.g. \f[C]127.0.0.1\f[R] becomes \f[C]127-0-0-1\f[R]. .PP To get the \f[C]server-hash\f[R] part, the easiest way is to visit .PP https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token .PP This page will list all the available Plex servers for your account with at least one \f[C].plex.direct\f[R] link for each. Copy one URL and replace the IP address with the desired address. This can be used as the \f[C]plex_url\f[R] value. .SS Known issues .SS Mount and --dir-cache-time .PP --dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the \f[C]cache\f[R] backend, it will manage its own entries based on the configured time. .PP To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set \f[C]--dir-cache-time\f[R] to a lower time than \f[C]--cache-info-age\f[R]. Default values are already configured in this way. .SS Windows support - Experimental .PP There are a couple of issues with Windows \f[C]mount\f[R] functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS. .PP Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependent on them. .PP Any reports or feedback on how cache behaves on this OS is greatly appreciated. .IP \[bu] 2 https://github.com/rclone/rclone/issues/1935 .IP \[bu] 2 https://github.com/rclone/rclone/issues/1907 .IP \[bu] 2 https://github.com/rclone/rclone/issues/1834 .SS Risk of throttling .PP Future iterations of the cache backend will make use of the pooling functionality of the cloud provider to synchronize and at the same time make writing through it more tolerant to failures. .PP There are a couple of enhancements in track to add these but in the meantime there is a valid concern that the expiring cache listings can lead to cloud provider throttles or bans due to repeated queries on it for very large mounts. .PP Some recommendations: - don\[aq]t use a very small interval for entry information (\f[C]--cache-info-age\f[R]) - while writes aren\[aq]t yet optimised, you can still write through \f[C]cache\f[R] which gives you the advantage of adding the file in the cache at the same time if configured to do so. .PP Future enhancements: .IP \[bu] 2 https://github.com/rclone/rclone/issues/1937 .IP \[bu] 2 https://github.com/rclone/rclone/issues/1936 .SS cache and crypt .PP One common scenario is to keep your data encrypted in the cloud provider using the \f[C]crypt\f[R] remote. \f[C]crypt\f[R] uses a similar technique to wrap around an existing remote and handles this translation in a seamless way. .PP There is an issue with wrapping the remotes in this order: \f[B]cloud remote\f[R] -> \f[B]crypt\f[R] -> \f[B]cache\f[R] .PP During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we\[aq]re downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: \f[B]cloud remote\f[R] -> \f[B]cache\f[R] -> \f[B]crypt\f[R] .SS absolute remote paths .PP \f[C]cache\f[R] can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the \f[C]remote\f[R] config setting and on the command line will be passed to the wrapped remote as is, but for storing the chunks on disk the path will be made relative by removing any leading \f[C]/\f[R] character. .PP This behavior is irrelevant for most backend types, but there are backends where a leading \f[C]/\f[R] changes the effective directory, e.g. in the \f[C]sftp\f[R] backend paths starting with a \f[C]/\f[R] are relative to the root of the SSH server and paths without are relative to the user home directory. As a result \f[C]sftp:bin\f[R] and \f[C]sftp:/bin\f[R] will share the same cache folder, even if they represent a different directory on the SSH server. .SS Cache and Remote Control (--rc) .PP Cache supports the new \f[C]--rc\f[R] mode in rclone and can be remote controlled through the following end points: By default, the listener is disabled if you do not add the flag. .SS rc cache/expire .PP Purge a remote from the cache backend. Supports either a directory or a file. It supports both encrypted and unencrypted file names if cache is wrapped by crypt. .PP Params: - \f[B]remote\f[R] = path to remote \f[B](required)\f[R] - \f[B]withData\f[R] = true/false to delete cached data (chunks) as well \f[I](optional, false by default)\f[R] .SS Standard options .PP Here are the Standard options specific to cache (Cache a remote). .SS --cache-remote .PP Remote to cache. .PP Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_CACHE_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --cache-plex-url .PP The URL of the Plex server. .PP Properties: .IP \[bu] 2 Config: plex_url .IP \[bu] 2 Env Var: RCLONE_CACHE_PLEX_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-plex-username .PP The username of the Plex user. .PP Properties: .IP \[bu] 2 Config: plex_username .IP \[bu] 2 Env Var: RCLONE_CACHE_PLEX_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-plex-password .PP The password of the Plex user. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: plex_password .IP \[bu] 2 Env Var: RCLONE_CACHE_PLEX_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-chunk-size .PP The size of a chunk (partial file data). .PP Use lower numbers for slower connections. If the chunk size is changed, any downloaded chunks will be invalid and cache-chunk-path will need to be cleared or unexpected EOF errors will occur. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_CACHE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 5Mi .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]1M\[dq] .RS 2 .IP \[bu] 2 1 MiB .RE .IP \[bu] 2 \[dq]5M\[dq] .RS 2 .IP \[bu] 2 5 MiB .RE .IP \[bu] 2 \[dq]10M\[dq] .RS 2 .IP \[bu] 2 10 MiB .RE .RE .SS --cache-info-age .PP How long to cache file structure information (directory listings, file size, times, etc.). If all write operations are done through the cache then you can safely make this value very large as the cache store will also be updated in real time. .PP Properties: .IP \[bu] 2 Config: info_age .IP \[bu] 2 Env Var: RCLONE_CACHE_INFO_AGE .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 6h0m0s .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]1h\[dq] .RS 2 .IP \[bu] 2 1 hour .RE .IP \[bu] 2 \[dq]24h\[dq] .RS 2 .IP \[bu] 2 24 hours .RE .IP \[bu] 2 \[dq]48h\[dq] .RS 2 .IP \[bu] 2 48 hours .RE .RE .SS --cache-chunk-total-size .PP The total size that the chunks can take up on the local disk. .PP If the cache exceeds this value then it will start to delete the oldest chunks until it goes under this value. .PP Properties: .IP \[bu] 2 Config: chunk_total_size .IP \[bu] 2 Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Gi .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]500M\[dq] .RS 2 .IP \[bu] 2 500 MiB .RE .IP \[bu] 2 \[dq]1G\[dq] .RS 2 .IP \[bu] 2 1 GiB .RE .IP \[bu] 2 \[dq]10G\[dq] .RS 2 .IP \[bu] 2 10 GiB .RE .RE .SS Advanced options .PP Here are the Advanced options specific to cache (Cache a remote). .SS --cache-plex-token .PP The plex token for authentication - auto set normally. .PP Properties: .IP \[bu] 2 Config: plex_token .IP \[bu] 2 Env Var: RCLONE_CACHE_PLEX_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-plex-insecure .PP Skip all certificate verification when connecting to the Plex server. .PP Properties: .IP \[bu] 2 Config: plex_insecure .IP \[bu] 2 Env Var: RCLONE_CACHE_PLEX_INSECURE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-db-path .PP Directory to store file structure metadata DB. .PP The remote name is used as the DB file name. .PP Properties: .IP \[bu] 2 Config: db_path .IP \[bu] 2 Env Var: RCLONE_CACHE_DB_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]$HOME/.cache/rclone/cache-backend\[dq] .SS --cache-chunk-path .PP Directory to cache chunk files. .PP Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path. .PP This config follows the \[dq]--cache-db-path\[dq]. If you specify a custom location for \[dq]--cache-db-path\[dq] and don\[aq]t specify one for \[dq]--cache-chunk-path\[dq] then \[dq]--cache-chunk-path\[dq] will use the same path as \[dq]--cache-db-path\[dq]. .PP Properties: .IP \[bu] 2 Config: chunk_path .IP \[bu] 2 Env Var: RCLONE_CACHE_CHUNK_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]$HOME/.cache/rclone/cache-backend\[dq] .SS --cache-db-purge .PP Clear all the cached data for this remote on start. .PP Properties: .IP \[bu] 2 Config: db_purge .IP \[bu] 2 Env Var: RCLONE_CACHE_DB_PURGE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --cache-chunk-clean-interval .PP How often should the cache perform cleanups of the chunk storage. .PP The default value should be ok for most people. If you find that the cache goes over \[dq]cache-chunk-total-size\[dq] too often then try to lower this value to force it to perform cleanups more often. .PP Properties: .IP \[bu] 2 Config: chunk_clean_interval .IP \[bu] 2 Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --cache-read-retries .PP How many times to retry a read from a cache storage. .PP Since reading from a cache stream is independent from downloading file data, readers can get to a point where there\[aq]s no more data in the cache. Most of the times this can indicate a connectivity issue if cache isn\[aq]t able to provide file data anymore. .PP For really slow connections, increase this to a point where the stream is able to provide data but your experience will be very stuttering. .PP Properties: .IP \[bu] 2 Config: read_retries .IP \[bu] 2 Env Var: RCLONE_CACHE_READ_RETRIES .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 10 .SS --cache-workers .PP How many workers should run in parallel to download chunks. .PP Higher values will mean more parallel processing (better CPU needed) and more concurrent requests on the cloud provider. This impacts several aspects like the cloud provider API limits, more stress on the hardware that rclone runs on but it also means that streams will be more fluid and data will be available much more faster to readers. .PP \f[B]Note\f[R]: If the optional Plex integration is enabled then this setting will adapt to the type of reading performed and the value specified here will be used as a maximum number of workers to use. .PP Properties: .IP \[bu] 2 Config: workers .IP \[bu] 2 Env Var: RCLONE_CACHE_WORKERS .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 4 .SS --cache-chunk-no-memory .PP Disable the in-memory cache for storing chunks during streaming. .PP By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible. .PP This transient data is evicted as soon as it is read and the number of chunks stored doesn\[aq]t exceed the number of workers. However, depending on other settings like \[dq]cache-chunk-size\[dq] and \[dq]cache-workers\[dq] this footprint can increase if there are parallel streams too (multiple files being read at the same time). .PP If the hardware permits it, use this feature to provide an overall better performance during streaming but it can also be disabled if RAM is not available on the local machine. .PP Properties: .IP \[bu] 2 Config: chunk_no_memory .IP \[bu] 2 Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --cache-rps .PP Limits the number of requests per second to the source FS (-1 to disable). .PP This setting places a hard limit on the number of requests per second that cache will be doing to the cloud provider remote and try to respect that value by setting waits between reads. .PP If you find that you\[aq]re getting banned or limited on the cloud provider through cache and know that a smaller number of requests per second will allow you to work with it then you can use this setting for that. .PP A good balance of all the other settings should make this setting useless but it is available to set for more special cases. .PP \f[B]NOTE\f[R]: This will limit the number of requests during streams but other API calls to the cloud provider like directory listings will still pass. .PP Properties: .IP \[bu] 2 Config: rps .IP \[bu] 2 Env Var: RCLONE_CACHE_RPS .IP \[bu] 2 Type: int .IP \[bu] 2 Default: -1 .SS --cache-writes .PP Cache file data on writes through the FS. .PP If you need to read files immediately after you upload them through cache you can enable this flag to have their data stored in the cache store at the same time during upload. .PP Properties: .IP \[bu] 2 Config: writes .IP \[bu] 2 Env Var: RCLONE_CACHE_WRITES .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --cache-tmp-upload-path .PP Directory to keep temporary files until they are uploaded. .PP This is the path where cache will use as a temporary storage for new files that need to be uploaded to the cloud provider. .PP Specifying a value will enable this feature. Without it, it is completely disabled and files will be uploaded directly to the cloud provider .PP Properties: .IP \[bu] 2 Config: tmp_upload_path .IP \[bu] 2 Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cache-tmp-wait-time .PP How long should files be stored in local cache before being uploaded. .PP This is the duration that a file must wait in the temporary location \f[I]cache-tmp-upload-path\f[R] before it is selected for upload. .PP Note that only one file is uploaded at a time and it can take longer to start the upload if a queue formed for this purpose. .PP Properties: .IP \[bu] 2 Config: tmp_wait_time .IP \[bu] 2 Env Var: RCLONE_CACHE_TMP_WAIT_TIME .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 15s .SS --cache-db-wait-time .PP How long to wait for the DB to be available - 0 is unlimited. .PP Only one process can have the DB open at any one time, so rclone waits for this duration for the DB to become available before it gives an error. .PP If you set it to 0 then it will wait forever. .PP Properties: .IP \[bu] 2 Config: db_wait_time .IP \[bu] 2 Env Var: RCLONE_CACHE_DB_WAIT_TIME .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1s .SS --cache-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_CACHE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Backend commands .PP Here are the commands specific to the cache backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS stats .PP Print stats on the cache backend in JSON format. .IP .nf \f[C] rclone backend stats remote: [options] [<arguments>+] \f[R] .fi .SH Chunker .PP The \f[C]chunker\f[R] overlay transparently splits large files into smaller chunks during upload to wrapped remote and transparently assembles them back when the file is downloaded. This allows to effectively overcome size limits imposed by storage providers. .SS Configuration .PP To use it, first set up the underlying remote following the configuration instructions for that remote. You can also use a local pathname instead of a remote. .PP First check your chosen remote is working - we\[aq]ll call it \f[C]remote:path\f[R] here. Note that anything inside \f[C]remote:path\f[R] will be chunked and anything outside won\[aq]t. This means that if you are using a bucket-based remote (e.g. S3, B2, swift) then you should probably put the bucket in the remote \f[C]s3:bucket\f[R]. .PP Now configure \f[C]chunker\f[R] using \f[C]rclone config\f[R]. We will call this one \f[C]overlay\f[R] to separate it from the \f[C]remote\f[R] itself. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> overlay Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Transparently chunk/split large files \[rs] \[dq]chunker\[dq] [snip] Storage> chunker Remote to chunk/unchunk. Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). Enter a string value. Press Enter for the default (\[dq]\[dq]). remote> remote:path Files larger than chunk size will be split in chunks. Enter a size with suffix K,M,G,T. Press Enter for the default (\[dq]2G\[dq]). chunk_size> 100M Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. Enter a string value. Press Enter for the default (\[dq]md5\[dq]). Choose a number from below, or type in your own value 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise \[rs] \[dq]none\[dq] 2 / MD5 for composite files \[rs] \[dq]md5\[dq] 3 / SHA1 for composite files \[rs] \[dq]sha1\[dq] 4 / MD5 for all files \[rs] \[dq]md5all\[dq] 5 / SHA1 for all files \[rs] \[dq]sha1all\[dq] 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported \[rs] \[dq]md5quick\[dq] 7 / Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 \[rs] \[dq]sha1quick\[dq] hash_type> md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [overlay] type = chunker remote = remote:bucket chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Specifying the remote .PP In normal use, make sure the remote has a \f[C]:\f[R] in. If you specify the remote without a \f[C]:\f[R] then rclone will use a local directory of that name. So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone will chunk stuff in that directory. If you use a remote of \f[C]name\f[R] then rclone will put files in a directory called \f[C]name\f[R] in the current directory. .SS Chunking .PP When rclone starts a file upload, chunker checks the file size. If it doesn\[aq]t exceed the configured chunk size, chunker will just pass the file to the wrapped remote (however, see caveat below). If a file is large, chunker will transparently cut data in pieces with temporary names and stream them one by one, on the fly. Each data chunk will contain the specified number of bytes, except for the last one which may have less data. If file size is unknown in advance (this is called a streaming upload), chunker will internally create a temporary copy, record its size and repeat the above process. .PP When upload completes, temporary chunk files are finally renamed. This scheme guarantees that operations can be run in parallel and look from outside as atomic. A similar method with hidden temporary chunks is used for other operations (copy/move/rename, etc.). If an operation fails, hidden chunks are normally destroyed, and the target composite file stays intact. .PP When a composite file download is requested, chunker transparently assembles it by concatenating data chunks in order. As the split is trivial one could even manually concatenate data chunks together to obtain the original content. .PP When the \f[C]list\f[R] rclone command scans a directory on wrapped remote, the potential chunk files are accounted for, grouped and assembled into composite directory entries. Any temporary chunks are hidden. .PP List and other commands can sometimes come across composite files with missing or invalid chunks, e.g. shadowed by like-named directory or another file. This usually means that wrapped file system has been directly tampered with or damaged. If chunker detects a missing chunk it will by default print warning, skip the whole incomplete group of chunks but proceed with current command. You can set the \f[C]--chunker-fail-hard\f[R] flag to have commands abort with error message in such cases. .PP \f[B]Caveat\f[R]: As it is now, chunker will always create a temporary file in the backend and then rename it, even if the file is below the chunk threshold. This will result in unnecessary API calls and can severely restrict throughput when handling transfers primarily composed of small files on some backends (e.g. Box). A workaround to this issue is to use chunker only for files above the chunk threshold via \f[C]--min-size\f[R] and then perform a separate call without chunker on the remaining files. .SS Chunk names .PP The default chunk name format is \f[C]*.rclone_chunk.###\f[R], hence by default chunk names are \f[C]BIG_FILE_NAME.rclone_chunk.001\f[R], \f[C]BIG_FILE_NAME.rclone_chunk.002\f[R] etc. You can configure another name format using the \f[C]name_format\f[R] configuration file option. The format uses asterisk \f[C]*\f[R] as a placeholder for the base file name and one or more consecutive hash characters \f[C]#\f[R] as a placeholder for sequential chunk number. There must be one and only one asterisk. The number of consecutive hash characters defines the minimum length of a string representing a chunk number. If decimal chunk number has less digits than the number of hashes, it is left-padded by zeros. If the decimal string is longer, it is left intact. By default numbering starts from 1 but there is another option that allows user to start from 0, e.g. for compatibility with legacy software. .PP For example, if name format is \f[C]big_*-##.part\f[R] and original file name is \f[C]data.txt\f[R] and numbering starts from 0, then the first chunk will be named \f[C]big_data.txt-00.part\f[R], the 99th chunk will be \f[C]big_data.txt-98.part\f[R] and the 302nd chunk will become \f[C]big_data.txt-301.part\f[R]. .PP Note that \f[C]list\f[R] assembles composite directory entries only when chunk names match the configured format and treats non-conforming file names as normal non-chunked files. .PP When using \f[C]norename\f[R] transactions, chunk names will additionally have a unique file version suffix. For example, \f[C]BIG_FILE_NAME.rclone_chunk.001_bp562k\f[R]. .SS Metadata .PP Besides data chunks chunker will by default create metadata object for a composite file. The object is named after the original file. Chunker allows user to disable metadata completely (the \f[C]none\f[R] format). Note that metadata is normally not created for files smaller than the configured chunk size. This may change in future rclone releases. .SS Simple JSON metadata format .PP This is the default format. It supports hash sums and chunk validation for composite files. Meta objects carry the following fields: .IP \[bu] 2 \f[C]ver\f[R] - version of format, currently \f[C]1\f[R] .IP \[bu] 2 \f[C]size\f[R] - total size of composite file .IP \[bu] 2 \f[C]nchunks\f[R] - number of data chunks in file .IP \[bu] 2 \f[C]md5\f[R] - MD5 hashsum of composite file (if present) .IP \[bu] 2 \f[C]sha1\f[R] - SHA1 hashsum (if present) .IP \[bu] 2 \f[C]txn\f[R] - identifies current version of the file .PP There is no field for composite file name as it\[aq]s simply equal to the name of meta object on the wrapped remote. Please refer to respective sections for details on hashsums and modified time handling. .SS No metadata .PP You can disable meta objects by setting the meta format option to \f[C]none\f[R]. In this mode chunker will scan directory for all files that follow configured chunk name format, group them by detecting chunks with the same base name and show group names as virtual composite files. This method is more prone to missing chunk errors (especially missing last chunk) than format with metadata enabled. .SS Hashsums .PP Chunker supports hashsums only when a compatible metadata is present. Hence, if you choose metadata format of \f[C]none\f[R], chunker will report hashsum as \f[C]UNSUPPORTED\f[R]. .PP Please note that by default metadata is stored only for composite files. If a file is smaller than configured chunk size, chunker will transparently redirect hash requests to wrapped remote, so support depends on that. You will see the empty string as a hashsum of requested type for small files if the wrapped remote doesn\[aq]t support it. .PP Many storage backends support MD5 and SHA1 hash types, so does chunker. With chunker you can choose one or another but not both. MD5 is set by default as the most supported type. Since chunker keeps hashes for composite files and falls back to the wrapped remote hash for non-chunked ones, we advise you to choose the same hash type as supported by wrapped remote so that your file listings look coherent. .PP If your storage backend does not support MD5 or SHA1 but you need consistent file hashing, configure chunker with \f[C]md5all\f[R] or \f[C]sha1all\f[R]. These two modes guarantee given hash for all files. If wrapped remote doesn\[aq]t support it, chunker will then add metadata to all files, even small. However, this can double the amount of small files in storage and incur additional service charges. You can even use chunker to force md5/sha1 support in any other remote at expense of sidecar meta objects by setting e.g. \f[C]hash_type=sha1all\f[R] to force hashsums and \f[C]chunk_size=1P\f[R] to effectively disable chunking. .PP Normally, when a file is copied to chunker controlled remote, chunker will ask the file source for compatible file hash and revert to on-the-fly calculation if none is found. This involves some CPU overhead but provides a guarantee that given hashsum is available. Also, chunker will reject a server-side copy or move operation if source and destination hashsum types are different resulting in the extra network bandwidth, too. In some rare cases this may be undesired, so chunker provides two optional choices: \f[C]sha1quick\f[R] and \f[C]md5quick\f[R]. If the source does not support primary hash type and the quick mode is enabled, chunker will try to fall back to the secondary type. This will save CPU and bandwidth but can result in empty hashsums at destination. Beware of consequences: the \f[C]sync\f[R] command will revert (sometimes silently) to time/size comparison if compatible hashsums between source and target are not found. .SS Modification times .PP Chunker stores modification times using the wrapped remote so support depends on that. For a small non-chunked file the chunker overlay simply manipulates modification time of the wrapped remote file. For a composite file with metadata chunker will get and set modification time of the metadata object on the wrapped remote. If file is chunked but metadata format is \f[C]none\f[R] then chunker will use modification time of the first data chunk. .SS Migrations .PP The idiomatic way to migrate to a different chunk size, hash type, transaction style or chunk naming scheme is to: .IP \[bu] 2 Collect all your chunked files under a directory and have your chunker remote point to it. .IP \[bu] 2 Create another directory (most probably on the same cloud storage) and configure a new remote with desired metadata format, hash type, chunk naming etc. .IP \[bu] 2 Now run \f[C]rclone sync --interactive oldchunks: newchunks:\f[R] and all your data will be transparently converted in transfer. This may take some time, yet chunker will try server-side copy if possible. .IP \[bu] 2 After checking data integrity you may remove configuration section of the old remote. .PP If rclone gets killed during a long operation on a big composite file, hidden temporary chunks may stay in the directory. They will not be shown by the \f[C]list\f[R] command but will eat up your account quota. Please note that the \f[C]deletefile\f[R] command deletes only active chunks of a file. As a workaround, you can use remote of the wrapped file system to see them. An easy way to get rid of hidden garbage is to copy littered directory somewhere using the chunker remote and purge the original directory. The \f[C]copy\f[R] command will copy only active chunks while the \f[C]purge\f[R] will remove everything including garbage. .SS Caveats and Limitations .PP Chunker requires wrapped remote to support server-side \f[C]move\f[R] (or \f[C]copy\f[R] + \f[C]delete\f[R]) operations, otherwise it will explicitly refuse to start. This is because it internally renames temporary chunk files to their final names when an operation completes successfully. .PP Chunker encodes chunk number in file name, so with default \f[C]name_format\f[R] setting it adds 17 characters. Also chunker adds 7 characters of temporary suffix during operations. Many file systems limit base file name without path by 255 characters. Using rclone\[aq]s crypt remote as a base file system limits file name by 143 characters. Thus, maximum name length is 231 for most files and 119 for chunker-over-crypt. A user in need can change name format to e.g. \f[C]*.rcc##\f[R] and save 10 characters (provided at most 99 chunks per file). .PP Note that a move implemented using the copy-and-delete method may incur double charging with some cloud storage providers. .PP Chunker will not automatically rename existing chunks when you run \f[C]rclone config\f[R] on a live remote and change the chunk name format. Beware that in result of this some files which have been treated as chunks before the change can pop up in directory listings as normal files and vice versa. The same warning holds for the chunk size. If you desperately need to change critical chunking settings, you should run data migration as described above. .PP If wrapped remote is case insensitive, the chunker overlay will inherit that property (so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and \[dq]hello.doc\[dq] in the same directory). .PP Chunker included in rclone releases up to \f[C]v1.54\f[R] can sometimes fail to detect metadata produced by recent versions of rclone. We recommend users to keep rclone up-to-date to avoid data corruption. .PP Changing \f[C]transactions\f[R] is dangerous and requires explicit migration. .SS Standard options .PP Here are the Standard options specific to chunker (Transparently chunk/split large files). .SS --chunker-remote .PP Remote to chunk/unchunk. .PP Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_CHUNKER_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --chunker-chunk-size .PP Files larger than chunk size will be split in chunks. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_CHUNKER_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 2Gi .SS --chunker-hash-type .PP Choose how chunker handles hash sums. .PP All modes but \[dq]none\[dq] require metadata. .PP Properties: .IP \[bu] 2 Config: hash_type .IP \[bu] 2 Env Var: RCLONE_CHUNKER_HASH_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]md5\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]none\[dq] .RS 2 .IP \[bu] 2 Pass any hash supported by wrapped remote for non-chunked files. .IP \[bu] 2 Return nothing otherwise. .RE .IP \[bu] 2 \[dq]md5\[dq] .RS 2 .IP \[bu] 2 MD5 for composite files. .RE .IP \[bu] 2 \[dq]sha1\[dq] .RS 2 .IP \[bu] 2 SHA1 for composite files. .RE .IP \[bu] 2 \[dq]md5all\[dq] .RS 2 .IP \[bu] 2 MD5 for all files. .RE .IP \[bu] 2 \[dq]sha1all\[dq] .RS 2 .IP \[bu] 2 SHA1 for all files. .RE .IP \[bu] 2 \[dq]md5quick\[dq] .RS 2 .IP \[bu] 2 Copying a file to chunker will request MD5 from the source. .IP \[bu] 2 Falling back to SHA1 if unsupported. .RE .IP \[bu] 2 \[dq]sha1quick\[dq] .RS 2 .IP \[bu] 2 Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to chunker (Transparently chunk/split large files). .SS --chunker-name-format .PP String format of chunk file names. .PP The two placeholders are: base file name (*) and chunk number (#...). There must be one and only one asterisk and one or more consecutive hash characters. If chunk number has less digits than the number of hashes, it is left-padded by zeros. If there are more digits in the number, they are left as is. Possible chunk files are ignored if their name does not match given format. .PP Properties: .IP \[bu] 2 Config: name_format .IP \[bu] 2 Env Var: RCLONE_CHUNKER_NAME_FORMAT .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]*.rclone_chunk.###\[dq] .SS --chunker-start-from .PP Minimum valid chunk number. Usually 0 or 1. .PP By default chunk numbers start from 1. .PP Properties: .IP \[bu] 2 Config: start_from .IP \[bu] 2 Env Var: RCLONE_CHUNKER_START_FROM .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1 .SS --chunker-meta-format .PP Format of the metadata object or \[dq]none\[dq]. .PP By default \[dq]simplejson\[dq]. Metadata is a small JSON file named after the composite file. .PP Properties: .IP \[bu] 2 Config: meta_format .IP \[bu] 2 Env Var: RCLONE_CHUNKER_META_FORMAT .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]simplejson\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]none\[dq] .RS 2 .IP \[bu] 2 Do not use metadata files at all. .IP \[bu] 2 Requires hash type \[dq]none\[dq]. .RE .IP \[bu] 2 \[dq]simplejson\[dq] .RS 2 .IP \[bu] 2 Simple JSON supports hash sums and chunk validation. .IP \[bu] 2 It has the following fields: ver, size, nchunks, md5, sha1. .RE .RE .SS --chunker-fail-hard .PP Choose how chunker should handle files with missing or invalid chunks. .PP Properties: .IP \[bu] 2 Config: fail_hard .IP \[bu] 2 Env Var: RCLONE_CHUNKER_FAIL_HARD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Report errors and abort current command. .RE .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Warn user, skip incomplete file and proceed. .RE .RE .SS --chunker-transactions .PP Choose how chunker should handle temporary files during transactions. .PP Properties: .IP \[bu] 2 Config: transactions .IP \[bu] 2 Env Var: RCLONE_CHUNKER_TRANSACTIONS .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]rename\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]rename\[dq] .RS 2 .IP \[bu] 2 Rename temporary files after a successful transaction. .RE .IP \[bu] 2 \[dq]norename\[dq] .RS 2 .IP \[bu] 2 Leave temporary file names and write transaction ID to metadata file. .IP \[bu] 2 Metadata is required for no rename transactions (meta format cannot be \[dq]none\[dq]). .IP \[bu] 2 If you are using norename transactions you should be careful not to downgrade Rclone .IP \[bu] 2 as older versions of Rclone don\[aq]t support this transaction style and will misinterpret .IP \[bu] 2 files manipulated by norename transactions. .IP \[bu] 2 This method is EXPERIMENTAL, don\[aq]t use on production systems. .RE .IP \[bu] 2 \[dq]auto\[dq] .RS 2 .IP \[bu] 2 Rename or norename will be used depending on capabilities of the backend. .IP \[bu] 2 If meta format is set to \[dq]none\[dq], rename transactions will always be used. .IP \[bu] 2 This method is EXPERIMENTAL, don\[aq]t use on production systems. .RE .RE .SS --chunker-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_CHUNKER_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Cloudinary .PP This is a backend for the Cloudinary (https://cloudinary.com/) platform .SS About Cloudinary .PP Cloudinary (https://cloudinary.com/) is an image and video API platform. Trusted by 1.5 million developers and 10,000 enterprise and hyper-growth companies as a critical part of their tech stack to deliver visually engaging experiences. .SS Accounts & Pricing .PP To use this backend, you need to create a free account (https://cloudinary.com/users/register_free) on Cloudinary. Start with a free plan with generous usage limits. Then, as your requirements grow, upgrade to a plan that best fits your needs. See the pricing details (https://cloudinary.com/pricing). .SS Securing Your Credentials .PP Please refer to the docs (https://rclone.org/docs/#configuration-encryption-cheatsheet) .SS Configuration .PP Here is an example of making a Cloudinary configuration. .PP First, create a cloudinary.com (https://cloudinary.com/users/register_free) account and choose a plan. .PP You will need to log in and get the \f[C]API Key\f[R] and \f[C]API Secret\f[R] for your account from the developer section. .PP Now run .PP \f[C]rclone config\f[R] .PP Follow the interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter the name for the new remote. name> cloudinary-media-library Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / cloudinary.com \[rs] (cloudinary) [snip] Storage> cloudinary Option cloud_name. You can find your cloudinary.com cloud_name in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard) Enter a value. cloud_name> **************************** Option api_key. You can find your cloudinary.com api key in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard) Enter a value. api_key> **************************** Option api_secret. You can find your cloudinary.com api secret in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard) This value must be a single character, one of the following: y, g. y/g> y Enter a value. api_secret> **************************** Option upload_prefix. [Upload prefix](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters) to specify alternative data center Enter a value. upload_prefix> Option upload_preset. [Upload presets](https://cloudinary.com/documentation/upload_presets) can be defined for different upload profiles Enter a value. upload_preset> Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: cloudinary - api_key: **************************** - api_secret: **************************** - cloud_name: **************************** - upload_prefix: - upload_preset: Keep this \[dq]cloudinary-media-library\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP List directories in the top level of your Media Library .PP \f[C]rclone lsd cloudinary-media-library:\f[R] .PP Make a new directory. .PP \f[C]rclone mkdir cloudinary-media-library:directory\f[R] .PP List the contents of a directory. .PP \f[C]rclone ls cloudinary-media-library:directory\f[R] .SS Modified time and hashes .PP Cloudinary stores md5 and timestamps for any successful Put automatically and read-only. .SS Standard options .PP Here are the Standard options specific to cloudinary (Cloudinary). .SS --cloudinary-cloud-name .PP Cloudinary Environment Name .PP Properties: .IP \[bu] 2 Config: cloud_name .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_CLOUD_NAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --cloudinary-api-key .PP Cloudinary API Key .PP Properties: .IP \[bu] 2 Config: api_key .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_API_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --cloudinary-api-secret .PP Cloudinary API Secret .PP Properties: .IP \[bu] 2 Config: api_secret .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_API_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --cloudinary-upload-prefix .PP Specify the API endpoint for environments out of the US .PP Properties: .IP \[bu] 2 Config: upload_prefix .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_UPLOAD_PREFIX .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --cloudinary-upload-preset .PP Upload Preset to select asset manipulation on upload .PP Properties: .IP \[bu] 2 Config: upload_preset .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_UPLOAD_PRESET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to cloudinary (Cloudinary). .SS --cloudinary-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot .SS --cloudinary-eventually-consistent-delay .PP Wait N seconds for eventual consistency of the databases that support the backend operation .PP Properties: .IP \[bu] 2 Config: eventually_consistent_delay .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_EVENTUALLY_CONSISTENT_DELAY .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 0s .SS --cloudinary-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_CLOUDINARY_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Citrix ShareFile .PP Citrix ShareFile (https://sharefile.com) is a secure file sharing and transfer service aimed as business. .SS Configuration .PP The initial setup for Citrix ShareFile involves getting a token from Citrix ShareFile which you can in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value XX / Citrix Sharefile \[rs] \[dq]sharefile\[dq] Storage> sharefile ** See help for sharefile backend at: https://rclone.org/sharefile/ ** ID of the root folder Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the standard values here or any folder ID (long hex number ID). Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Access the Personal Folders. (Default) \[rs] \[dq]\[dq] 2 / Access the Favorites folder. \[rs] \[dq]favorites\[dq] 3 / Access all the shared folders. \[rs] \[dq]allshared\[dq] 4 / Access all the individual connectors. \[rs] \[dq]connectors\[dq] 5 / Access the home, favorites, and shared folders as well as the connectors. \[rs] \[dq]top\[dq] root_folder_id> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for access Waiting for code... Got code Configuration complete. Options: - type: sharefile - endpoint: https://XXX.sharefile.com - token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019-09-30T19:41:45.878561877+01:00\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Citrix ShareFile. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you to unblock it temporarily if you are running a host firewall. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your ShareFile .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your ShareFile .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an ShareFile directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Modification times and hashes .PP ShareFile allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP ShareFile supports MD5 type hashes, so you can use the \f[C]--checksum\f[R] flag. .SS Transfers .PP For files above 128 MiB rclone will use a chunked transfer. Rclone will upload up to \f[C]--transfers\f[R] chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 64 MiB so increasing \f[C]--transfers\f[R] will increase memory use. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} .TE .PP 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: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} T{ \&. T}@T{ 0x2E T}@T{ \[uFF0E] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to sharefile (Citrix Sharefile). .SS --sharefile-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-root-folder-id .PP ID of the root folder. .PP Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the standard values here or any folder ID (long hex number ID). .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Access the Personal Folders (default). .RE .IP \[bu] 2 \[dq]favorites\[dq] .RS 2 .IP \[bu] 2 Access the Favorites folder. .RE .IP \[bu] 2 \[dq]allshared\[dq] .RS 2 .IP \[bu] 2 Access all the shared folders. .RE .IP \[bu] 2 \[dq]connectors\[dq] .RS 2 .IP \[bu] 2 Access all the individual connectors. .RE .IP \[bu] 2 \[dq]top\[dq] .RS 2 .IP \[bu] 2 Access the home, favorites, and shared folders as well as the connectors. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to sharefile (Citrix Sharefile). .SS --sharefile-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --sharefile-upload-cutoff .PP Cutoff for switching to multipart upload. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 128Mi .SS --sharefile-chunk-size .PP Upload chunk size. .PP Must a power of 2 >= 256k. .PP Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer. .PP Reducing this will reduce memory usage but decrease performance. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 64Mi .SS --sharefile-endpoint .PP Endpoint for API calls. .PP This is usually auto discovered as part of the oauth process, but can be set manually to something like: https://XXX.sharefile.com .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --sharefile-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot .SS --sharefile-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_SHAREFILE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Note that ShareFile is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP ShareFile only supports filenames up to 256 characters in length. .PP \f[C]rclone about\f[R] is not supported by the Citrix ShareFile backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH Crypt .PP Rclone \f[C]crypt\f[R] remotes encrypt and decrypt other remotes. .PP A remote of type \f[C]crypt\f[R] does not access a storage system (https://rclone.org/overview/) directly, but instead wraps another remote, which in turn accesses the storage system. This is similar to how alias (https://rclone.org/alias/), union (https://rclone.org/union/), chunker (https://rclone.org/chunker/) and a few others work. It makes the usage very flexible, as you can add a layer, in this case an encryption layer, on top of any other backend, even in multiple layers. Rclone\[aq]s functionality can be used as with any other remote, for example you can mount (https://rclone.org/commands/rclone_mount/) a crypt remote. .PP Accessing a storage system through a crypt remote realizes client-side encryption, which makes it safe to keep your data in a location you do not trust will not get compromised. When working against the \f[C]crypt\f[R] remote, rclone will automatically encrypt (before uploading) and decrypt (after downloading) on your local system as needed on the fly, leaving the data encrypted at rest in the wrapped remote. If you access the storage system using an application other than rclone, or access the wrapped remote directly using rclone, there will not be any encryption/decryption: Downloading existing content will just give you the encrypted (scrambled) format, and anything you upload will \f[I]not\f[R] become encrypted. .PP The encryption is a secret-key encryption (also called symmetric key encryption) algorithm, where a password (or pass phrase) is used to generate real encryption key. The password can be supplied by user, or you may chose to let rclone generate one. It will be stored in the configuration file, in a lightly obscured form. If you are in an environment where you are not able to keep your configuration secured, you should add configuration encryption (https://rclone.org/docs/#configuration-encryption) as protection. As long as you have this configuration file, you will be able to decrypt your data. Without the configuration file, as long as you remember the password (or keep it in a safe place), you can re-create the configuration and gain access to the existing data. You may also configure a corresponding remote in a different installation to access the same data. See below for guidance to changing password. .PP Encryption uses cryptographic salt (https://en.wikipedia.org/wiki/Salt_(cryptography)), to permute the encryption key so that the same string may be encrypted in different ways. When configuring the crypt remote it is optional to enter a salt, or to let rclone generate a unique salt. If omitted, rclone uses a built-in unique string. Normally in cryptography, the salt is stored together with the encrypted content, and do not have to be memorized by the user. This is not the case in rclone, because rclone does not store any additional information on the remotes. Use of custom salt is effectively a second password that must be memorized. .PP File content encryption is performed using NaCl SecretBox (https://godoc.org/golang.org/x/crypto/nacl/secretbox), based on XSalsa20 cipher and Poly1305 for integrity. Names (file- and directory names) are also encrypted by default, but this has some implications and is therefore possible to be turned off. .SS Configuration .PP Here is an example of how to make a remote called \f[C]secret\f[R]. .PP To use \f[C]crypt\f[R], first set up the underlying remote. Follow the \f[C]rclone config\f[R] instructions for the specific backend. .PP Before configuring the crypt remote, check the underlying remote is working. In this example the underlying remote is called \f[C]remote\f[R]. We will configure a path \f[C]path\f[R] within this remote to contain the encrypted content. Anything inside \f[C]remote:path\f[R] will be encrypted and anything outside will not. .PP Configure \f[C]crypt\f[R] using \f[C]rclone config\f[R]. In this example the \f[C]crypt\f[R] remote is called \f[C]secret\f[R], to differentiate it from the underlying \f[C]remote\f[R]. .PP When you are done you can use the crypt remote named \f[C]secret\f[R] just as you would with any other remote, e.g. \f[C]rclone copy D:\[rs]docs secret:\[rs]docs\f[R], and rclone will encrypt and decrypt as needed on the fly. If you access the wrapped remote \f[C]remote:path\f[R] directly you will bypass the encryption, and anything you read will be in encrypted form, and anything you write will be unencrypted. To avoid issues it is best to configure a dedicated path for encrypted content, and access it exclusively through a crypt remote. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> secret Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Encrypt/Decrypt a remote \[rs] \[dq]crypt\[dq] [snip] Storage> crypt ** See help for crypt backend at: https://rclone.org/crypt/ ** Remote to encrypt/decrypt. Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). Enter a string value. Press Enter for the default (\[dq]\[dq]). remote> remote:path How to encrypt the filenames. Enter a string value. Press Enter for the default (\[dq]standard\[dq]). Choose a number from below, or type in your own value. / Encrypt the filenames. 1 | See the docs for the details. \[rs] \[dq]standard\[dq] 2 / Very simple filename obfuscation. \[rs] \[dq]obfuscate\[dq] / Don\[aq]t encrypt the file names. 3 | Adds a \[dq].bin\[dq] extension only. \[rs] \[dq]off\[dq] filename_encryption> Option to either encrypt directory names or leave them intact. NB If filename_encryption is \[dq]off\[dq] then this option will do nothing. Enter a boolean value (true or false). Press Enter for the default (\[dq]true\[dq]). Choose a number from below, or type in your own value 1 / Encrypt directory names. \[rs] \[dq]true\[dq] 2 / Don\[aq]t encrypt directory names, leave them intact. \[rs] \[dq]false\[dq] directory_name_encryption> Password or pass phrase for encryption. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank (default) y/g/n> g Password strength in bits. 64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this password? Please note that an obscured version of this password (and not the password itself) will be stored under your configuration file, so keep this generated password in a safe place. y) Yes (default) n) No y/n> Edit advanced config? (y/n) y) Yes n) No (default) y/n> Remote config -------------------- [secret] type = crypt remote = remote:path password = *** ENCRYPTED *** password2 = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> \f[R] .fi .PP \f[B]Important\f[R] The crypt password stored in \f[C]rclone.conf\f[R] is lightly obscured. That only protects it from cursory inspection. It is not secure unless configuration encryption (https://rclone.org/docs/#configuration-encryption) of \f[C]rclone.conf\f[R] is specified. .PP A long passphrase is recommended, or \f[C]rclone config\f[R] can generate a random one. .PP The obscured password is created using AES-CTR with a static key. The IV (nonce) is stored verbatim at the beginning of the obscured password. This static key is shared between all versions of rclone. .PP If you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible, but the obscured version will be different due to the different salt. .PP Rclone does not encrypt .IP \[bu] 2 file length - this can be calculated within 16 bytes .IP \[bu] 2 modification time - used for syncing .SS Specifying the remote .PP When configuring the remote to encrypt/decrypt, you may specify any string that rclone accepts as a source/destination of other commands. .PP The primary use case is to specify the path into an already configured remote (e.g. \f[C]remote:path/to/dir\f[R] or \f[C]remote:bucket\f[R]), such that data in a remote untrusted location can be stored encrypted. .PP You may also specify a local filesystem path, such as \f[C]/path/to/dir\f[R] on Linux, \f[C]C:\[rs]path\[rs]to\[rs]dir\f[R] on Windows. By creating a crypt remote pointing to such a local filesystem path, you can use rclone as a utility for pure local file encryption, for example to keep encrypted files on a removable USB drive. .PP \f[B]Note\f[R]: A string which do not contain a \f[C]:\f[R] will by rclone be treated as a relative path in the local filesystem. For example, if you enter the name \f[C]remote\f[R] without the trailing \f[C]:\f[R], it will be treated as a subdirectory of the current directory with name \[dq]remote\[dq]. .PP If a path \f[C]remote:path/to/dir\f[R] is specified, rclone stores encrypted files in \f[C]path/to/dir\f[R] on the remote. With file name encryption, files saved to \f[C]secret:subdir/subfile\f[R] are stored in the unencrypted path \f[C]path/to/dir\f[R] but the \f[C]subdir/subpath\f[R] element is encrypted. .PP The path you specify does not have to exist, rclone will create it when needed. .PP If you intend to use the wrapped remote both directly for keeping unencrypted content, as well as through a crypt remote for encrypted content, it is recommended to point the crypt remote to a separate directory within the wrapped remote. If you use a bucket-based storage system (e.g. Swift, S3, Google Compute Storage, B2) it is generally advisable to wrap the crypt remote around a specific bucket (\f[C]s3:bucket\f[R]). If wrapping around the entire root of the storage (\f[C]s3:\f[R]), and use the optional file name encryption, rclone will encrypt the bucket name. .SS Changing password .PP Should the password, or the configuration file containing a lightly obscured form of the password, be compromised, you need to re-encrypt your data with a new password. Since rclone uses secret-key encryption, where the encryption key is generated directly from the password kept on the client, it is not possible to change the password/key of already encrypted content. Just changing the password configured for an existing crypt remote means you will no longer able to decrypt any of the previously encrypted content. The only possibility is to re-upload everything via a crypt remote configured with your new password. .PP Depending on the size of your data, your bandwidth, storage quota etc, there are different approaches you can take: - If you have everything in a different location, for example on your local system, you could remove all of the prior encrypted files, change the password for your configured crypt remote (or delete and re-create the crypt configuration), and then re-upload everything from the alternative location. - If you have enough space on the storage system you can create a new crypt remote pointing to a separate directory on the same backend, and then use rclone to copy everything from the original crypt remote to the new, effectively decrypting everything on the fly using the old password and re-encrypting using the new password. When done, delete the original crypt remote directory and finally the rclone crypt configuration with the old password. All data will be streamed from the storage system and back, so you will get half the bandwidth and be charged twice if you have upload and download quota on the storage system. .PP \f[B]Note\f[R]: A security problem related to the random password generator was fixed in rclone version 1.53.3 (released 2020-11-19). Passwords generated by rclone config in version 1.49.0 (released 2019-08-26) to 1.53.2 (released 2020-10-26) are not considered secure and should be changed. If you made up your own password, or used rclone version older than 1.49.0 or newer than 1.53.2 to generate it, you are \f[I]not\f[R] affected by this issue. See issue #4783 (https://github.com/rclone/rclone/issues/4783) for more details, and a tool you can use to check if you are affected. .SS Example .PP Create the following file structure using \[dq]standard\[dq] file name encryption. .IP .nf \f[C] plaintext/ \[u251C]\[u2500]\[u2500] file0.txt \[u251C]\[u2500]\[u2500] file1.txt \[u2514]\[u2500]\[u2500] subdir \[u251C]\[u2500]\[u2500] file2.txt \[u251C]\[u2500]\[u2500] file3.txt \[u2514]\[u2500]\[u2500] subsubdir \[u2514]\[u2500]\[u2500] file4.txt \f[R] .fi .PP Copy these to the remote, and list them .IP .nf \f[C] $ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 subdir/file3.txt \f[R] .fi .PP The crypt remote looks like .IP .nf \f[C] $ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 v05749mltvv1tf4onltun46gls 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps \f[R] .fi .PP The directory structure is preserved .IP .nf \f[C] $ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 subsubdir/file4.txt \f[R] .fi .PP Without file name encryption \f[C].bin\f[R] extensions are added to underlying names. This prevents the cloud provider attempting to interpret file content. .IP .nf \f[C] $ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin \f[R] .fi .SS File name encryption modes .PP Off .IP \[bu] 2 doesn\[aq]t hide file names or directory structure .IP \[bu] 2 allows for longer file names (\[ti]246 characters) .IP \[bu] 2 can use sub paths and copy single files .PP Standard .IP \[bu] 2 file names encrypted .IP \[bu] 2 file names can\[aq]t be as long (\[ti]143 characters) .IP \[bu] 2 can use sub paths and copy single files .IP \[bu] 2 directory structure visible .IP \[bu] 2 identical files names will have identical uploaded names .IP \[bu] 2 can use shortcuts to shorten the directory recursion .PP Obfuscation .PP This is a simple \[dq]rotate\[dq] of the filename, with each file having a rot distance based on the filename. Rclone stores the distance at the beginning of the filename. A file called \[dq]hello\[dq] may become \[dq]53.jgnnq\[dq]. .PP Obfuscation is not a strong encryption of filenames, but hinders automated scanning tools picking up on filename patterns. It is an intermediate between \[dq]off\[dq] and \[dq]standard\[dq] which allows for longer path segment names. .PP There is a possibility with some unicode based filenames that the obfuscation is weak and may map lower case characters to upper case equivalents. .PP Obfuscation cannot be relied upon for strong protection. .IP \[bu] 2 file names very lightly obfuscated .IP \[bu] 2 file names can be longer than standard encryption .IP \[bu] 2 can use sub paths and copy single files .IP \[bu] 2 directory structure visible .IP \[bu] 2 identical files names will have identical uploaded names .PP Cloud storage systems have limits on file name length and total path length which rclone is more likely to breach using \[dq]Standard\[dq] file name encryption. Where file names are 143 or fewer characters in length issues should not be encountered, irrespective of cloud storage provider. .PP An experimental advanced option \f[C]filename_encoding\f[R] is now provided to address this problem to a certain degree. For cloud storage systems with case sensitive file names (e.g. Google Drive), \f[C]base64\f[R] can be used to reduce file name length. For cloud storage systems using UTF-16 to store file names internally (e.g. OneDrive, Dropbox, Box), \f[C]base32768\f[R] can be used to drastically reduce file name length. .PP An alternative, future rclone file name encryption mode may tolerate backend provider path length limits. .SS Directory name encryption .PP Crypt offers the option of encrypting dir names or leaving them intact. There are two options: .PP True .PP Encrypts the whole file path including directory names Example: \f[C]1/12/123.txt\f[R] is encrypted to \f[C]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\f[R] .PP False .PP Only encrypts file names, skips directory names Example: \f[C]1/12/123.txt\f[R] is encrypted to \f[C]1/12/qgm4avr35m5loi1th53ato71v0\f[R] .SS Modification times and hashes .PP Crypt stores modification times using the underlying remote so support depends on that. .PP Hashes are not stored for crypt. However the data integrity is protected by an extremely strong crypto authenticator. .PP Use the \f[C]rclone cryptcheck\f[R] command to check the integrity of an encrypted remote instead of \f[C]rclone check\f[R] which can\[aq]t check the checksums properly. .SS Standard options .PP Here are the Standard options specific to crypt (Encrypt/Decrypt a remote). .SS --crypt-remote .PP Remote to encrypt/decrypt. .PP Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_CRYPT_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --crypt-filename-encryption .PP How to encrypt the filenames. .PP Properties: .IP \[bu] 2 Config: filename_encryption .IP \[bu] 2 Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]standard\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]standard\[dq] .RS 2 .IP \[bu] 2 Encrypt the filenames. .IP \[bu] 2 See the docs for the details. .RE .IP \[bu] 2 \[dq]obfuscate\[dq] .RS 2 .IP \[bu] 2 Very simple filename obfuscation. .RE .IP \[bu] 2 \[dq]off\[dq] .RS 2 .IP \[bu] 2 Don\[aq]t encrypt the file names. .IP \[bu] 2 Adds a \[dq].bin\[dq], or \[dq]suffix\[dq] extension only. .RE .RE .SS --crypt-directory-name-encryption .PP Option to either encrypt directory names or leave them intact. .PP NB If filename_encryption is \[dq]off\[dq] then this option will do nothing. .PP Properties: .IP \[bu] 2 Config: directory_name_encryption .IP \[bu] 2 Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Encrypt directory names. .RE .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Don\[aq]t encrypt directory names, leave them intact. .RE .RE .SS --crypt-password .PP Password or pass phrase for encryption. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_CRYPT_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --crypt-password2 .PP Password or pass phrase for salt. .PP Optional but recommended. Should be different to the previous password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password2 .IP \[bu] 2 Env Var: RCLONE_CRYPT_PASSWORD2 .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to crypt (Encrypt/Decrypt a remote). .SS --crypt-server-side-across-configs .PP Deprecated: use --server-side-across-configs instead. .PP Allow server-side operations (e.g. copy) to work across different crypt configs. .PP Normally this option is not what you want, but if you have two crypts pointing to the same backend you can use it. .PP This can be used, for example, to change file name encryption type without re-uploading all the data. Just make two crypt backends pointing to two different directories with the single changed parameter and use rclone move to move the files between the crypt remotes. .PP Properties: .IP \[bu] 2 Config: server_side_across_configs .IP \[bu] 2 Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --crypt-show-mapping .PP For all files listed show how the names encrypt. .PP If this flag is set then for each file that the remote is asked to list, it will log (at level INFO) a line stating the decrypted file name and the encrypted file name. .PP This is so you can work out which encrypted names are which decrypted names just in case you need to do something with the encrypted file names, or for debugging purposes. .PP Properties: .IP \[bu] 2 Config: show_mapping .IP \[bu] 2 Env Var: RCLONE_CRYPT_SHOW_MAPPING .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --crypt-no-data-encryption .PP Option to either encrypt file data or leave it unencrypted. .PP Properties: .IP \[bu] 2 Config: no_data_encryption .IP \[bu] 2 Env Var: RCLONE_CRYPT_NO_DATA_ENCRYPTION .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Don\[aq]t encrypt file data, leave it unencrypted. .RE .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Encrypt file data. .RE .RE .SS --crypt-pass-bad-blocks .PP If set this will pass bad blocks through as all 0. .PP This should not be set in normal operation, it should only be set if trying to recover an encrypted file with errors and it is desired to recover as much of the file as possible. .PP Properties: .IP \[bu] 2 Config: pass_bad_blocks .IP \[bu] 2 Env Var: RCLONE_CRYPT_PASS_BAD_BLOCKS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --crypt-strict-names .PP If set, this will raise an error when crypt comes across a filename that can\[aq]t be decrypted. .PP (By default, rclone will just log a NOTICE and continue as normal.) This can happen if encrypted and unencrypted files are stored in the same directory (which is not recommended.) It may also indicate a more serious problem that should be investigated. .PP Properties: .IP \[bu] 2 Config: strict_names .IP \[bu] 2 Env Var: RCLONE_CRYPT_STRICT_NAMES .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --crypt-filename-encoding .PP How to encode the encrypted filename to text string. .PP This option could help with shortening the encrypted filename. The suitable option would depend on the way your remote count the filename length and if it\[aq]s case sensitive. .PP Properties: .IP \[bu] 2 Config: filename_encoding .IP \[bu] 2 Env Var: RCLONE_CRYPT_FILENAME_ENCODING .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]base32\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]base32\[dq] .RS 2 .IP \[bu] 2 Encode using base32. Suitable for all remote. .RE .IP \[bu] 2 \[dq]base64\[dq] .RS 2 .IP \[bu] 2 Encode using base64. Suitable for case sensitive remote. .RE .IP \[bu] 2 \[dq]base32768\[dq] .RS 2 .IP \[bu] 2 Encode using base32768. Suitable if your remote counts UTF-16 or .IP \[bu] 2 Unicode codepoint instead of UTF-8 byte length. (Eg. Onedrive, Dropbox) .RE .RE .SS --crypt-suffix .PP If this is set it will override the default suffix of \[dq].bin\[dq]. .PP Setting suffix to \[dq]none\[dq] will result in an empty suffix. This may be useful when the path length is critical. .PP Properties: .IP \[bu] 2 Config: suffix .IP \[bu] 2 Env Var: RCLONE_CRYPT_SUFFIX .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq].bin\[dq] .SS --crypt-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_CRYPT_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Any metadata supported by the underlying remote is read and written. .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Backend commands .PP Here are the commands specific to the crypt backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS encode .PP Encode the given filename(s) .IP .nf \f[C] rclone backend encode remote: [options] [<arguments>+] \f[R] .fi .PP This encodes the filenames given as arguments returning a list of strings of the encoded results. .PP Usage Example: .IP .nf \f[C] rclone backend encode crypt: file1 [file2...] rclone rc backend/command command=encode fs=crypt: file1 [file2...] \f[R] .fi .SS decode .PP Decode the given filename(s) .IP .nf \f[C] rclone backend decode remote: [options] [<arguments>+] \f[R] .fi .PP This decodes the filenames given as arguments returning a list of strings of the decoded results. It will return an error if any of the inputs are invalid. .PP Usage Example: .IP .nf \f[C] rclone backend decode crypt: encryptedfile1 [encryptedfile2...] rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] \f[R] .fi .SS Backing up an encrypted remote .PP If you wish to backup an encrypted remote, it is recommended that you use \f[C]rclone sync\f[R] on the encrypted files, and make sure the passwords are the same in the new encrypted remote. .PP This will have the following advantages .IP \[bu] 2 \f[C]rclone sync\f[R] will check the checksums while copying .IP \[bu] 2 you can use \f[C]rclone check\f[R] between the encrypted remotes .IP \[bu] 2 you don\[aq]t decrypt and encrypt unnecessarily .PP For example, let\[aq]s say you have your original remote at \f[C]remote:\f[R] with the encrypted version at \f[C]eremote:\f[R] with path \f[C]remote:crypt\f[R]. You would then set up the new remote \f[C]remote2:\f[R] and then the encrypted version \f[C]eremote2:\f[R] with path \f[C]remote2:crypt\f[R] using the same passwords as \f[C]eremote:\f[R]. .PP To sync the two remotes you would do .IP .nf \f[C] rclone sync --interactive remote:crypt remote2:crypt \f[R] .fi .PP And to check the integrity you would do .IP .nf \f[C] rclone check remote:crypt remote2:crypt \f[R] .fi .SS File formats .SS File encryption .PP Files are encrypted 1:1 source file to destination object. The file has a header and is divided into chunks. .SS Header .IP \[bu] 2 8 bytes magic string \f[C]RCLONE\[rs]x00\[rs]x00\f[R] .IP \[bu] 2 24 bytes Nonce (IV) .PP The initial nonce is generated from the operating systems crypto strong random number generator. The nonce is incremented for each chunk read making sure each nonce is unique for each block written. The chance of a nonce being reused is minuscule. If you wrote an exabyte of data (10\[S1]\[u2078] bytes) you would have a probability of approximately 2\[tmu]10\[u207B]\[S3]\[S2] of reusing a nonce. .SS Chunk .PP Each chunk will contain 64 KiB of data, except for the last one which may have less data. The data chunk is in standard NaCl SecretBox format. SecretBox uses XSalsa20 and Poly1305 to encrypt and authenticate messages. .PP Each chunk contains: .IP \[bu] 2 16 Bytes of Poly1305 authenticator .IP \[bu] 2 1 - 65536 bytes XSalsa20 encrypted data .PP 64k chunk size was chosen as the best performing chunk size (the authenticator takes too much time below this and the performance drops off due to cache effects above this). Note that these chunks are buffered in memory so they can\[aq]t be too big. .PP This uses a 32 byte (256 bit key) key derived from the user password. .SS Examples .PP 1 byte file will encrypt to .IP \[bu] 2 32 bytes header .IP \[bu] 2 17 bytes data chunk .PP 49 bytes total .PP 1 MiB (1048576 bytes) file will encrypt to .IP \[bu] 2 32 bytes header .IP \[bu] 2 16 chunks of 65568 bytes .PP 1049120 bytes total (a 0.05% overhead). This is the overhead for big files. .SS Name encryption .PP File names are encrypted segment by segment - the path is broken up into \f[C]/\f[R] separated strings and these are encrypted individually. .PP File segments are padded using PKCS#7 to a multiple of 16 bytes before encryption. .PP They are then encrypted with EME using AES with 256 bit key. EME (ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 paper \[dq]A Parallelizable Enciphering Mode\[dq] by Halevi and Rogaway. .PP This makes for deterministic encryption which is what we want - the same filename must encrypt to the same thing otherwise we can\[aq]t find it on the cloud storage system. .PP This means that .IP \[bu] 2 filenames with the same name will encrypt the same .IP \[bu] 2 filenames which start the same won\[aq]t have a common prefix .PP This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password. .PP After encryption they are written out using a modified version of standard \f[C]base32\f[R] encoding as described in RFC4648. The standard encoding is modified in two ways: .IP \[bu] 2 it becomes lower case (no-one likes upper case filenames!) .IP \[bu] 2 we strip the padding character \f[C]=\f[R] .PP \f[C]base32\f[R] is used rather than the more efficient \f[C]base64\f[R] so rclone can be used on case insensitive remotes (e.g. Windows, Box, Dropbox, Onedrive etc). .SS Key derivation .PP Rclone uses \f[C]scrypt\f[R] with parameters \f[C]N=16384, r=8, p=1\f[R] with an optional user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key material required. If the user doesn\[aq]t supply a salt then rclone uses an internal one. .PP \f[C]scrypt\f[R] makes it impractical to mount a dictionary attack on rclone encrypted data. For full protection against this you should always use a salt. .SS SEE ALSO .IP \[bu] 2 rclone cryptdecode (https://rclone.org/commands/rclone_cryptdecode/) - Show forward/reverse mapping of encrypted filenames .SH Compress .SS Warning .PP This remote is currently \f[B]experimental\f[R]. Things may break and data may be lost. Anything you do with this remote is at your own risk. Please understand the risks associated with using experimental code and don\[aq]t use this remote in critical applications. .PP The \f[C]Compress\f[R] remote adds compression to another remote. It is best used with remotes containing many large compressible files. .SS Configuration .PP To use this remote, all you need to do is specify another remote and a compression mode to use: .IP .nf \f[C] Current remotes: Name Type ==== ==== remote_to_press sometype e) Edit existing remote $ rclone config 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> n name> compress \&... 8 / Compress a remote \[rs] \[dq]compress\[dq] \&... Storage> compress ** See help for compress backend at: https://rclone.org/compress/ ** Remote to compress. Enter a string value. Press Enter for the default (\[dq]\[dq]). remote> remote_to_press:subdir Compression mode. Enter a string value. Press Enter for the default (\[dq]gzip\[dq]). Choose a number from below, or type in your own value 1 / Gzip compression balanced for speed and compression strength. \[rs] \[dq]gzip\[dq] compression_mode> gzip Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [compress] type = compress remote = remote_to_press:subdir compression_mode = gzip -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Compression Modes .PP Currently only gzip compression is supported. It provides a decent balance between speed and size and is well supported by other applications. Compression strength can further be configured via an advanced setting where 0 is no compression and 9 is strongest compression. .SS File types .PP If you open a remote wrapped by compress, you will see that there are many files with an extension corresponding to the compression algorithm you chose. These files are standard files that can be opened by various archive programs, but they have some hidden metadata that allows them to be used by rclone. While you may download and decompress these files at will, do \f[B]not\f[R] manually delete or rename files. Files without correct metadata files will not be recognized by rclone. .SS File names .PP The compressed files will be named \f[C]*.###########.gz\f[R] where \f[C]*\f[R] is the base file and the \f[C]#\f[R] part is base64 encoded size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend. .SS Standard options .PP Here are the Standard options specific to compress (Compress a remote). .SS --compress-remote .PP Remote to compress. .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_COMPRESS_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --compress-mode .PP Compression mode. .PP Properties: .IP \[bu] 2 Config: mode .IP \[bu] 2 Env Var: RCLONE_COMPRESS_MODE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]gzip\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]gzip\[dq] .RS 2 .IP \[bu] 2 Standard gzip compression with fastest parameters. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to compress (Compress a remote). .SS --compress-level .PP GZIP compression level (-2 to 9). .PP Generally -1 (default, equivalent to 5) is recommended. Levels 1 to 9 increase compression at the cost of speed. Going past 6 generally offers very little return. .PP Level -2 uses Huffman encoding only. Only use if you know what you are doing. Level 0 turns off compression. .PP Properties: .IP \[bu] 2 Config: level .IP \[bu] 2 Env Var: RCLONE_COMPRESS_LEVEL .IP \[bu] 2 Type: int .IP \[bu] 2 Default: -1 .SS --compress-ram-cache-limit .PP Some remotes don\[aq]t allow the upload of files with unknown size. In this case the compressed file will need to be cached to determine it\[aq]s size. .PP Files smaller than this limit will be cached in RAM, files larger than this limit will be cached on disk. .PP Properties: .IP \[bu] 2 Config: ram_cache_limit .IP \[bu] 2 Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 20Mi .SS --compress-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_COMPRESS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Any metadata supported by the underlying remote is read and written. .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SH Combine .PP The \f[C]combine\f[R] backend joins remotes together into a single directory tree. .PP For example you might have a remote for images on one provider: .IP .nf \f[C] $ rclone tree s3:imagesbucket / \[u251C]\[u2500]\[u2500] image1.jpg \[u2514]\[u2500]\[u2500] image2.jpg \f[R] .fi .PP And a remote for files on another: .IP .nf \f[C] $ rclone tree drive:important/files / \[u251C]\[u2500]\[u2500] file1.txt \[u2514]\[u2500]\[u2500] file2.txt \f[R] .fi .PP The \f[C]combine\f[R] backend can join these together into a synthetic directory structure like this: .IP .nf \f[C] $ rclone tree combined: / \[u251C]\[u2500]\[u2500] files \[br] \[u251C]\[u2500]\[u2500] file1.txt \[br] \[u2514]\[u2500]\[u2500] file2.txt \[u2514]\[u2500]\[u2500] images \[u251C]\[u2500]\[u2500] image1.jpg \[u2514]\[u2500]\[u2500] image2.jpg \f[R] .fi .PP You\[aq]d do this by specifying an \f[C]upstreams\f[R] parameter in the config like this .IP .nf \f[C] upstreams = images=s3:imagesbucket files=drive:important/files \f[R] .fi .PP During the initial setup with \f[C]rclone config\f[R] you will specify the upstreams remotes as a space separated list. The upstream remotes can either be a local paths or other remotes. .SS Configuration .PP Here is an example of how to make a combine called \f[C]remote\f[R] for the example above. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. \&... XX / Combine several remotes into one \[rs] (combine) \&... Storage> combine Option upstreams. Upstreams for combining These should be in the form dir=remote:path dir2=remote2:path Where before the = is specified the root directory and after is the remote to put there. Embedded spaces can be added using quotes \[dq]dir=remote:path with space\[dq] \[dq]dir2=remote2:path with space\[dq] Enter a fs.SpaceSepList value. upstreams> images=s3:imagesbucket files=drive:important/files Configuration complete. Options: - type: combine - upstreams: images=s3:imagesbucket files=drive:important/files Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Configuring for Google Drive Shared Drives .PP Rclone has a convenience feature for making a combine backend for all the shared drives you have access to. .PP Assuming your main (non shared drive) Google drive remote is called \f[C]drive:\f[R] you would run .IP .nf \f[C] rclone backend -o config drives drive: \f[R] .fi .PP This would produce something like this: .IP .nf \f[C] [My Drive] type = alias remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=: [Test Drive] type = alias remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: [AllDrives] type = combine upstreams = \[dq]My Drive=My Drive:\[dq] \[dq]Test Drive=Test Drive:\[dq] \f[R] .fi .PP If you then add that config to your config file (find it with \f[C]rclone config file\f[R]) then you can access all the shared drives in one place with the \f[C]AllDrives:\f[R] remote. .PP See the Google Drive docs (https://rclone.org/drive/#drives) for full info. .SS Standard options .PP Here are the Standard options specific to combine (Combine several remotes into one). .SS --combine-upstreams .PP Upstreams for combining .PP These should be in the form .IP .nf \f[C] dir=remote:path dir2=remote2:path \f[R] .fi .PP Where before the = is specified the root directory and after is the remote to put there. .PP Embedded spaces can be added using quotes .IP .nf \f[C] \[dq]dir=remote:path with space\[dq] \[dq]dir2=remote2:path with space\[dq] \f[R] .fi .PP Properties: .IP \[bu] 2 Config: upstreams .IP \[bu] 2 Env Var: RCLONE_COMBINE_UPSTREAMS .IP \[bu] 2 Type: SpaceSepList .IP \[bu] 2 Default: .SS Advanced options .PP Here are the Advanced options specific to combine (Combine several remotes into one). .SS --combine-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_COMBINE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Any metadata supported by the underlying remote is read and written. .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SH Dropbox .PP Paths are specified as \f[C]remote:path\f[R] .PP Dropbox paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP The initial setup for dropbox involves getting a token from Dropbox which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] n) New remote d) Delete remote q) Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Dropbox \[rs] \[dq]dropbox\[dq] [snip] Storage> dropbox Dropbox App Key - leave blank normally. app_key> Dropbox App Secret - leave blank normally. app_secret> Remote config Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX Configuration complete. Options: - type: dropbox - app_key: - app_secret: - token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Dropbox. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and it may require you to unblock it temporarily if you are running a host firewall, or use manual mode. .PP You can then use it like this, .PP List directories in top level of your dropbox .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your dropbox .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to a dropbox directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Dropbox for business .PP Rclone supports Dropbox for business and Team Folders. .PP When using Dropbox for business \f[C]remote:\f[R] and \f[C]remote:path/to/file\f[R] will refer to your personal folder. .PP If you wish to see Team Folders you must use a leading \f[C]/\f[R] in the path, so \f[C]rclone lsd remote:/\f[R] will refer to the root and show you all Team Folders and your User Folder. .PP You can then use team folders like this \f[C]remote:/TeamFolder\f[R] and \f[C]remote:/TeamFolder/path/to/file\f[R]. .PP A leading \f[C]/\f[R] for a Dropbox personal account will do nothing, but it will take an extra HTTP transaction so it should be avoided. .SS Modification times and hashes .PP Dropbox supports modified times, but the only way to set a modification time is to re-upload the file. .PP This means that if you uploaded your data with an older version of rclone which didn\[aq]t support the v2 API and modified times, rclone will decide to upload all your old data to fix the modification times. If you don\[aq]t want this to happen use \f[C]--size-only\f[R] or \f[C]--checksum\f[R] flag to stop it. .PP Dropbox supports its own hash type (https://www.dropbox.com/developers/reference/content-hash) which is checked for all transfers. .SS Restricted filename characters .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} T{ DEL T}@T{ 0x7F T}@T{ \[u2421] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} .TE .PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Batch mode uploads .PP Using batch mode uploads is very important for performance when using the Dropbox API. See the dropbox performance guide (https://developers.dropbox.com/dbx-performance-guide) for more info. .PP There are 3 modes rclone can use for uploads. .SS --dropbox-batch-mode off .PP In this mode rclone will not use upload batching. This was the default before rclone v1.55. It has the disadvantage that it is very likely to encounter \f[C]too_many_requests\f[R] errors like this .IP .nf \f[C] NOTICE: too_many_requests/.: Too many requests or write operations. Trying again in 15 seconds. \f[R] .fi .PP When rclone receives these it has to wait for 15s or sometimes 300s before continuing which really slows down transfers. .PP This will happen especially if \f[C]--transfers\f[R] is large, so this mode isn\[aq]t recommended except for compatibility or investigating problems. .SS --dropbox-batch-mode sync .PP In this mode rclone will batch up uploads to the size specified by \f[C]--dropbox-batch-size\f[R] and commit them together. .PP Using this mode means you can use a much higher \f[C]--transfers\f[R] parameter (32 or 64 works fine) without receiving \f[C]too_many_requests\f[R] errors. .PP This mode ensures full data integrity. .PP Note that there may be a pause when quitting rclone while rclone finishes up the last batch using this mode. .SS --dropbox-batch-mode async .PP In this mode rclone will batch up uploads to the size specified by \f[C]--dropbox-batch-size\f[R] and commit them together. .PP However it will not wait for the status of the batch to be returned to the caller. This means rclone can use a much bigger batch size (much bigger than \f[C]--transfers\f[R]), at the cost of not being able to check the status of the upload. .PP This provides the maximum possible upload speed especially with lots of small files, however rclone can\[aq]t check the file got uploaded properly using this mode. .PP If you are using this mode then using \[dq]rclone check\[dq] after the transfer completes is recommended. Or you could do an initial transfer with \f[C]--dropbox-batch-mode async\f[R] then do a final transfer with \f[C]--dropbox-batch-mode sync\f[R] (the default). .PP Note that there may be a pause when quitting rclone while rclone finishes up the last batch using this mode. .SS Standard options .PP Here are the Standard options specific to dropbox (Dropbox). .SS --dropbox-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_DROPBOX_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_DROPBOX_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to dropbox (Dropbox). .SS --dropbox-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_DROPBOX_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_DROPBOX_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_DROPBOX_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_DROPBOX_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --dropbox-chunk-size .PP Upload chunk size (< 150Mi). .PP Any files larger than this will be uploaded in chunks of this size. .PP Note that chunks are buffered in memory (one at a time) so rclone can deal with retries. Setting this larger will increase the speed slightly (at most 10% for 128 MiB in tests) at the cost of using more memory. It can be set smaller if you are tight on memory. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_DROPBOX_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 48Mi .SS --dropbox-impersonate .PP Impersonate this user when using a business account. .PP Note that if you want to use impersonate, you should make sure this flag is set when running \[dq]rclone config\[dq] as this will cause rclone to request the \[dq]members.read\[dq] scope which it won\[aq]t normally. This is needed to lookup a members email address into the internal ID that dropbox uses in the API. .PP Using the \[dq]members.read\[dq] scope will require a Dropbox Team Admin to approve during the OAuth flow. .PP You will have to use your own App (setting your own client_id and client_secret) to use this option as currently rclone\[aq]s default set of permissions doesn\[aq]t include \[dq]members.read\[dq]. This can be added once v1.55 or later is in use everywhere. .PP Properties: .IP \[bu] 2 Config: impersonate .IP \[bu] 2 Env Var: RCLONE_DROPBOX_IMPERSONATE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-shared-files .PP Instructs rclone to work on individual shared files. .PP In this mode rclone\[aq]s features are extremely limited - only list (ls, lsl, etc.) operations and read operations (e.g. downloading) are supported in this mode. All other operations will be disabled. .PP Properties: .IP \[bu] 2 Config: shared_files .IP \[bu] 2 Env Var: RCLONE_DROPBOX_SHARED_FILES .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --dropbox-shared-folders .PP Instructs rclone to work on shared folders. .PP When this flag is used with no path only the List operation is supported and all available shared folders will be listed. If you specify a path the first part will be interpreted as the name of shared folder. Rclone will then try to mount this shared to the root namespace. On success shared folder rclone proceeds normally. The shared folder is now pretty much a normal folder and all normal operations are supported. .PP Note that we don\[aq]t unmount the shared folder afterwards so the --dropbox-shared-folders can be omitted after the first use of a particular shared folder. .PP See also --dropbox-root-namespace for an alternative way to work with shared folders. .PP Properties: .IP \[bu] 2 Config: shared_folders .IP \[bu] 2 Env Var: RCLONE_DROPBOX_SHARED_FOLDERS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --dropbox-pacer-min-sleep .PP Minimum time to sleep between API calls. .PP Properties: .IP \[bu] 2 Config: pacer_min_sleep .IP \[bu] 2 Env Var: RCLONE_DROPBOX_PACER_MIN_SLEEP .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 10ms .SS --dropbox-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_DROPBOX_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot .SS --dropbox-root-namespace .PP Specify a different Dropbox namespace ID to use as the root for all paths. .PP Properties: .IP \[bu] 2 Config: root_namespace .IP \[bu] 2 Env Var: RCLONE_DROPBOX_ROOT_NAMESPACE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --dropbox-batch-mode .PP Upload file batching sync|async|off. .PP This sets the batch mode used by rclone. .PP For full info see the main docs (https://rclone.org/dropbox/#batch-mode) .PP This has 3 possible values .IP \[bu] 2 off - no batching .IP \[bu] 2 sync - batch uploads and check completion (default) .IP \[bu] 2 async - batch upload and don\[aq]t check completion .PP Rclone will close any outstanding batches when it exits which may make a delay on quit. .PP Properties: .IP \[bu] 2 Config: batch_mode .IP \[bu] 2 Env Var: RCLONE_DROPBOX_BATCH_MODE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]sync\[dq] .SS --dropbox-batch-size .PP Max number of files in upload batch. .PP This sets the batch size of files to upload. It has to be less than 1000. .PP By default this is 0 which means rclone will calculate the batch size depending on the setting of batch_mode. .IP \[bu] 2 batch_mode: async - default batch_size is 100 .IP \[bu] 2 batch_mode: sync - default batch_size is the same as --transfers .IP \[bu] 2 batch_mode: off - not in use .PP Rclone will close any outstanding batches when it exits which may make a delay on quit. .PP Setting this is a great idea if you are uploading lots of small files as it will make them a lot quicker. You can use --transfers 32 to maximise throughput. .PP Properties: .IP \[bu] 2 Config: batch_size .IP \[bu] 2 Env Var: RCLONE_DROPBOX_BATCH_SIZE .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 0 .SS --dropbox-batch-timeout .PP Max time to allow an idle upload batch before uploading. .PP If an upload batch is idle for more than this long then it will be uploaded. .PP The default for this is 0 which means rclone will choose a sensible default based on the batch_mode in use. .IP \[bu] 2 batch_mode: async - default batch_timeout is 10s .IP \[bu] 2 batch_mode: sync - default batch_timeout is 500ms .IP \[bu] 2 batch_mode: off - not in use .PP Properties: .IP \[bu] 2 Config: batch_timeout .IP \[bu] 2 Env Var: RCLONE_DROPBOX_BATCH_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 0s .SS --dropbox-batch-commit-timeout .PP Max time to wait for a batch to finish committing .PP Properties: .IP \[bu] 2 Config: batch_commit_timeout .IP \[bu] 2 Env Var: RCLONE_DROPBOX_BATCH_COMMIT_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 10m0s .SS --dropbox-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_DROPBOX_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Note that Dropbox is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP There are some file names such as \f[C]thumbs.db\f[R] which Dropbox can\[aq]t store. There is a full list of them in the \[dq]Ignored Files\[dq] section of this document (https://www.dropbox.com/en/help/145). Rclone will issue an error message \f[C]File name disallowed - not uploading\f[R] if it attempts to upload one of those file names, but the sync won\[aq]t fail. .PP Some errors may occur if you try to sync copyright-protected files because Dropbox has its own copyright detector (https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that prevents this sort of file being downloaded. This will return the error \f[C]ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.\f[R] .PP If you have more than 10,000 files in a directory then \f[C]rclone purge dropbox:dir\f[R] will return the error \f[C]Failed to purge: There are too many files involved in this operation\f[R]. As a work-around do an \f[C]rclone delete dropbox:dir\f[R] followed by an \f[C]rclone rmdir dropbox:dir\f[R]. .PP When using \f[C]rclone link\f[R] you\[aq]ll need to set \f[C]--expire\f[R] if using a non-personal account otherwise the visibility may not be correct. (Note that \f[C]--expire\f[R] isn\[aq]t supported on personal accounts). See the forum discussion (https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211) and the dropbox SDK issue (https://github.com/dropbox/dropbox-sdk-go-unofficial/issues/75). .SS Get your own Dropbox App ID .PP When you use rclone with Dropbox in its default configuration you are using rclone\[aq]s App ID. This is shared between all the rclone users. .PP Here is how to create your own Dropbox App ID for rclone: .IP "1." 3 Log into the Dropbox App console (https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not to be the same account as the Dropbox you want to access) .IP "2." 3 Choose an API => Usually this should be \f[C]Dropbox API\f[R] .IP "3." 3 Choose the type of access you want to use => \f[C]Full Dropbox\f[R] or \f[C]App Folder\f[R]. If you want to use Team Folders, \f[C]Full Dropbox\f[R] is required (see here (https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/How-to-create-team-folder-inside-my-app-s-folder/m-p/601005/highlight/true#M27911)). .IP "4." 3 Name your App. The app name is global, so you can\[aq]t use \f[C]rclone\f[R] for example .IP "5." 3 Click the button \f[C]Create App\f[R] .IP "6." 3 Switch to the \f[C]Permissions\f[R] tab. Enable at least the following permissions: \f[C]account_info.read\f[R], \f[C]files.metadata.write\f[R], \f[C]files.content.write\f[R], \f[C]files.content.read\f[R], \f[C]sharing.write\f[R]. The \f[C]files.metadata.read\f[R] and \f[C]sharing.read\f[R] checkboxes will be marked too. Click \f[C]Submit\f[R] .IP "7." 3 Switch to the \f[C]Settings\f[R] tab. Fill \f[C]OAuth2 - Redirect URIs\f[R] as \f[C]http://localhost:53682/\f[R] and click on \f[C]Add\f[R] .IP "8." 3 Find the \f[C]App key\f[R] and \f[C]App secret\f[R] values on the \f[C]Settings\f[R] tab. Use these values in rclone config to add a new remote or edit an existing remote. The \f[C]App key\f[R] setting corresponds to \f[C]client_id\f[R] in rclone config, the \f[C]App secret\f[R] corresponds to \f[C]client_secret\f[R] .SH Enterprise File Fabric .PP This backend supports Storage Made Easy\[aq]s Enterprise File Fabric\[tm] (https://storagemadeeasy.com/about/) which provides a software solution to integrate and unify File and Object Storage accessible through a global file system. .SS Configuration .PP The initial setup for the Enterprise File Fabric backend involves getting a token from the Enterprise File Fabric which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Enterprise File Fabric \[rs] \[dq]filefabric\[dq] [snip] Storage> filefabric ** See help for filefabric backend at: https://rclone.org/filefabric/ ** URL of the Enterprise File Fabric to connect to Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Storage Made Easy US \[rs] \[dq]https://storagemadeeasy.com\[dq] 2 / Storage Made Easy EU \[rs] \[dq]https://eu.storagemadeeasy.com\[dq] 3 / Connect to your Enterprise File Fabric \[rs] \[dq]https://yourfabric.smestorage.com\[dq] url> https://yourfabric.smestorage.com/ ID of the root folder Leave blank normally. Fill in to make rclone start with directory of a given ID. Enter a string value. Press Enter for the default (\[dq]\[dq]). root_folder_id> Permanent Authentication Token A Permanent Authentication Token can be created in the Enterprise File Fabric, on the users Dashboard under Security, there is an entry you\[aq]ll see called \[dq]My Authentication Tokens\[dq]. Click the Manage button to create one. These tokens are normally valid for several years. For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens Enter a string value. Press Enter for the default (\[dq]\[dq]). permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config Configuration complete. Options: - type: filefabric - url: https://yourfabric.smestorage.com/ - permanent_token: xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Enterprise File Fabric .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your Enterprise File Fabric .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an Enterprise File Fabric directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Modification times and hashes .PP The Enterprise File Fabric allows modification times to be set on files accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP The Enterprise File Fabric does not support any data hashes at this time. .SS Restricted filename characters .PP The default restricted characters set (https://rclone.org/overview/#restricted-characters) will be replaced. .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Empty files .PP Empty files aren\[aq]t supported by the Enterprise File Fabric. Rclone will therefore upload an empty file as a single space with a mime type of \f[C]application/vnd.rclone.empty.file\f[R] and files with that mime type are treated as empty. .SS Root folder ID .PP You can set the \f[C]root_folder_id\f[R] for rclone. This is the directory (identified by its \f[C]Folder ID\f[R]) that rclone considers to be the root of your Enterprise File Fabric. .PP Normally you will leave this blank and rclone will determine the correct root to use itself. .PP However you can set this to restrict rclone to a specific folder hierarchy. .PP In order to do this you will have to find the \f[C]Folder ID\f[R] of the directory you wish rclone to display. These aren\[aq]t displayed in the web interface, but you can use \f[C]rclone lsf\f[R] to find them, for example .IP .nf \f[C] $ rclone lsf --dirs-only -Fip --csv filefabric: 120673758,Burnt PDFs/ 120673759,My Quick Uploads/ 120673755,My Syncs/ 120673756,My backups/ 120673757,My contacts/ 120673761,S3 Storage/ \f[R] .fi .PP The ID for \[dq]S3 Storage\[dq] would be \f[C]120673761\f[R]. .SS Standard options .PP Here are the Standard options specific to filefabric (Enterprise File Fabric). .SS --filefabric-url .PP URL of the Enterprise File Fabric to connect to. .PP Properties: .IP \[bu] 2 Config: url .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]https://storagemadeeasy.com\[dq] .RS 2 .IP \[bu] 2 Storage Made Easy US .RE .IP \[bu] 2 \[dq]https://eu.storagemadeeasy.com\[dq] .RS 2 .IP \[bu] 2 Storage Made Easy EU .RE .IP \[bu] 2 \[dq]https://yourfabric.smestorage.com\[dq] .RS 2 .IP \[bu] 2 Connect to your Enterprise File Fabric .RE .RE .SS --filefabric-root-folder-id .PP ID of the root folder. .PP Leave blank normally. .PP Fill in to make rclone start with directory of a given ID. .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filefabric-permanent-token .PP Permanent Authentication Token. .PP A Permanent Authentication Token can be created in the Enterprise File Fabric, on the users Dashboard under Security, there is an entry you\[aq]ll see called \[dq]My Authentication Tokens\[dq]. Click the Manage button to create one. .PP These tokens are normally valid for several years. .PP For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens .PP Properties: .IP \[bu] 2 Config: permanent_token .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to filefabric (Enterprise File Fabric). .SS --filefabric-token .PP Session Token. .PP This is a session token which rclone caches in the config file. It is usually valid for 1 hour. .PP Don\[aq]t set this value - rclone will set it automatically. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filefabric-token-expiry .PP Token expiry time. .PP Don\[aq]t set this value - rclone will set it automatically. .PP Properties: .IP \[bu] 2 Config: token_expiry .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filefabric-version .PP Version read from the file fabric. .PP Don\[aq]t set this value - rclone will set it automatically. .PP Properties: .IP \[bu] 2 Config: version .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_VERSION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filefabric-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,Del,Ctl,InvalidUtf8,Dot .SS --filefabric-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_FILEFABRIC_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Files.com .PP Files.com (https://www.files.com/) is a cloud storage service that provides a secure and easy way to store and share files. .PP The initial setup for filescom involves authenticating with your Files.com account. You can do this by providing your site subdomain, username, and password. Alternatively, you can authenticate using an API Key from Files.com (https://www.files.com/docs/sdk-and-apis/api-keys/). \f[C]rclone config\f[R] walks you through it. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Files.com \[rs] \[dq]filescom\[dq] [snip] Storage> filescom Option site. Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com) Enter a value. Press Enter to leave empty. site> mysite Option username. The username used to authenticate with Files.com. Enter a value. Press Enter to leave empty. username> user Option password. The password used to authenticate with Files.com. Choose an alternative below. Press Enter for the default (n). y) Yes, type in my own password g) Generate random password n) No, leave this optional password blank (default) y/g/n> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: filescom - site: mysite - username: user - password: *** ENCRYPTED *** Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Once configured you can use rclone. .PP See all files in the top level: .IP .nf \f[C] rclone lsf remote: \f[R] .fi .PP Make a new directory in the root: .IP .nf \f[C] rclone mkdir remote:dir \f[R] .fi .PP Recursively List the contents: .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote directory, deleting any excess files in the directory. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:dir \f[R] .fi .SS Standard options .PP Here are the Standard options specific to filescom (Files.com). .SS --filescom-site .PP Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com). .PP Properties: .IP \[bu] 2 Config: site .IP \[bu] 2 Env Var: RCLONE_FILESCOM_SITE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filescom-username .PP The username used to authenticate with Files.com. .PP Properties: .IP \[bu] 2 Config: username .IP \[bu] 2 Env Var: RCLONE_FILESCOM_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filescom-password .PP The password used to authenticate with Files.com. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_FILESCOM_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to filescom (Files.com). .SS --filescom-api-key .PP The API key used to authenticate with Files.com. .PP Properties: .IP \[bu] 2 Config: api_key .IP \[bu] 2 Env Var: RCLONE_FILESCOM_API_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --filescom-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_FILESCOM_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot .SS --filescom-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_FILESCOM_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH FTP .PP FTP is the File Transfer Protocol. Rclone FTP support is provided using the github.com/jlaffaye/ftp (https://godoc.org/github.com/jlaffaye/ftp) package. .PP Limitations of Rclone\[aq]s FTP backend .PP Paths are specified as \f[C]remote:path\f[R]. If the path does not begin with a \f[C]/\f[R] it is relative to the home directory of the user. An empty path \f[C]remote:\f[R] refers to the user\[aq]s home directory. .SS Configuration .PP To create an FTP configuration named \f[C]remote\f[R], run .IP .nf \f[C] rclone config \f[R] .fi .PP Rclone config guides you through an interactive setup process. A minimal rclone FTP remote definition only requires host, username and password. For an anonymous FTP server, see below. .IP .nf \f[C] No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / FTP \[rs] \[dq]ftp\[dq] [snip] Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ ** FTP host to connect to Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com \[rs] \[dq]ftp.example.com\[dq] host> ftp.example.com FTP username Enter a string value. Press Enter for the default (\[dq]$USER\[dq]). user> FTP port number Enter a signed integer. Press Enter for the default (21). port> FTP password y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Use FTP over TLS (Implicit) Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). explicit_tls> Remote config Configuration complete. Options: - type: ftp - host: ftp.example.com - pass: *** ENCRYPTED *** Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP To see all directories in the home directory of \f[C]remote\f[R] .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new directory .IP .nf \f[C] rclone mkdir remote:path/to/directory \f[R] .fi .PP List the contents of a directory .IP .nf \f[C] rclone ls remote:path/to/directory \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote directory, deleting any excess files in the directory. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:directory \f[R] .fi .SS Anonymous FTP .PP When connecting to a FTP server that allows anonymous login, you can use the special \[dq]anonymous\[dq] username. Traditionally, this user account accepts any string as a password, although it is common to use either the password \[dq]anonymous\[dq] or \[dq]guest\[dq]. Some servers require the use of a valid e-mail address as password. .PP Using on-the-fly or connection string (https://rclone.org/docs/#connection-strings) remotes makes it easy to access such servers, without requiring any configuration in advance. The following are examples of that: .IP .nf \f[C] rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=$(rclone obscure dummy) rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=$(rclone obscure dummy): \f[R] .fi .PP The above examples work in Linux shells and in PowerShell, but not Windows Command Prompt. They execute the rclone obscure (https://rclone.org/commands/rclone_obscure/) command to create a password string in the format required by the pass option. The following examples are exactly the same, except use an already obscured string representation of the same password \[dq]dummy\[dq], and therefore works even in Windows Command Prompt: .IP .nf \f[C] rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM: \f[R] .fi .SS Implicit TLS .PP Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled in the FTP backend config for the remote, or with \f[C]--ftp-tls\f[R]. The default FTPS port is \f[C]990\f[R], not \f[C]21\f[R] and can be set with \f[C]--ftp-port\f[R]. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP File names cannot end with the following characters. Replacement is limited to the last character in a file name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} .TE .PP Not all FTP servers can have all characters in file names, for example: .PP .TS tab(@); l c. T{ FTP Server T}@T{ Forbidden characters T} _ T{ proftpd T}@T{ \f[C]*\f[R] T} T{ pureftpd T}@T{ \f[C]\[rs] [ ]\f[R] T} .TE .PP This backend\[aq]s interactive configuration wizard provides a selection of sensible encoding settings for major FTP servers: ProFTPd, PureFTPd, VsFTPd. Just hit a selection number when prompted. .SS Standard options .PP Here are the Standard options specific to ftp (FTP). .SS --ftp-host .PP FTP host to connect to. .PP E.g. \[dq]ftp.example.com\[dq]. .PP Properties: .IP \[bu] 2 Config: host .IP \[bu] 2 Env Var: RCLONE_FTP_HOST .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --ftp-user .PP FTP username. .PP Properties: .IP \[bu] 2 Config: user .IP \[bu] 2 Env Var: RCLONE_FTP_USER .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]$USER\[dq] .SS --ftp-port .PP FTP port number. .PP Properties: .IP \[bu] 2 Config: port .IP \[bu] 2 Env Var: RCLONE_FTP_PORT .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 21 .SS --ftp-pass .PP FTP password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: pass .IP \[bu] 2 Env Var: RCLONE_FTP_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --ftp-tls .PP Use Implicit FTPS (FTP over TLS). .PP When using implicit FTP over TLS the client connects using TLS right from the start which breaks compatibility with non-TLS-aware servers. This is usually served over port 990 rather than port 21. Cannot be used in combination with explicit FTPS. .PP Properties: .IP \[bu] 2 Config: tls .IP \[bu] 2 Env Var: RCLONE_FTP_TLS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-explicit-tls .PP Use Explicit FTPS (FTP over TLS). .PP When using explicit FTP over TLS the client explicitly requests security from the server in order to upgrade a plain text connection to an encrypted one. Cannot be used in combination with implicit FTPS. .PP Properties: .IP \[bu] 2 Config: explicit_tls .IP \[bu] 2 Env Var: RCLONE_FTP_EXPLICIT_TLS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS Advanced options .PP Here are the Advanced options specific to ftp (FTP). .SS --ftp-concurrency .PP Maximum number of FTP simultaneous connections, 0 for unlimited. .PP Note that setting this is very likely to cause deadlocks so it should be used with care. .PP If you are doing a sync or copy then make sure concurrency is one more than the sum of \f[C]--transfers\f[R] and \f[C]--checkers\f[R]. .PP If you use \f[C]--check-first\f[R] then it just needs to be one more than the maximum of \f[C]--checkers\f[R] and \f[C]--transfers\f[R]. .PP So for \f[C]concurrency 3\f[R] you\[aq]d use \f[C]--checkers 2 --transfers 2 --check-first\f[R] or \f[C]--checkers 1 --transfers 1\f[R]. .PP Properties: .IP \[bu] 2 Config: concurrency .IP \[bu] 2 Env Var: RCLONE_FTP_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 0 .SS --ftp-no-check-certificate .PP Do not verify the TLS certificate of the server. .PP Properties: .IP \[bu] 2 Config: no_check_certificate .IP \[bu] 2 Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-disable-epsv .PP Disable using EPSV even if server advertises support. .PP Properties: .IP \[bu] 2 Config: disable_epsv .IP \[bu] 2 Env Var: RCLONE_FTP_DISABLE_EPSV .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-disable-mlsd .PP Disable using MLSD even if server advertises support. .PP Properties: .IP \[bu] 2 Config: disable_mlsd .IP \[bu] 2 Env Var: RCLONE_FTP_DISABLE_MLSD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-disable-utf8 .PP Disable using UTF-8 even if server advertises support. .PP Properties: .IP \[bu] 2 Config: disable_utf8 .IP \[bu] 2 Env Var: RCLONE_FTP_DISABLE_UTF8 .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-writing-mdtm .PP Use MDTM to set modification time (VsFtpd quirk) .PP Properties: .IP \[bu] 2 Config: writing_mdtm .IP \[bu] 2 Env Var: RCLONE_FTP_WRITING_MDTM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-force-list-hidden .PP Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD. .PP Properties: .IP \[bu] 2 Config: force_list_hidden .IP \[bu] 2 Env Var: RCLONE_FTP_FORCE_LIST_HIDDEN .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-idle-timeout .PP Max time before closing idle connections. .PP If no connections have been returned to the connection pool in the time given, rclone will empty the connection pool. .PP Set to 0 to keep connections indefinitely. .PP Properties: .IP \[bu] 2 Config: idle_timeout .IP \[bu] 2 Env Var: RCLONE_FTP_IDLE_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --ftp-close-timeout .PP Maximum time to wait for a response to close. .PP Properties: .IP \[bu] 2 Config: close_timeout .IP \[bu] 2 Env Var: RCLONE_FTP_CLOSE_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --ftp-tls-cache-size .PP Size of TLS session cache for all control and data connections. .PP TLS cache allows to resume TLS sessions and reuse PSK between connections. Increase if default size is not enough resulting in TLS resumption errors. Enabled by default. Use 0 to disable. .PP Properties: .IP \[bu] 2 Config: tls_cache_size .IP \[bu] 2 Env Var: RCLONE_FTP_TLS_CACHE_SIZE .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 32 .SS --ftp-disable-tls13 .PP Disable TLS 1.3 (workaround for FTP servers with buggy TLS) .PP Properties: .IP \[bu] 2 Config: disable_tls13 .IP \[bu] 2 Env Var: RCLONE_FTP_DISABLE_TLS13 .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-shut-timeout .PP Maximum time to wait for data connection closing status. .PP Properties: .IP \[bu] 2 Config: shut_timeout .IP \[bu] 2 Env Var: RCLONE_FTP_SHUT_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --ftp-ask-password .PP Allow asking for FTP password when needed. .PP If this is set and no password is supplied then rclone will ask for a password .PP Properties: .IP \[bu] 2 Config: ask_password .IP \[bu] 2 Env Var: RCLONE_FTP_ASK_PASSWORD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-socks-proxy .PP Socks 5 proxy host. .PP Supports the format user:pass\[at]host:port, user\[at]host:port, host:port. .PP Example: .IP .nf \f[C] myUser:myPass\[at]localhost:9005 \f[R] .fi .PP Properties: .IP \[bu] 2 Config: socks_proxy .IP \[bu] 2 Env Var: RCLONE_FTP_SOCKS_PROXY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --ftp-no-check-upload .PP Don\[aq]t check the upload is OK .PP Normally rclone will try to check the upload exists after it has uploaded a file to make sure the size and modification time are as expected. .PP This flag stops rclone doing these checks. This enables uploading to folders which are write only. .PP You will likely need to use the --inplace flag also if uploading to a write only folder. .PP Properties: .IP \[bu] 2 Config: no_check_upload .IP \[bu] 2 Env Var: RCLONE_FTP_NO_CHECK_UPLOAD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --ftp-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_FTP_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,Del,Ctl,RightSpace,Dot .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]Asterisk,Ctl,Dot,Slash\[dq] .RS 2 .IP \[bu] 2 ProFTPd can\[aq]t handle \[aq]*\[aq] in file names .RE .IP \[bu] 2 \[dq]BackSlash,Ctl,Del,Dot,RightSpace,Slash,SquareBracket\[dq] .RS 2 .IP \[bu] 2 PureFTPd can\[aq]t handle \[aq][]\[aq] or \[aq]*\[aq] in file names .RE .IP \[bu] 2 \[dq]Ctl,LeftPeriod,Slash\[dq] .RS 2 .IP \[bu] 2 VsFTPd can\[aq]t handle file names starting with dot .RE .RE .SS --ftp-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_FTP_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP FTP servers acting as rclone remotes must support \f[C]passive\f[R] mode. The mode cannot be configured as \f[C]passive\f[R] is the only supported one. Rclone\[aq]s FTP implementation is not compatible with \f[C]active\f[R] mode as the library it uses doesn\[aq]t support it (https://github.com/jlaffaye/ftp/issues/29). This will likely never be supported due to security concerns. .PP Rclone\[aq]s FTP backend does not support any checksums but can compare file sizes. .PP \f[C]rclone about\f[R] is not supported by the FTP backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .PP The implementation of : \f[C]--dump headers\f[R], \f[C]--dump bodies\f[R], \f[C]--dump auth\f[R] for debugging isn\[aq]t the same as for rclone HTTP based backends - it has less fine grained control. .PP \f[C]--timeout\f[R] isn\[aq]t supported (but \f[C]--contimeout\f[R] is). .PP \f[C]--bind\f[R] isn\[aq]t supported. .PP Rclone\[aq]s FTP backend could support server-side move but does not at present. .PP The \f[C]ftp_proxy\f[R] environment variable is not currently supported. .SS Modification times .PP File modification time (timestamps) is supported to 1 second resolution for major FTP servers: ProFTPd, PureFTPd, VsFTPd, and FileZilla FTP server. The \f[C]VsFTPd\f[R] server has non-standard implementation of time related protocol commands and needs a special configuration setting: \f[C]writing_mdtm = true\f[R]. .PP Support for precise file time with other FTP servers varies depending on what protocol extensions they advertise. If all the \f[C]MLSD\f[R], \f[C]MDTM\f[R] and \f[C]MFTM\f[R] extensions are present, rclone will use them together to provide precise time. Otherwise the times you see on the FTP server through rclone are those of the last file upload. .PP You can use the following command to check whether rclone can use precise time with your FTP server: \f[C]rclone backend features your_ftp_remote:\f[R] (the trailing colon is important). Look for the number in the line tagged by \f[C]Precision\f[R] designating the remote time precision expressed as nanoseconds. A value of \f[C]1000000000\f[R] means that file time precision of 1 second is available. A value of \f[C]3153600000000000000\f[R] (or another large number) means \[dq]unsupported\[dq]. .SH Gofile .PP Gofile (https://gofile.io) is a content storage and distribution platform. Its aim is to provide as much service as possible for free or at a very low price. .PP The initial setup for Gofile involves logging in to the web interface and going to the \[dq]My Profile\[dq] section. Copy the \[dq]Account API token\[dq] for use in the config file. .PP Note that if you wish to connect rclone to Gofile you will need a premium account. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. XX / Gofile \[rs] (gofile) Storage> gofile Option access_token. API Access token You can get this from the web control panel. Enter a value. Press Enter to leave empty. access_token> YOURACCESSTOKEN Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: gofile - access_token: YOURACCESSTOKEN Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories and files in the top level of your Gofile .IP .nf \f[C] rclone lsf remote: \f[R] .fi .PP To copy a local directory to an Gofile directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Modification times and hashes .PP Gofile supports modification times with a resolution of 1 second. .PP Gofile supports MD5 hashes, so you can use the \f[C]--checksum\f[R] flag. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ ! T}@T{ 0x21 T}@T{ \[uFF01] T} T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP 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: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \&. T}@T{ 0x2E T}@T{ \[uFF0E] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Public Links .PP Gofile supports \f[C]rclone link\f[R] to make public links to files or directories. If you specify a directory it will download as a \f[C]zip\f[R] file. You can use the \f[C]--expire\f[R] flag to specify the time the link should be valid. Note that \f[C]rclone link --unlink\f[R] removes all the public links for a file. .SS Root folder ID .PP You can set the \f[C]root_folder_id\f[R] for rclone. This is the directory (identified by its \f[C]Folder ID\f[R]) that rclone considers to be the root of your Gofile drive. .PP Normally you will leave this blank and rclone will determine the correct root to use itself and fill in the value in the config file. .PP However you can set this to restrict rclone to a specific folder hierarchy. .PP In order to do this you will have to find the \f[C]Folder ID\f[R] of the directory you wish rclone to display. .PP You can do this with rclone .IP .nf \f[C] $ rclone lsf -Fip --dirs-only remote: d6341f53-ee65-4f29-9f59-d11e8070b2a0;Files/ f4f5c9b8-6ece-478b-b03e-4538edfe5a1c;Photos/ d50e356c-29ca-4b27-a3a7-494d91026e04;Videos/ \f[R] .fi .PP The ID to use is the part before the \f[C];\f[R] so you could set .IP .nf \f[C] root_folder_id = d6341f53-ee65-4f29-9f59-d11e8070b2a0 \f[R] .fi .PP To restrict rclone to the \f[C]Files\f[R] directory. .SS Standard options .PP Here are the Standard options specific to gofile (Gofile). .SS --gofile-access-token .PP API Access token .PP You can get this from the web control panel. .PP Properties: .IP \[bu] 2 Config: access_token .IP \[bu] 2 Env Var: RCLONE_GOFILE_ACCESS_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to gofile (Gofile). .SS --gofile-root-folder-id .PP ID of the root folder .PP Leave this blank normally, rclone will fill it in automatically. .PP If you want rclone to be restricted to a particular folder you can fill it in - see the docs for more info. .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_GOFILE_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gofile-account-id .PP Account ID .PP Leave this blank normally, rclone will fill it in automatically. .PP Properties: .IP \[bu] 2 Config: account_id .IP \[bu] 2 Env Var: RCLONE_GOFILE_ACCOUNT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gofile-list-chunk .PP Number of items to list in each call .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_GOFILE_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1000 .SS --gofile-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_GOFILE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation .SS --gofile-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_GOFILE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Gofile only supports filenames up to 255 characters in length, where a character is a unicode character. .PP Directories should not be cached for more than 24h otherwise files in the directory may not be downloadable. In practice this means when using a VFS based rclone command such as \f[C]rclone mount\f[R] you should make sure \f[C]--dir-cache-time\f[R] is less than \f[C]24h\f[R]. .PP Note that Gofile is currently limited to a total of 100,000 items. If you attempt to upload more than that you will get \f[C]error-limit-100000\f[R]. This limit may be lifted in the future. .SS Duplicated files .PP Gofile is capable of having files with duplicated file names. For instance two files called \f[C]hello.txt\f[R] in the same directory. .PP Rclone cannot sync that to a normal file system but it can be fixed with the \f[C]rclone dedupe\f[R] command. .PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .PP Use \f[C]rclone dedupe\f[R] to fix duplicated files. .SH Google Cloud Storage .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .SS Configuration .PP The initial setup for google cloud storage involves getting a token from Google Cloud Storage which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] n) New remote d) Delete remote q) Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Cloud Storage (this is not Google Drive) \[rs] \[dq]google cloud storage\[dq] [snip] Storage> google cloud storage Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Project number optional - needed only for list/create/delete buckets - see your developer console. project_number> 12345678 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Access Control List for new objects. Choose a number from below, or type in your own value 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. \[rs] \[dq]authenticatedRead\[dq] 2 / Object owner gets OWNER access, and project team owners get OWNER access. \[rs] \[dq]bucketOwnerFullControl\[dq] 3 / Object owner gets OWNER access, and project team owners get READER access. \[rs] \[dq]bucketOwnerRead\[dq] 4 / Object owner gets OWNER access [default if left blank]. \[rs] \[dq]private\[dq] 5 / Object owner gets OWNER access, and project team members get access according to their roles. \[rs] \[dq]projectPrivate\[dq] 6 / Object owner gets OWNER access, and all Users get READER access. \[rs] \[dq]publicRead\[dq] object_acl> 4 Access Control List for new buckets. Choose a number from below, or type in your own value 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. \[rs] \[dq]authenticatedRead\[dq] 2 / Project team owners get OWNER access [default if left blank]. \[rs] \[dq]private\[dq] 3 / Project team members get access according to their roles. \[rs] \[dq]projectPrivate\[dq] 4 / Project team owners get OWNER access, and all Users get READER access. \[rs] \[dq]publicRead\[dq] 5 / Project team owners get OWNER access, and all Users get WRITER access. \[rs] \[dq]publicReadWrite\[dq] bucket_acl> 2 Location for the newly created buckets. Choose a number from below, or type in your own value 1 / Empty for default location (US). \[rs] \[dq]\[dq] 2 / Multi-regional location for Asia. \[rs] \[dq]asia\[dq] 3 / Multi-regional location for Europe. \[rs] \[dq]eu\[dq] 4 / Multi-regional location for United States. \[rs] \[dq]us\[dq] 5 / Taiwan. \[rs] \[dq]asia-east1\[dq] 6 / Tokyo. \[rs] \[dq]asia-northeast1\[dq] 7 / Singapore. \[rs] \[dq]asia-southeast1\[dq] 8 / Sydney. \[rs] \[dq]australia-southeast1\[dq] 9 / Belgium. \[rs] \[dq]europe-west1\[dq] 10 / London. \[rs] \[dq]europe-west2\[dq] 11 / Iowa. \[rs] \[dq]us-central1\[dq] 12 / South Carolina. \[rs] \[dq]us-east1\[dq] 13 / Northern Virginia. \[rs] \[dq]us-east4\[dq] 14 / Oregon. \[rs] \[dq]us-west1\[dq] location> 12 The storage class to use when storing objects in Google Cloud Storage. Choose a number from below, or type in your own value 1 / Default \[rs] \[dq]\[dq] 2 / Multi-regional storage class \[rs] \[dq]MULTI_REGIONAL\[dq] 3 / Regional storage class \[rs] \[dq]REGIONAL\[dq] 4 / Nearline storage class \[rs] \[dq]NEARLINE\[dq] 5 / Coldline storage class \[rs] \[dq]COLDLINE\[dq] 6 / Durable reduced availability storage class \[rs] \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] storage_class> 5 Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configuration complete. Options: - type: google cloud storage - client_id: - client_secret: - token: {\[dq]AccessToken\[dq]:\[dq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014-07-17T20:49:14.929208288+01:00\[dq],\[dq]Extra\[dq]:null} - project_number: 12345678 - object_acl: private - bucket_acl: private Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode. .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all the buckets in your project .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new bucket .IP .nf \f[C] rclone mkdir remote:bucket \f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] rclone ls remote:bucket \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:bucket \f[R] .fi .SS Service Account support .PP You can set up rclone with Google Cloud Storage in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don\[aq]t have actively logged-in users, for example build machines. .PP To get credentials for Google Cloud Platform IAM Service Accounts (https://cloud.google.com/iam/docs/service-accounts), please head to the Service Account (https://console.cloud.google.com/permissions/serviceaccounts) section of the Google Developer Console. Service Accounts behave just like normal \f[C]User\f[R] permissions in Google Cloud Storage ACLs (https://cloud.google.com/storage/docs/access-control), so you can limit their access (e.g. make them read only). After creating an account, a JSON file containing the Service Account\[aq]s credentials will be downloaded onto your machines. These credentials are what rclone will use for authentication. .PP To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the \f[C]service_account_file\f[R] prompt and rclone won\[aq]t use the browser based authentication flow. If you\[aq]d rather stuff the contents of the credentials file into the rclone config file, you can set \f[C]service_account_credentials\f[R] with the actual contents of the file instead, or set the equivalent environment variable. .SS Service Account Authentication with Access Tokens .PP Another option for service account authentication is to use access tokens via \f[I]gcloud impersonate-service-account\f[R]. Access tokens protect security by avoiding the use of the JSON key file, which can be breached. They also bypass oauth login flow, which is simpler on remote VMs that lack a web browser. .PP If you already have a working service account, skip to step 3. .SS 1. Create a service account using .IP .nf \f[C] gcloud iam service-accounts create gcs-read-only \f[R] .fi .PP You can re-use an existing service account as well (like the one created above) .SS 2. Attach a Viewer (read-only) or User (read-write) role to the service account .IP .nf \f[C] $ PROJECT_ID=my-project $ gcloud --verbose iam service-accounts add-iam-policy-binding \[rs] gcs-read-only\[at]${PROJECT_ID}.iam.gserviceaccount.com \[rs] --member=serviceAccount:gcs-read-only\[at]${PROJECT_ID}.iam.gserviceaccount.com \[rs] --role=roles/storage.objectViewer \f[R] .fi .PP Use the Google Cloud console to identify a limited role. Some relevant pre-defined roles: .IP \[bu] 2 \f[I]roles/storage.objectUser\f[R] -- read-write access but no admin privileges .IP \[bu] 2 \f[I]roles/storage.objectViewer\f[R] -- read-only access to objects .IP \[bu] 2 \f[I]roles/storage.admin\f[R] -- create buckets & administrative roles .SS 3. Get a temporary access key for the service account .IP .nf \f[C] $ gcloud auth application-default print-access-token \[rs] --impersonate-service-account \[rs] gcs-read-only\[at]${PROJECT_ID}.iam.gserviceaccount.com ya29.c.c0ASRK0GbAFEewXD [truncated] \f[R] .fi .SS 4. Update \f[C]access_token\f[R] setting .PP hit \f[C]CTRL-C\f[R] when you see \f[I]waiting for code\f[R]. This will save the config without doing oauth flow .IP .nf \f[C] rclone config update ${REMOTE_NAME} access_token ya29.c.c0Axxxx \f[R] .fi .SS 5. Run rclone as usual .IP .nf \f[C] rclone ls dev-gcs:${MY_BUCKET}/ \f[R] .fi .SS More Info on Service Accounts .IP \[bu] 2 Official GCS Docs (https://cloud.google.com/compute/docs/access/service-accounts) .IP \[bu] 2 Guide on Service Accounts using Key Files (less secure, but similar concepts) (https://forum.rclone.org/t/access-using-google-service-account/24822/2) .SS Anonymous Access .PP For downloads of objects that permit public access you can configure rclone to use anonymous access by setting \f[C]anonymous\f[R] to \f[C]true\f[R]. With unauthorized access you can\[aq]t write or create files but only read or list those buckets and objects that have public read access. .SS Application Default Credentials .PP If no other source of credentials is provided, rclone will fall back to Application Default Credentials (https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) this is useful both when you already have configured authentication for your developer account, or in production when running on a google compute host. Note that if running in docker, you may need to run additional commands on your google compute machine - see this page (https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). .PP Note that in the case application default credentials are used, there is no need to explicitly configure a project number. .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .SS Custom upload headers .PP You can set custom upload headers with the \f[C]--header-upload\f[R] flag. Google Cloud Storage supports the headers as described in the working with metadata documentation (https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) .IP \[bu] 2 Cache-Control .IP \[bu] 2 Content-Disposition .IP \[bu] 2 Content-Encoding .IP \[bu] 2 Content-Language .IP \[bu] 2 Content-Type .IP \[bu] 2 X-Goog-Storage-Class .IP \[bu] 2 X-Goog-Meta- .PP Eg \f[C]--header-upload \[dq]Content-Type text/potato\[dq]\f[R] .PP Note that the last of these is for setting custom metadata in the form \f[C]--header-upload \[dq]x-goog-meta-key: value\[dq]\f[R] .SS Modification times .PP Google Cloud Storage stores md5sum natively. Google\[aq]s gsutil (https://cloud.google.com/storage/docs/gsutil) tool stores modification time with one-second precision as \f[C]goog-reserved-file-mtime\f[R] in file metadata. .PP To ensure compatibility with gsutil, rclone stores modification time in 2 separate metadata entries. \f[C]mtime\f[R] uses RFC3339 format with one-nanosecond precision. \f[C]goog-reserved-file-mtime\f[R] uses Unix timestamp format with one-second precision. To get modification time from object metadata, rclone reads the metadata in the following order: \f[C]mtime\f[R], \f[C]goog-reserved-file-mtime\f[R], object updated time. .PP Note that rclone\[aq]s default modify window is 1ns. Files uploaded by gsutil only contain timestamps with one-second precision. If you use rclone to sync files previously uploaded by gsutil, rclone will attempt to update modification time for all these files. To avoid these possibly unnecessary updates, use \f[C]--modify-window 1s\f[R]. .SS Restricted filename characters .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ LF T}@T{ 0x0A T}@T{ \[u240A] T} T{ CR T}@T{ 0x0D T}@T{ \[u240D] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). .SS --gcs-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_GCS_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_GCS_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-project-number .PP Project number. .PP Optional - needed only for list/create/delete buckets - see your developer console. .PP Properties: .IP \[bu] 2 Config: project_number .IP \[bu] 2 Env Var: RCLONE_GCS_PROJECT_NUMBER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-user-project .PP User project. .PP Optional - needed only for requester pays. .PP Properties: .IP \[bu] 2 Config: user_project .IP \[bu] 2 Env Var: RCLONE_GCS_USER_PROJECT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-service-account-file .PP Service Account Credentials JSON file path. .PP Leave blank normally. Needed only if you want use SA instead of interactive login. .PP Leading \f[C]\[ti]\f[R] will be expanded in the file name as will environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. .PP Properties: .IP \[bu] 2 Config: service_account_file .IP \[bu] 2 Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-service-account-credentials .PP Service Account Credentials JSON blob. .PP Leave blank normally. Needed only if you want use SA instead of interactive login. .PP Properties: .IP \[bu] 2 Config: service_account_credentials .IP \[bu] 2 Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-anonymous .PP Access public buckets and objects without credentials. .PP Set to \[aq]true\[aq] if you just want to download files and don\[aq]t configure credentials. .PP Properties: .IP \[bu] 2 Config: anonymous .IP \[bu] 2 Env Var: RCLONE_GCS_ANONYMOUS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-object-acl .PP Access Control List for new objects. .PP Properties: .IP \[bu] 2 Config: object_acl .IP \[bu] 2 Env Var: RCLONE_GCS_OBJECT_ACL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]authenticatedRead\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 All Authenticated Users get READER access. .RE .IP \[bu] 2 \[dq]bucketOwnerFullControl\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 Project team owners get OWNER access. .RE .IP \[bu] 2 \[dq]bucketOwnerRead\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 Project team owners get READER access. .RE .IP \[bu] 2 \[dq]private\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 Default if left blank. .RE .IP \[bu] 2 \[dq]projectPrivate\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 Project team members get access according to their roles. .RE .IP \[bu] 2 \[dq]publicRead\[dq] .RS 2 .IP \[bu] 2 Object owner gets OWNER access. .IP \[bu] 2 All Users get READER access. .RE .RE .SS --gcs-bucket-acl .PP Access Control List for new buckets. .PP Properties: .IP \[bu] 2 Config: bucket_acl .IP \[bu] 2 Env Var: RCLONE_GCS_BUCKET_ACL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]authenticatedRead\[dq] .RS 2 .IP \[bu] 2 Project team owners get OWNER access. .IP \[bu] 2 All Authenticated Users get READER access. .RE .IP \[bu] 2 \[dq]private\[dq] .RS 2 .IP \[bu] 2 Project team owners get OWNER access. .IP \[bu] 2 Default if left blank. .RE .IP \[bu] 2 \[dq]projectPrivate\[dq] .RS 2 .IP \[bu] 2 Project team members get access according to their roles. .RE .IP \[bu] 2 \[dq]publicRead\[dq] .RS 2 .IP \[bu] 2 Project team owners get OWNER access. .IP \[bu] 2 All Users get READER access. .RE .IP \[bu] 2 \[dq]publicReadWrite\[dq] .RS 2 .IP \[bu] 2 Project team owners get OWNER access. .IP \[bu] 2 All Users get WRITER access. .RE .RE .SS --gcs-bucket-policy-only .PP Access checks should use bucket-level IAM policies. .PP If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this. .PP When it is set, rclone: .IP \[bu] 2 ignores ACLs set on buckets .IP \[bu] 2 ignores ACLs set on objects .IP \[bu] 2 creates buckets with Bucket Policy Only set .PP Docs: https://cloud.google.com/storage/docs/bucket-policy-only .PP Properties: .IP \[bu] 2 Config: bucket_policy_only .IP \[bu] 2 Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-location .PP Location for the newly created buckets. .PP Properties: .IP \[bu] 2 Config: location .IP \[bu] 2 Env Var: RCLONE_GCS_LOCATION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Empty for default location (US) .RE .IP \[bu] 2 \[dq]asia\[dq] .RS 2 .IP \[bu] 2 Multi-regional location for Asia .RE .IP \[bu] 2 \[dq]eu\[dq] .RS 2 .IP \[bu] 2 Multi-regional location for Europe .RE .IP \[bu] 2 \[dq]us\[dq] .RS 2 .IP \[bu] 2 Multi-regional location for United States .RE .IP \[bu] 2 \[dq]asia-east1\[dq] .RS 2 .IP \[bu] 2 Taiwan .RE .IP \[bu] 2 \[dq]asia-east2\[dq] .RS 2 .IP \[bu] 2 Hong Kong .RE .IP \[bu] 2 \[dq]asia-northeast1\[dq] .RS 2 .IP \[bu] 2 Tokyo .RE .IP \[bu] 2 \[dq]asia-northeast2\[dq] .RS 2 .IP \[bu] 2 Osaka .RE .IP \[bu] 2 \[dq]asia-northeast3\[dq] .RS 2 .IP \[bu] 2 Seoul .RE .IP \[bu] 2 \[dq]asia-south1\[dq] .RS 2 .IP \[bu] 2 Mumbai .RE .IP \[bu] 2 \[dq]asia-south2\[dq] .RS 2 .IP \[bu] 2 Delhi .RE .IP \[bu] 2 \[dq]asia-southeast1\[dq] .RS 2 .IP \[bu] 2 Singapore .RE .IP \[bu] 2 \[dq]asia-southeast2\[dq] .RS 2 .IP \[bu] 2 Jakarta .RE .IP \[bu] 2 \[dq]australia-southeast1\[dq] .RS 2 .IP \[bu] 2 Sydney .RE .IP \[bu] 2 \[dq]australia-southeast2\[dq] .RS 2 .IP \[bu] 2 Melbourne .RE .IP \[bu] 2 \[dq]europe-north1\[dq] .RS 2 .IP \[bu] 2 Finland .RE .IP \[bu] 2 \[dq]europe-west1\[dq] .RS 2 .IP \[bu] 2 Belgium .RE .IP \[bu] 2 \[dq]europe-west2\[dq] .RS 2 .IP \[bu] 2 London .RE .IP \[bu] 2 \[dq]europe-west3\[dq] .RS 2 .IP \[bu] 2 Frankfurt .RE .IP \[bu] 2 \[dq]europe-west4\[dq] .RS 2 .IP \[bu] 2 Netherlands .RE .IP \[bu] 2 \[dq]europe-west6\[dq] .RS 2 .IP \[bu] 2 Z\[:u]rich .RE .IP \[bu] 2 \[dq]europe-central2\[dq] .RS 2 .IP \[bu] 2 Warsaw .RE .IP \[bu] 2 \[dq]us-central1\[dq] .RS 2 .IP \[bu] 2 Iowa .RE .IP \[bu] 2 \[dq]us-east1\[dq] .RS 2 .IP \[bu] 2 South Carolina .RE .IP \[bu] 2 \[dq]us-east4\[dq] .RS 2 .IP \[bu] 2 Northern Virginia .RE .IP \[bu] 2 \[dq]us-west1\[dq] .RS 2 .IP \[bu] 2 Oregon .RE .IP \[bu] 2 \[dq]us-west2\[dq] .RS 2 .IP \[bu] 2 California .RE .IP \[bu] 2 \[dq]us-west3\[dq] .RS 2 .IP \[bu] 2 Salt Lake City .RE .IP \[bu] 2 \[dq]us-west4\[dq] .RS 2 .IP \[bu] 2 Las Vegas .RE .IP \[bu] 2 \[dq]northamerica-northeast1\[dq] .RS 2 .IP \[bu] 2 Montr\['e]al .RE .IP \[bu] 2 \[dq]northamerica-northeast2\[dq] .RS 2 .IP \[bu] 2 Toronto .RE .IP \[bu] 2 \[dq]southamerica-east1\[dq] .RS 2 .IP \[bu] 2 S\[~a]o Paulo .RE .IP \[bu] 2 \[dq]southamerica-west1\[dq] .RS 2 .IP \[bu] 2 Santiago .RE .IP \[bu] 2 \[dq]asia1\[dq] .RS 2 .IP \[bu] 2 Dual region: asia-northeast1 and asia-northeast2. .RE .IP \[bu] 2 \[dq]eur4\[dq] .RS 2 .IP \[bu] 2 Dual region: europe-north1 and europe-west4. .RE .IP \[bu] 2 \[dq]nam4\[dq] .RS 2 .IP \[bu] 2 Dual region: us-central1 and us-east1. .RE .RE .SS --gcs-storage-class .PP The storage class to use when storing objects in Google Cloud Storage. .PP Properties: .IP \[bu] 2 Config: storage_class .IP \[bu] 2 Env Var: RCLONE_GCS_STORAGE_CLASS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Default .RE .IP \[bu] 2 \[dq]MULTI_REGIONAL\[dq] .RS 2 .IP \[bu] 2 Multi-regional storage class .RE .IP \[bu] 2 \[dq]REGIONAL\[dq] .RS 2 .IP \[bu] 2 Regional storage class .RE .IP \[bu] 2 \[dq]NEARLINE\[dq] .RS 2 .IP \[bu] 2 Nearline storage class .RE .IP \[bu] 2 \[dq]COLDLINE\[dq] .RS 2 .IP \[bu] 2 Coldline storage class .RE .IP \[bu] 2 \[dq]ARCHIVE\[dq] .RS 2 .IP \[bu] 2 Archive storage class .RE .IP \[bu] 2 \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] .RS 2 .IP \[bu] 2 Durable reduced availability storage class .RE .RE .SS --gcs-env-auth .PP Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars). .PP Only applies if service_account_file and service_account_credentials is blank. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_GCS_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Enter credentials in the next step. .RE .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Get GCP IAM credentials from the environment (env vars or IAM). .RE .RE .SS Advanced options .PP Here are the Advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). .SS --gcs-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_GCS_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_GCS_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_GCS_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_GCS_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-access-token .PP Short-lived access token. .PP Leave blank normally. Needed only if you want use short-lived access token instead of interactive login. .PP Properties: .IP \[bu] 2 Config: access_token .IP \[bu] 2 Env Var: RCLONE_GCS_ACCESS_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-directory-markers .PP Upload an empty object with a trailing slash when a new directory is created .PP Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with \[dq]/\[dq], to persist the folder. .PP Properties: .IP \[bu] 2 Config: directory_markers .IP \[bu] 2 Env Var: RCLONE_GCS_DIRECTORY_MARKERS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-no-check-bucket .PP If set, don\[aq]t attempt to check the bucket exists or create it. .PP This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. .PP Properties: .IP \[bu] 2 Config: no_check_bucket .IP \[bu] 2 Env Var: RCLONE_GCS_NO_CHECK_BUCKET .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-decompress .PP If set this will decompress gzip encoded objects. .PP It is possible to upload objects to GCS with \[dq]Content-Encoding: gzip\[dq] set. Normally rclone will download these files as compressed objects. .PP If this flag is set then rclone will decompress these files with \[dq]Content-Encoding: gzip\[dq] as they are received. This means that rclone can\[aq]t check the size and hash but the file contents will be decompressed. .PP Properties: .IP \[bu] 2 Config: decompress .IP \[bu] 2 Env Var: RCLONE_GCS_DECOMPRESS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gcs-endpoint .PP Endpoint for the service. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_GCS_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gcs-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_GCS_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,CrLf,InvalidUtf8,Dot .SS --gcs-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_GCS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP \f[C]rclone about\f[R] is not supported by the Google Cloud Storage backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH Google Drive .PP Paths are specified as \f[C]drive:path\f[R] .PP Drive paths may be as deep as required, e.g. \f[C]drive:directory/subdirectory\f[R]. .SS Configuration .PP The initial setup for drive involves getting a token from Google drive which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Drive \[rs] \[dq]drive\[dq] [snip] Storage> drive Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Scope that rclone should use when requesting access from drive. Choose a number from below, or type in your own value 1 / Full access all files, excluding Application Data Folder. \[rs] \[dq]drive\[dq] 2 / Read-only access to file metadata and file contents. \[rs] \[dq]drive.readonly\[dq] / Access to files created by rclone only. 3 | These are visible in the drive website. | File authorization is revoked when the user deauthorizes the app. \[rs] \[dq]drive.file\[dq] / Allows read and write access to the Application Data folder. 4 | This is not visible in the drive website. \[rs] \[dq]drive.appfolder\[dq] / Allows read-only access to file metadata but 5 | does not allow any access to read or download file content. \[rs] \[dq]drive.metadata.readonly\[dq] scope> 1 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configure this as a Shared Drive (Team Drive)? y) Yes n) No y/n> n Configuration complete. Options: type: drive - client_id: - client_secret: - scope: drive - root_folder_id: - service_account_file: - token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014-03-16T13:57:58.955387075Z\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and it may require you to unblock it temporarily if you are running a host firewall, or use manual mode. .PP You can then use it like this, .PP List directories in top level of your drive .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your drive .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to a drive directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Scopes .PP Rclone allows you to select which scope you would like for rclone to use. This changes what type of token is granted to rclone. The scopes are defined here (https://developers.google.com/drive/v3/web/about-auth). .PP A comma-separated list is allowed e.g. \f[C]drive.readonly,drive.file\f[R]. .PP The scope are .SS drive .PP This is the default scope and allows full access to all files, except for the Application Data Folder (see below). .PP Choose this one if you aren\[aq]t sure. .SS drive.readonly .PP This allows read only access to all files. Files may be listed and downloaded but not uploaded, renamed or deleted. .SS drive.file .PP With this scope rclone can read/view/modify only those files and folders it creates. .PP So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone. .PP This can be useful if you are using rclone to backup data and you want to be sure confidential data on your drive is not visible to rclone. .PP Files created with this scope are visible in the web interface. .SS drive.appfolder .PP This gives rclone its own private area to store files. Rclone will not be able to see any other files on your drive and you won\[aq]t be able to see rclone\[aq]s files from the web interface either. .SS drive.metadata.readonly .PP This allows read only access to file names only. It does not allow rclone to download or upload data, or rename or delete files or directories. .SS Root folder ID .PP This option has been moved to the advanced section. You can set the \f[C]root_folder_id\f[R] for rclone. This is the directory (identified by its \f[C]Folder ID\f[R]) that rclone considers to be the root of your drive. .PP Normally you will leave this blank and rclone will determine the correct root to use itself. .PP However you can set this to restrict rclone to a specific folder hierarchy or to access data within the \[dq]Computers\[dq] tab on the drive web interface (where files from Google\[aq]s Backup and Sync desktop program go). .PP In order to do this you will have to find the \f[C]Folder ID\f[R] of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the drive web interface. .PP So if the folder you want rclone to use has a URL which looks like \f[C]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] in the browser, then you use \f[C]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] as the \f[C]root_folder_id\f[R] in the config. .PP \f[B]NB\f[R] folders under the \[dq]Computers\[dq] tab seem to be read only (drive gives a 500 error) when using rclone. .PP There doesn\[aq]t appear to be an API to discover the folder IDs of the \[dq]Computers\[dq] tab - please contact us if you know otherwise! .PP Note also that rclone can\[aq]t access any data under the \[dq]Backups\[dq] tab on the google drive web interface yet. .SS Service Account support .PP You can set up rclone with Google Drive in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don\[aq]t have actively logged-in users, for example build machines. .PP To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the \f[C]service_account_file\f[R] prompt during \f[C]rclone config\f[R] and rclone won\[aq]t use the browser based authentication flow. If you\[aq]d rather stuff the contents of the credentials file into the rclone config file, you can set \f[C]service_account_credentials\f[R] with the actual contents of the file instead, or set the equivalent environment variable. .SS Use case - Google Workspace account and individual Drive .PP Let\[aq]s say that you are the administrator of a Google Workspace. The goal is to read or write data on an individual\[aq]s Drive account, who IS a member of the domain. We\[aq]ll call the domain \f[B]example.com\f[R], and the user \f[B]foo\[at]example.com\f[R]. .PP There\[aq]s a few steps we need to go through to accomplish this: .SS 1. Create a service account for example.com .IP \[bu] 2 To create a service account and obtain its credentials, go to the Google Developer Console (https://console.developers.google.com). .IP \[bu] 2 You must have a project - create one if you don\[aq]t and make sure you are on the selected project. .IP \[bu] 2 Then go to \[dq]IAM & admin\[dq] -> \[dq]Service Accounts\[dq]. .IP \[bu] 2 Use the \[dq]Create Service Account\[dq] button. Fill in \[dq]Service account name\[dq] and \[dq]Service account ID\[dq] with something that identifies your client. .IP \[bu] 2 Select \[dq]Create And Continue\[dq]. Step 2 and 3 are optional. .IP \[bu] 2 Click on the newly created service account .IP \[bu] 2 Click \[dq]Keys\[dq] and then \[dq]Add Key\[dq] and then \[dq]Create new key\[dq] .IP \[bu] 2 Choose type \[dq]JSON\[dq] and click create .IP \[bu] 2 This will download a small JSON file that rclone will use for authentication. .PP If you ever need to remove access, press the \[dq]Delete service account key\[dq] button. .SS 2. Allowing API access to example.com Google Drive .IP \[bu] 2 Go to example.com\[aq]s Workspace Admin Console (https://admin.google.com) .IP \[bu] 2 Go into \[dq]Security\[dq] (or use the search bar) .IP \[bu] 2 Select \[dq]Access and data control\[dq] and then \[dq]API controls\[dq] .IP \[bu] 2 Click \[dq]Manage domain-wide delegation\[dq] .IP \[bu] 2 Click \[dq]Add new\[dq] .IP \[bu] 2 In the \[dq]Client ID\[dq] field enter the service account\[aq]s \[dq]Client ID\[dq] - this can be found in the Developer Console under \[dq]IAM & Admin\[dq] -> \[dq]Service Accounts\[dq], then \[dq]View Client ID\[dq] for the newly created service account. It is a \[ti]21 character numerical string. .IP \[bu] 2 In the next field, \[dq]OAuth Scopes\[dq], enter \f[C]https://www.googleapis.com/auth/drive\f[R] to grant read/write access to Google Drive specifically. You can also use \f[C]https://www.googleapis.com/auth/drive.readonly\f[R] for read only access. .IP \[bu] 2 Click \[dq]Authorise\[dq] .SS 3. Configure rclone, assuming a new install .IP .nf \f[C] rclone config n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Type drive client_id> # Can be left blank client_secret> # Can be left blank scope> # Select the scope use used in step 2 root_folder_id> # Can be left blank service_account_file> /home/foo/myJSONfile.json # Path to the JSON file you downloaded in step 1. y/n> # Auto config, n \f[R] .fi .SS 4. Verify that it\[aq]s working .IP \[bu] 2 \f[C]rclone -v --drive-impersonate foo\[at]example.com lsf gdrive:backup\f[R] .IP \[bu] 2 The arguments do: .RS 2 .IP \[bu] 2 \f[C]-v\f[R] - verbose logging .IP \[bu] 2 \f[C]--drive-impersonate foo\[at]example.com\f[R] - this is what does the magic, pretending to be user foo. .IP \[bu] 2 \f[C]lsf\f[R] - list files in a parsing friendly way .IP \[bu] 2 \f[C]gdrive:backup\f[R] - use the remote called gdrive, work in the folder named backup. .RE .PP Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using \f[C]--drive-impersonate\f[R], do this instead: - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step 1 - use rclone without specifying the \f[C]--drive-impersonate\f[R] option, like this: \f[C]rclone -v lsf gdrive:backup\f[R] .SS Shared drives (team drives) .PP If you want to configure the remote to point to a Google Shared Drive (previously known as Team Drives) then answer \f[C]y\f[R] to the question \f[C]Configure this as a Shared Drive (Team Drive)?\f[R]. .PP This will fetch the list of Shared Drives from google and allow you to configure which one you want to use. You can also type in a Shared Drive ID if you prefer. .PP For example: .IP .nf \f[C] Configure this as a Shared Drive (Team Drive)? y) Yes n) No y/n> y Fetching Shared Drive list... Choose a number from below, or type in your own value 1 / Rclone Test \[rs] \[dq]xxxxxxxxxxxxxxxxxxxx\[dq] 2 / Rclone Test 2 \[rs] \[dq]yyyyyyyyyyyyyyyyyyyy\[dq] 3 / Rclone Test 3 \[rs] \[dq]zzzzzzzzzzzzzzzzzzzz\[dq] Enter a Shared Drive ID> 1 Configuration complete. Options: - type: drive - client_id: - client_secret: - token: {\[dq]AccessToken\[dq]:\[dq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014-03-16T13:57:58.955387075Z\[dq],\[dq]Extra\[dq]:null} - team_drive: xxxxxxxxxxxxxxxxxxxx Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .PP It does this by combining multiple \f[C]list\f[R] calls into a single API request. .PP This works by combining many \f[C]\[aq]%s\[aq] in parents\f[R] filters into one expression. To list the contents of directories a, b and c, the following requests will be send by the regular \f[C]List\f[R] function: .IP .nf \f[C] trashed=false and \[aq]a\[aq] in parents trashed=false and \[aq]b\[aq] in parents trashed=false and \[aq]c\[aq] in parents \f[R] .fi .PP These can now be combined into a single request: .IP .nf \f[C] trashed=false and (\[aq]a\[aq] in parents or \[aq]b\[aq] in parents or \[aq]c\[aq] in parents) \f[R] .fi .PP The implementation of \f[C]ListR\f[R] will put up to 50 \f[C]parents\f[R] filters into one request. It will use the \f[C]--checkers\f[R] value to specify the number of requests to run in parallel. .PP In tests, these batch requests were up to 20x faster than the regular method. Running the following command against different sized folders gives: .IP .nf \f[C] rclone lsjson -vv -R --checkers=6 gdrive:folder \f[R] .fi .PP small folder (220 directories, 700 files): .IP \[bu] 2 without \f[C]--fast-list\f[R]: 38s .IP \[bu] 2 with \f[C]--fast-list\f[R]: 10s .PP large folder (10600 directories, 39000 files): .IP \[bu] 2 without \f[C]--fast-list\f[R]: 22:05 min .IP \[bu] 2 with \f[C]--fast-list\f[R]: 58s .SS Modification times and hashes .PP Google drive stores modification times accurate to 1 ms. .PP Hash algorithms MD5, SHA1 and SHA256 are supported. Note, however, that a small fraction of files uploaded may not have SHA1 or SHA256 hashes especially if they were uploaded before 2018. .SS Restricted filename characters .PP Only Invalid UTF-8 bytes will be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .PP In contrast to other backends, \f[C]/\f[R] can also be used in names and \f[C].\f[R] or \f[C]..\f[R] are valid names. .SS Revisions .PP Google drive stores revisions of files. When you upload a change to an existing file to google drive using rclone it will create a new revision of that file. .PP Revisions follow the standard google policy which at time of writing was .IP \[bu] 2 They are deleted after 30 days or 100 revisions (whatever comes first). .IP \[bu] 2 They do not count towards a user storage quota. .SS Deleting files .PP By default rclone will send all files to the trash when deleting files. If deleting them permanently is required then use the \f[C]--drive-use-trash=false\f[R] flag, or set the equivalent environment variable. .SS Shortcuts .PP In March 2020 Google introduced a new feature in Google Drive called drive shortcuts (https://support.google.com/drive/answer/9700156) (API (https://developers.google.com/drive/api/v3/shortcuts)). These will (by September 2020) replace the ability for files or folders to be in multiple folders at once (https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). .PP Shortcuts are files that link to other files on Google Drive somewhat like a symlink in unix, except they point to the underlying file data (e.g. the inode in unix terms) so they don\[aq]t break if the source is renamed or moved about. .PP By default rclone treats these as follows. .PP For shortcuts pointing to files: .IP \[bu] 2 When listing a file shortcut appears as the destination file. .IP \[bu] 2 When downloading the contents of the destination file is downloaded. .IP \[bu] 2 When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. .IP \[bu] 2 When server-side moving (renaming) the shortcut is renamed, not the destination file. .IP \[bu] 2 When server-side copying the shortcut is copied, not the contents of the shortcut. (unless \f[C]--drive-copy-shortcut-content\f[R] is in use in which case the contents of the shortcut gets copied). .IP \[bu] 2 When deleting the shortcut is deleted not the linked file. .IP \[bu] 2 When setting the modification time, the modification time of the linked file will be set. .PP For shortcuts pointing to folders: .IP \[bu] 2 When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) .IP \[bu] 2 When downloading the contents of the linked folder and sub contents are downloaded .IP \[bu] 2 When uploading to a shortcut folder the file will be placed in the linked folder .IP \[bu] 2 When server-side moving (renaming) the shortcut is renamed, not the destination folder .IP \[bu] 2 When server-side copying the contents of the linked folder is copied, not the shortcut. .IP \[bu] 2 When deleting with \f[C]rclone rmdir\f[R] or \f[C]rclone purge\f[R] the shortcut is deleted not the linked folder. .IP \[bu] 2 \f[B]NB\f[R] When deleting with \f[C]rclone remove\f[R] or \f[C]rclone mount\f[R] the contents of the linked folder will be deleted. .PP The rclone backend (https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. .PP Shortcuts can be completely ignored with the \f[C]--drive-skip-shortcuts\f[R] flag or the corresponding \f[C]skip_shortcuts\f[R] configuration setting. .PP If you have shortcuts that lead to an infinite recursion in your drive (e.g. a shortcut pointing to a parent folder), \f[C]skip_shortcuts\f[R] might be mandatory to be able to copy the drive. .SS Emptying trash .PP If you wish to empty your trash you can use the \f[C]rclone cleanup remote:\f[R] command which will permanently delete all your trashed files. This command does not take any path arguments. .PP Note that Google Drive takes some time (minutes to days) to empty the trash even though the command returns within a few seconds. No output is echoed, so there will be no confirmation even using -v or -vv. .SS Quota information .PP To view your current quota you can use the \f[C]rclone about remote:\f[R] command which will display your usage limit (quota), the usage in Google Drive, the size of all files in the Trash and the space used by other Google services such as Gmail. This command does not take any path arguments. .SS Import/Export of google documents .PP Google documents can be exported from and uploaded to Google Drive. .PP When rclone downloads a Google doc it chooses a format to download depending upon the \f[C]--drive-export-formats\f[R] setting. By default the export formats are \f[C]docx,xlsx,pptx,svg\f[R] which are a sensible default for an editable document. .PP When choosing a format, rclone runs down the list provided in order and chooses the first file format the doc can be exported as from the list. If the file can\[aq]t be exported to a format on the formats list, then rclone will choose a format from the default list. .PP If you prefer an archive copy then you might use \f[C]--drive-export-formats pdf\f[R], or if you prefer openoffice/libreoffice formats you might use \f[C]--drive-export-formats ods,odt,odp\f[R]. .PP Note that rclone adds the extension to the google doc, so if it is called \f[C]My Spreadsheet\f[R] on google docs, it will be exported as \f[C]My Spreadsheet.xlsx\f[R] or \f[C]My Spreadsheet.pdf\f[R] etc. .PP When importing files into Google Drive, rclone will convert all files with an extension in \f[C]--drive-import-formats\f[R] to their associated document type. rclone will not convert any files by default, since the conversion is lossy process. .PP The conversion must result in a file with the same extension when the \f[C]--drive-export-formats\f[R] rules are applied to the uploaded document. .PP Here are some examples for allowed and prohibited conversions. .PP .TS tab(@); l l l l l. T{ export-formats T}@T{ import-formats T}@T{ Upload Ext T}@T{ Document Ext T}@T{ Allowed T} _ T{ odt T}@T{ odt T}@T{ odt T}@T{ odt T}@T{ Yes T} T{ odt T}@T{ docx,odt T}@T{ odt T}@T{ odt T}@T{ Yes T} T{ T}@T{ docx T}@T{ docx T}@T{ docx T}@T{ Yes T} T{ T}@T{ odt T}@T{ odt T}@T{ docx T}@T{ No T} T{ odt,docx T}@T{ docx,odt T}@T{ docx T}@T{ odt T}@T{ No T} T{ docx,odt T}@T{ docx,odt T}@T{ docx T}@T{ docx T}@T{ Yes T} T{ docx,odt T}@T{ docx,odt T}@T{ odt T}@T{ docx T}@T{ No T} .TE .PP This limitation can be disabled by specifying \f[C]--drive-allow-import-name-change\f[R]. When using this flag, rclone can convert multiple files types resulting in the same document type at once, e.g. with \f[C]--drive-import-formats docx,odt,txt\f[R], all files having these extension would result in a document represented as a docx file. This brings the additional risk of overwriting a document, if multiple files have the same stem. Many rclone operations will not handle this name change in any way. They assume an equal name when copying files and might copy the file again or delete them when the name changes. .PP Here are the possible export extensions with their corresponding mime types. Most of these can also be used for importing, but there more that are not listed here. Some of these additional ones might only be available when the operating system provides the correct MIME type entries. .PP This list can be changed by Google Drive at any time and might not represent the currently available conversions. .PP .TS tab(@); lw(19.7n) lw(24.1n) lw(26.2n). T{ Extension T}@T{ Mime Type T}@T{ Description T} _ T{ bmp T}@T{ image/bmp T}@T{ Windows Bitmap format T} T{ csv T}@T{ text/csv T}@T{ Standard CSV format for Spreadsheets T} T{ doc T}@T{ application/msword T}@T{ Classic Word file T} T{ docx T}@T{ application/vnd.openxmlformats-officedocument.wordprocessingml.document T}@T{ Microsoft Office Document T} T{ epub T}@T{ application/epub+zip T}@T{ E-book format T} T{ html T}@T{ text/html T}@T{ An HTML Document T} T{ jpg T}@T{ image/jpeg T}@T{ A JPEG Image File T} T{ json T}@T{ application/vnd.google-apps.script+json T}@T{ JSON Text Format for Google Apps scripts T} T{ md T}@T{ text/markdown T}@T{ Markdown Text Format T} T{ odp T}@T{ application/vnd.oasis.opendocument.presentation T}@T{ Openoffice Presentation T} T{ ods T}@T{ application/vnd.oasis.opendocument.spreadsheet T}@T{ Openoffice Spreadsheet T} T{ ods T}@T{ application/x-vnd.oasis.opendocument.spreadsheet T}@T{ Openoffice Spreadsheet T} T{ odt T}@T{ application/vnd.oasis.opendocument.text T}@T{ Openoffice Document T} T{ pdf T}@T{ application/pdf T}@T{ Adobe PDF Format T} T{ pjpeg T}@T{ image/pjpeg T}@T{ Progressive JPEG Image T} T{ png T}@T{ image/png T}@T{ PNG Image Format T} T{ pptx T}@T{ application/vnd.openxmlformats-officedocument.presentationml.presentation T}@T{ Microsoft Office Powerpoint T} T{ rtf T}@T{ application/rtf T}@T{ Rich Text Format T} T{ svg T}@T{ image/svg+xml T}@T{ Scalable Vector Graphics Format T} T{ tsv T}@T{ text/tab-separated-values T}@T{ Standard TSV format for spreadsheets T} T{ txt T}@T{ text/plain T}@T{ Plain Text T} T{ wmf T}@T{ application/x-msmetafile T}@T{ Windows Meta File T} T{ xls T}@T{ application/vnd.ms-excel T}@T{ Classic Excel file T} T{ xlsx T}@T{ application/vnd.openxmlformats-officedocument.spreadsheetml.sheet T}@T{ Microsoft Office Spreadsheet T} T{ zip T}@T{ application/zip T}@T{ A ZIP file of HTML, Images CSS T} .TE .PP Google documents can also be exported as link files. These files will open a browser window for the Google Docs website of that document when opened. The link file extension has to be specified as a \f[C]--drive-export-formats\f[R] parameter. They will match all available Google Documents. .PP .TS tab(@); l l l. T{ Extension T}@T{ Description T}@T{ OS Support T} _ T{ desktop T}@T{ freedesktop.org specified desktop entry T}@T{ Linux T} T{ link.html T}@T{ An HTML Document with a redirect T}@T{ All T} T{ url T}@T{ INI style link file T}@T{ macOS, Windows T} T{ webloc T}@T{ macOS specific XML format T}@T{ macOS T} .TE .SS Standard options .PP Here are the Standard options specific to drive (Google Drive). .SS --drive-client-id .PP Google Application Client Id Setting your own is recommended. See https://rclone.org/drive/#making-your-own-client-id for how to create your own. If you leave this blank, it will use an internal key which is low performance. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_DRIVE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_DRIVE_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-scope .PP Comma separated list of scopes that rclone should use when requesting access from drive. .PP Properties: .IP \[bu] 2 Config: scope .IP \[bu] 2 Env Var: RCLONE_DRIVE_SCOPE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]drive\[dq] .RS 2 .IP \[bu] 2 Full access all files, excluding Application Data Folder. .RE .IP \[bu] 2 \[dq]drive.readonly\[dq] .RS 2 .IP \[bu] 2 Read-only access to file metadata and file contents. .RE .IP \[bu] 2 \[dq]drive.file\[dq] .RS 2 .IP \[bu] 2 Access to files created by rclone only. .IP \[bu] 2 These are visible in the drive website. .IP \[bu] 2 File authorization is revoked when the user deauthorizes the app. .RE .IP \[bu] 2 \[dq]drive.appfolder\[dq] .RS 2 .IP \[bu] 2 Allows read and write access to the Application Data folder. .IP \[bu] 2 This is not visible in the drive website. .RE .IP \[bu] 2 \[dq]drive.metadata.readonly\[dq] .RS 2 .IP \[bu] 2 Allows read-only access to file metadata but .IP \[bu] 2 does not allow any access to read or download file content. .RE .RE .SS --drive-service-account-file .PP Service Account Credentials JSON file path. .PP Leave blank normally. Needed only if you want use SA instead of interactive login. .PP Leading \f[C]\[ti]\f[R] will be expanded in the file name as will environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. .PP Properties: .IP \[bu] 2 Config: service_account_file .IP \[bu] 2 Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-alternate-export .PP Deprecated: No longer needed. .PP Properties: .IP \[bu] 2 Config: alternate_export .IP \[bu] 2 Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS Advanced options .PP Here are the Advanced options specific to drive (Google Drive). .SS --drive-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_DRIVE_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_DRIVE_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_DRIVE_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_DRIVE_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-root-folder-id .PP ID of the root folder. Leave blank normally. .PP Fill in to access \[dq]Computers\[dq] folders (see docs), or for rclone to use a non root folder as its starting point. .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-service-account-credentials .PP Service Account Credentials JSON blob. .PP Leave blank normally. Needed only if you want use SA instead of interactive login. .PP Properties: .IP \[bu] 2 Config: service_account_credentials .IP \[bu] 2 Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-team-drive .PP ID of the Shared Drive (Team Drive). .PP Properties: .IP \[bu] 2 Config: team_drive .IP \[bu] 2 Env Var: RCLONE_DRIVE_TEAM_DRIVE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-auth-owner-only .PP Only consider files owned by the authenticated user. .PP Properties: .IP \[bu] 2 Config: auth_owner_only .IP \[bu] 2 Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-use-trash .PP Send files to the trash instead of deleting permanently. .PP Defaults to true, namely sending files to the trash. Use \f[C]--drive-use-trash=false\f[R] to delete files permanently instead. .PP Properties: .IP \[bu] 2 Config: use_trash .IP \[bu] 2 Env Var: RCLONE_DRIVE_USE_TRASH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --drive-copy-shortcut-content .PP Server side copy contents of shortcuts instead of the shortcut. .PP When doing server side copies, normally rclone will copy shortcuts as shortcuts. .PP If this flag is used then rclone will copy the contents of shortcuts rather than shortcuts themselves when doing server side copies. .PP Properties: .IP \[bu] 2 Config: copy_shortcut_content .IP \[bu] 2 Env Var: RCLONE_DRIVE_COPY_SHORTCUT_CONTENT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-skip-gdocs .PP Skip google documents in all listings. .PP If given, gdocs practically become invisible to rclone. .PP Properties: .IP \[bu] 2 Config: skip_gdocs .IP \[bu] 2 Env Var: RCLONE_DRIVE_SKIP_GDOCS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-show-all-gdocs .PP Show all Google Docs including non-exportable ones in listings. .PP If you try a server side copy on a Google Form without this flag, you will get this error: .IP .nf \f[C] No export formats found for \[dq]application/vnd.google-apps.form\[dq] \f[R] .fi .PP However adding this flag will allow the form to be server side copied. .PP Note that rclone doesn\[aq]t add extensions to the Google Docs file names in this mode. .PP Do \f[B]not\f[R] use this flag when trying to download Google Docs - rclone will fail to download them. .PP Properties: .IP \[bu] 2 Config: show_all_gdocs .IP \[bu] 2 Env Var: RCLONE_DRIVE_SHOW_ALL_GDOCS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-skip-checksum-gphotos .PP Skip checksums on Google photos and videos only. .PP Use this if you get checksum errors when transferring Google photos or videos. .PP Setting this flag will cause Google photos and videos to return a blank checksums. .PP Google photos are identified by being in the \[dq]photos\[dq] space. .PP Corrupted checksums are caused by Google modifying the image/video but not updating the checksum. .PP Properties: .IP \[bu] 2 Config: skip_checksum_gphotos .IP \[bu] 2 Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-shared-with-me .PP Only show files that are shared with me. .PP Instructs rclone to operate on your \[dq]Shared with me\[dq] folder (where Google Drive lets you access the files and folders others have shared with you). .PP This works both with the \[dq]list\[dq] (lsd, lsl, etc.) and the \[dq]copy\[dq] commands (copy, sync, etc.), and with all other commands too. .PP Properties: .IP \[bu] 2 Config: shared_with_me .IP \[bu] 2 Env Var: RCLONE_DRIVE_SHARED_WITH_ME .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-trashed-only .PP Only show files that are in the trash. .PP This will show trashed files in their original directory structure. .PP Properties: .IP \[bu] 2 Config: trashed_only .IP \[bu] 2 Env Var: RCLONE_DRIVE_TRASHED_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-starred-only .PP Only show files that are starred. .PP Properties: .IP \[bu] 2 Config: starred_only .IP \[bu] 2 Env Var: RCLONE_DRIVE_STARRED_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-formats .PP Deprecated: See export_formats. .PP Properties: .IP \[bu] 2 Config: formats .IP \[bu] 2 Env Var: RCLONE_DRIVE_FORMATS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-export-formats .PP Comma separated list of preferred formats for downloading Google docs. .PP Properties: .IP \[bu] 2 Config: export_formats .IP \[bu] 2 Env Var: RCLONE_DRIVE_EXPORT_FORMATS .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]docx,xlsx,pptx,svg\[dq] .SS --drive-import-formats .PP Comma separated list of preferred formats for uploading Google docs. .PP Properties: .IP \[bu] 2 Config: import_formats .IP \[bu] 2 Env Var: RCLONE_DRIVE_IMPORT_FORMATS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-allow-import-name-change .PP Allow the filetype to change when uploading Google docs. .PP E.g. file.doc to file.docx. This will confuse sync and reupload every time. .PP Properties: .IP \[bu] 2 Config: allow_import_name_change .IP \[bu] 2 Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-use-created-date .PP Use file created date instead of modified date. .PP Useful when downloading data and you want the creation date used in place of the last modified date. .PP \f[B]WARNING\f[R]: This flag may have some unexpected consequences. .PP When uploading to your drive all files will be overwritten unless they haven\[aq]t been modified since their creation. And the inverse will occur while downloading. This side effect can be avoided by using the \[dq]--checksum\[dq] flag. .PP This feature was implemented to retain photos capture date as recorded by google photos. You will first need to check the \[dq]Create a Google Photos folder\[dq] option in your google drive settings. You can then copy or move the photos locally and use the date the image was taken (created) set as the modification date. .PP Properties: .IP \[bu] 2 Config: use_created_date .IP \[bu] 2 Env Var: RCLONE_DRIVE_USE_CREATED_DATE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-use-shared-date .PP Use date file was shared instead of modified date. .PP Note that, as with \[dq]--drive-use-created-date\[dq], this flag may have unexpected consequences when uploading/downloading files. .PP If both this flag and \[dq]--drive-use-created-date\[dq] are set, the created date is used. .PP Properties: .IP \[bu] 2 Config: use_shared_date .IP \[bu] 2 Env Var: RCLONE_DRIVE_USE_SHARED_DATE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-list-chunk .PP Size of listing chunk 100-1000, 0 to disable. .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_DRIVE_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1000 .SS --drive-impersonate .PP Impersonate this user when using a service account. .PP Properties: .IP \[bu] 2 Config: impersonate .IP \[bu] 2 Env Var: RCLONE_DRIVE_IMPERSONATE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-upload-cutoff .PP Cutoff for switching to chunked upload. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 8Mi .SS --drive-chunk-size .PP Upload chunk size. .PP Must a power of 2 >= 256k. .PP Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer. .PP Reducing this will reduce memory usage but decrease performance. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_DRIVE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 8Mi .SS --drive-acknowledge-abuse .PP Set to allow files which return cannotDownloadAbusiveFile to be downloaded. .PP If downloading a file returns the error \[dq]This file has been identified as malware or spam and cannot be downloaded\[dq] with the error code \[dq]cannotDownloadAbusiveFile\[dq] then supply this flag to rclone to indicate you acknowledge the risks of downloading the file and rclone will download it anyway. .PP Note that if you are using service account it will need Manager permission (not Content Manager) to for this flag to work. If the SA does not have the right permission, Google will just ignore the flag. .PP Properties: .IP \[bu] 2 Config: acknowledge_abuse .IP \[bu] 2 Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-keep-revision-forever .PP Keep new head revision of each file forever. .PP Properties: .IP \[bu] 2 Config: keep_revision_forever .IP \[bu] 2 Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-size-as-quota .PP Show sizes as storage quota usage, not actual size. .PP Show the size of a file as the storage quota used. This is the current version plus any older versions that have been set to keep forever. .PP \f[B]WARNING\f[R]: This flag may have some unexpected consequences. .PP It is not recommended to set this flag in your config - the recommended usage is using the flag form --drive-size-as-quota when doing rclone ls/lsl/lsf/lsjson/etc only. .PP If you do use this flag for syncing (not recommended) then you will need to use --ignore size also. .PP Properties: .IP \[bu] 2 Config: size_as_quota .IP \[bu] 2 Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-v2-download-min-size .PP If Object\[aq]s are greater, use drive v2 API to download. .PP Properties: .IP \[bu] 2 Config: v2_download_min_size .IP \[bu] 2 Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: off .SS --drive-pacer-min-sleep .PP Minimum time to sleep between API calls. .PP Properties: .IP \[bu] 2 Config: pacer_min_sleep .IP \[bu] 2 Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 100ms .SS --drive-pacer-burst .PP Number of API calls to allow without sleeping. .PP Properties: .IP \[bu] 2 Config: pacer_burst .IP \[bu] 2 Env Var: RCLONE_DRIVE_PACER_BURST .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 100 .SS --drive-server-side-across-configs .PP Deprecated: use --server-side-across-configs instead. .PP Allow server-side operations (e.g. copy) to work across different drive configs. .PP This can be useful if you wish to do a server-side copy between two different Google drives. Note that this isn\[aq]t enabled by default because it isn\[aq]t easy to tell if it will work between any two configurations. .PP Properties: .IP \[bu] 2 Config: server_side_across_configs .IP \[bu] 2 Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-disable-http2 .PP Disable drive using http2. .PP There is currently an unsolved issue with the google drive backend and HTTP/2. HTTP/2 is therefore disabled by default for the drive backend but can be re-enabled here. When the issue is solved this flag will be removed. .PP See: https://github.com/rclone/rclone/issues/3631 .PP Properties: .IP \[bu] 2 Config: disable_http2 .IP \[bu] 2 Env Var: RCLONE_DRIVE_DISABLE_HTTP2 .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --drive-stop-on-upload-limit .PP Make upload limit errors be fatal. .PP At the time of writing it is only possible to upload 750 GiB of data to Google Drive a day (this is an undocumented limit). When this limit is reached Google Drive produces a slightly different error message. When this flag is set it causes these errors to be fatal. These will stop the in-progress sync. .PP Note that this detection is relying on error message strings which Google don\[aq]t document so it may break in the future. .PP See: https://github.com/rclone/rclone/issues/3857 .PP Properties: .IP \[bu] 2 Config: stop_on_upload_limit .IP \[bu] 2 Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-stop-on-download-limit .PP Make download limit errors be fatal. .PP At the time of writing it is only possible to download 10 TiB of data from Google Drive a day (this is an undocumented limit). When this limit is reached Google Drive produces a slightly different error message. When this flag is set it causes these errors to be fatal. These will stop the in-progress sync. .PP Note that this detection is relying on error message strings which Google don\[aq]t document so it may break in the future. .PP Properties: .IP \[bu] 2 Config: stop_on_download_limit .IP \[bu] 2 Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-skip-shortcuts .PP If set skip shortcut files. .PP Normally rclone dereferences shortcut files making them appear as if they are the original file (see the shortcuts section). If this flag is set then rclone will ignore shortcut files completely. .PP Properties: .IP \[bu] 2 Config: skip_shortcuts .IP \[bu] 2 Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-skip-dangling-shortcuts .PP If set skip dangling shortcut files. .PP If this is set then rclone will not show any dangling shortcuts in listings. .PP Properties: .IP \[bu] 2 Config: skip_dangling_shortcuts .IP \[bu] 2 Env Var: RCLONE_DRIVE_SKIP_DANGLING_SHORTCUTS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --drive-resource-key .PP Resource key for accessing a link-shared file. .PP If you need to access files shared with a link like this .IP .nf \f[C] https://drive.google.com/drive/folders/XXX?resourcekey=YYY&usp=sharing \f[R] .fi .PP Then you will need to use the first part \[dq]XXX\[dq] as the \[dq]root_folder_id\[dq] and the second part \[dq]YYY\[dq] as the \[dq]resource_key\[dq] otherwise you will get 404 not found errors when trying to access the directory. .PP See: https://developers.google.com/drive/api/guides/resource-keys .PP This resource key requirement only applies to a subset of old files. .PP Note also that opening the folder once in the web interface (with the user you\[aq]ve authenticated rclone with) seems to be enough so that the resource key is not needed. .PP Properties: .IP \[bu] 2 Config: resource_key .IP \[bu] 2 Env Var: RCLONE_DRIVE_RESOURCE_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --drive-fast-list-bug-fix .PP Work around a bug in Google Drive listing. .PP Normally rclone will work around a bug in Google Drive when using --fast-list (ListR) where the search \[dq](A in parents) or (B in parents)\[dq] returns nothing sometimes. See #3114, #4289 and https://issuetracker.google.com/issues/149522397 .PP Rclone detects this by finding no items in more than one directory when listing and retries them as lists of individual directories. .PP This means that if you have a lot of empty directories rclone will end up listing them all individually and this can take many more API calls. .PP This flag allows the work-around to be disabled. This is \f[B]not\f[R] recommended in normal use - only if you have a particular case you are having trouble with like many empty directories. .PP Properties: .IP \[bu] 2 Config: fast_list_bug_fix .IP \[bu] 2 Env Var: RCLONE_DRIVE_FAST_LIST_BUG_FIX .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --drive-metadata-owner .PP Control whether owner should be read or written in metadata. .PP Owner is a standard part of the file metadata so is easy to read. But it isn\[aq]t always desirable to set the owner from the metadata. .PP Note that you can\[aq]t set the owner on Shared Drives, and that setting ownership will generate an email to the new owner (this can\[aq]t be disabled), and you can\[aq]t transfer ownership to someone outside your organization. .PP Properties: .IP \[bu] 2 Config: metadata_owner .IP \[bu] 2 Env Var: RCLONE_DRIVE_METADATA_OWNER .IP \[bu] 2 Type: Bits .IP \[bu] 2 Default: read .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]off\[dq] .RS 2 .IP \[bu] 2 Do not read or write the value .RE .IP \[bu] 2 \[dq]read\[dq] .RS 2 .IP \[bu] 2 Read the value only .RE .IP \[bu] 2 \[dq]write\[dq] .RS 2 .IP \[bu] 2 Write the value only .RE .IP \[bu] 2 \[dq]failok\[dq] .RS 2 .IP \[bu] 2 If writing fails log errors only, don\[aq]t fail the transfer .RE .IP \[bu] 2 \[dq]read,write\[dq] .RS 2 .IP \[bu] 2 Read and Write the value. .RE .RE .SS --drive-metadata-permissions .PP Control whether permissions should be read or written in metadata. .PP Reading permissions metadata from files can be done quickly, but it isn\[aq]t always desirable to set the permissions from the metadata. .PP Note that rclone drops any inherited permissions on Shared Drives and any owner permission on My Drives as these are duplicated in the owner metadata. .PP Properties: .IP \[bu] 2 Config: metadata_permissions .IP \[bu] 2 Env Var: RCLONE_DRIVE_METADATA_PERMISSIONS .IP \[bu] 2 Type: Bits .IP \[bu] 2 Default: off .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]off\[dq] .RS 2 .IP \[bu] 2 Do not read or write the value .RE .IP \[bu] 2 \[dq]read\[dq] .RS 2 .IP \[bu] 2 Read the value only .RE .IP \[bu] 2 \[dq]write\[dq] .RS 2 .IP \[bu] 2 Write the value only .RE .IP \[bu] 2 \[dq]failok\[dq] .RS 2 .IP \[bu] 2 If writing fails log errors only, don\[aq]t fail the transfer .RE .IP \[bu] 2 \[dq]read,write\[dq] .RS 2 .IP \[bu] 2 Read and Write the value. .RE .RE .SS --drive-metadata-labels .PP Control whether labels should be read or written in metadata. .PP Reading labels metadata from files takes an extra API transaction and will slow down listings. It isn\[aq]t always desirable to set the labels from the metadata. .PP The format of labels is documented in the drive API documentation at https://developers.google.com/drive/api/reference/rest/v3/Label - rclone just provides a JSON dump of this format. .PP When setting labels, the label and fields must already exist - rclone will not create them. This means that if you are transferring labels from two different accounts you will have to create the labels in advance and use the metadata mapper to translate the IDs between the two accounts. .PP Properties: .IP \[bu] 2 Config: metadata_labels .IP \[bu] 2 Env Var: RCLONE_DRIVE_METADATA_LABELS .IP \[bu] 2 Type: Bits .IP \[bu] 2 Default: off .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]off\[dq] .RS 2 .IP \[bu] 2 Do not read or write the value .RE .IP \[bu] 2 \[dq]read\[dq] .RS 2 .IP \[bu] 2 Read the value only .RE .IP \[bu] 2 \[dq]write\[dq] .RS 2 .IP \[bu] 2 Write the value only .RE .IP \[bu] 2 \[dq]failok\[dq] .RS 2 .IP \[bu] 2 If writing fails log errors only, don\[aq]t fail the transfer .RE .IP \[bu] 2 \[dq]read,write\[dq] .RS 2 .IP \[bu] 2 Read and Write the value. .RE .RE .SS --drive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_DRIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: InvalidUtf8 .SS --drive-env-auth .PP Get IAM credentials from runtime (environment variables or instance meta data if no env vars). .PP Only applies if service_account_file and service_account_credentials is blank. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_DRIVE_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Enter credentials in the next step. .RE .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Get GCP IAM credentials from the environment (env vars or IAM). .RE .RE .SS --drive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_DRIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP User metadata is stored in the properties field of the drive object. .PP Metadata is supported on files and directories. .PP Here are the possible system metadata items for the drive backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ btime T}@T{ Time of file birth (creation) with mS accuracy. Note that this is only writable on fresh uploads - it can\[aq]t be written for updates. T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999Z07:00 T}@T{ N T} T{ content-type T}@T{ The MIME type of the file. T}@T{ string T}@T{ text/plain T}@T{ N T} T{ copy-requires-writer-permission T}@T{ Whether the options to copy, print, or download this file, should be disabled for readers and commenters. T}@T{ boolean T}@T{ true T}@T{ N T} T{ description T}@T{ A short description of the file. T}@T{ string T}@T{ Contract for signing T}@T{ N T} T{ folder-color-rgb T}@T{ The color for a folder or a shortcut to a folder as an RGB hex string. T}@T{ string T}@T{ 881133 T}@T{ N T} T{ labels T}@T{ Labels attached to this file in a JSON dump of Googled drive format. Enable with --drive-metadata-labels. T}@T{ JSON T}@T{ [] T}@T{ N T} T{ mtime T}@T{ Time of last modification with mS accuracy. T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999Z07:00 T}@T{ N T} T{ owner T}@T{ The owner of the file. Usually an email address. Enable with --drive-metadata-owner. T}@T{ string T}@T{ user\[at]example.com T}@T{ N T} T{ permissions T}@T{ Permissions in a JSON dump of Google drive format. On shared drives these will only be present if they aren\[aq]t inherited. Enable with --drive-metadata-permissions. T}@T{ JSON T}@T{ {} T}@T{ N T} T{ starred T}@T{ Whether the user has starred the file. T}@T{ boolean T}@T{ false T}@T{ N T} T{ viewed-by-me T}@T{ Whether the file has been viewed by this user. T}@T{ boolean T}@T{ true T}@T{ \f[B]Y\f[R] T} T{ writers-can-share T}@T{ Whether users with only writer permission can modify the file\[aq]s permissions. Not populated and ignored when setting for items in shared drives. T}@T{ boolean T}@T{ false T}@T{ N T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Backend commands .PP Here are the commands specific to the drive backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS get .PP Get command for fetching the drive config parameters .IP .nf \f[C] rclone backend get remote: [options] [<arguments>+] \f[R] .fi .PP This is a get command which will be used to fetch the various drive config parameters .PP Usage Examples: .IP .nf \f[C] rclone backend get drive: [-o service_account_file] [-o chunk_size] rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] \f[R] .fi .PP Options: .IP \[bu] 2 \[dq]chunk_size\[dq]: show the current upload chunk size .IP \[bu] 2 \[dq]service_account_file\[dq]: show the current service account file .SS set .PP Set command for updating the drive config parameters .IP .nf \f[C] rclone backend set remote: [options] [<arguments>+] \f[R] .fi .PP This is a set command which will be used to update the various drive config parameters .PP Usage Examples: .IP .nf \f[C] rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] \f[R] .fi .PP Options: .IP \[bu] 2 \[dq]chunk_size\[dq]: update the current upload chunk size .IP \[bu] 2 \[dq]service_account_file\[dq]: update the current service account file .SS shortcut .PP Create shortcuts from files or directories .IP .nf \f[C] rclone backend shortcut remote: [options] [<arguments>+] \f[R] .fi .PP This command creates shortcuts from files or directories. .PP Usage: .IP .nf \f[C] rclone backend shortcut drive: source_item destination_shortcut rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut \f[R] .fi .PP In the first example this creates a shortcut from the \[dq]source_item\[dq] which can be a file or a directory to the \[dq]destination_shortcut\[dq]. The \[dq]source_item\[dq] and the \[dq]destination_shortcut\[dq] should be relative paths from \[dq]drive:\[dq] .PP In the second example this creates a shortcut from the \[dq]source_item\[dq] relative to \[dq]drive:\[dq] to the \[dq]destination_shortcut\[dq] relative to \[dq]drive2:\[dq]. This may fail with a permission error if the user authenticated with \[dq]drive2:\[dq] can\[aq]t read files from \[dq]drive:\[dq]. .PP Options: .IP \[bu] 2 \[dq]target\[dq]: optional target remote for the shortcut destination .SS drives .PP List the Shared Drives available to this account .IP .nf \f[C] rclone backend drives remote: [options] [<arguments>+] \f[R] .fi .PP This command lists the Shared Drives (Team Drives) available to this account. .PP Usage: .IP .nf \f[C] rclone backend [-o config] drives drive: \f[R] .fi .PP This will return a JSON list of objects like this .IP .nf \f[C] [ { \[dq]id\[dq]: \[dq]0ABCDEF-01234567890\[dq], \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], \[dq]name\[dq]: \[dq]My Drive\[dq] }, { \[dq]id\[dq]: \[dq]0ABCDEFabcdefghijkl\[dq], \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], \[dq]name\[dq]: \[dq]Test Drive\[dq] } ] \f[R] .fi .PP With the -o config parameter it will output the list in a format suitable for adding to a config file to make aliases for all the drives found and a combined drive. .IP .nf \f[C] [My Drive] type = alias remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=: [Test Drive] type = alias remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: [AllDrives] type = combine upstreams = \[dq]My Drive=My Drive:\[dq] \[dq]Test Drive=Test Drive:\[dq] \f[R] .fi .PP Adding this to the rclone config file will cause those team drives to be accessible with the aliases shown. Any illegal characters will be substituted with \[dq]_\[dq] and duplicate names will have numbers suffixed. It will also add a remote called AllDrives which shows all the shared drives combined into one directory tree. .SS untrash .PP Untrash files and directories .IP .nf \f[C] rclone backend untrash remote: [options] [<arguments>+] \f[R] .fi .PP This command untrashes all the files and directories in the directory passed in recursively. .PP Usage: .PP This takes an optional directory to trash which make this easier to use via the API. .IP .nf \f[C] rclone backend untrash drive:directory rclone backend --interactive untrash drive:directory subdir \f[R] .fi .PP Use the --interactive/-i or --dry-run flag to see what would be restored before restoring it. .PP Result: .IP .nf \f[C] { \[dq]Untrashed\[dq]: 17, \[dq]Errors\[dq]: 0 } \f[R] .fi .SS copyid .PP Copy files by ID .IP .nf \f[C] rclone backend copyid remote: [options] [<arguments>+] \f[R] .fi .PP This command copies files by ID .PP Usage: .IP .nf \f[C] rclone backend copyid drive: ID path rclone backend copyid drive: ID1 path1 ID2 path2 \f[R] .fi .PP It copies the drive file with ID given to the path (an rclone path which will be passed internally to rclone copyto). The ID and path pairs can be repeated. .PP The path should end with a / to indicate copy the file as named to this directory. If it doesn\[aq]t end with a / then the last path component will be used as the file name. .PP If the destination is a drive backend then server-side copying will be attempted if possible. .PP Use the --interactive/-i or --dry-run flag to see what would be copied before copying. .SS exportformats .PP Dump the export formats for debug purposes .IP .nf \f[C] rclone backend exportformats remote: [options] [<arguments>+] \f[R] .fi .SS importformats .PP Dump the import formats for debug purposes .IP .nf \f[C] rclone backend importformats remote: [options] [<arguments>+] \f[R] .fi .SS query .PP List files using Google Drive query language .IP .nf \f[C] rclone backend query remote: [options] [<arguments>+] \f[R] .fi .PP This command lists files based on a query .PP Usage: .IP .nf \f[C] rclone backend query drive: query \f[R] .fi .PP The query syntax is documented at Google Drive Search query terms and operators (https://developers.google.com/drive/api/guides/ref-search-terms). .PP For example: .IP .nf \f[C] rclone backend query drive: \[dq]\[aq]0ABc9DEFGHIJKLMNop0QRatUVW3X\[aq] in parents and name contains \[aq]foo\[aq]\[dq] \f[R] .fi .PP If the query contains literal \[aq] or \ characters, these need to be escaped with \ characters. \[dq]\[aq]\[dq] becomes \[dq]\[aq]\[dq] and \[dq]\[dq] becomes \[dq]\[rs]\[dq], for example to match a file named \[dq]foo \[aq] \&.txt\[dq]: .IP .nf \f[C] rclone backend query drive: \[dq]name = \[aq]foo \[rs]\[aq] \[rs]\[rs]\[rs].txt\[aq]\[dq] \f[R] .fi .PP The result is a JSON array of matches, for example: .IP .nf \f[C] [ { \[dq]createdTime\[dq]: \[dq]2017-06-29T19:58:28.537Z\[dq], \[dq]id\[dq]: \[dq]0AxBe_CDEF4zkGHI4d0FjYko2QkD\[dq], \[dq]md5Checksum\[dq]: \[dq]68518d16be0c6fbfab918be61d658032\[dq], \[dq]mimeType\[dq]: \[dq]text/plain\[dq], \[dq]modifiedTime\[dq]: \[dq]2024-02-02T10:40:02.874Z\[dq], \[dq]name\[dq]: \[dq]foo \[aq] \[rs]\[rs].txt\[dq], \[dq]parents\[dq]: [ \[dq]0BxAe_BCDE4zkFGZpcWJGek0xbzC\[dq] ], \[dq]resourceKey\[dq]: \[dq]0-ABCDEFGHIXJQpIGqBJq3MC\[dq], \[dq]sha1Checksum\[dq]: \[dq]8f284fa768bfb4e45d076a579ab3905ab6bfa893\[dq], \[dq]size\[dq]: \[dq]311\[dq], \[dq]webViewLink\[dq]: \[dq]https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk\[rs]u0026resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC\[dq] } ] \f[R] .fi .SS rescue .PP Rescue or delete any orphaned files .IP .nf \f[C] rclone backend rescue remote: [options] [<arguments>+] \f[R] .fi .PP This command rescues or deletes any orphaned files or directories. .PP Sometimes files can get orphaned in Google Drive. This means that they are no longer in any folder in Google Drive. .PP This command finds those files and either rescues them to a directory you specify or deletes them. .PP Usage: .PP This can be used in 3 ways. .PP First, list all orphaned files .IP .nf \f[C] rclone backend rescue drive: \f[R] .fi .PP Second rescue all orphaned files to the directory indicated .IP .nf \f[C] rclone backend rescue drive: \[dq]relative/path/to/rescue/directory\[dq] \f[R] .fi .PP e.g. To rescue all orphans to a directory called \[dq]Orphans\[dq] in the top level .IP .nf \f[C] rclone backend rescue drive: Orphans \f[R] .fi .PP Third delete all orphaned files to the trash .IP .nf \f[C] rclone backend rescue drive: -o delete \f[R] .fi .SS Limitations .PP Drive has quite a lot of rate limiting. This causes rclone to be limited to transferring about 2 files per second only. Individual files may be transferred much faster at 100s of MiB/s but lots of small files can take a long time. .PP Server side copies are also subject to a separate rate limit. If you see User rate limit exceeded errors, wait at least 24 hours and retry. You can disable server-side copies with \f[C]--disable copy\f[R] to download and upload the files if you prefer. .SS Limitations of Google Docs .PP Google docs will appear as size -1 in \f[C]rclone ls\f[R], \f[C]rclone ncdu\f[R] etc, and as size 0 in anything which uses the VFS layer, e.g. \f[C]rclone mount\f[R] and \f[C]rclone serve\f[R]. When calculating directory totals, e.g. in \f[C]rclone size\f[R] and \f[C]rclone ncdu\f[R], they will be counted in as empty files. .PP This is because rclone can\[aq]t find out the size of the Google docs without downloading them. .PP Google docs will transfer correctly with \f[C]rclone sync\f[R], \f[C]rclone copy\f[R] etc as rclone knows to ignore the size when doing the transfer. .PP However an unfortunate consequence of this is that you may not be able to download Google docs using \f[C]rclone mount\f[R]. If it doesn\[aq]t work you will get a 0 sized file. If you try again the doc may gain its correct size and be downloadable. Whether it will work on not depends on the application accessing the mount and the OS you are running - experiment to find out if it does work for you! .SS Duplicated files .PP Sometimes, for no reason I\[aq]ve been able to track down, drive will duplicate a file that rclone uploads. Drive unlike all the other remotes can have duplicated files. .PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .PP Use \f[C]rclone dedupe\f[R] to fix duplicated files. .PP Note that this isn\[aq]t just a problem with rclone, even Google Photos on Android duplicates files on drive sometimes. .SS Rclone appears to be re-copying files it shouldn\[aq]t .PP The most likely cause of this is the duplicated file issue above - run \f[C]rclone dedupe\f[R] and check your logs for duplicate object or directory messages. .PP This can also be caused by a delay/caching on google drive\[aq]s end when comparing directory listings. Specifically with team drives used in combination with --fast-list. Files that were uploaded recently may not appear on the directory list sent to rclone when using --fast-list. .PP Waiting a moderate period of time between attempts (estimated to be approximately 1 hour) and/or not using --fast-list both seem to be effective in preventing the problem. .SS SHA1 or SHA256 hashes may be missing .PP All files have MD5 hashes, but a small fraction of files uploaded may not have SHA1 or SHA256 hashes especially if they were uploaded before 2018. .SS Making your own client_id .PP When you use rclone with Google drive in its default configuration you are using rclone\[aq]s client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. rclone already has a high quota and I will continue to make sure it is high enough by contacting Google. .PP It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower. .PP Here is how to create your own Google Drive client ID for rclone: .IP "1." 3 Log into the Google API Console (https://console.developers.google.com/) with your Google account. It doesn\[aq]t matter what Google account you use. (It need not be the same account as the Google Drive you want to access) .IP "2." 3 Select a project or create a new project. .IP "3." 3 Under \[dq]ENABLE APIS AND SERVICES\[dq] search for \[dq]Drive\[dq], and enable the \[dq]Google Drive API\[dq]. .IP "4." 3 Click \[dq]Credentials\[dq] in the left-side panel (not \[dq]Create credentials\[dq], which opens the wizard). .IP "5." 3 If you already configured an \[dq]Oauth Consent Screen\[dq], then skip to the next step; if not, click on \[dq]CONFIGURE CONSENT SCREEN\[dq] button (near the top right corner of the right panel), then select \[dq]External\[dq] and click on \[dq]CREATE\[dq]; on the next screen, enter an \[dq]Application name\[dq] (\[dq]rclone\[dq] is OK); enter \[dq]User Support Email\[dq] (your own email is OK); enter \[dq]Developer Contact Email\[dq] (your own email is OK); then click on \[dq]Save\[dq] (all other data is optional). You will also have to add some scopes (https://developers.google.com/drive/api/guides/api-specific-auth), including .IP \[bu] 2 \f[C]https://www.googleapis.com/auth/docs\f[R] .IP \[bu] 2 \f[C]https://www.googleapis.com/auth/drive\f[R] in order to be able to edit, create and delete files with RClone. .IP \[bu] 2 \f[C]https://www.googleapis.com/auth/drive.metadata.readonly\f[R] which you may also want to add. .IP \[bu] 2 If you want to add all at once, comma separated it would be \f[C]https://www.googleapis.com/auth/docs,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/drive.metadata.readonly\f[R]. .IP " 6." 4 After adding scopes, click \[dq]Save and continue\[dq] to add test users. Be sure to add your own account to the test users. Once you\[aq]ve added yourself as a test user and saved the changes, click again on \[dq]Credentials\[dq] on the left panel to go back to the \[dq]Credentials\[dq] screen. .RS 4 .PP (PS: if you are a GSuite user, you could also select \[dq]Internal\[dq] instead of \[dq]External\[dq] above, but this will restrict API use to Google Workspace users in your organisation). .RE .IP " 7." 4 Click on the \[dq]+ CREATE CREDENTIALS\[dq] button at the top of the screen, then select \[dq]OAuth client ID\[dq]. .IP " 8." 4 Choose an application type of \[dq]Desktop app\[dq] and click \[dq]Create\[dq]. (the default name is fine) .IP " 9." 4 It will show you a client ID and client secret. Make a note of these. .RS 4 .PP (If you selected \[dq]External\[dq] at Step 5 continue to Step 10. If you chose \[dq]Internal\[dq] you don\[aq]t need to publish and can skip straight to Step 11 but your destination drive must be part of the same Google Workspace.) .RE .IP "10." 4 Go to \[dq]Oauth consent screen\[dq] and then click \[dq]PUBLISH APP\[dq] button and confirm. You will also want to add yourself as a test user. .IP "11." 4 Provide the noted client ID and client secret to rclone. .PP Be aware that, due to the \[dq]enhanced security\[dq] recently introduced by Google, you are theoretically expected to \[dq]submit your app for verification\[dq] and then wait a few weeks(!) for their response; in practice, you can go right ahead and use the client ID and client secret with rclone, the only issue will be a very scary confirmation screen shown when you connect via your browser for rclone to be able to get its token-id (but as this only happens during the remote configuration, it\[aq]s not such a big deal). Keeping the application in \[dq]Testing\[dq] will work as well, but the limitation is that any grants will expire after a week, which can be annoying to refresh constantly. If, for whatever reason, a short grant time is not a problem, then keeping the application in testing mode would also be sufficient. .PP (Thanks to \[at]balazer on github for these instructions.) .PP Sometimes, creation of an OAuth consent in Google API Console fails due to an error message \[lq]The request failed because changes to one of the field of the resource is not supported\[rq]. As a convenient workaround, the necessary Google Drive API key can be created on the Python Quickstart (https://developers.google.com/drive/api/v3/quickstart/python) page. Just push the Enable the Drive API button to receive the Client ID and Secret. Note that it will automatically create a new project in the API Console. .SH Google Photos .PP The rclone backend for Google Photos (https://www.google.com/photos/about/) is a specialized backend for transferring photos and videos to and from Google Photos. .PP \f[B]NB\f[R] The Google Photos API which rclone uses has quite a few limitations, so please read the limitations section carefully to make sure it is suitable for your use. .SS Configuration .PP The initial setup for google cloud storage involves getting a token from Google Photos which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Google Photos \[rs] \[dq]google photos\[dq] [snip] Storage> google photos ** See help for google photos backend at: https://rclone.org/googlephotos/ ** Google Application Client Id Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). client_id> Google Application Client Secret Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). client_secret> Set to make the Google Photos backend read only. If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code *** IMPORTANT: All media items uploaded to Google Photos with rclone *** are stored in full resolution at original quality. These uploads *** will count towards storage in your Google Account. Configuration complete. Options: - type: google photos - token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019-06-28T17:38:04.644930156+01:00\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all the albums in your photos .IP .nf \f[C] rclone lsd remote:album \f[R] .fi .PP Make a new album .IP .nf \f[C] rclone mkdir remote:album/newAlbum \f[R] .fi .PP List the contents of an album .IP .nf \f[C] rclone ls remote:album/newAlbum \f[R] .fi .PP Sync \f[C]/home/local/images\f[R] to the Google Photos, removing any excess files in the album. .IP .nf \f[C] rclone sync --interactive /home/local/image remote:album/newAlbum \f[R] .fi .SS Layout .PP As Google Photos is not a general purpose cloud storage system, the backend is laid out to help you navigate it. .PP The directories under \f[C]media\f[R] show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup \f[C]remote:media/by-month\f[R]. (\f[B]NB\f[R] \f[C]remote:media/by-day\f[R] is rather slow at the moment so avoid for syncing.) .PP Note that all your photos and videos will appear somewhere under \f[C]media\f[R], but they may not appear under \f[C]album\f[R] unless you\[aq]ve put them into albums. .IP .nf \f[C] / - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - feature - favorites - file1.jpg - file2.jpg \f[R] .fi .PP There are two writable parts of the tree, the \f[C]upload\f[R] directory and sub directories of the \f[C]album\f[R] directory. .PP The \f[C]upload\f[R] directory is for uploading files you don\[aq]t want to put into albums. This will be empty to start with and will contain the files you\[aq]ve uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to \f[C]album\f[R] will work better. .PP Directories within the \f[C]album\f[R] directory are also writeable and you may create new directories (albums) under \f[C]album\f[R]. If you copy files with a directory hierarchy in there then rclone will create albums with the \f[C]/\f[R] character in them. For example if you do .IP .nf \f[C] rclone copy /path/to/images remote:album/images \f[R] .fi .PP and the images directory contains .IP .nf \f[C] images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg \f[R] .fi .PP Then rclone will create the following albums with the following files in .IP \[bu] 2 images .RS 2 .IP \[bu] 2 file1.jpg .RE .IP \[bu] 2 images/dir .RS 2 .IP \[bu] 2 file2.jpg .RE .IP \[bu] 2 images/dir2/dir3 .RS 2 .IP \[bu] 2 file3.jpg .RE .PP This means that you can use the \f[C]album\f[R] path pretty much like a normal filesystem and it is a good target for repeated syncing. .PP The \f[C]shared-album\f[R] directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. .SS Standard options .PP Here are the Standard options specific to google photos (Google Photos). .SS --gphotos-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-read-only .PP Set to make the Google Photos backend read only. .PP If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. .PP Properties: .IP \[bu] 2 Config: read_only .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_READ_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS Advanced options .PP Here are the Advanced options specific to google photos (Google Photos). .SS --gphotos-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gphotos-read-size .PP Set to read the size of media items. .PP Normally rclone does not read the size of media items since this takes another transaction. This isn\[aq]t necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media. .PP Properties: .IP \[bu] 2 Config: read_size .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_READ_SIZE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gphotos-start-year .PP Year limits the photos to be downloaded to those which are uploaded after the given year. .PP Properties: .IP \[bu] 2 Config: start_year .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_START_YEAR .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 2000 .SS --gphotos-include-archived .PP Also view and download archived media. .PP By default, rclone does not request archived media. Thus, when syncing, archived media is not visible in directory listings or transferred. .PP Note that media in albums is always visible and synced, no matter their archive status. .PP With this flag, archived media are always visible in directory listings and transferred. .PP Without this flag, archived media will not be visible in directory listings and won\[aq]t be transferred. .PP Properties: .IP \[bu] 2 Config: include_archived .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --gphotos-proxy .PP Use the gphotosdl proxy for downloading the full resolution images .PP The Google API will deliver images and video which aren\[aq]t full resolution, and/or have EXIF data missing. .PP However if you ue the gphotosdl proxy tnen you can download original, unchanged images. .PP This runs a headless browser in the background. .PP Download the software from gphotosdl (https://github.com/rclone/gphotosdl) .PP First run with .IP .nf \f[C] gphotosdl -login \f[R] .fi .PP Then once you have logged into google photos close the browser window and run .IP .nf \f[C] gphotosdl \f[R] .fi .PP Then supply the parameter \f[C]--gphotos-proxy \[dq]http://localhost:8282\[dq]\f[R] to make rclone use the proxy. .PP Properties: .IP \[bu] 2 Config: proxy .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_PROXY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --gphotos-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,CrLf,InvalidUtf8,Dot .SS --gphotos-batch-mode .PP Upload file batching sync|async|off. .PP This sets the batch mode used by rclone. .PP This has 3 possible values .IP \[bu] 2 off - no batching .IP \[bu] 2 sync - batch uploads and check completion (default) .IP \[bu] 2 async - batch upload and don\[aq]t check completion .PP Rclone will close any outstanding batches when it exits which may make a delay on quit. .PP Properties: .IP \[bu] 2 Config: batch_mode .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_BATCH_MODE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]sync\[dq] .SS --gphotos-batch-size .PP Max number of files in upload batch. .PP This sets the batch size of files to upload. It has to be less than 50. .PP By default this is 0 which means rclone will calculate the batch size depending on the setting of batch_mode. .IP \[bu] 2 batch_mode: async - default batch_size is 50 .IP \[bu] 2 batch_mode: sync - default batch_size is the same as --transfers .IP \[bu] 2 batch_mode: off - not in use .PP Rclone will close any outstanding batches when it exits which may make a delay on quit. .PP Setting this is a great idea if you are uploading lots of small files as it will make them a lot quicker. You can use --transfers 32 to maximise throughput. .PP Properties: .IP \[bu] 2 Config: batch_size .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_BATCH_SIZE .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 0 .SS --gphotos-batch-timeout .PP Max time to allow an idle upload batch before uploading. .PP If an upload batch is idle for more than this long then it will be uploaded. .PP The default for this is 0 which means rclone will choose a sensible default based on the batch_mode in use. .IP \[bu] 2 batch_mode: async - default batch_timeout is 10s .IP \[bu] 2 batch_mode: sync - default batch_timeout is 1s .IP \[bu] 2 batch_mode: off - not in use .PP Properties: .IP \[bu] 2 Config: batch_timeout .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_BATCH_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 0s .SS --gphotos-batch-commit-timeout .PP Max time to wait for a batch to finish committing .PP Properties: .IP \[bu] 2 Config: batch_commit_timeout .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_BATCH_COMMIT_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 10m0s .SS --gphotos-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_GPHOTOS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn\[aq]t understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item. .PP Note that all media items uploaded to Google Photos through the API are stored in full resolution at \[dq]original quality\[dq] and \f[B]will\f[R] count towards your storage quota in your Google Account. The API does \f[B]not\f[R] offer a way to upload in \[dq]high quality\[dq] mode.. .PP \f[C]rclone about\f[R] is not supported by the Google Photos backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP See List of backends that do not support rclone about (https://rclone.org/overview/#optional-features) See rclone about (https://rclone.org/commands/rclone_about/) .SS Downloading Images .PP When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115 (https://issuetracker.google.com/issues/112096115). .PP \f[B]The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on \[dq]Google Photos\[dq] as a backup of your photos. You will not be able to use rclone to redownload original images. You could use \[aq]google takeout\[aq] to recover the original photos as a last resort\f[R] .PP \f[B]NB\f[R] you \f[B]can\f[R] use the --gphotos-proxy flag to use a headless browser to download images in full resolution. .SS Downloading Videos .PP When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044 (https://issuetracker.google.com/issues/113672044). .PP \f[B]NB\f[R] you \f[B]can\f[R] use the --gphotos-proxy flag to use a headless browser to download images in full resolution. .SS Duplicates .PP If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called \f[C]file.jpg\f[R] would then appear as \f[C]file {123456}.jpg\f[R] and \f[C]file {ABCDEF}.jpg\f[R] (the actual IDs are a lot longer alas!). .PP If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to \f[C]upload\f[R] then uploaded the same image to \f[C]album/my_album\f[R] the filename of the image in \f[C]album/my_album\f[R] will be what it was uploaded with initially, not what you uploaded it with to \f[C]album\f[R]. In practise this shouldn\[aq]t cause too many problems. .SS Modification times .PP The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known. .PP This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes. .SS Size .PP The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check. .PP It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is \f[B]very slow\f[R] and uses up a lot of transactions. This can be enabled with the \f[C]--gphotos-read-size\f[R] option or the \f[C]read_size = true\f[R] config parameter. .PP If you want to use the backend with \f[C]rclone mount\f[R] you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You\[aq]ll need to experiment to see if it works for you without the flag. .SS Albums .PP Rclone can only upload files to albums it created. This is a limitation of the Google Photos API (https://developers.google.com/photos/library/guides/manage-albums). .PP Rclone can remove files it uploaded from albums it created only. .SS Deleting files .PP Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781 (https://issuetracker.google.com/issues/109759781). .PP Rclone cannot delete files anywhere except under \f[C]album\f[R]. .SS Deleting albums .PP The Google Photos API does not support deleting albums - see bug #135714733 (https://issuetracker.google.com/issues/135714733). .SH Hasher .PP Hasher is a special overlay backend to create remotes which handle checksums for other remotes. It\[aq]s main functions include: - Emulate hash types unimplemented by backends - Cache checksums to help with slow hashing of large local or (S)FTP files - Warm up checksum cache from external SUM files .SS Getting started .PP To use Hasher, first set up the underlying remote following the configuration instructions for that remote. You can also use a local pathname instead of a remote. Check that your base remote is working. .PP Let\[aq]s call the base remote \f[C]myRemote:path\f[R] here. Note that anything inside \f[C]myRemote:path\f[R] will be handled by hasher and anything outside won\[aq]t. This means that if you are using a bucket based remote (S3, B2, Swift) then you should put the bucket in the remote \f[C]s3:bucket\f[R]. .PP Now proceed to interactive or manual configuration. .SS Interactive configuration .PP Run \f[C]rclone config\f[R]: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> Hasher1 Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Handle checksums for other remotes \[rs] \[dq]hasher\[dq] [snip] Storage> hasher Remote to cache checksums for, like myremote:mypath. Enter a string value. Press Enter for the default (\[dq]\[dq]). remote> myRemote:path Comma separated list of supported checksum types. Enter a string value. Press Enter for the default (\[dq]md5,sha1\[dq]). hashsums> md5 Maximum time to keep checksums in cache. 0 = no cache, off = cache forever. max_age> off Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [Hasher1] type = hasher remote = myRemote:path hashsums = md5 max_age = off -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Manual configuration .PP Run \f[C]rclone config path\f[R] to see the path of current active config file, usually \f[C]YOURHOME/.config/rclone/rclone.conf\f[R]. Open it in your favorite text editor, find section for the base remote and create new section for hasher like in the following examples: .IP .nf \f[C] [Hasher1] type = hasher remote = myRemote:path hashes = md5 max_age = off [Hasher2] type = hasher remote = /local/path hashes = dropbox,sha1 max_age = 24h \f[R] .fi .PP Hasher takes basically the following parameters: - \f[C]remote\f[R] is required, - \f[C]hashes\f[R] is a comma separated list of supported checksums (by default \f[C]md5,sha1\f[R]), - \f[C]max_age\f[R] - maximum time to keep a checksum value in the cache, \f[C]0\f[R] will disable caching completely, \f[C]off\f[R] will cache \[dq]forever\[dq] (that is until the files get changed). .PP Make sure the \f[C]remote\f[R] has \f[C]:\f[R] (colon) in. If you specify the remote without a colon then rclone will use a local directory of that name. So if you use a remote of \f[C]/local/path\f[R] then rclone will handle hashes for that directory. If you use \f[C]remote = name\f[R] literally then rclone will put files \f[B]in a directory called \f[CB]name\f[B] located under current directory\f[R]. .SS Usage .SS Basic operations .PP Now you can use it as \f[C]Hasher2:subdir/file\f[R] instead of base remote. Hasher will transparently update cache with new checksums when a file is fully read or overwritten, like: .IP .nf \f[C] rclone copy External:path/file Hasher:dest/path rclone cat Hasher:path/to/file > /dev/null \f[R] .fi .PP The way to refresh \f[B]all\f[R] cached checksums (even unsupported by the base backend) for a subtree is to \f[B]re-download\f[R] all files in the subtree. For example, use \f[C]hashsum --download\f[R] using \f[B]any\f[R] supported hashsum on the command line (we just care to re-read): .IP .nf \f[C] rclone hashsum MD5 --download Hasher:path/to/subtree > /dev/null rclone backend dump Hasher:path/to/subtree \f[R] .fi .PP You can print or drop hashsum cache using custom backend commands: .IP .nf \f[C] rclone backend dump Hasher:dir/subdir rclone backend drop Hasher: \f[R] .fi .SS Pre-Seed from a SUM File .PP Hasher supports two backend commands: generic SUM file \f[C]import\f[R] and faster but less consistent \f[C]stickyimport\f[R]. .IP .nf \f[C] rclone backend import Hasher:dir/subdir SHA1 /path/to/SHA1SUM [--checkers 4] \f[R] .fi .PP Instead of SHA1 it can be any hash supported by the remote. The last argument can point to either a local or an \f[C]other-remote:path\f[R] text file in SUM format. The command will parse the SUM file, then walk down the path given by the first argument, snapshot current fingerprints and fill in the cache entries correspondingly. - Paths in the SUM file are treated as relative to \f[C]hasher:dir/subdir\f[R]. - The command will \f[B]not\f[R] check that supplied values are correct. You \f[B]must know\f[R] what you are doing. - This is a one-time action. The SUM file will not get \[dq]attached\[dq] to the remote. Cache entries can still be overwritten later, should the object\[aq]s fingerprint change. - The tree walk can take long depending on the tree size. You can increase \f[C]--checkers\f[R] to make it faster. Or use \f[C]stickyimport\f[R] if you don\[aq]t care about fingerprints and consistency. .IP .nf \f[C] rclone backend stickyimport hasher:path/to/data sha1 remote:/path/to/sum.sha1 \f[R] .fi .PP \f[C]stickyimport\f[R] is similar to \f[C]import\f[R] but works much faster because it does not need to stat existing files and skips initial tree walk. Instead of binding cache entries to file fingerprints it creates \f[I]sticky\f[R] entries bound to the file name alone ignoring size, modification time etc. Such hash entries can be replaced only by \f[C]purge\f[R], \f[C]delete\f[R], \f[C]backend drop\f[R] or by full re-read/re-write of the files. .SS Configuration reference .SS Standard options .PP Here are the Standard options specific to hasher (Better checksums for other remotes). .SS --hasher-remote .PP Remote to cache checksums for (e.g. myRemote:path). .PP Properties: .IP \[bu] 2 Config: remote .IP \[bu] 2 Env Var: RCLONE_HASHER_REMOTE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --hasher-hashes .PP Comma separated list of supported checksum types. .PP Properties: .IP \[bu] 2 Config: hashes .IP \[bu] 2 Env Var: RCLONE_HASHER_HASHES .IP \[bu] 2 Type: CommaSepList .IP \[bu] 2 Default: md5,sha1 .SS --hasher-max-age .PP Maximum time to keep checksums in cache (0 = no cache, off = cache forever). .PP Properties: .IP \[bu] 2 Config: max_age .IP \[bu] 2 Env Var: RCLONE_HASHER_MAX_AGE .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: off .SS Advanced options .PP Here are the Advanced options specific to hasher (Better checksums for other remotes). .SS --hasher-auto-size .PP Auto-update checksum for files smaller than this size (disabled by default). .PP Properties: .IP \[bu] 2 Config: auto_size .IP \[bu] 2 Env Var: RCLONE_HASHER_AUTO_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 0 .SS --hasher-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_HASHER_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Any metadata supported by the underlying remote is read and written. .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Backend commands .PP Here are the commands specific to the hasher backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS drop .PP Drop cache .IP .nf \f[C] rclone backend drop remote: [options] [<arguments>+] \f[R] .fi .PP Completely drop checksum cache. Usage Example: rclone backend drop hasher: .SS dump .PP Dump the database .IP .nf \f[C] rclone backend dump remote: [options] [<arguments>+] \f[R] .fi .PP Dump cache records covered by the current remote .SS fulldump .PP Full dump of the database .IP .nf \f[C] rclone backend fulldump remote: [options] [<arguments>+] \f[R] .fi .PP Dump all cache records in the database .SS import .PP Import a SUM file .IP .nf \f[C] rclone backend import remote: [options] [<arguments>+] \f[R] .fi .PP Amend hash cache from a SUM file and bind checksums to files by size/time. Usage Example: rclone backend import hasher:subdir md5 /path/to/sum.md5 .SS stickyimport .PP Perform fast import of a SUM file .IP .nf \f[C] rclone backend stickyimport remote: [options] [<arguments>+] \f[R] .fi .PP Fill hash cache from a SUM file without verifying file fingerprints. Usage Example: rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5 .SS Implementation details (advanced) .PP This section explains how various rclone operations work on a hasher remote. .PP \f[B]Disclaimer. This section describes current implementation which can change in future rclone versions!.\f[R] .SS Hashsum command .PP The \f[C]rclone hashsum\f[R] (or \f[C]md5sum\f[R] or \f[C]sha1sum\f[R]) command will: .IP "1." 3 if requested hash is supported by lower level, just pass it. .IP "2." 3 if object size is below \f[C]auto_size\f[R] then download object and calculate \f[I]requested\f[R] hashes on the fly. .IP "3." 3 if unsupported and the size is big enough, build object \f[C]fingerprint\f[R] (including size, modtime if supported, first-found \f[I]other\f[R] hash if any). .IP "4." 3 if the strict match is found in cache for the requested remote, return the stored hash. .IP "5." 3 if remote found but fingerprint mismatched, then purge the entry and proceed to step 6. .IP "6." 3 if remote not found or had no requested hash type or after step 5: download object, calculate all \f[I]supported\f[R] hashes on the fly and store in cache; return requested hash. .SS Other operations .IP \[bu] 2 any time a hash is requested, follow the logic from 1-4 from \f[C]hashsum\f[R] above .IP \[bu] 2 whenever a file is uploaded or downloaded \f[B]in full\f[R], capture the stream to calculate all supported hashes on the fly and update database .IP \[bu] 2 server-side \f[C]move\f[R] will update keys of existing cache entries .IP \[bu] 2 \f[C]deletefile\f[R] will remove a single cache entry .IP \[bu] 2 \f[C]purge\f[R] will remove all cache entries under the purged path .PP Note that setting \f[C]max_age = 0\f[R] will disable checksum caching completely. .PP If you set \f[C]max_age = off\f[R], checksums in cache will never age, unless you fully rewrite or delete the file. .SS Cache storage .PP Cached checksums are stored as \f[C]bolt\f[R] database files under rclone cache directory, usually \f[C]\[ti]/.cache/rclone/kv/\f[R]. Databases are maintained one per \f[I]base\f[R] backend, named like \f[C]BaseRemote\[ti]hasher.bolt\f[R]. Checksums for multiple \f[C]alias\f[R]-es into a single base backend will be stored in the single database. All local paths are treated as aliases into the \f[C]local\f[R] backend (unless encrypted or chunked) and stored in \f[C]\[ti]/.cache/rclone/kv/local\[ti]hasher.bolt\f[R]. Databases can be shared between multiple rclone processes. .SH HDFS .PP HDFS (https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html) is a distributed file-system, part of the Apache Hadoop (https://hadoop.apache.org/) framework. .PP Paths are specified as \f[C]remote:\f[R] or \f[C]remote:path/to/dir\f[R]. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [skip] XX / Hadoop distributed file system \[rs] \[dq]hdfs\[dq] [skip] Storage> hdfs ** See help for hdfs backend at: https://rclone.org/hdfs/ ** hadoop name node and port Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Connect to host namenode at port 8020 \[rs] \[dq]namenode:8020\[dq] namenode> namenode.hadoop:8020 hadoop user name Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / Connect to hdfs as root \[rs] \[dq]root\[dq] username> root Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config Configuration complete. Options: - type: hdfs - namenode: namenode.hadoop:8020 - username: root Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== hadoop hdfs 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 \f[R] .fi .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all the top level directories .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List the contents of a directory .IP .nf \f[C] rclone ls remote:directory \f[R] .fi .PP Sync the remote \f[C]directory\f[R] to \f[C]/home/local/directory\f[R], deleting any excess files. .IP .nf \f[C] rclone sync --interactive remote:directory /home/local/directory \f[R] .fi .SS Setting up your own HDFS instance for testing .PP You may start with a manual setup (https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) or use the docker image from the tests: .PP If you want to build the docker image .IP .nf \f[C] git clone https://github.com/rclone/rclone.git cd rclone/fstest/testserver/images/test-hdfs docker build --rm -t rclone/test-hdfs . \f[R] .fi .PP Or you can just use the latest one pushed .IP .nf \f[C] docker run --rm --name \[dq]rclone-hdfs\[dq] -p 127.0.0.1:9866:9866 -p 127.0.0.1:8020:8020 --hostname \[dq]rclone-hdfs\[dq] rclone/test-hdfs \f[R] .fi .PP \f[B]NB\f[R] it need few seconds to startup. .PP For this docker image the remote needs to be configured like this: .IP .nf \f[C] [remote] type = hdfs namenode = 127.0.0.1:8020 username = root \f[R] .fi .PP You can stop this image with \f[C]docker kill rclone-hdfs\f[R] (\f[B]NB\f[R] it does not use volumes, so all data uploaded will be lost.) .SS Modification times .PP Time accurate to 1 second is stored. .SS Checksum .PP No checksums are implemented. .SS Usage information .PP You can use the \f[C]rclone about remote:\f[R] command which will display filesystem size and current usage. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8). .SS Standard options .PP Here are the Standard options specific to hdfs (Hadoop distributed file system). .SS --hdfs-namenode .PP Hadoop name nodes and ports. .PP E.g. \[dq]namenode-1:8020,namenode-2:8020,...\[dq] to connect to host namenodes at port 8020. .PP Properties: .IP \[bu] 2 Config: namenode .IP \[bu] 2 Env Var: RCLONE_HDFS_NAMENODE .IP \[bu] 2 Type: CommaSepList .IP \[bu] 2 Default: .SS --hdfs-username .PP Hadoop user name. .PP Properties: .IP \[bu] 2 Config: username .IP \[bu] 2 Env Var: RCLONE_HDFS_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]root\[dq] .RS 2 .IP \[bu] 2 Connect to hdfs as root. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to hdfs (Hadoop distributed file system). .SS --hdfs-service-principal-name .PP Kerberos service principal name for the namenode. .PP Enables KERBEROS authentication. Specifies the Service Principal Name (SERVICE/FQDN) for the namenode. E.g. \[dq]hdfs/namenode.hadoop.docker\[dq] for namenode running as service \[aq]hdfs\[aq] with FQDN \[aq]namenode.hadoop.docker\[aq]. .PP Properties: .IP \[bu] 2 Config: service_principal_name .IP \[bu] 2 Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hdfs-data-transfer-protection .PP Kerberos data transfer protection: authentication|integrity|privacy. .PP Specifies whether or not authentication, data signature integrity checks, and wire encryption are required when communicating with the datanodes. Possible values are \[aq]authentication\[aq], \[aq]integrity\[aq] and \[aq]privacy\[aq]. Used only with KERBEROS enabled. .PP Properties: .IP \[bu] 2 Config: data_transfer_protection .IP \[bu] 2 Env Var: RCLONE_HDFS_DATA_TRANSFER_PROTECTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]privacy\[dq] .RS 2 .IP \[bu] 2 Ensure authentication, integrity and encryption enabled. .RE .RE .SS --hdfs-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_HDFS_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot .SS --hdfs-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_HDFS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .IP \[bu] 2 No server-side \f[C]Move\f[R] or \f[C]DirMove\f[R]. .IP \[bu] 2 Checksums not implemented. .SH HiDrive .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for hidrive involves getting a token from HiDrive which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / HiDrive \[rs] \[dq]hidrive\[dq] [snip] Storage> hidrive OAuth Client Id - Leave blank normally. client_id> OAuth Client Secret - Leave blank normally. client_secret> Access permissions that rclone should use when requesting access from HiDrive. Leave blank normally. scope_access> Edit advanced config? y/n> n 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/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx Log in and authorize rclone for access Waiting for code... Got code Configuration complete. Options: - type: hidrive - token: {\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq]} Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP \f[B]You should be aware that OAuth-tokens can be used to access your account and hence should not be shared with other persons.\f[R] See the below section for more information. .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from HiDrive. This only runs from the moment it opens your browser to the moment you get back the verification code. The webserver runs on \f[C]http://127.0.0.1:53682/\f[R]. If local port \f[C]53682\f[R] is protected by a firewall you may need to temporarily unblock the firewall to complete authorization. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your HiDrive root folder .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your HiDrive filesystem .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to a HiDrive directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Keeping your tokens safe .PP Any OAuth-tokens will be stored by rclone in the remote\[aq]s configuration file as unencrypted text. Anyone can use a valid refresh-token to access your HiDrive filesystem without knowing your password. Therefore you should make sure no one else can access your configuration. .PP It is possible to encrypt rclone\[aq]s configuration file. You can find information on securing your configuration file by viewing the configuration encryption docs (https://rclone.org/docs/#configuration-encryption). .SS Invalid refresh token .PP As can be verified here (https://developer.hidrive.com/basics-flows/), each \f[C]refresh_token\f[R] (for Native Applications) is valid for 60 days. If used to access HiDrivei, its validity will be automatically extended. .PP This means that if you .IP \[bu] 2 Don\[aq]t use the HiDrive remote for 60 days .PP then rclone will return an error which includes a text that implies the refresh token is \f[I]invalid\f[R] or \f[I]expired\f[R]. .PP To fix this you will need to authorize rclone to access your HiDrive account again. .PP Using .IP .nf \f[C] rclone config reconnect remote: \f[R] .fi .PP the process is very similar to the process of initial setup exemplified before. .SS Modification times and hashes .PP HiDrive allows modification times to be set on objects accurate to 1 second. .PP HiDrive supports its own hash type (https://static.hidrive.com/dev/0001) which is used to verify the integrity of file contents after successful transfers. .SS Restricted filename characters .PP HiDrive cannot store files or folders that include \f[C]/\f[R] (0x2F) or null-bytes (0x00) in their name. Any other characters can be used in the names of files or folders. Additionally, files or folders cannot be named either of the following: \f[C].\f[R] or \f[C]..\f[R] .PP Therefore rclone will automatically replace these characters, if files or folders are stored or accessed with such names. .PP You can read about how this filename encoding works in general here. .PP Keep in mind that HiDrive only supports file or folder names with a length of 255 characters or less. .SS Transfers .PP HiDrive limits file sizes per single request to a maximum of 2 GiB. To allow storage of larger files and allow for better upload performance, the hidrive backend will use a chunked transfer for files larger than 96 MiB. Rclone will upload multiple parts/chunks of the file at the same time. Chunks in the process of being uploaded are buffered in memory, so you may want to restrict this behaviour on systems with limited resources. .PP You can customize this behaviour using the following options: .IP \[bu] 2 \f[C]chunk_size\f[R]: size of file parts .IP \[bu] 2 \f[C]upload_cutoff\f[R]: files larger or equal to this in size will use a chunked transfer .IP \[bu] 2 \f[C]upload_concurrency\f[R]: number of file-parts to upload at the same time .PP See the below section about configuration options for more details. .SS Root folder .PP You can set the root folder for rclone. This is the directory that rclone considers to be the root of your HiDrive. .PP Usually, you will leave this blank, and rclone will use the root of the account. .PP However, you can set this to restrict rclone to a specific folder hierarchy. .PP This works by prepending the contents of the \f[C]root_prefix\f[R] option to any paths accessed by rclone. For example, the following two ways to access the home directory are equivalent: .IP .nf \f[C] rclone lsd --hidrive-root-prefix=\[dq]/users/test/\[dq] remote:path rclone lsd remote:/users/test/path \f[R] .fi .PP See the below section about configuration options for more details. .SS Directory member count .PP By default, rclone will know the number of directory members contained in a directory. For example, \f[C]rclone lsd\f[R] uses this information. .PP The acquisition of this information will result in additional time costs for HiDrive\[aq]s API. When dealing with large directory structures, it may be desirable to circumvent this time cost, especially when this information is not explicitly needed. For this, the \f[C]disable_fetching_member_count\f[R] option can be used. .PP See the below section about configuration options for more details. .SS Standard options .PP Here are the Standard options specific to hidrive (HiDrive). .SS --hidrive-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hidrive-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hidrive-scope-access .PP Access permissions that rclone should use when requesting access from HiDrive. .PP Properties: .IP \[bu] 2 Config: scope_access .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_SCOPE_ACCESS .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]rw\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]rw\[dq] .RS 2 .IP \[bu] 2 Read and write access to resources. .RE .IP \[bu] 2 \[dq]ro\[dq] .RS 2 .IP \[bu] 2 Read-only access to resources. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to hidrive (HiDrive). .SS --hidrive-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hidrive-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hidrive-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --hidrive-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --hidrive-scope-role .PP User-level that rclone should use when requesting access from HiDrive. .PP Properties: .IP \[bu] 2 Config: scope_role .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_SCOPE_ROLE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]user\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]user\[dq] .RS 2 .IP \[bu] 2 User-level access to management permissions. .IP \[bu] 2 This will be sufficient in most cases. .RE .IP \[bu] 2 \[dq]admin\[dq] .RS 2 .IP \[bu] 2 Extensive access to management permissions. .RE .IP \[bu] 2 \[dq]owner\[dq] .RS 2 .IP \[bu] 2 Full access to management permissions. .RE .RE .SS --hidrive-root-prefix .PP The root/parent folder for all paths. .PP Fill in to use the specified folder as the parent for all paths given to the remote. This way rclone can use any folder as its starting point. .PP Properties: .IP \[bu] 2 Config: root_prefix .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_ROOT_PREFIX .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]/\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]/\[dq] .RS 2 .IP \[bu] 2 The topmost directory accessible by rclone. .IP \[bu] 2 This will be equivalent with \[dq]root\[dq] if rclone uses a regular HiDrive user account. .RE .IP \[bu] 2 \[dq]root\[dq] .RS 2 .IP \[bu] 2 The topmost directory of the HiDrive user account .RE .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 This specifies that there is no root-prefix for your paths. .IP \[bu] 2 When using this you will always need to specify paths to this remote with a valid parent e.g. \[dq]remote:/path/to/dir\[dq] or \[dq]remote:root/path/to/dir\[dq]. .RE .RE .SS --hidrive-endpoint .PP Endpoint for the service. .PP This is the URL that API-calls will be made to. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]https://api.hidrive.strato.com/2.1\[dq] .SS --hidrive-disable-fetching-member-count .PP Do not fetch number of objects in directories unless it is absolutely necessary. .PP Requests may be faster if the number of objects in subdirectories is not fetched. .PP Properties: .IP \[bu] 2 Config: disable_fetching_member_count .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_DISABLE_FETCHING_MEMBER_COUNT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --hidrive-chunk-size .PP Chunksize for chunked uploads. .PP Any files larger than the configured cutoff (or files of unknown size) will be uploaded in chunks of this size. .PP The upper limit for this is 2147483647 bytes (about 2.000Gi). That is the maximum amount of bytes a single upload-operation will support. Setting this above the upper limit or to a negative value will cause uploads to fail. .PP Setting this to larger values may increase the upload speed at the cost of using more memory. It can be set to smaller values smaller to save on memory. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 48Mi .SS --hidrive-upload-cutoff .PP Cutoff/Threshold for chunked uploads. .PP Any files larger than this will be uploaded in chunks of the configured chunksize. .PP The upper limit for this is 2147483647 bytes (about 2.000Gi). That is the maximum amount of bytes a single upload-operation will support. Setting this above the upper limit will cause uploads to fail. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 96Mi .SS --hidrive-upload-concurrency .PP Concurrency for chunked uploads. .PP This is the upper limit for how many transfers for the same file are running concurrently. Setting this above to a value smaller than 1 will cause uploads to deadlock. .PP 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. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 4 .SS --hidrive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,Dot .SS --hidrive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_HIDRIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .SS Symbolic links .PP HiDrive is able to store symbolic links (\f[I]symlinks\f[R]) by design, for example, when unpacked from a zip archive. .PP There exists no direct mechanism to manage native symlinks in remotes. As such this implementation has chosen to ignore any native symlinks present in the remote. rclone will not be able to access or show any symlinks stored in the hidrive-remote. This means symlinks cannot be individually removed, copied, or moved, except when removing, copying, or moving the parent folder. .PP \f[I]This does not affect the \f[CI].rclonelink\f[I]-files that rclone uses to encode and store symbolic links.\f[R] .SS Sparse files .PP It is possible to store sparse files in HiDrive. .PP Note that copying a sparse file will expand the holes into null-byte (0x00) regions that will then consume disk space. Likewise, when downloading a sparse file, the resulting file will have null-byte regions in the place of file holes. .SH HTTP .PP The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and turn into a remote. This has been tested with common webservers such as Apache/Nginx/Caddy and will likely work with file listings from most web servers. (If it doesn\[aq]t then please file an issue, or send a pull request!) .PP Paths are specified as \f[C]remote:\f[R] or \f[C]remote:path\f[R]. .PP The \f[C]remote:\f[R] represents the configured url, and any path following it will be resolved relative to this url, according to the URL standard. This means with remote url \f[C]https://beta.rclone.org/branch\f[R] and path \f[C]fix\f[R], the resolved URL will be \f[C]https://beta.rclone.org/branch/fix\f[R], while with path \f[C]/fix\f[R] the resolved URL will be \f[C]https://beta.rclone.org/fix\f[R] as the absolute path is resolved from the root of the domain. .PP If the path following the \f[C]remote:\f[R] ends with \f[C]/\f[R] it will be assumed to point to a directory. If the path does not end with \f[C]/\f[R], then a HEAD request is sent and the response used to decide if it it is treated as a file or a directory (run with \f[C]-vv\f[R] to see details). When --http-no-head is specified, a path without ending \f[C]/\f[R] is always assumed to be a file. If rclone incorrectly assumes the path is a file, the solution is to specify the path with ending \f[C]/\f[R]. When you know the path is a directory, ending it with \f[C]/\f[R] is always better as it avoids the initial HEAD request. .PP To just download a single file it is easier to use copyurl (https://rclone.org/commands/rclone_copyurl/). .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / HTTP \[rs] \[dq]http\[dq] [snip] Storage> http URL of http host to connect to Choose a number from below, or type in your own value 1 / Connect to example.com \[rs] \[dq]https://example.com\[dq] url> https://beta.rclone.org Remote config Configuration complete. Options: - type: http - url: https://beta.rclone.org Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes: Name Type ==== ==== remote http 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 \f[R] .fi .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all the top level directories .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List the contents of a directory .IP .nf \f[C] rclone ls remote:directory \f[R] .fi .PP Sync the remote \f[C]directory\f[R] to \f[C]/home/local/directory\f[R], deleting any excess files. .IP .nf \f[C] rclone sync --interactive remote:directory /home/local/directory \f[R] .fi .SS Read only .PP This remote is read only - you can\[aq]t upload files to an HTTP server. .SS Modification times .PP Most HTTP servers store time accurate to 1 second. .SS Checksum .PP No checksums are stored. .SS Usage without a config file .PP Since the http remote only has one config parameter it is easy to use without a config file: .IP .nf \f[C] rclone lsd --http-url https://beta.rclone.org :http: \f[R] .fi .PP or: .IP .nf \f[C] rclone lsd :http,url=\[aq]https://beta.rclone.org\[aq]: \f[R] .fi .SS Standard options .PP Here are the Standard options specific to http (HTTP). .SS --http-url .PP URL of HTTP host to connect to. .PP E.g. \[dq]https://example.com\[dq], or \[dq]https://user:pass\[at]example.com\[dq] to use a username and password. .PP Properties: .IP \[bu] 2 Config: url .IP \[bu] 2 Env Var: RCLONE_HTTP_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --http-no-escape .PP Do not escape URL metacharacters in path names. .PP Properties: .IP \[bu] 2 Config: no_escape .IP \[bu] 2 Env Var: RCLONE_HTTP_NO_ESCAPE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS Advanced options .PP Here are the Advanced options specific to http (HTTP). .SS --http-headers .PP Set HTTP headers for all transactions. .PP Use this to set additional HTTP headers for all transactions. .PP The input format is comma separated list of key,value pairs. Standard CSV encoding (https://godoc.org/encoding/csv) may be used. .PP For example, to set a Cookie use \[aq]Cookie,name=value\[aq], or \[aq]\[dq]Cookie\[dq],\[dq]name=value\[dq]\[aq]. .PP You can set multiple headers, e.g. \[aq]\[dq]Cookie\[dq],\[dq]name=value\[dq],\[dq]Authorization\[dq],\[dq]xxx\[dq]\[aq]. .PP Properties: .IP \[bu] 2 Config: headers .IP \[bu] 2 Env Var: RCLONE_HTTP_HEADERS .IP \[bu] 2 Type: CommaSepList .IP \[bu] 2 Default: .SS --http-no-slash .PP Set this if the site doesn\[aq]t end directories with /. .PP Use this if your target website does not use / on the end of directories. .PP A / on the end of a path is how rclone normally tells the difference between files and directories. If this flag is set, then rclone will treat all files with Content-Type: text/html as directories and read URLs from them rather than downloading them. .PP Note that this may cause rclone to confuse genuine HTML files with directories. .PP Properties: .IP \[bu] 2 Config: no_slash .IP \[bu] 2 Env Var: RCLONE_HTTP_NO_SLASH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --http-no-head .PP Don\[aq]t use HEAD requests. .PP HEAD requests are mainly used to find file sizes in dir listing. If your site is being very slow to load then you can try this option. Normally rclone does a HEAD request for each potential file in a directory listing to: .IP \[bu] 2 find its size .IP \[bu] 2 check it really exists .IP \[bu] 2 check to see if it is a directory .PP If you set this option, rclone will not do the HEAD request. This will mean that directory listings are much quicker, but rclone won\[aq]t have the times or sizes of any files, and some files that don\[aq]t exist may be in the listing. .PP Properties: .IP \[bu] 2 Config: no_head .IP \[bu] 2 Env Var: RCLONE_HTTP_NO_HEAD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --http-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_HTTP_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Backend commands .PP Here are the commands specific to the http backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS set .PP Set command for updating the config parameters. .IP .nf \f[C] rclone backend set remote: [options] [<arguments>+] \f[R] .fi .PP This set command can be used to update the config parameters for a running http backend. .PP Usage Examples: .IP .nf \f[C] rclone backend set remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2] rclone rc backend/command command=set fs=remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2] rclone rc backend/command command=set fs=remote: -o url=https://example.com \f[R] .fi .PP The option keys are named as they are in the config file. .PP This rebuilds the connection to the http 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. .PP It doesn\[aq]t return anything. .SS Limitations .PP \f[C]rclone about\f[R] is not supported by the HTTP backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH ImageKit .PP This is a backend for the ImageKit.io (https://imagekit.io/) storage service. .SS About ImageKit .PP ImageKit.io (https://imagekit.io/) provides real-time image and video optimizations, transformations, and CDN delivery. Over 1,000 businesses and 70,000 developers trust ImageKit with their images and videos on the web. .SS Accounts & Pricing .PP To use this backend, you need to create an account (https://imagekit.io/registration/) on ImageKit. Start with a free plan with generous usage limits. Then, as your requirements grow, upgrade to a plan that best fits your needs. See the pricing details (https://imagekit.io/plans). .SS Configuration .PP Here is an example of making an imagekit configuration. .PP Firstly create a ImageKit.io (https://imagekit.io/) account and choose a plan. .PP You will need to log in and get the \f[C]publicKey\f[R] and \f[C]privateKey\f[R] for your account from the developer section. .PP Now run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n Enter the name for the new remote. name> imagekit-media-library Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / ImageKit.io \[rs] (imagekit) [snip] Storage> imagekit Option endpoint. You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) Enter a value. endpoint> https://ik.imagekit.io/imagekit_id Option public_key. You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) Enter a value. public_key> public_**************************** Option private_key. You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) Enter a value. private_key> private_**************************** Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: imagekit - endpoint: https://ik.imagekit.io/imagekit_id - public_key: public_**************************** - private_key: private_**************************** Keep this \[dq]imagekit-media-library\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP List directories in the top level of your Media Library .IP .nf \f[C] rclone lsd imagekit-media-library: \f[R] .fi .PP Make a new directory. .IP .nf \f[C] rclone mkdir imagekit-media-library:directory \f[R] .fi .PP List the contents of a directory. .IP .nf \f[C] rclone ls imagekit-media-library:directory \f[R] .fi .SS Modified time and hashes .PP ImageKit does not support modification times or hashes yet. .SS Checksums .PP No checksums are supported. .SS Standard options .PP Here are the Standard options specific to imagekit (ImageKit.io). .SS --imagekit-endpoint .PP You can find your ImageKit.io URL endpoint in your dashboard (https://imagekit.io/dashboard/developer/api-keys) .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --imagekit-public-key .PP You can find your ImageKit.io public key in your dashboard (https://imagekit.io/dashboard/developer/api-keys) .PP Properties: .IP \[bu] 2 Config: public_key .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_PUBLIC_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --imagekit-private-key .PP You can find your ImageKit.io private key in your dashboard (https://imagekit.io/dashboard/developer/api-keys) .PP Properties: .IP \[bu] 2 Config: private_key .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_PRIVATE_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to imagekit (ImageKit.io). .SS --imagekit-only-signed .PP If you have configured \f[C]Restrict unsigned image URLs\f[R] in your dashboard settings, set this to true. .PP Properties: .IP \[bu] 2 Config: only_signed .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_ONLY_SIGNED .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --imagekit-versions .PP Include old versions in directory listings. .PP Properties: .IP \[bu] 2 Config: versions .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_VERSIONS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --imagekit-upload-tags .PP Tags to add to the uploaded files, e.g. \[dq]tag1,tag2\[dq]. .PP Properties: .IP \[bu] 2 Config: upload_tags .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_UPLOAD_TAGS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --imagekit-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket .SS --imagekit-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_IMAGEKIT_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Any metadata supported by the underlying remote is read and written. .PP Here are the possible system metadata items for the imagekit backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ aws-tags T}@T{ AI generated tags by AWS Rekognition associated with the image T}@T{ string T}@T{ tag1,tag2 T}@T{ \f[B]Y\f[R] T} T{ btime T}@T{ Time of file birth (creation) read from Last-Modified header T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ \f[B]Y\f[R] T} T{ custom-coordinates T}@T{ Custom coordinates of the file T}@T{ string T}@T{ 0,0,100,100 T}@T{ \f[B]Y\f[R] T} T{ file-type T}@T{ Type of the file T}@T{ string T}@T{ image T}@T{ \f[B]Y\f[R] T} T{ google-tags T}@T{ AI generated tags by Google Cloud Vision associated with the image T}@T{ string T}@T{ tag1,tag2 T}@T{ \f[B]Y\f[R] T} T{ has-alpha T}@T{ Whether the image has alpha channel or not T}@T{ bool T}@T{ T}@T{ \f[B]Y\f[R] T} T{ height T}@T{ Height of the image or video in pixels T}@T{ int T}@T{ T}@T{ \f[B]Y\f[R] T} T{ is-private-file T}@T{ Whether the file is private or not T}@T{ bool T}@T{ T}@T{ \f[B]Y\f[R] T} T{ size T}@T{ Size of the object in bytes T}@T{ int64 T}@T{ T}@T{ \f[B]Y\f[R] T} T{ tags T}@T{ Tags associated with the file T}@T{ string T}@T{ tag1,tag2 T}@T{ \f[B]Y\f[R] T} T{ width T}@T{ Width of the image or video in pixels T}@T{ int T}@T{ T}@T{ \f[B]Y\f[R] T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SH iCloud Drive .SS Configuration .PP The initial setup for an iCloud Drive backend involves getting a trust token/session. This can be done by simply using the regular iCloud password, and accepting the code prompt on another iCloud connected device. .PP \f[B]IMPORTANT\f[R]: At the moment an app specific password won\[aq]t be accepted. Only use your regular password and 2FA. .PP \f[C]rclone config\f[R] walks you through the token creation. The trust token is valid for 30 days. After which you will have to reauthenticate with \f[C]rclone reconnect\f[R] or \f[C]rclone config\f[R]. .PP Here is an example of how to make a remote called \f[C]iclouddrive\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> iclouddrive Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / iCloud Drive \[rs] (iclouddrive) [snip] Storage> iclouddrive Option apple_id. Apple ID. Enter a value. apple_id> APPLEID Option password. Password. Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n Option config_2fa. Two-factor authentication: please enter your 2FA code Enter a value. config_2fa> 2FACODE Remote config -------------------- [iclouddrive] - type: iclouddrive - apple_id: APPLEID - password: *** ENCRYPTED *** - cookies: **************************** - trust_token: **************************** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Advanced Data Protection .PP ADP is currently unsupported and need to be disabled .PP On iPhone, Settings \f[C]>\f[R] Apple Account \f[C]>\f[R] iCloud \f[C]>\f[R] \[aq]Access iCloud Data on the Web\[aq] must be ON, and \[aq]Advanced Data Protection\[aq] OFF. .SS Troubleshooting .SS Missing PCS cookies from the request .PP This means you have Advanced Data Protection (ADP) turned on. This is not supported at the moment. If you want to use rclone you will have to turn it off. See above for how to turn it off. .PP You will need to clear the \f[C]cookies\f[R] and the \f[C]trust_token\f[R] fields in the config. Or you can delete the remote config and start again. .PP You should then run \f[C]rclone reconnect remote:\f[R]. .PP Note that changing the ADP setting may not take effect immediately - you may need to wait a few hours or a day before you can get rclone to work - keep clearing the config entry and running \f[C]rclone reconnect remote:\f[R] until rclone functions properly. .SS Standard options .PP Here are the Standard options specific to iclouddrive (iCloud Drive). .SS --iclouddrive-apple-id .PP Apple ID. .PP Properties: .IP \[bu] 2 Config: apple_id .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_APPLE_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --iclouddrive-password .PP Password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --iclouddrive-trust-token .PP Trust token (internal use) .PP Properties: .IP \[bu] 2 Config: trust_token .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_TRUST_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --iclouddrive-cookies .PP cookies (internal use only) .PP Properties: .IP \[bu] 2 Config: cookies .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_COOKIES .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to iclouddrive (iCloud Drive). .SS --iclouddrive-client-id .PP Client id .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d\[dq] .SS --iclouddrive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS --iclouddrive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_ICLOUDDRIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Internet Archive .PP The Internet Archive backend utilizes Items on archive.org (https://archive.org/) .PP Refer to IAS3 API documentation (https://archive.org/services/docs/api/ias3.html) for the API this backend uses. .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:item/path/to/dir\f[R]. .PP Unlike S3, listing up all items uploaded by you isn\[aq]t supported. .PP Once you have made a remote, you can use it like this: .PP Make a new item .IP .nf \f[C] rclone mkdir remote:item \f[R] .fi .PP List the contents of a item .IP .nf \f[C] rclone ls remote:item \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote item, deleting any excess files in the item. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:item \f[R] .fi .SS Notes .PP Because of Internet Archive\[aq]s architecture, it enqueues write operations (and extra post-processings) in a per-item queue. You can check item\[aq]s queue at https://catalogd.archive.org/history/item-name-here . Because of that, all uploads/deletes will not show up immediately and takes some time to be available. The per-item queue is enqueued to an another queue, Item Deriver Queue. You can check the status of Item Deriver Queue here. (https://catalogd.archive.org/catalog.php?whereami=1) This queue has a limit, and it may block you from uploading, or even deleting. You should avoid uploading a lot of small files for better behavior. .PP You can optionally wait for the server\[aq]s processing to finish, by setting non-zero value to \f[C]wait_archive\f[R] key. By making it wait, rclone can do normal file comparison. Make sure to set a large enough value (e.g. \f[C]30m0s\f[R] for smaller files) as it can take a long time depending on server\[aq]s queue. .SS About metadata .PP This backend supports setting, updating and reading metadata of each file. The metadata will appear as file metadata on Internet Archive. However, some fields are reserved by both Internet Archive and rclone. .PP The following are reserved by Internet Archive: - \f[C]name\f[R] - \f[C]source\f[R] - \f[C]size\f[R] - \f[C]md5\f[R] - \f[C]crc32\f[R] - \f[C]sha1\f[R] - \f[C]format\f[R] - \f[C]old_version\f[R] - \f[C]viruscheck\f[R] - \f[C]summation\f[R] .PP Trying to set values to these keys is ignored with a warning. Only setting \f[C]mtime\f[R] is an exception. Doing so make it the identical behavior as setting ModTime. .PP rclone reserves all the keys starting with \f[C]rclone-\f[R]. Setting value for these keys will give you warnings, but values are set according to request. .PP If there are multiple values for a key, only the first one is returned. This is a limitation of rclone, that supports one value per one key. It can be triggered when you did a server-side copy. .PP Reading metadata will also provide custom (non-standard nor reserved) ones. .SS Filtering auto generated files .PP The Internet Archive automatically creates metadata files after upload. These can cause problems when doing an \f[C]rclone sync\f[R] as rclone will try, and fail, to delete them. These metadata files are not changeable, as they are created by the Internet Archive automatically. .PP These auto-created files can be excluded from the sync using metadata filtering (https://rclone.org/filtering/#metadata). .IP .nf \f[C] rclone sync ... --metadata-exclude \[dq]source=metadata\[dq] --metadata-exclude \[dq]format=Metadata\[dq] \f[R] .fi .PP Which excludes from the sync any files which have the \f[C]source=metadata\f[R] or \f[C]format=Metadata\f[R] flags which are added to Internet Archive auto-created files. .SS Configuration .PP Here is an example of making an internetarchive configuration. Most applies to the other providers as well, any differences are described below. .PP First run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. XX / InternetArchive Items \[rs] (internetarchive) Storage> internetarchive Option access_key_id. IAS3 Access Key. Leave blank for anonymous access. You can find one here: https://archive.org/account/s3.php Enter a value. Press Enter to leave empty. access_key_id> XXXX Option secret_access_key. IAS3 Secret Key (password). Leave blank for anonymous access. Enter a value. Press Enter to leave empty. secret_access_key> XXXX Edit advanced config? y) Yes n) No (default) y/n> y Option endpoint. IAS3 Endpoint. Leave blank for default value. Enter a string value. Press Enter for the default (https://s3.us.archive.org). endpoint> Option front_endpoint. Host of InternetArchive Frontend. Leave blank for default value. Enter a string value. Press Enter for the default (https://archive.org). front_endpoint> Option disable_checksum. Don\[aq]t store MD5 checksum with object metadata. Normally rclone will calculate the MD5 checksum of the input before uploading it so it can ask the server to check the object against checksum. This is great for data integrity checking but can cause long delays for large files to start uploading. Enter a boolean value (true or false). Press Enter for the default (true). disable_checksum> true Option encoding. The encoding for the backend. See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. Enter a encoder.MultiEncoder value. Press Enter for the default (Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot). encoding> Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: internetarchive - access_key_id: XXXX - secret_access_key: XXXX Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Standard options .PP Here are the Standard options specific to internetarchive (Internet Archive). .SS --internetarchive-access-key-id .PP IAS3 Access Key. .PP Leave blank for anonymous access. You can find one here: https://archive.org/account/s3.php .PP Properties: .IP \[bu] 2 Config: access_key_id .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_ACCESS_KEY_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --internetarchive-secret-access-key .PP IAS3 Secret Key (password). .PP Leave blank for anonymous access. .PP Properties: .IP \[bu] 2 Config: secret_access_key .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_SECRET_ACCESS_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to internetarchive (Internet Archive). .SS --internetarchive-endpoint .PP IAS3 Endpoint. .PP Leave blank for default value. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]https://s3.us.archive.org\[dq] .SS --internetarchive-front-endpoint .PP Host of InternetArchive Frontend. .PP Leave blank for default value. .PP Properties: .IP \[bu] 2 Config: front_endpoint .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_FRONT_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]https://archive.org\[dq] .SS --internetarchive-disable-checksum .PP Don\[aq]t ask the server to test against MD5 checksum calculated by rclone. Normally rclone will calculate the MD5 checksum of the input before uploading it so it can ask the server to check the object against checksum. This is great for data integrity checking but can cause long delays for large files to start uploading. .PP Properties: .IP \[bu] 2 Config: disable_checksum .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_DISABLE_CHECKSUM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --internetarchive-wait-archive .PP Timeout for waiting the server\[aq]s processing tasks (specifically archive and book_op) to finish. Only enable if you need to be guaranteed to be reflected after write operations. 0 to disable waiting. No errors to be thrown in case of timeout. .PP Properties: .IP \[bu] 2 Config: wait_archive .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_WAIT_ARCHIVE .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 0s .SS --internetarchive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot .SS --internetarchive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_INTERNETARCHIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Metadata fields provided by Internet Archive. If there are multiple values for a key, only the first one is returned. This is a limitation of Rclone, that supports one value per one key. .PP Owner is able to add custom keys. Metadata feature grabs all the keys including them. .PP Here are the possible system metadata items for the internetarchive backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ crc32 T}@T{ CRC32 calculated by Internet Archive T}@T{ string T}@T{ 01234567 T}@T{ \f[B]Y\f[R] T} T{ format T}@T{ Name of format identified by Internet Archive T}@T{ string T}@T{ Comma-Separated Values T}@T{ \f[B]Y\f[R] T} T{ md5 T}@T{ MD5 hash calculated by Internet Archive T}@T{ string T}@T{ 01234567012345670123456701234567 T}@T{ \f[B]Y\f[R] T} T{ mtime T}@T{ Time of last modification, managed by Rclone T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z T}@T{ \f[B]Y\f[R] T} T{ name T}@T{ Full file path, without the bucket part T}@T{ filename T}@T{ backend/internetarchive/internetarchive.go T}@T{ \f[B]Y\f[R] T} T{ old_version T}@T{ Whether the file was replaced and moved by keep-old-version flag T}@T{ boolean T}@T{ true T}@T{ \f[B]Y\f[R] T} T{ rclone-ia-mtime T}@T{ Time of last modification, managed by Internet Archive T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z T}@T{ N T} T{ rclone-mtime T}@T{ Time of last modification, managed by Rclone T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z T}@T{ N T} T{ rclone-update-track T}@T{ Random value used by Rclone for tracking changes inside Internet Archive T}@T{ string T}@T{ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa T}@T{ N T} T{ sha1 T}@T{ SHA1 hash calculated by Internet Archive T}@T{ string T}@T{ 0123456701234567012345670123456701234567 T}@T{ \f[B]Y\f[R] T} T{ size T}@T{ File size in bytes T}@T{ decimal number T}@T{ 123456 T}@T{ \f[B]Y\f[R] T} T{ source T}@T{ The source of the file T}@T{ string T}@T{ original T}@T{ \f[B]Y\f[R] T} T{ summation T}@T{ Check https://forum.rclone.org/t/31922 for how it is used T}@T{ string T}@T{ md5 T}@T{ \f[B]Y\f[R] T} T{ viruscheck T}@T{ The last time viruscheck process was run for the file (?) T}@T{ unixtime T}@T{ 1654191352 T}@T{ \f[B]Y\f[R] T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SH Jottacloud .PP Jottacloud is a cloud storage service provider from a Norwegian company, using its own datacenters in Norway. In addition to the official service at jottacloud.com (https://www.jottacloud.com/), it also provides white-label solutions to different companies, such as: * Telia * Telia Cloud (cloud.telia.se) * Telia Sky (sky.telia.no) * Tele2 * Tele2 Cloud (mittcloud.tele2.se) * Onlime * Onlime Cloud Storage (onlime.dk) * Elkj\[/o]p (with subsidiaries): * Elkj\[/o]p Cloud (cloud.elkjop.no) * Elgiganten Sweden (cloud.elgiganten.se) * Elgiganten Denmark (cloud.elgiganten.dk) * Giganti Cloud (cloud.gigantti.fi) * ELKO Cloud (cloud.elko.is) .PP Most of the white-label versions are supported by this backend, although may require different authentication setup - described below. .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Authentication types .PP Some of the whitelabel versions uses a different authentication method than the official service, and you have to choose the correct one when setting up the remote. .SS Standard authentication .PP The standard authentication method used by the official service (jottacloud.com), as well as some of the whitelabel services, requires you to generate a single-use personal login token from the account security settings in the service\[aq]s web interface. Log in to your account, go to \[dq]Settings\[dq] and then \[dq]Security\[dq], or use the direct link presented to you by rclone when configuring the remote: <https://www.jottacloud.com/web/secure>. Scroll down to the section \[dq]Personal login token\[dq], and click the \[dq]Generate\[dq] button. Note that if you are using a whitelabel service you probably can\[aq]t use the direct link, you need to find the same page in their dedicated web interface, and also it may be in a different location than described above. .PP To access your account from multiple instances of rclone, you need to configure each of them with a separate personal login token. E.g. you create a Jottacloud remote with rclone in one location, and copy the configuration file to a second location where you also want to run rclone and access the same remote. Then you need to replace the token for one of them, using the config reconnect (https://rclone.org/commands/rclone_config_reconnect/) command, which requires you to generate a new personal login token and supply as input. If you do not do this, the token may easily end up being invalidated, resulting in both instances failing with an error message something along the lines of: .IP .nf \f[C] oauth2: cannot fetch token: 400 Bad Request Response: {\[dq]error\[dq]:\[dq]invalid_grant\[dq],\[dq]error_description\[dq]:\[dq]Stale token\[dq]} \f[R] .fi .PP When this happens, you need to replace the token as described above to be able to use your remote again. .PP All personal login tokens you have taken into use will be listed in the web interface under \[dq]My logged in devices\[dq], and from the right side of that list you can click the \[dq]X\[dq] button to revoke individual tokens. .SS Legacy authentication .PP If you are using one of the whitelabel versions (e.g. from Elkj\[/o]p) you may not have the option to generate a CLI token. In this case you\[aq]ll have to use the legacy authentication. To do this select yes when the setup asks for legacy authentication and enter your username and password. The rest of the setup is identical to the default setup. .SS Telia Cloud authentication .PP Similar to other whitelabel versions Telia Cloud doesn\[aq]t offer the option of creating a CLI token, and additionally uses a separate authentication flow where the username is generated internally. To setup rclone to use Telia Cloud, choose Telia Cloud authentication in the setup. The rest of the setup is identical to the default setup. .SS Tele2 Cloud authentication .PP As Tele2-Com Hem merger was completed this authentication can be used for former Com Hem Cloud and Tele2 Cloud customers as no support for creating a CLI token exists, and additionally uses a separate authentication flow where the username is generated internally. To setup rclone to use Tele2 Cloud, choose Tele2 Cloud authentication in the setup. The rest of the setup is identical to the default setup. .SS Onlime Cloud Storage authentication .PP Onlime has sold access to Jottacloud proper, while providing localized support to Danish Customers, but have recently set up their own hosting, transferring their customers from Jottacloud servers to their own ones. .PP This, of course, necessitates using their servers for authentication, but otherwise functionality and architecture seems equivalent to Jottacloud. .PP To setup rclone to use Onlime Cloud Storage, choose Onlime Cloud authentication in the setup. The rest of the setup is identical to the default setup. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R] with the default setup. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Jottacloud \[rs] (jottacloud) [snip] Storage> jottacloud Edit advanced config? y) Yes n) No (default) y/n> n Option config_type. Select authentication type. Choose a number from below, or type in an existing string value. Press Enter for the default (standard). / Standard authentication. 1 | Use this if you\[aq]re a normal Jottacloud user. \[rs] (standard) / Legacy authentication. 2 | This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. \[rs] (legacy) / Telia Cloud authentication. 3 | Use this if you are using Telia Cloud. \[rs] (telia) / Tele2 Cloud authentication. 4 | Use this if you are using Tele2 Cloud. \[rs] (tele2) / Onlime Cloud authentication. 5 | Use this if you are using Onlime Cloud. \[rs] (onlime) config_type> 1 Personal login token. Generate here: https://www.jottacloud.com/web/secure Login Token> <your token here> Use a non-standard device/mountpoint? Choosing no, the default, will let you access the storage used for the archive section of the official Jottacloud client. If you instead want to access the sync or the backup section, for example, you must choose yes. y) Yes n) No (default) y/n> y Option config_device. The device to use. In standard setup the built-in Jotta device is used, which contains predefined mountpoints for archive, sync etc. All other devices are treated as backup devices by the official Jottacloud client. You may create a new by entering a unique name. Choose a number from below, or type in your own string value. Press Enter for the default (DESKTOP-3H31129). 1 > DESKTOP-3H31129 2 > Jotta config_device> 2 Option config_mountpoint. The mountpoint to use for the built-in device Jotta. The standard setup is to use the Archive mountpoint. Most other mountpoints have very limited support in rclone and should generally be avoided. Choose a number from below, or type in an existing string value. Press Enter for the default (Archive). 1 > Archive 2 > Shared 3 > Sync config_mountpoint> 1 Configuration complete. Options: - type: jottacloud - configVersion: 1 - client_id: jottacli - client_secret: - tokenURL: https://id.jottacloud.com/auth/realms/jottacloud/protocol/openid-connect/token - token: {........} - username: 2940e57271a93d987d6f8a21 - device: Jotta - mountpoint: Archive Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Jottacloud .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your Jottacloud .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an Jottacloud directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Devices and Mountpoints .PP The official Jottacloud client registers a device for each computer you install it on, and shows them in the backup section of the user interface. For each folder you select for backup it will create a mountpoint within this device. A built-in device called Jotta is special, and contains mountpoints Archive, Sync and some others, used for corresponding features in official clients. .PP With rclone you\[aq]ll want to use the standard Jotta/Archive device/mountpoint in most cases. However, you may for example want to access files from the sync or backup functionality provided by the official clients, and rclone therefore provides the option to select other devices and mountpoints during config. .PP You are allowed to create new devices and mountpoints. All devices except the built-in Jotta device are treated as backup devices by official Jottacloud clients, and the mountpoints on them are individual backup sets. .PP With the built-in Jotta device, only existing, built-in, mountpoints can be selected. In addition to the mentioned Archive and Sync, it may contain several other mountpoints such as: Latest, Links, Shared and Trash. All of these are special mountpoints with a different internal representation than the \[dq]regular\[dq] mountpoints. Rclone will only to a very limited degree support them. Generally you should avoid these, unless you know what you are doing. .SS --fast-list .PP This backend supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .PP Note that the implementation in Jottacloud always uses only a single API request to get the entire list, so for large folders this could lead to long wait time before the first results are shown. .PP Note also that with rclone version 1.58 and newer, information about MIME types (https://rclone.org/overview/#mime-type) and metadata item utime are not available when using \f[C]--fast-list\f[R]. .SS Modification times and hashes .PP Jottacloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP Jottacloud supports MD5 type hashes, so you can use the \f[C]--checksum\f[R] flag. .PP Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (in location given by --temp-dir (https://rclone.org/docs/#temp-dir-dir)) before it is uploaded. Small files will be cached in memory - see the --jottacloud-md5-memory-limit flag. When uploading from local disk the source checksum is always available, so this does not apply. Starting with rclone version 1.52 the same is true for encrypted remotes (in older versions the crypt backend would not calculate hashes for uploads from local disk, so the Jottacloud backend had to do it as described above). .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in XML strings. .SS Deleting files .PP By default, rclone will send all files to the trash when deleting files. They will be permanently deleted automatically after 30 days. You may bypass the trash and permanently delete files immediately by using the --jottacloud-hard-delete flag, or set the equivalent environment variable. Emptying the trash is supported by the cleanup (https://rclone.org/commands/rclone_cleanup/) command. .SS Versions .PP Jottacloud supports file versioning. When rclone uploads a new version of a file it creates a new version of it. Currently rclone only supports retrieving the current version but older versions can be accessed via the Jottacloud Website. .PP Versioning can be disabled by \f[C]--jottacloud-no-versions\f[R] option. This is achieved by deleting the remote file prior to uploading a new version. If the upload the fails no version of the file will be available in the remote. .SS Quota information .PP To view your current quota you can use the \f[C]rclone about remote:\f[R] command which will display your usage limit (unless it is unlimited) and the current usage. .SS Standard options .PP Here are the Standard options specific to jottacloud (Jottacloud). .SS --jottacloud-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --jottacloud-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to jottacloud (Jottacloud). .SS --jottacloud-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --jottacloud-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --jottacloud-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --jottacloud-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --jottacloud-md5-memory-limit .PP Files bigger than this will be cached on disk to calculate the MD5 if required. .PP Properties: .IP \[bu] 2 Config: md5_memory_limit .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Mi .SS --jottacloud-trashed-only .PP Only show files that are in the trash. .PP This will show trashed files in their original directory structure. .PP Properties: .IP \[bu] 2 Config: trashed_only .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_TRASHED_ONLY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --jottacloud-hard-delete .PP Delete files permanently rather than putting them into the trash. .PP Properties: .IP \[bu] 2 Config: hard_delete .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_HARD_DELETE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --jottacloud-upload-resume-limit .PP Files bigger than this can be resumed if the upload fail\[aq]s. .PP Properties: .IP \[bu] 2 Config: upload_resume_limit .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Mi .SS --jottacloud-no-versions .PP Avoid server side versioning by deleting files and recreating files instead of overwriting them. .PP Properties: .IP \[bu] 2 Config: no_versions .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_NO_VERSIONS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --jottacloud-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot .SS --jottacloud-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_JOTTACLOUD_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP Jottacloud has limited support for metadata, currently an extended set of timestamps. .PP Here are the possible system metadata items for the jottacloud backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ btime T}@T{ Time of file birth (creation), read from rclone metadata T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ N T} T{ content-type T}@T{ MIME type, also known as media type T}@T{ string T}@T{ text/plain T}@T{ \f[B]Y\f[R] T} T{ mtime T}@T{ Time of last modification, read from rclone metadata T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ N T} T{ utime T}@T{ Time of last upload, when current revision was created, generated by backend T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05.999999999Z07:00 T}@T{ \f[B]Y\f[R] T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Limitations .PP Note that Jottacloud is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP There are quite a few characters that can\[aq]t be in Jottacloud file names. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a ? in it will be mapped to \[uFF1F] instead. .PP Jottacloud only supports filenames up to 255 characters in length. .SS Troubleshooting .PP Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove operations to previously deleted paths to fail. Emptying the trash should help in such cases. .SH Koofr .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr web application (https://app.koofr.net/app/admin/preferences/password), giving the password a nice name like \f[C]rclone\f[R] and clicking on generate. .PP Here is an example of how to make a remote called \f[C]koofr\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> koofr Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers \[rs] (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ \[rs] (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ \[rs] (digistorage) 3 / Any other Koofr API compatible storage service \[rs] (other) provider> 1 Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n Remote config -------------------- [koofr] type = koofr provider = koofr user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP You can choose to edit advanced config in order to enter your own service URL if you use an on-premise or white label Koofr instance, or choose an alternative mount instead of your primary storage. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Koofr .IP .nf \f[C] rclone lsd koofr: \f[R] .fi .PP List all the files in your Koofr .IP .nf \f[C] rclone ls koofr: \f[R] .fi .PP To copy a local directory to an Koofr directory called backup .IP .nf \f[C] rclone copy /home/source koofr:backup \f[R] .fi .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in XML strings. .SS Standard options .PP Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). .SS --koofr-provider .PP Choose your storage provider. .PP Properties: .IP \[bu] 2 Config: provider .IP \[bu] 2 Env Var: RCLONE_KOOFR_PROVIDER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]koofr\[dq] .RS 2 .IP \[bu] 2 Koofr, https://app.koofr.net/ .RE .IP \[bu] 2 \[dq]digistorage\[dq] .RS 2 .IP \[bu] 2 Digi Storage, https://storage.rcs-rds.ro/ .RE .IP \[bu] 2 \[dq]other\[dq] .RS 2 .IP \[bu] 2 Any other Koofr API compatible storage service .RE .RE .SS --koofr-endpoint .PP The Koofr API endpoint to use. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_KOOFR_ENDPOINT .IP \[bu] 2 Provider: other .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --koofr-user .PP Your user name. .PP Properties: .IP \[bu] 2 Config: user .IP \[bu] 2 Env Var: RCLONE_KOOFR_USER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --koofr-password .PP Your password for rclone generate one at https://app.koofr.net/app/admin/preferences/password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_KOOFR_PASSWORD .IP \[bu] 2 Provider: koofr .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). .SS --koofr-mountid .PP Mount ID of the mount to use. .PP If omitted, the primary mount is used. .PP Properties: .IP \[bu] 2 Config: mountid .IP \[bu] 2 Env Var: RCLONE_KOOFR_MOUNTID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --koofr-setmtime .PP Does the backend support setting modification time. .PP Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. .PP Properties: .IP \[bu] 2 Config: setmtime .IP \[bu] 2 Env Var: RCLONE_KOOFR_SETMTIME .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .SS --koofr-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_KOOFR_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS --koofr-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_KOOFR_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Note that Koofr is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .SS Providers .SS Koofr .PP This is the original Koofr (https://koofr.eu) storage provider used as main example and described in the configuration section above. .SS Digi Storage .PP Digi Storage (https://www.digi.ro/servicii/online/digi-storage) is a cloud storage service run by Digi.ro (https://www.digi.ro/) that provides a Koofr API. .PP Here is an example of how to make a remote called \f[C]ds\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> ds Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers \[rs] (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ \[rs] (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ \[rs] (digistorage) 3 / Any other Koofr API compatible storage service \[rs] (other) provider> 2 Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [ds] type = koofr provider = digistorage user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Other .PP You may also want to use another, public or private storage provider that runs a Koofr API compatible service, by simply providing the base URL to connect to. .PP Here is an example of how to make a remote called \f[C]other\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> other Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers \[rs] (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ \[rs] (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ \[rs] (digistorage) 3 / Any other Koofr API compatible storage service \[rs] (other) provider> 3 Option endpoint. The Koofr API endpoint to use. Enter a value. endpoint> https://koofr.other.org Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at your service\[aq]s settings page). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [other] type = koofr provider = other endpoint = https://koofr.other.org user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SH Linkbox .PP Linkbox is a private cloud drive (https://linkbox.to/). .SS Configuration .PP Here is an example of making a remote for Linkbox. .PP First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. XX / Linkbox \[rs] (linkbox) Storage> XX Option token. Token from https://www.linkbox.to/admin/account Enter a value. token> testFromCLToken Configuration complete. Options: - type: linkbox - token: XXXXXXXXXXX Keep this \[dq]linkbox\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .SS Standard options .PP Here are the Standard options specific to linkbox (Linkbox). .SS --linkbox-token .PP Token from https://www.linkbox.to/admin/account .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_LINKBOX_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to linkbox (Linkbox). .SS --linkbox-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_LINKBOX_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SH Mail.ru Cloud .PP Mail.ru Cloud (https://cloud.mail.ru/) is a cloud storage provided by a Russian internet company Mail.Ru Group (https://mail.ru). The official desktop client is Disk-O: (https://disk-o.cloud/en), available on Windows and Mac OS. .SS Features highlights .IP \[bu] 2 Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R] .IP \[bu] 2 Files have a \f[C]last modified time\f[R] property, directories don\[aq]t .IP \[bu] 2 Deleted files are by default moved to the trash .IP \[bu] 2 Files and directories can be shared via public links .IP \[bu] 2 Partial uploads or streaming are not supported, file size must be known before upload .IP \[bu] 2 Maximum file size is limited to 2G for a free account, unlimited for paid accounts .IP \[bu] 2 Storage keeps hash for all files and performs transparent deduplication, the hash algorithm is a modified SHA1 .IP \[bu] 2 If a particular file is already present in storage, one can quickly submit file hash instead of long file upload (this optimization is supported by rclone) .SS Configuration .PP Here is an example of making a mailru configuration. .PP First create a Mail.ru Cloud account and choose a tariff. .PP You will need to log in and create an app password for rclone. Rclone \f[B]will not work\f[R] with your normal username and password - it will give an error like \f[C]oauth2: server response missing access_token\f[R]. .IP \[bu] 2 Click on your user icon in the top right .IP \[bu] 2 Go to Security / \[dq]\[u041F]\[u0430]\[u0440]\[u043E]\[u043B]\[u044C] \[u0438] \[u0431]\[u0435]\[u0437]\[u043E]\[u043F]\[u0430]\[u0441]\[u043D]\[u043E]\[u0441]\[u0442]\[u044C]\[dq] .IP \[bu] 2 Click password for apps / \[dq]\[u041F]\[u0430]\[u0440]\[u043E]\[u043B]\[u0438] \[u0434]\[u043B]\[u044F] \[u0432]\[u043D]\[u0435]\[u0448]\[u043D]\[u0438]\[u0445] \[u043F]\[u0440]\[u0438]\[u043B]\[u043E]\[u0436]\[u0435]\[u043D]\[u0438]\[u0439]\[dq] .IP \[bu] 2 Add the password - give it a name - eg \[dq]rclone\[dq] .IP \[bu] 2 Copy the password and use this password below - your normal login password won\[aq]t work. .PP Now run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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. Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Mail.ru Cloud \[rs] \[dq]mailru\[dq] [snip] Storage> mailru User name (usually email) Enter a string value. Press Enter for the default (\[dq]\[dq]). user> username\[at]mail.ru Password This must be an app password - rclone will not work with your normal password. See the Configuration section in the docs for how to make an app password. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Skip full upload if there is another file with same data hash. This feature is called \[dq]speedup\[dq] or \[dq]put by hash\[dq]. It is especially efficient in case of generally available files like popular books, video or audio clips [snip] Enter a boolean value (true or false). Press Enter for the default (\[dq]true\[dq]). Choose a number from below, or type in your own value 1 / Enable \[rs] \[dq]true\[dq] 2 / Disable \[rs] \[dq]false\[dq] speedup_enable> 1 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Configuration complete. Options: - type: mailru - user: username\[at]mail.ru - pass: *** ENCRYPTED *** - speedup_enable: true Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Configuration of this backend does not require a local web browser. You can use the configured backend as shown below: .PP See top level directories .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new directory .IP .nf \f[C] rclone mkdir remote:directory \f[R] .fi .PP List the contents of a directory .IP .nf \f[C] rclone ls remote:directory \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote path, deleting any excess files in the path. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:directory \f[R] .fi .SS Modification times and hashes .PP Files support a modification time attribute with up to 1 second precision. Directories do not have a modification time, which is shown as \[dq]Jan 1 1970\[dq]. .PP File hashes are supported, with a custom Mail.ru algorithm based on SHA1. If file size is less than or equal to the SHA1 block size (20 bytes), its hash is simply its data right-padded with zero bytes. Hashes of a larger file is computed as a SHA1 of the file data bytes concatenated with a decimal representation of the data length. .SS Emptying Trash .PP Removing a file or directory actually moves it to the trash, which is not visible to rclone but can be seen in a web browser. The trashed file still occupies part of total quota. If you wish to empty your trash and free some quota, you can use the \f[C]rclone cleanup remote:\f[R] command, which will permanently delete all your trashed files. This command does not take any path arguments. .SS Quota information .PP To view your current quota you can use the \f[C]rclone about remote:\f[R] command which will display your usage limit (quota) and the current usage. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to mailru (Mail.ru Cloud). .SS --mailru-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_MAILRU_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_MAILRU_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-user .PP User name (usually email). .PP Properties: .IP \[bu] 2 Config: user .IP \[bu] 2 Env Var: RCLONE_MAILRU_USER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --mailru-pass .PP Password. .PP This must be an app password - rclone will not work with your normal password. See the Configuration section in the docs for how to make an app password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: pass .IP \[bu] 2 Env Var: RCLONE_MAILRU_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --mailru-speedup-enable .PP Skip full upload if there is another file with same data hash. .PP This feature is called \[dq]speedup\[dq] or \[dq]put by hash\[dq]. It is especially efficient in case of generally available files like popular books, video or audio clips, because files are searched by hash in all accounts of all mailru users. It is meaningless and ineffective if source file is unique or encrypted. Please note that rclone may need local memory and disk space to calculate content hash in advance and decide whether full upload is required. Also, if rclone does not know file size in advance (e.g. in case of streaming or partial uploads), it will not even try this optimization. .PP Properties: .IP \[bu] 2 Config: speedup_enable .IP \[bu] 2 Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Enable .RE .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Disable .RE .RE .SS Advanced options .PP Here are the Advanced options specific to mailru (Mail.ru Cloud). .SS --mailru-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_MAILRU_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_MAILRU_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_MAILRU_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_MAILRU_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --mailru-speedup-file-patterns .PP Comma separated list of file name patterns eligible for speedup (put by hash). .PP Patterns are case insensitive and can contain \[aq]*\[aq] or \[aq]?\[aq] meta characters. .PP Properties: .IP \[bu] 2 Config: speedup_file_patterns .IP \[bu] 2 Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3,\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 Empty list completely disables speedup (put by hash). .RE .IP \[bu] 2 \[dq]*\[dq] .RS 2 .IP \[bu] 2 All files will be attempted for speedup. .RE .IP \[bu] 2 \[dq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3\[dq] .RS 2 .IP \[bu] 2 Only common audio/video files will be tried for put by hash. .RE .IP \[bu] 2 \[dq]\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[dq] .RS 2 .IP \[bu] 2 Only common archives or PDF books will be tried for speedup. .RE .RE .SS --mailru-speedup-max-disk .PP This option allows you to disable speedup (put by hash) for large files. .PP Reason is that preliminary hashing can exhaust your RAM or disk space. .PP Properties: .IP \[bu] 2 Config: speedup_max_disk .IP \[bu] 2 Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 3Gi .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]0\[dq] .RS 2 .IP \[bu] 2 Completely disable speedup (put by hash). .RE .IP \[bu] 2 \[dq]1G\[dq] .RS 2 .IP \[bu] 2 Files larger than 1Gb will be uploaded directly. .RE .IP \[bu] 2 \[dq]3G\[dq] .RS 2 .IP \[bu] 2 Choose this option if you have less than 3Gb free on local disk. .RE .RE .SS --mailru-speedup-max-memory .PP Files larger than the size given below will always be hashed on disk. .PP Properties: .IP \[bu] 2 Config: speedup_max_memory .IP \[bu] 2 Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 32Mi .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]0\[dq] .RS 2 .IP \[bu] 2 Preliminary hashing will always be done in a temporary disk location. .RE .IP \[bu] 2 \[dq]32M\[dq] .RS 2 .IP \[bu] 2 Do not dedicate more than 32Mb RAM for preliminary hashing. .RE .IP \[bu] 2 \[dq]256M\[dq] .RS 2 .IP \[bu] 2 You have at most 256Mb RAM free for hash calculations. .RE .RE .SS --mailru-check-hash .PP What should copy do if file checksum is mismatched or invalid. .PP Properties: .IP \[bu] 2 Config: check_hash .IP \[bu] 2 Env Var: RCLONE_MAILRU_CHECK_HASH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: true .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Fail with error. .RE .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Ignore and continue. .RE .RE .SS --mailru-user-agent .PP HTTP user agent used internally by client. .PP Defaults to \[dq]rclone/VERSION\[dq] or \[dq]--user-agent\[dq] provided on command line. .PP Properties: .IP \[bu] 2 Config: user_agent .IP \[bu] 2 Env Var: RCLONE_MAILRU_USER_AGENT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-quirks .PP Comma separated list of internal maintenance flags. .PP This option must not be used by an ordinary user. It is intended only to facilitate remote troubleshooting of backend issues. Strict meaning of flags is not documented and not guaranteed to persist between releases. Quirks will be removed when the backend grows stable. Supported quirks: atomicmkdir binlist unknowndirs .PP Properties: .IP \[bu] 2 Config: quirks .IP \[bu] 2 Env Var: RCLONE_MAILRU_QUIRKS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --mailru-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_MAILRU_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS --mailru-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_MAILRU_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP File size limits depend on your account. A single file size is limited by 2G for a free account and unlimited for paid tariffs. Please refer to the Mail.ru site for the total uploaded size limits. .PP Note that Mailru is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .SH Mega .PP Mega (https://mega.nz/) is a cloud storage and file hosting service known for its security feature where all files are encrypted locally before they are uploaded. This prevents anyone (including employees of Mega) from accessing the files without knowledge of the key used for encryption. .PP This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption. .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / Mega \[rs] \[dq]mega\[dq] [snip] Storage> mega User name user> you\[at]example.com Password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: Remote config Configuration complete. Options: - type: mega - user: you\[at]example.com - pass: *** ENCRYPTED *** Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP \f[B]NOTE:\f[R] The encryption keys need to have been already generated after a regular login via the browser, otherwise attempting to use the credentials in \f[C]rclone\f[R] will fail. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Mega .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your Mega .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an Mega directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Modification times and hashes .PP Mega does not support modification times or hashes yet. .SS Restricted filename characters .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Duplicated files .PP Mega can have two files with exactly the same name and path (unlike a normal file system). .PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .PP Use \f[C]rclone dedupe\f[R] to fix duplicated files. .SS Failure to log-in .SS Object not found .PP If you are connecting to your Mega remote for the first time, to test access and synchronization, you may receive an error such as .IP .nf \f[C] Failed to create file system for \[dq]my-mega-remote:\[dq]: couldn\[aq]t login: Object (typically, node or user) not found \f[R] .fi .PP The diagnostic steps often recommended in the rclone forum (https://forum.rclone.org/search?q=mega) start with the \f[B]MEGAcmd\f[R] utility. Note that this refers to the official C++ command from https://github.com/meganz/MEGAcmd and not the go language built command from t3rm1n4l/megacmd that is no longer maintained. .PP Follow the instructions for installing MEGAcmd and try accessing your remote as they recommend. You can establish whether or not you can log in using MEGAcmd, and obtain diagnostic information to help you, and search or work with others in the forum. .IP .nf \f[C] MEGA CMD> login me\[at]example.com Password: Fetching nodes ... Loading transfers from local cache Login complete as me\[at]example.com me\[at]example.com:/$ \f[R] .fi .PP Note that some have found issues with passwords containing special characters. If you can not log on with rclone, but MEGAcmd logs on just fine, then consider changing your password temporarily to pure alphanumeric characters, in case that helps. .SS Repeated commands blocks access .PP Mega remotes seem to get blocked (reject logins) under \[dq]heavy use\[dq]. We haven\[aq]t worked out the exact blocking rules but it seems to be related to fast paced, successive rclone commands. .PP For example, executing this command 90 times in a row \f[C]rclone link remote:file\f[R] will cause the remote to become \[dq]blocked\[dq]. This is not an abnormal situation, for example if you wish to get the public links of a directory with hundred of files... After more or less a week, the remote will remote accept rclone logins normally again. .PP You can mitigate this issue by mounting the remote it with \f[C]rclone mount\f[R]. This will log-in when mounting and a log-out when unmounting only. You can also run \f[C]rclone rcd\f[R] and then use \f[C]rclone rc\f[R] to run the commands over the API to avoid logging in each time. .PP Rclone does not currently close mega sessions (you can see them in the web interface), however closing the sessions does not solve the issue. .PP If you space rclone commands by 3 seconds it will avoid blocking the remote. We haven\[aq]t identified the exact blocking rules, so perhaps one could execute the command 80 times without waiting and avoid blocking by waiting 3 seconds, then continuing... .PP Note that this has been observed by trial and error and might not be set in stone. .PP Other tools seem not to produce this blocking effect, as they use a different working approach (state-based, using sessionIDs instead of log-in) which isn\[aq]t compatible with the current stateless rclone approach. .PP Note that once blocked, the use of other tools (such as megacmd) is not a sure workaround: following megacmd login times have been observed in succession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. Web access looks unaffected though. .PP Investigation is continuing in relation to workarounds based on timeouts, pacers, retrials and tpslimits - if you discover something relevant, please post on the forum. .PP So, if rclone was working nicely and suddenly you are unable to log-in and you are sure the user and the password are correct, likely you have got the remote blocked for a while. .SS Standard options .PP Here are the Standard options specific to mega (Mega). .SS --mega-user .PP User name. .PP Properties: .IP \[bu] 2 Config: user .IP \[bu] 2 Env Var: RCLONE_MEGA_USER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --mega-pass .PP Password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: pass .IP \[bu] 2 Env Var: RCLONE_MEGA_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to mega (Mega). .SS --mega-debug .PP Output more debug from Mega. .PP If this flag is set (along with -vv) it will print further debugging information from the mega backend. .PP Properties: .IP \[bu] 2 Config: debug .IP \[bu] 2 Env Var: RCLONE_MEGA_DEBUG .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --mega-hard-delete .PP Delete files permanently rather than putting them into the trash. .PP Normally the mega backend will put all deletions into the trash rather than permanently deleting them. If you specify this then rclone will permanently delete objects instead. .PP Properties: .IP \[bu] 2 Config: hard_delete .IP \[bu] 2 Env Var: RCLONE_MEGA_HARD_DELETE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --mega-use-https .PP Use HTTPS for transfers. .PP MEGA uses plain text HTTP connections by default. Some ISPs throttle HTTP connections, this causes transfers to become very slow. Enabling this will force MEGA to use HTTPS for all transfers. HTTPS is normally not necessary since all data is already encrypted anyway. Enabling it will increase CPU usage and add network overhead. .PP Properties: .IP \[bu] 2 Config: use_https .IP \[bu] 2 Env Var: RCLONE_MEGA_USE_HTTPS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --mega-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_MEGA_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,InvalidUtf8,Dot .SS --mega-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_MEGA_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Process \f[C]killed\f[R] .PP On accounts with large files or something else, memory usage can significantly increase when executing list/sync instructions. When running on cloud providers (like AWS with EC2), check if the instance type has sufficient memory/CPU to execute the commands. Use the resource monitoring tools to inspect after sending the commands. Look at this issue (https://forum.rclone.org/t/rclone-with-mega-appears-to-work-only-in-some-accounts/40233/4). .SS Limitations .PP This backend uses the go-mega go library (https://github.com/t3rm1n4l/go-mega) which is an opensource go library implementing the Mega API. There doesn\[aq]t appear to be any documentation for the mega protocol beyond the mega C++ SDK (https://github.com/meganz/sdk) source code so there are likely quite a few errors still remaining in this library. .PP Mega allows duplicate files which may confuse rclone. .SH Memory .PP The memory backend is an in RAM backend. It does not persist its data - use the local backend for that. .PP The memory backend behaves like a bucket-based remote (e.g. like s3). Because it has no parameters you can just use it with the \f[C]:memory:\f[R] remote name. .SS Configuration .PP You can configure it as a remote like this with \f[C]rclone config\f[R] too if you want to: .IP .nf \f[C] 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 (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Memory \[rs] \[dq]memory\[dq] [snip] Storage> memory ** See help for memory backend at: https://rclone.org/memory/ ** Remote config Configuration complete. Options: - type: memory Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP Because the memory backend isn\[aq]t persistent it is most useful for testing or with an rclone server or rclone mount, e.g. .IP .nf \f[C] rclone mount :memory: /mnt/tmp rclone serve webdav :memory: rclone serve sftp :memory: \f[R] .fi .SS Modification times and hashes .PP The memory backend supports MD5 hashes and modification times accurate to 1 nS. .SS Restricted filename characters .PP The memory backend replaces the default restricted characters set (https://rclone.org/overview/#restricted-characters). .SS Advanced options .PP Here are the Advanced options specific to memory (In memory object storage system.). .SS --memory-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_MEMORY_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SH Akamai NetStorage .PP Paths are specified as \f[C]remote:\f[R] You may put subdirectories in too, e.g. \f[C]remote:/path/to/dir\f[R]. If you have a CP code you can use that as the folder after the domain such as <domain>/<cpcode>/<internal directories within cpcode>. .PP For example, this is commonly configured with or without a CP code: * \f[B]With a CP code\f[R]. \f[C][your-domain-prefix]-nsu.akamaihd.net/123456/subdirectory/\f[R] * \f[B]Without a CP code\f[R]. \f[C][your-domain-prefix]-nsu.akamaihd.net\f[R] .PP See all buckets rclone lsd remote: The initial setup for Netstorage involves getting an account and secret. Use \f[C]rclone config\f[R] to walk you through the setup process. .SS Configuration .PP Here\[aq]s an example of how to make a remote called \f[C]ns1\f[R]. .IP "1." 3 To begin the interactive configuration process, enter this command: .IP .nf \f[C] rclone config \f[R] .fi .IP "2." 3 Type \f[C]n\f[R] to create a new remote. .IP .nf \f[C] n) New remote d) Delete remote q) Quit config e/n/d/q> n \f[R] .fi .IP "3." 3 For this example, enter \f[C]ns1\f[R] when you reach the name> prompt. .IP .nf \f[C] name> ns1 \f[R] .fi .IP "4." 3 Enter \f[C]netstorage\f[R] as the type of storage to configure. .IP .nf \f[C] Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value XX / NetStorage \[rs] \[dq]netstorage\[dq] Storage> netstorage \f[R] .fi .IP "5." 3 Select between the HTTP or HTTPS protocol. Most users should choose HTTPS, which is the default. HTTP is provided primarily for debugging purposes. .IP .nf \f[C] Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value 1 / HTTP protocol \[rs] \[dq]http\[dq] 2 / HTTPS protocol \[rs] \[dq]https\[dq] protocol> 1 \f[R] .fi .IP "6." 3 Specify your NetStorage host, CP code, and any necessary content paths using this format: \f[C]<domain>/<cpcode>/<content>/\f[R] .IP .nf \f[C] Enter a string value. Press Enter for the default (\[dq]\[dq]). host> baseball-nsu.akamaihd.net/123456/content/ \f[R] .fi .IP "7." 3 Set the netstorage account name .IP .nf \f[C] Enter a string value. Press Enter for the default (\[dq]\[dq]). account> username \f[R] .fi .IP "8." 3 Set the Netstorage account secret/G2O key which will be used for authentication purposes. Select the \f[C]y\f[R] option to set your own password then enter your secret. Note: The secret is stored in the \f[C]rclone.conf\f[R] file with hex-encoded encryption. .IP .nf \f[C] y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: \f[R] .fi .IP "9." 3 View the summary and confirm your remote configuration. .IP .nf \f[C] [ns1] type = netstorage protocol = http host = baseball-nsu.akamaihd.net/123456/content/ account = username secret = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This remote is called \f[C]ns1\f[R] and can now be used. .SS Example operations .PP Get started with rclone and NetStorage with these examples. For additional rclone commands, visit https://rclone.org/commands/. .SS See contents of a directory in your project .IP .nf \f[C] rclone lsd ns1:/974012/testing/ \f[R] .fi .SS Sync the contents local with remote .IP .nf \f[C] rclone sync . ns1:/974012/testing/ \f[R] .fi .SS Upload local content to remote .IP .nf \f[C] rclone copy notes.txt ns1:/974012/testing/ \f[R] .fi .SS Delete content on remote .IP .nf \f[C] rclone delete ns1:/974012/testing/notes.txt \f[R] .fi .SS Move or copy content between CP codes. .PP Your credentials must have access to two CP codes on the same remote. You can\[aq]t perform operations between different remotes. .IP .nf \f[C] rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/ \f[R] .fi .SS Features .SS Symlink Support .PP The Netstorage backend changes the rclone \f[C]--links, -l\f[R] behavior. When uploading, instead of creating the .rclonelink file, use the \[dq]symlink\[dq] API in order to create the corresponding symlink on the remote. The .rclonelink file will not be created, the upload will be intercepted and only the symlink file that matches the source file name with no suffix will be created on the remote. .PP This will effectively allow commands like copy/copyto, move/moveto and sync to upload from local to remote and download from remote to local directories with symlinks. Due to internal rclone limitations, it is not possible to upload an individual symlink file to any remote backend. You can always use the \[dq]backend symlink\[dq] command to create a symlink on the NetStorage server, refer to \[dq]symlink\[dq] section below. .PP Individual symlink files on the remote can be used with the commands like \[dq]cat\[dq] to print the destination name, or \[dq]delete\[dq] to delete symlink, or copy, copy/to and move/moveto to download from the remote to local. Note: individual symlink files on the remote should be specified including the suffix .rclonelink. .PP \f[B]Note\f[R]: No file with the suffix .rclonelink should ever exist on the server since it is not possible to actually upload/create a file with .rclonelink suffix with rclone, it can only exist if it is manually created through a non-rclone method on the remote. .SS Implicit vs. Explicit Directories .PP With NetStorage, directories can exist in one of two forms: .IP "1." 3 \f[B]Explicit Directory\f[R]. This is an actual, physical directory that you have created in a storage group. .IP "2." 3 \f[B]Implicit Directory\f[R]. This refers to a directory within a path that has not been physically created. For example, during upload of a file, nonexistent subdirectories can be specified in the target path. NetStorage creates these as \[dq]implicit.\[dq] While the directories aren\[aq]t physically created, they exist implicitly and the noted path is connected with the uploaded file. .PP Rclone will intercept all file uploads and mkdir commands for the NetStorage remote and will explicitly issue the mkdir command for each directory in the uploading path. This will help with the interoperability with the other Akamai services such as SFTP and the Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly. .SS \f[C]--fast-list\f[R] / ListR support .PP NetStorage remote supports the ListR feature by using the \[dq]list\[dq] NetStorage API action to return a lexicographical list of all objects within the specified CP code, recursing into subdirectories as they\[aq]re encountered. .IP \[bu] 2 \f[B]Rclone will use the ListR method for some commands by default\f[R]. Commands such as \f[C]lsf -R\f[R] will use ListR by default. To disable this, include the \f[C]--disable listR\f[R] option to use the non-recursive method of listing objects. .IP \[bu] 2 \f[B]Rclone will not use the ListR method for some commands\f[R]. Commands such as \f[C]sync\f[R] don\[aq]t use ListR by default. To force using the ListR method, include the \f[C]--fast-list\f[R] option. .PP There are pros and cons of using the ListR method, refer to rclone documentation (https://rclone.org/docs/#fast-list). In general, the sync command over an existing deep tree on the remote will run faster with the \[dq]--fast-list\[dq] flag but with extra memory usage as a side effect. It might also result in higher CPU utilization but the whole task can be completed faster. .PP \f[B]Note\f[R]: There is a known limitation that \[dq]lsf -R\[dq] will display number of files in the directory and directory size as -1 when ListR method is used. The workaround is to pass \[dq]--disable listR\[dq] flag if these numbers are important in the output. .SS Purge .PP NetStorage remote supports the purge feature by using the \[dq]quick-delete\[dq] NetStorage API action. The quick-delete action is disabled by default for security reasons and can be enabled for the account through the Akamai portal. Rclone will first try to use quick-delete action for the purge command and if this functionality is disabled then will fall back to a standard delete method. .PP \f[B]Note\f[R]: Read the NetStorage Usage API (https://learn.akamai.com/en-us/webhelp/netstorage/netstorage-http-api-developer-guide/GUID-15836617-9F50-405A-833C-EA2556756A30.html) for considerations when using \[dq]quick-delete\[dq]. In general, using quick-delete method will not delete the tree immediately and objects targeted for quick-delete may still be accessible. .SS Standard options .PP Here are the Standard options specific to netstorage (Akamai NetStorage). .SS --netstorage-host .PP Domain+path of NetStorage host to connect to. .PP Format should be \f[C]<domain>/<internal folders>\f[R] .PP Properties: .IP \[bu] 2 Config: host .IP \[bu] 2 Env Var: RCLONE_NETSTORAGE_HOST .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --netstorage-account .PP Set the NetStorage account name .PP Properties: .IP \[bu] 2 Config: account .IP \[bu] 2 Env Var: RCLONE_NETSTORAGE_ACCOUNT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --netstorage-secret .PP Set the NetStorage account secret/G2O key for authentication. .PP Please choose the \[aq]y\[aq] option to set your own password then enter your secret. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: secret .IP \[bu] 2 Env Var: RCLONE_NETSTORAGE_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to netstorage (Akamai NetStorage). .SS --netstorage-protocol .PP Select between HTTP or HTTPS protocol. .PP Most users should choose HTTPS, which is the default. HTTP is provided primarily for debugging purposes. .PP Properties: .IP \[bu] 2 Config: protocol .IP \[bu] 2 Env Var: RCLONE_NETSTORAGE_PROTOCOL .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]https\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]http\[dq] .RS 2 .IP \[bu] 2 HTTP protocol .RE .IP \[bu] 2 \[dq]https\[dq] .RS 2 .IP \[bu] 2 HTTPS protocol .RE .RE .SS --netstorage-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_NETSTORAGE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Backend commands .PP Here are the commands specific to the netstorage backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS du .PP Return disk usage information for a specified directory .IP .nf \f[C] rclone backend du remote: [options] [<arguments>+] \f[R] .fi .PP The usage information returned, includes the targeted directory as well as all files stored in any sub-directories that may exist. .SS symlink .PP You can create a symbolic link in ObjectStore with the symlink action. .IP .nf \f[C] rclone backend symlink remote: [options] [<arguments>+] \f[R] .fi .PP The desired path location (including applicable sub-directories) ending in the object that will be the target of the symlink (for example, /links/mylink). Include the file extension for the object, if applicable. \f[C]rclone backend symlink <src> <path>\f[R] .SH Microsoft Azure Blob Storage .PP Paths are specified as \f[C]remote:container\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:container/path/to/dir\f[R]. .SS Configuration .PP Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / Microsoft Azure Blob Storage \[rs] \[dq]azureblob\[dq] [snip] Storage> azureblob Storage Account Name account> account_name Storage Account Key key> base64encodedkey== Endpoint for the service - leave blank normally. endpoint> Remote config Configuration complete. Options: - type: azureblob - account: account_name - key: base64encodedkey== - endpoint: Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See all containers .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new container .IP .nf \f[C] rclone mkdir remote:container \f[R] .fi .PP List the contents of a container .IP .nf \f[C] rclone ls remote:container \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote container, deleting any excess files in the container. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:container \f[R] .fi .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .SS Modification times and hashes .PP The modification time is stored as metadata on the object with the \f[C]mtime\f[R] key. It is stored using RFC3339 Format time with nanosecond precision. The metadata is supplied during directory listings so there is no performance overhead to using it. .PP If you wish to use the Azure standard \f[C]LastModified\f[R] time stored on the object as the modified time, then use the \f[C]--use-server-modtime\f[R] flag. Note that rclone can\[aq]t set \f[C]LastModified\f[R], so using the \f[C]--update\f[R] flag when syncing is recommended if using \f[C]--use-server-modtime\f[R]. .PP MD5 hashes are stored with blobs. However blobs that were uploaded in chunks only have an MD5 if the source remote was capable of MD5 hashes, e.g. the local disk. .SS Performance .PP When uploading large files, increasing the value of \f[C]--azureblob-upload-concurrency\f[R] will increase performance at the cost of using more memory. The default of 16 is set quite conservatively to use less memory. It maybe be necessary raise it to 64 or higher to fully utilize a 1 GBit/s link with a single file transfer. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} .TE .PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \&. T}@T{ 0x2E T}@T{ \[uFF0E] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Authentication .PP There are a number of ways of supplying credentials for Azure Blob Storage. Rclone tries them in the order of the sections below. .SS Env Auth .PP If the \f[C]env_auth\f[R] config parameter is \f[C]true\f[R] then rclone will pull credentials from the environment or runtime. .PP It tries these authentication methods in this order: .IP "1." 3 Environment Variables .IP "2." 3 Managed Service Identity Credentials .IP "3." 3 Azure CLI credentials (as used by the az tool) .PP These are described in the following sections .SS Env Auth: 1. Environment Variables .PP If \f[C]env_auth\f[R] is set and environment variables are present rclone authenticates a service principal with a secret or certificate, or a user with a password, depending on which environment variable are set. It reads configuration from these variables, in the following order: .IP "1." 3 Service principal with client secret .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]AZURE_CLIENT_SECRET\f[R]: one of the service principal\[aq]s client secrets .RE .IP "2." 3 Service principal with certificate .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]AZURE_CLIENT_CERTIFICATE_PATH\f[R]: path to a PEM or PKCS12 certificate file including the private key. .IP \[bu] 2 \f[C]AZURE_CLIENT_CERTIFICATE_PASSWORD\f[R]: (optional) password for the certificate file. .IP \[bu] 2 \f[C]AZURE_CLIENT_SEND_CERTIFICATE_CHAIN\f[R]: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to \[dq]true\[dq] or \[dq]1\[dq], authentication requests include the x5c header. .RE .IP "3." 3 User with username and password .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: (optional) tenant to authenticate in. Defaults to \[dq]organizations\[dq]. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: client ID of the application the user will authenticate to .IP \[bu] 2 \f[C]AZURE_USERNAME\f[R]: a username (usually an email address) .IP \[bu] 2 \f[C]AZURE_PASSWORD\f[R]: the user\[aq]s password .RE .IP "4." 3 Workload Identity .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: Tenant to authenticate in. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: Client ID of the application the user will authenticate to. .IP \[bu] 2 \f[C]AZURE_FEDERATED_TOKEN_FILE\f[R]: Path to projected service account token file. .IP \[bu] 2 \f[C]AZURE_AUTHORITY_HOST\f[R]: Authority of an Azure Active Directory endpoint (default: login.microsoftonline.com). .RE .SS Env Auth: 2. Managed Service Identity Credentials .PP When using Managed Service Identity if the VM(SS) on which this program is running has a system-assigned identity, it will be used by default. If the resource has no system-assigned but exactly one user-assigned identity, the user-assigned identity will be used by default. .PP If the resource has multiple user-assigned identities you will need to unset \f[C]env_auth\f[R] and set \f[C]use_msi\f[R] instead. See the \f[C]use_msi\f[R] section. .PP If you are operating in disconnected clouds, or private clouds such as Azure Stack you may want to set \f[C]disable_instance_discovery = true\f[R]. This determines whether rclone requests Microsoft Entra instance metadata from \f[C]https://login.microsoft.com/\f[R] before authenticating. Setting this to \f[C]true\f[R] will skip this request, making you responsible for ensuring the configured authority is valid and trustworthy. .SS Env Auth: 3. Azure CLI credentials (as used by the az tool) .PP Credentials created with the \f[C]az\f[R] tool can be picked up using \f[C]env_auth\f[R]. .PP For example if you were to login with a service principal like this: .IP .nf \f[C] az login --service-principal -u XXX -p XXX --tenant XXX \f[R] .fi .PP Then you could access rclone resources like this: .IP .nf \f[C] rclone lsf :azureblob,env_auth,account=ACCOUNT:CONTAINER \f[R] .fi .PP Or .IP .nf \f[C] rclone lsf --azureblob-env-auth --azureblob-account=ACCOUNT :azureblob:CONTAINER \f[R] .fi .PP Which is analogous to using the \f[C]az\f[R] tool: .IP .nf \f[C] az storage blob list --container-name CONTAINER --account-name ACCOUNT --auth-mode login \f[R] .fi .SS Account and Shared Key .PP This is the most straight forward and least flexible way. Just fill in the \f[C]account\f[R] and \f[C]key\f[R] lines and leave the rest blank. .SS SAS URL .PP This can be an account level SAS URL or container level SAS URL. .PP To use it leave \f[C]account\f[R] and \f[C]key\f[R] blank and fill in \f[C]sas_url\f[R]. .PP An account level SAS URL or container level SAS URL can be obtained from the Azure portal or the Azure Storage Explorer. To get a container level SAS URL right click on a container in the Azure Blob explorer in the Azure portal. .PP If you use a container level SAS URL, rclone operations are permitted only on a particular container, e.g. .IP .nf \f[C] rclone ls azureblob:container \f[R] .fi .PP You can also list the single container from the root. This will only show the container specified by the SAS URL. .IP .nf \f[C] $ rclone lsd azureblob: container/ \f[R] .fi .PP Note that you can\[aq]t see or access any other containers - this will fail .IP .nf \f[C] rclone ls azureblob:othercontainer \f[R] .fi .PP Container level SAS URLs are useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment such as a CI build server. .SS Service principal with client secret .PP If these variables are set, rclone will authenticate with a service principal with a client secret. .IP \[bu] 2 \f[C]tenant\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]client_id\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]client_secret\f[R]: one of the service principal\[aq]s client secrets .PP The credentials can also be placed in a file using the \f[C]service_principal_file\f[R] configuration option. .SS Service principal with certificate .PP If these variables are set, rclone will authenticate with a service principal with certificate. .IP \[bu] 2 \f[C]tenant\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]client_id\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]client_certificate_path\f[R]: path to a PEM or PKCS12 certificate file including the private key. .IP \[bu] 2 \f[C]client_certificate_password\f[R]: (optional) password for the certificate file. .IP \[bu] 2 \f[C]client_send_certificate_chain\f[R]: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to \[dq]true\[dq] or \[dq]1\[dq], authentication requests include the x5c header. .PP \f[B]NB\f[R] \f[C]client_certificate_password\f[R] must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .SS User with username and password .PP If these variables are set, rclone will authenticate with username and password. .IP \[bu] 2 \f[C]tenant\f[R]: (optional) tenant to authenticate in. Defaults to \[dq]organizations\[dq]. .IP \[bu] 2 \f[C]client_id\f[R]: client ID of the application the user will authenticate to .IP \[bu] 2 \f[C]username\f[R]: a username (usually an email address) .IP \[bu] 2 \f[C]password\f[R]: the user\[aq]s password .PP Microsoft doesn\[aq]t recommend this kind of authentication, because it\[aq]s less secure than other authentication flows. This method is not interactive, so it isn\[aq]t compatible with any form of multi-factor authentication, and the application must already have user or admin consent. This credential can only authenticate work and school accounts; it can\[aq]t authenticate Microsoft accounts. .PP \f[B]NB\f[R] \f[C]password\f[R] must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .SS Managed Service Identity Credentials .PP If \f[C]use_msi\f[R] is set then managed service identity credentials are used. This authentication only works when running in an Azure service. \f[C]env_auth\f[R] needs to be unset to use this. .PP However if you have multiple user identities to choose from these must be explicitly specified using exactly one of the \f[C]msi_object_id\f[R], \f[C]msi_client_id\f[R], or \f[C]msi_mi_res_id\f[R] parameters. .PP If none of \f[C]msi_object_id\f[R], \f[C]msi_client_id\f[R], or \f[C]msi_mi_res_id\f[R] is set, this is is equivalent to using \f[C]env_auth\f[R]. .SS Azure CLI tool \f[C]az\f[R] .PP Set to use the Azure CLI tool \f[C]az\f[R] (https://learn.microsoft.com/en-us/cli/azure/) as the sole means of authentication. .PP Setting this can be useful if you wish to use the \f[C]az\f[R] CLI on a host with a System Managed Identity that you do not want to use. .PP Don\[aq]t set \f[C]env_auth\f[R] at the same time. .SS Anonymous .PP If you want to access resources with public anonymous access then set \f[C]account\f[R] only. You can do this without making an rclone config: .IP .nf \f[C] rclone lsf :azureblob,account=ACCOUNT:CONTAINER \f[R] .fi .SS Standard options .PP Here are the Standard options specific to azureblob (Microsoft Azure Blob Storage). .SS --azureblob-account .PP Azure Storage Account Name. .PP Set this to the Azure Storage Account Name in use. .PP Leave blank to use SAS URL or Emulator, otherwise it needs to be set. .PP If this is blank and if env_auth is set it will be read from the environment variable \f[C]AZURE_STORAGE_ACCOUNT_NAME\f[R] if possible. .PP Properties: .IP \[bu] 2 Config: account .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ACCOUNT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-env-auth .PP Read credentials from runtime (environment variables, CLI or MSI). .PP See the authentication docs for full info. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-key .PP Storage Account Shared Key. .PP Leave blank to use SAS URL or Emulator. .PP Properties: .IP \[bu] 2 Config: key .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-sas-url .PP SAS URL for container level access only. .PP Leave blank if using account/key or Emulator. .PP Properties: .IP \[bu] 2 Config: sas_url .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_SAS_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-tenant .PP ID of the service principal\[aq]s tenant. Also called its directory ID. .PP Set this if using - Service principal with client secret - Service principal with certificate - User with username and password .PP Properties: .IP \[bu] 2 Config: tenant .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_TENANT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-client-id .PP The ID of the client in use. .PP Set this if using - Service principal with client secret - Service principal with certificate - User with username and password .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-client-secret .PP One of the service principal\[aq]s client secrets .PP Set this if using - Service principal with client secret .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-client-certificate-path .PP Path to a PEM or PKCS12 certificate file including the private key. .PP Set this if using - Service principal with certificate .PP Properties: .IP \[bu] 2 Config: client_certificate_path .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CLIENT_CERTIFICATE_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-client-certificate-password .PP Password for the certificate file (optional). .PP Optionally set this if using - Service principal with certificate .PP And the certificate has a password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: client_certificate_password .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CLIENT_CERTIFICATE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to azureblob (Microsoft Azure Blob Storage). .SS --azureblob-client-send-certificate-chain .PP Send the certificate chain when using certificate auth. .PP Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to true, authentication requests include the x5c header. .PP Optionally set this if using - Service principal with certificate .PP Properties: .IP \[bu] 2 Config: client_send_certificate_chain .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CLIENT_SEND_CERTIFICATE_CHAIN .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-username .PP User name (usually an email address) .PP Set this if using - User with username and password .PP Properties: .IP \[bu] 2 Config: username .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-password .PP The user\[aq]s password .PP Set this if using - User with username and password .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-service-principal-file .PP Path to file containing credentials for use with a service principal. .PP Leave blank normally. Needed only if you want to use a service principal instead of interactive login. .IP .nf \f[C] $ az ad sp create-for-rbac --name \[dq]<name>\[dq] \[rs] --role \[dq]Storage Blob Data Owner\[dq] \[rs] --scopes \[dq]/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account>/blobServices/default/containers/<container>\[dq] \[rs] > azure-principal.json \f[R] .fi .PP See \[dq]Create an Azure service principal\[dq] (https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and \[dq]Assign an Azure role for access to blob data\[dq] (https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details. .PP It may be more convenient to put the credentials directly into the rclone config file under the \f[C]client_id\f[R], \f[C]tenant\f[R] and \f[C]client_secret\f[R] keys instead of setting \f[C]service_principal_file\f[R]. .PP Properties: .IP \[bu] 2 Config: service_principal_file .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-disable-instance-discovery .PP Skip requesting Microsoft Entra instance metadata .PP This should be set true only by applications authenticating in disconnected clouds, or private clouds such as Azure Stack. .PP It determines whether rclone requests Microsoft Entra instance metadata from \f[C]https://login.microsoft.com/\f[R] before authenticating. .PP Setting this to true will skip this request, making you responsible for ensuring the configured authority is valid and trustworthy. .PP Properties: .IP \[bu] 2 Config: disable_instance_discovery .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_DISABLE_INSTANCE_DISCOVERY .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-use-msi .PP Use a managed service identity to authenticate (only works in Azure). .PP When true, use a managed service identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) to authenticate to Azure Storage instead of a SAS token or account key. .PP If the VM(SS) on which this program is running has a system-assigned identity, it will be used by default. If the resource has no system-assigned but exactly one user-assigned identity, the user-assigned identity will be used by default. If the resource has multiple user-assigned identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, msi_client_id, or msi_mi_res_id parameters. .PP Properties: .IP \[bu] 2 Config: use_msi .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_USE_MSI .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-msi-object-id .PP Object ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_client_id or msi_mi_res_id specified. .PP Properties: .IP \[bu] 2 Config: msi_object_id .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-msi-client-id .PP Object ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_object_id or msi_mi_res_id specified. .PP Properties: .IP \[bu] 2 Config: msi_client_id .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-msi-mi-res-id .PP Azure resource ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_client_id or msi_object_id specified. .PP Properties: .IP \[bu] 2 Config: msi_mi_res_id .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-use-emulator .PP Uses local storage emulator if provided as \[aq]true\[aq]. .PP Leave blank if using real azure storage endpoint. .PP Properties: .IP \[bu] 2 Config: use_emulator .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_USE_EMULATOR .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-use-az .PP Use Azure CLI tool az for authentication .PP Set to use the Azure CLI tool az (https://learn.microsoft.com/en-us/cli/azure/) as the sole means of authentication. .PP Setting this can be useful if you wish to use the az CLI on a host with a System Managed Identity that you do not want to use. .PP Don\[aq]t set env_auth at the same time. .PP Properties: .IP \[bu] 2 Config: use_az .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_USE_AZ .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-endpoint .PP Endpoint for the service. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-upload-cutoff .PP Cutoff for switching to chunked upload (<= 256 MiB) (deprecated). .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-chunk-size .PP Upload chunk size. .PP Note that this is stored in memory and there may be up to \[dq]--transfers\[dq] * \[dq]--azureblob-upload-concurrency\[dq] chunks stored at once in memory. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4Mi .SS --azureblob-upload-concurrency .PP Concurrency for multipart uploads. .PP This is the number of chunks of the same file that are uploaded concurrently. .PP 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. .PP In tests, upload speed increases almost linearly with upload concurrency. For example to fill a gigabit pipe it may be necessary to raise this to 64. Note that this will use more memory. .PP Note that chunks are stored in memory and there may be up to \[dq]--transfers\[dq] * \[dq]--azureblob-upload-concurrency\[dq] chunks stored at once in memory. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 16 .SS --azureblob-list-chunk .PP Size of blob list. .PP This sets the number of blobs requested in each listing chunk. Default is the maximum, 5000. \[dq]List blobs\[dq] requests are permitted 2 minutes per megabyte to complete. If an operation is taking longer than 2 minutes per megabyte on average, it will time out ( source (https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval) ). This can be used to limit the number of blobs items to return, to avoid the time out. .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 5000 .SS --azureblob-access-tier .PP Access tier of blob: hot, cool, cold or archive. .PP Archived blobs can be restored by setting access tier to hot, cool or cold. Leave blank if you intend to use default access tier, which is set at account level .PP If there is no \[dq]access tier\[dq] specified, rclone doesn\[aq]t apply any tier. rclone performs \[dq]Set Tier\[dq] operation on blobs while uploading, if objects are not modified, specifying \[dq]access tier\[dq] to new one will have no effect. If blobs are in \[dq]archive tier\[dq] at remote, trying to perform data transfer operations from remote will not be allowed. User should first restore by tiering blob to \[dq]Hot\[dq], \[dq]Cool\[dq] or \[dq]Cold\[dq]. .PP Properties: .IP \[bu] 2 Config: access_tier .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ACCESS_TIER .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azureblob-archive-tier-delete .PP Delete archive tier blobs before overwriting. .PP Archive tier blobs cannot be updated. So without this flag, if you attempt to update an archive tier blob, then rclone will produce the error: .IP .nf \f[C] can\[aq]t update archive tier blob without --azureblob-archive-tier-delete \f[R] .fi .PP With this flag set then before rclone attempts to overwrite an archive tier blob, it will delete the existing blob before uploading its replacement. This has the potential for data loss if the upload fails (unlike updating a normal blob) and also may cost more since deleting archive tier blobs early may be chargable. .PP Properties: .IP \[bu] 2 Config: archive_tier_delete .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-disable-checksum .PP Don\[aq]t store MD5 checksum with object metadata. .PP 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. .PP Properties: .IP \[bu] 2 Config: disable_checksum .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_DISABLE_CHECKSUM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-memory-pool-flush-time .PP How often internal memory buffer pools will be flushed. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_flush_time .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --azureblob-memory-pool-use-mmap .PP Whether to use mmap buffers in internal memory pool. (no longer used) .PP Properties: .IP \[bu] 2 Config: memory_pool_use_mmap .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 .SS --azureblob-public-access .PP Public access level of a container: blob or container. .PP Properties: .IP \[bu] 2 Config: public_access .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_PUBLIC_ACCESS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 The container and its blobs can be accessed only with an authorized request. .IP \[bu] 2 It\[aq]s a default value. .RE .IP \[bu] 2 \[dq]blob\[dq] .RS 2 .IP \[bu] 2 Blob data within this container can be read via anonymous request. .RE .IP \[bu] 2 \[dq]container\[dq] .RS 2 .IP \[bu] 2 Allow full public read access for container and blob data. .RE .RE .SS --azureblob-directory-markers .PP Upload an empty object with a trailing slash when a new directory is created .PP Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with \[dq]/\[dq], to persist the folder. .PP This object also has the metadata \[dq]hdi_isfolder = true\[dq] to conform to the Microsoft standard. .PP Properties: .IP \[bu] 2 Config: directory_markers .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_DIRECTORY_MARKERS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-no-check-container .PP If set, don\[aq]t attempt to check the container exists or create it. .PP This can be useful when trying to minimise the number of transactions rclone does if you know the container exists already. .PP Properties: .IP \[bu] 2 Config: no_check_container .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_NO_CHECK_CONTAINER .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-no-head-object .PP If set, do not do HEAD before GET when getting objects. .PP Properties: .IP \[bu] 2 Config: no_head_object .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_NO_HEAD_OBJECT .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azureblob-delete-snapshots .PP Set to specify how to deal with snapshots on blob deletion. .PP Properties: .IP \[bu] 2 Config: delete_snapshots .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_DELETE_SNAPSHOTS .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Choices: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 By default, the delete operation fails if a blob has snapshots .RE .IP \[bu] 2 \[dq]include\[dq] .RS 2 .IP \[bu] 2 Specify \[aq]include\[aq] to remove the root blob and all its snapshots .RE .IP \[bu] 2 \[dq]only\[dq] .RS 2 .IP \[bu] 2 Specify \[aq]only\[aq] to remove only the snapshots but keep the root blob. .RE .RE .SS --azureblob-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Custom upload headers .PP You can set custom upload headers with the \f[C]--header-upload\f[R] flag. .IP \[bu] 2 Cache-Control .IP \[bu] 2 Content-Disposition .IP \[bu] 2 Content-Encoding .IP \[bu] 2 Content-Language .IP \[bu] 2 Content-Type .PP Eg \f[C]--header-upload \[dq]Content-Type: text/potato\[dq]\f[R] .SS Limitations .PP MD5 sums are only uploaded with chunked files if the source has an MD5 sum. This will always be the case for a local to azure copy. .PP \f[C]rclone about\f[R] is not supported by the Microsoft Azure Blob storage backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SS Azure Storage Emulator Support .PP You can run rclone with the storage emulator (usually \f[I]azurite\f[R]). .PP To do this, just set up a new remote with \f[C]rclone config\f[R] following the instructions in the introduction and set \f[C]use_emulator\f[R] in the advanced settings as \f[C]true\f[R]. You do not need to provide a default account name nor an account key. But you can override them in the \f[C]account\f[R] and \f[C]key\f[R] options. (Prior to v1.61 they were hard coded to \f[I]azurite\f[R]\[aq]s \f[C]devstoreaccount1\f[R].) .PP Also, if you want to access a storage emulator instance running on a different machine, you can override the \f[C]endpoint\f[R] parameter in the advanced settings, setting it to \f[C]http(s)://<host>:<port>/devstoreaccount1\f[R] (e.g. \f[C]http://10.254.2.5:10000/devstoreaccount1\f[R]). .SH Microsoft Azure Files Storage .PP Paths are specified as \f[C]remote:\f[R] You may put subdirectories in too, e.g. \f[C]remote:path/to/dir\f[R]. .SS Configuration .PP Here is an example of making a Microsoft Azure Files Storage configuration. For a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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 / Microsoft Azure Files Storage \[rs] \[dq]azurefiles\[dq] [snip] Option account. Azure Storage Account Name. Set this to the Azure Storage Account Name in use. Leave blank to use SAS URL or connection string, otherwise it needs to be set. If this is blank and if env_auth is set it will be read from the environment variable \[ga]AZURE_STORAGE_ACCOUNT_NAME\[ga] if possible. Enter a value. Press Enter to leave empty. account> account_name Option share_name. Azure Files Share Name. This is required and is the name of the share to access. Enter a value. Press Enter to leave empty. share_name> share_name Option env_auth. Read credentials from runtime (environment variables, CLI or MSI). See the [authentication docs](/azurefiles#authentication) for full info. Enter a boolean value (true or false). Press Enter for the default (false). env_auth> Option key. Storage Account Shared Key. Leave blank to use SAS URL or connection string. Enter a value. Press Enter to leave empty. key> base64encodedkey== Option sas_url. SAS URL. Leave blank if using account/key or connection string. Enter a value. Press Enter to leave empty. sas_url> Option connection_string. Azure Files Connection String. Enter a value. Press Enter to leave empty. connection_string> [snip] Configuration complete. Options: - type: azurefiles - account: account_name - share_name: share_name - key: base64encodedkey== Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> \f[R] .fi .PP Once configured you can use rclone. .PP See all files in the top level: .IP .nf \f[C] rclone lsf remote: \f[R] .fi .PP Make a new directory in the root: .IP .nf \f[C] rclone mkdir remote:dir \f[R] .fi .PP Recursively List the contents: .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote directory, deleting any excess files in the directory. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:dir \f[R] .fi .SS Modified time .PP The modified time is stored as Azure standard \f[C]LastModified\f[R] time on files .SS Performance .PP When uploading large files, increasing the value of \f[C]--azurefiles-upload-concurrency\f[R] will increase performance at the cost of using more memory. The default of 16 is set quite conservatively to use less memory. It maybe be necessary raise it to 64 or higher to fully utilize a 1 GBit/s link with a single file transfer. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \&. T}@T{ 0x2E T}@T{ \[uFF0E] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Hashes .PP MD5 hashes are stored with files. Not all files will have MD5 hashes as these have to be uploaded with the file. .SS Authentication .PP There are a number of ways of supplying credentials for Azure Files Storage. Rclone tries them in the order of the sections below. .SS Env Auth .PP If the \f[C]env_auth\f[R] config parameter is \f[C]true\f[R] then rclone will pull credentials from the environment or runtime. .PP It tries these authentication methods in this order: .IP "1." 3 Environment Variables .IP "2." 3 Managed Service Identity Credentials .IP "3." 3 Azure CLI credentials (as used by the az tool) .PP These are described in the following sections .SS Env Auth: 1. Environment Variables .PP If \f[C]env_auth\f[R] is set and environment variables are present rclone authenticates a service principal with a secret or certificate, or a user with a password, depending on which environment variable are set. It reads configuration from these variables, in the following order: .IP "1." 3 Service principal with client secret .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]AZURE_CLIENT_SECRET\f[R]: one of the service principal\[aq]s client secrets .RE .IP "2." 3 Service principal with certificate .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]AZURE_CLIENT_CERTIFICATE_PATH\f[R]: path to a PEM or PKCS12 certificate file including the private key. .IP \[bu] 2 \f[C]AZURE_CLIENT_CERTIFICATE_PASSWORD\f[R]: (optional) password for the certificate file. .IP \[bu] 2 \f[C]AZURE_CLIENT_SEND_CERTIFICATE_CHAIN\f[R]: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to \[dq]true\[dq] or \[dq]1\[dq], authentication requests include the x5c header. .RE .IP "3." 3 User with username and password .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: (optional) tenant to authenticate in. Defaults to \[dq]organizations\[dq]. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: client ID of the application the user will authenticate to .IP \[bu] 2 \f[C]AZURE_USERNAME\f[R]: a username (usually an email address) .IP \[bu] 2 \f[C]AZURE_PASSWORD\f[R]: the user\[aq]s password .RE .IP "4." 3 Workload Identity .RS 4 .IP \[bu] 2 \f[C]AZURE_TENANT_ID\f[R]: Tenant to authenticate in. .IP \[bu] 2 \f[C]AZURE_CLIENT_ID\f[R]: Client ID of the application the user will authenticate to. .IP \[bu] 2 \f[C]AZURE_FEDERATED_TOKEN_FILE\f[R]: Path to projected service account token file. .IP \[bu] 2 \f[C]AZURE_AUTHORITY_HOST\f[R]: Authority of an Azure Active Directory endpoint (default: login.microsoftonline.com). .RE .SS Env Auth: 2. Managed Service Identity Credentials .PP When using Managed Service Identity if the VM(SS) on which this program is running has a system-assigned identity, it will be used by default. If the resource has no system-assigned but exactly one user-assigned identity, the user-assigned identity will be used by default. .PP If the resource has multiple user-assigned identities you will need to unset \f[C]env_auth\f[R] and set \f[C]use_msi\f[R] instead. See the \f[C]use_msi\f[R] section. .SS Env Auth: 3. Azure CLI credentials (as used by the az tool) .PP Credentials created with the \f[C]az\f[R] tool can be picked up using \f[C]env_auth\f[R]. .PP For example if you were to login with a service principal like this: .IP .nf \f[C] az login --service-principal -u XXX -p XXX --tenant XXX \f[R] .fi .PP Then you could access rclone resources like this: .IP .nf \f[C] rclone lsf :azurefiles,env_auth,account=ACCOUNT: \f[R] .fi .PP Or .IP .nf \f[C] rclone lsf --azurefiles-env-auth --azurefiles-account=ACCOUNT :azurefiles: \f[R] .fi .SS Account and Shared Key .PP This is the most straight forward and least flexible way. Just fill in the \f[C]account\f[R] and \f[C]key\f[R] lines and leave the rest blank. .SS SAS URL .PP To use it leave \f[C]account\f[R], \f[C]key\f[R] and \f[C]connection_string\f[R] blank and fill in \f[C]sas_url\f[R]. .SS Connection String .PP To use it leave \f[C]account\f[R], \f[C]key\f[R] and \[dq]sas_url\[dq] blank and fill in \f[C]connection_string\f[R]. .SS Service principal with client secret .PP If these variables are set, rclone will authenticate with a service principal with a client secret. .IP \[bu] 2 \f[C]tenant\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]client_id\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]client_secret\f[R]: one of the service principal\[aq]s client secrets .PP The credentials can also be placed in a file using the \f[C]service_principal_file\f[R] configuration option. .SS Service principal with certificate .PP If these variables are set, rclone will authenticate with a service principal with certificate. .IP \[bu] 2 \f[C]tenant\f[R]: ID of the service principal\[aq]s tenant. Also called its \[dq]directory\[dq] ID. .IP \[bu] 2 \f[C]client_id\f[R]: the service principal\[aq]s client ID .IP \[bu] 2 \f[C]client_certificate_path\f[R]: path to a PEM or PKCS12 certificate file including the private key. .IP \[bu] 2 \f[C]client_certificate_password\f[R]: (optional) password for the certificate file. .IP \[bu] 2 \f[C]client_send_certificate_chain\f[R]: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to \[dq]true\[dq] or \[dq]1\[dq], authentication requests include the x5c header. .PP \f[B]NB\f[R] \f[C]client_certificate_password\f[R] must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .SS User with username and password .PP If these variables are set, rclone will authenticate with username and password. .IP \[bu] 2 \f[C]tenant\f[R]: (optional) tenant to authenticate in. Defaults to \[dq]organizations\[dq]. .IP \[bu] 2 \f[C]client_id\f[R]: client ID of the application the user will authenticate to .IP \[bu] 2 \f[C]username\f[R]: a username (usually an email address) .IP \[bu] 2 \f[C]password\f[R]: the user\[aq]s password .PP Microsoft doesn\[aq]t recommend this kind of authentication, because it\[aq]s less secure than other authentication flows. This method is not interactive, so it isn\[aq]t compatible with any form of multi-factor authentication, and the application must already have user or admin consent. This credential can only authenticate work and school accounts; it can\[aq]t authenticate Microsoft accounts. .PP \f[B]NB\f[R] \f[C]password\f[R] must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .SS Managed Service Identity Credentials .PP If \f[C]use_msi\f[R] is set then managed service identity credentials are used. This authentication only works when running in an Azure service. \f[C]env_auth\f[R] needs to be unset to use this. .PP However if you have multiple user identities to choose from these must be explicitly specified using exactly one of the \f[C]msi_object_id\f[R], \f[C]msi_client_id\f[R], or \f[C]msi_mi_res_id\f[R] parameters. .PP If none of \f[C]msi_object_id\f[R], \f[C]msi_client_id\f[R], or \f[C]msi_mi_res_id\f[R] is set, this is is equivalent to using \f[C]env_auth\f[R]. .SS Standard options .PP Here are the Standard options specific to azurefiles (Microsoft Azure Files). .SS --azurefiles-account .PP Azure Storage Account Name. .PP Set this to the Azure Storage Account Name in use. .PP Leave blank to use SAS URL or connection string, otherwise it needs to be set. .PP If this is blank and if env_auth is set it will be read from the environment variable \f[C]AZURE_STORAGE_ACCOUNT_NAME\f[R] if possible. .PP Properties: .IP \[bu] 2 Config: account .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_ACCOUNT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-share-name .PP Azure Files Share Name. .PP This is required and is the name of the share to access. .PP Properties: .IP \[bu] 2 Config: share_name .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_SHARE_NAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-env-auth .PP Read credentials from runtime (environment variables, CLI or MSI). .PP See the authentication docs for full info. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azurefiles-key .PP Storage Account Shared Key. .PP Leave blank to use SAS URL or connection string. .PP Properties: .IP \[bu] 2 Config: key .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-sas-url .PP SAS URL. .PP Leave blank if using account/key or connection string. .PP Properties: .IP \[bu] 2 Config: sas_url .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_SAS_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-connection-string .PP Azure Files Connection String. .PP Properties: .IP \[bu] 2 Config: connection_string .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CONNECTION_STRING .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-tenant .PP ID of the service principal\[aq]s tenant. Also called its directory ID. .PP Set this if using - Service principal with client secret - Service principal with certificate - User with username and password .PP Properties: .IP \[bu] 2 Config: tenant .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_TENANT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-client-id .PP The ID of the client in use. .PP Set this if using - Service principal with client secret - Service principal with certificate - User with username and password .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-client-secret .PP One of the service principal\[aq]s client secrets .PP Set this if using - Service principal with client secret .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-client-certificate-path .PP Path to a PEM or PKCS12 certificate file including the private key. .PP Set this if using - Service principal with certificate .PP Properties: .IP \[bu] 2 Config: client_certificate_path .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CLIENT_CERTIFICATE_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-client-certificate-password .PP Password for the certificate file (optional). .PP Optionally set this if using - Service principal with certificate .PP And the certificate has a password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: client_certificate_password .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CLIENT_CERTIFICATE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to azurefiles (Microsoft Azure Files). .SS --azurefiles-client-send-certificate-chain .PP Send the certificate chain when using certificate auth. .PP Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to true, authentication requests include the x5c header. .PP Optionally set this if using - Service principal with certificate .PP Properties: .IP \[bu] 2 Config: client_send_certificate_chain .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CLIENT_SEND_CERTIFICATE_CHAIN .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azurefiles-username .PP User name (usually an email address) .PP Set this if using - User with username and password .PP Properties: .IP \[bu] 2 Config: username .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-password .PP The user\[aq]s password .PP Set this if using - User with username and password .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-service-principal-file .PP Path to file containing credentials for use with a service principal. .PP Leave blank normally. Needed only if you want to use a service principal instead of interactive login. .IP .nf \f[C] $ az ad sp create-for-rbac --name \[dq]<name>\[dq] \[rs] --role \[dq]Storage Files Data Owner\[dq] \[rs] --scopes \[dq]/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account>/blobServices/default/containers/<container>\[dq] \[rs] > azure-principal.json \f[R] .fi .PP See \[dq]Create an Azure service principal\[dq] (https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and \[dq]Assign an Azure role for access to files data\[dq] (https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details. .PP \f[B]NB\f[R] this section needs updating for Azure Files - pull requests appreciated! .PP It may be more convenient to put the credentials directly into the rclone config file under the \f[C]client_id\f[R], \f[C]tenant\f[R] and \f[C]client_secret\f[R] keys instead of setting \f[C]service_principal_file\f[R]. .PP Properties: .IP \[bu] 2 Config: service_principal_file .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_SERVICE_PRINCIPAL_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-use-msi .PP Use a managed service identity to authenticate (only works in Azure). .PP When true, use a managed service identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) to authenticate to Azure Storage instead of a SAS token or account key. .PP If the VM(SS) on which this program is running has a system-assigned identity, it will be used by default. If the resource has no system-assigned but exactly one user-assigned identity, the user-assigned identity will be used by default. If the resource has multiple user-assigned identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, msi_client_id, or msi_mi_res_id parameters. .PP Properties: .IP \[bu] 2 Config: use_msi .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_USE_MSI .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --azurefiles-msi-object-id .PP Object ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_client_id or msi_mi_res_id specified. .PP Properties: .IP \[bu] 2 Config: msi_object_id .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_MSI_OBJECT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-msi-client-id .PP Object ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_object_id or msi_mi_res_id specified. .PP Properties: .IP \[bu] 2 Config: msi_client_id .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_MSI_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-msi-mi-res-id .PP Azure resource ID of the user-assigned MSI to use, if any. .PP Leave blank if msi_client_id or msi_object_id specified. .PP Properties: .IP \[bu] 2 Config: msi_mi_res_id .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_MSI_MI_RES_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-endpoint .PP Endpoint for the service. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --azurefiles-chunk-size .PP Upload chunk size. .PP Note that this is stored in memory and there may be up to \[dq]--transfers\[dq] * \[dq]--azurefile-upload-concurrency\[dq] chunks stored at once in memory. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4Mi .SS --azurefiles-upload-concurrency .PP Concurrency for multipart uploads. .PP This is the number of chunks of the same file that are uploaded concurrently. .PP 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. .PP Note that chunks are stored in memory and there may be up to \[dq]--transfers\[dq] * \[dq]--azurefile-upload-concurrency\[dq] chunks stored at once in memory. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 16 .SS --azurefiles-max-stream-size .PP Max size for streamed files. .PP Azure files needs to know in advance how big the file will be. When rclone doesn\[aq]t know it uses this value instead. .PP This will be used when rclone is streaming data, the most common uses are: .IP \[bu] 2 Uploading files with \f[C]--vfs-cache-mode off\f[R] with \f[C]rclone mount\f[R] .IP \[bu] 2 Using \f[C]rclone rcat\f[R] .IP \[bu] 2 Copying files with unknown length .PP You will need this much free space in the share as the file will be this size temporarily. .PP Properties: .IP \[bu] 2 Config: max_stream_size .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_MAX_STREAM_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Gi .SS --azurefiles-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot .SS --azurefiles-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_AZUREFILES_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Custom upload headers .PP You can set custom upload headers with the \f[C]--header-upload\f[R] flag. .IP \[bu] 2 Cache-Control .IP \[bu] 2 Content-Disposition .IP \[bu] 2 Content-Encoding .IP \[bu] 2 Content-Language .IP \[bu] 2 Content-Type .PP Eg \f[C]--header-upload \[dq]Content-Type: text/potato\[dq]\f[R] .SS Limitations .PP MD5 sums are only uploaded with chunked files if the source has an MD5 sum. This will always be the case for a local to azure copy. .SH Microsoft OneDrive .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] XX / Microsoft OneDrive \[rs] \[dq]onedrive\[dq] [snip] Storage> onedrive Microsoft App Client Id Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). client_id> Microsoft App Client Secret Leave blank normally. Enter a string value. Press Enter for the default (\[dq]\[dq]). client_secret> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config 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 n) No y/n> y If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Choose a number from below, or type in an existing value 1 / OneDrive Personal or Business \[rs] \[dq]onedrive\[dq] 2 / Sharepoint site \[rs] \[dq]sharepoint\[dq] 3 / Type in driveID \[rs] \[dq]driveid\[dq] 4 / Type in SiteID \[rs] \[dq]siteid\[dq] 5 / Search a Sharepoint site \[rs] \[dq]search\[dq] Your choice> 1 Found 1 drives, please select the one you want to use: 0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk Chose drive to use:> 0 Found drive \[aq]root\[aq] of type \[aq]business\[aq], URL: https://org-my.sharepoint.com/personal/you/Documents Is that okay? y) Yes n) No y/n> y Configuration complete. Options: - type: onedrive - token: {\[dq]access_token\[dq]:\[dq]youraccesstoken\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]yourrefreshtoken\[dq],\[dq]expiry\[dq]:\[dq]2018-08-26T22:39:52.486512262+08:00\[dq]} - drive_id: b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk - drive_type: business Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See the remote setup docs (https://rclone.org/remote_setup/) for how to set it up on a machine with no Internet browser available. .PP Note that rclone runs a webserver on your local machine to collect the token as returned from Microsoft. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you to unblock it temporarily if you are running a host firewall. .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your OneDrive .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your OneDrive .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an OneDrive directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Getting your own Client ID and Key .PP rclone uses a default Client ID when talking to OneDrive, unless a custom \f[C]client_id\f[R] is specified in the config. The default Client ID and Key are shared by all rclone users when performing requests. .PP You may choose to create and use your own Client ID, in case the default one does not work well for you. For example, you might see throttling. .SS Creating Client ID for OneDrive Personal .PP To create your own Client ID, please follow these steps: .IP "1." 3 Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and then click \f[C]New registration\f[R]. .IP "2." 3 Enter a name for your app, choose account type \f[C]Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)\f[R], select \f[C]Web\f[R] in \f[C]Redirect URI\f[R], then type (do not copy and paste) \f[C]http://localhost:53682/\f[R] and click Register. Copy and keep the \f[C]Application (client) ID\f[R] under the app name for later use. .IP "3." 3 Under \f[C]manage\f[R] select \f[C]Certificates & secrets\f[R], click \f[C]New client secret\f[R]. Enter a description (can be anything) and set \f[C]Expires\f[R] to 24 months. Copy and keep that secret \f[I]Value\f[R] for later use (you \f[I]won\[aq]t\f[R] be able to see this value afterwards). .IP "4." 3 Under \f[C]manage\f[R] select \f[C]API permissions\f[R], click \f[C]Add a permission\f[R] and select \f[C]Microsoft Graph\f[R] then select \f[C]delegated permissions\f[R]. .IP "5." 3 Search and select the following permissions: \f[C]Files.Read\f[R], \f[C]Files.ReadWrite\f[R], \f[C]Files.Read.All\f[R], \f[C]Files.ReadWrite.All\f[R], \f[C]offline_access\f[R], \f[C]User.Read\f[R] and \f[C]Sites.Read.All\f[R] (if custom access scopes are configured, select the permissions accordingly). Once selected click \f[C]Add permissions\f[R] at the bottom. .PP Now the application is complete. Run \f[C]rclone config\f[R] to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. .PP The access_scopes option allows you to configure the permissions requested by rclone. See Microsoft Docs (https://docs.microsoft.com/en-us/graph/permissions-reference#files-permissions) for more information about the different scopes. .PP The \f[C]Sites.Read.All\f[R] permission is required if you need to search SharePoint sites when configuring the remote (https://github.com/rclone/rclone/pull/5883). However, if that permission is not assigned, you need to exclude \f[C]Sites.Read.All\f[R] from your access scopes or set \f[C]disable_site_permission\f[R] option to true in the advanced options. .SS Creating Client ID for OneDrive Business .PP The steps for OneDrive Personal may or may not work for OneDrive Business, depending on the security settings of the organization. A common error is that the publisher of the App is not verified. .PP You may try to verify you account (https://docs.microsoft.com/en-us/azure/active-directory/develop/publisher-verification-overview), or try to limit the App to your organization only, as shown below. .IP "1." 3 Make sure to create the App with your business account. .IP "2." 3 Follow the steps above to create an App. However, we need a different account type here: \f[C]Accounts in this organizational directory only (*** - Single tenant)\f[R]. Note that you can also change the account type after creating the App. .IP "3." 3 Find the tenant ID (https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant) of your organization. .IP "4." 3 In the rclone config, set \f[C]auth_url\f[R] to \f[C]https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/authorize\f[R]. .IP "5." 3 In the rclone config, set \f[C]token_url\f[R] to \f[C]https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/token\f[R]. .PP Note: If you have a special region, you may need a different host in step 4 and 5. Here are some hints (https://github.com/rclone/rclone/blob/bc23bf11db1c78c6ebbf8ea538fbebf7058b4176/backend/onedrive/onedrive.go#L86). .SS Using OAuth Client Credential flow .PP OAuth Client Credential flow will allow rclone to use permissions directly associated with the Azure AD Enterprise application, rather that adopting the context of an Azure AD user account. .PP This flow can be enabled by following the steps below: .IP "1." 3 Create the Enterprise App registration in the Azure AD portal and obtain a Client ID and Client Secret as described above. .IP "2." 3 Ensure that the application has the appropriate permissions and they are assigned as \f[I]Application Permissions\f[R] .IP "3." 3 Configure the remote, ensuring that \f[I]Client ID\f[R] and \f[I]Client Secret\f[R] are entered correctly. .IP "4." 3 In the \f[I]Advanced Config\f[R] section, enter \f[C]true\f[R] for \f[C]client_credentials\f[R] and in the \f[C]tenant\f[R] section enter the tenant ID. .PP When it comes to choosing the type of the connection work with the client credentials flow. In particular the \[dq]onedrive\[dq] option does not work. You can use the \[dq]sharepoint\[dq] option or if that does not find the correct drive ID type it in manually with the \[dq]driveid\[dq] option. .PP \f[B]NOTE\f[R] Assigning permissions directly to the application means that anyone with the \f[I]Client ID\f[R] and \f[I]Client Secret\f[R] can access your OneDrive files. Take care to safeguard these credentials. .SS Modification times and hashes .PP OneDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP OneDrive Personal, OneDrive for Business and Sharepoint Server support QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). .PP Before rclone 1.62 the default hash for Onedrive Personal was \f[C]SHA1\f[R]. For rclone 1.62 and above the default for all Onedrive backends is \f[C]QuickXorHash\f[R]. .PP Starting from July 2023 \f[C]SHA1\f[R] support is being phased out in Onedrive Personal in favour of \f[C]QuickXorHash\f[R]. If necessary the \f[C]--onedrive-hash-type\f[R] flag (or \f[C]hash_type\f[R] config option) can be used to select \f[C]SHA1\f[R] during the transition period if this is important your workflow. .PP For all types of OneDrive you can use the \f[C]--checksum\f[R] flag. .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .PP This must be enabled with the \f[C]--onedrive-delta\f[R] flag (or \f[C]delta = true\f[R] in the config file) as it can cause performance degradation. .PP It does this by using the delta listing facilities of OneDrive which returns all the files in the remote very efficiently. This is much more efficient than listing directories recursively and is Microsoft\[aq]s recommended way of reading all the file information from a drive. .PP This can be useful with \f[C]rclone mount\f[R] and rclone rc vfs/refresh recursive=true (https://rclone.org/rc/#vfs-refresh)) to very quickly fill the mount with information about all the files. .PP The API used for the recursive listing (\f[C]ListR\f[R]) only supports listing from the root of the drive. This will become increasingly inefficient the further away you get from the root as rclone will have to discard files outside of the directory you are using. .PP Some commands (like \f[C]rclone lsf -R\f[R]) will use \f[C]ListR\f[R] by default - you can turn this off with \f[C]--disable ListR\f[R] if you need to. .SS Restricted filename characters .PP In addition to the default restricted characters set (https://rclone.org/overview/#restricted-characters) the following characters are also replaced: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} T{ \&. T}@T{ 0x2E T}@T{ \[uFF0E] T} .TE .PP File names can also not begin with the following characters. These only get replaced if they are the first character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} T{ \[ti] T}@T{ 0x7E T}@T{ \[uFF5E] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Deleting files .PP Any files you delete with rclone will end up in the trash. Microsoft doesn\[aq]t provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft\[aq]s apps or via the OneDrive website. .SS Standard options .PP Here are the Standard options specific to onedrive (Microsoft OneDrive). .SS --onedrive-client-id .PP OAuth Client Id. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_id .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-client-secret .PP OAuth Client Secret. .PP Leave blank normally. .PP Properties: .IP \[bu] 2 Config: client_secret .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-region .PP Choose national cloud region for OneDrive. .PP Properties: .IP \[bu] 2 Config: region .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_REGION .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]global\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]global\[dq] .RS 2 .IP \[bu] 2 Microsoft Cloud Global .RE .IP \[bu] 2 \[dq]us\[dq] .RS 2 .IP \[bu] 2 Microsoft Cloud for US Government .RE .IP \[bu] 2 \[dq]de\[dq] .RS 2 .IP \[bu] 2 Microsoft Cloud Germany (deprecated - try global region first). .RE .IP \[bu] 2 \[dq]cn\[dq] .RS 2 .IP \[bu] 2 Azure and Office 365 operated by Vnet Group in China .RE .RE .SS --onedrive-tenant .PP ID of the service principal\[aq]s tenant. Also called its directory ID. .PP Set this if using - Client Credential flow .PP Properties: .IP \[bu] 2 Config: tenant .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_TENANT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Advanced options .PP Here are the Advanced options specific to onedrive (Microsoft OneDrive). .SS --onedrive-token .PP OAuth Access Token as a JSON blob. .PP Properties: .IP \[bu] 2 Config: token .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-auth-url .PP Auth server URL. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: auth_url .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_AUTH_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-token-url .PP Token server url. .PP Leave blank to use the provider defaults. .PP Properties: .IP \[bu] 2 Config: token_url .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_TOKEN_URL .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-client-credentials .PP Use client credentials OAuth flow. .PP This will use the OAUTH2 client Credentials Flow as described in RFC 6749. .PP Properties: .IP \[bu] 2 Config: client_credentials .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_CLIENT_CREDENTIALS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-chunk-size .PP Chunk size to upload files with - must be multiple of 320k (327,680 bytes). .PP Above this size files will be chunked - must be multiple of 320k (327,680 bytes) and should not exceed 250M (262,144,000 bytes) else you may encounter \[dq]Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big.\[dq] Note that the chunks will be buffered into memory. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Mi .SS --onedrive-drive-id .PP The ID of the drive to use. .PP Properties: .IP \[bu] 2 Config: drive_id .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_DRIVE_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-drive-type .PP The type of the drive (personal | business | documentLibrary). .PP Properties: .IP \[bu] 2 Config: drive_type .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-root-folder-id .PP ID of the root folder. .PP This isn\[aq]t normally needed, but in special circumstances you might know the folder ID that you wish to access but not be able to get there through a path traversal. .PP Properties: .IP \[bu] 2 Config: root_folder_id .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_ROOT_FOLDER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-access-scopes .PP Set scopes to be requested by rclone. .PP Choose or manually enter a custom space separated list with all scopes, that rclone should request. .PP Properties: .IP \[bu] 2 Config: access_scopes .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_ACCESS_SCOPES .IP \[bu] 2 Type: SpaceSepList .IP \[bu] 2 Default: Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access\[dq] .RS 2 .IP \[bu] 2 Read and write access to all resources .RE .IP \[bu] 2 \[dq]Files.Read Files.Read.All Sites.Read.All offline_access\[dq] .RS 2 .IP \[bu] 2 Read only access to all resources .RE .IP \[bu] 2 \[dq]Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All offline_access\[dq] .RS 2 .IP \[bu] 2 Read and write access to all resources, without the ability to browse SharePoint sites. .IP \[bu] 2 Same as if disable_site_permission was set to true .RE .RE .SS --onedrive-disable-site-permission .PP Disable the request for Sites.Read.All permission. .PP If set to true, you will no longer be able to search for a SharePoint site when configuring drive ID, because rclone will not request Sites.Read.All permission. Set it to true if your organization didn\[aq]t assign Sites.Read.All permission to the application, and your organization disallows users to consent app permission request on their own. .PP Properties: .IP \[bu] 2 Config: disable_site_permission .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_DISABLE_SITE_PERMISSION .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-expose-onenote-files .PP Set to make OneNote files show up in directory listings. .PP By default, rclone will hide OneNote files in directory listings because operations like \[dq]Open\[dq] and \[dq]Update\[dq] won\[aq]t work on them. But this behaviour may also prevent you from deleting them. If you want to delete OneNote files or otherwise want them to show up in directory listing, set this option. .PP Properties: .IP \[bu] 2 Config: expose_onenote_files .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-server-side-across-configs .PP Deprecated: use --server-side-across-configs instead. .PP Allow server-side operations (e.g. copy) to work across different onedrive configs. .PP This will work if you are copying between two OneDrive \f[I]Personal\f[R] drives AND the files to copy are already shared between them. Additionally, it should also function for a user who has access permissions both between Onedrive for \f[I]business\f[R] and \f[I]SharePoint\f[R] under the \f[I]same tenant\f[R], and between \f[I]SharePoint\f[R] and another \f[I]SharePoint\f[R] under the \f[I]same tenant\f[R]. In other cases, rclone will fall back to normal copy (which will be slightly slower). .PP Properties: .IP \[bu] 2 Config: server_side_across_configs .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-list-chunk .PP Size of listing chunk. .PP Properties: .IP \[bu] 2 Config: list_chunk .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_LIST_CHUNK .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 1000 .SS --onedrive-no-versions .PP Remove all versions on modifying operations. .PP Onedrive for business creates versions when rclone uploads new files overwriting an existing one and when it sets the modification time. .PP These versions take up space out of the quota. .PP This flag checks for versions after file upload and setting modification time and removes all but the last version. .PP \f[B]NB\f[R] Onedrive personal can\[aq]t currently delete versions so don\[aq]t use this flag there. .PP Properties: .IP \[bu] 2 Config: no_versions .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_NO_VERSIONS .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-hard-delete .PP Permanently delete files on removal. .PP Normally files will get sent to the recycle bin on deletion. Setting this flag causes them to be permanently deleted. Use with care. .PP OneDrive personal accounts do not support the permanentDelete API, it only applies to OneDrive for Business and SharePoint document libraries. .PP Properties: .IP \[bu] 2 Config: hard_delete .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_HARD_DELETE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-link-scope .PP Set the scope of the links created by the link command. .PP Properties: .IP \[bu] 2 Config: link_scope .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_LINK_SCOPE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]anonymous\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]anonymous\[dq] .RS 2 .IP \[bu] 2 Anyone with the link has access, without needing to sign in. .IP \[bu] 2 This may include people outside of your organization. .IP \[bu] 2 Anonymous link support may be disabled by an administrator. .RE .IP \[bu] 2 \[dq]organization\[dq] .RS 2 .IP \[bu] 2 Anyone signed into your organization (tenant) can use the link to get access. .IP \[bu] 2 Only available in OneDrive for Business and SharePoint. .RE .RE .SS --onedrive-link-type .PP Set the type of the links created by the link command. .PP Properties: .IP \[bu] 2 Config: link_type .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_LINK_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]view\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]view\[dq] .RS 2 .IP \[bu] 2 Creates a read-only link to the item. .RE .IP \[bu] 2 \[dq]edit\[dq] .RS 2 .IP \[bu] 2 Creates a read-write link to the item. .RE .IP \[bu] 2 \[dq]embed\[dq] .RS 2 .IP \[bu] 2 Creates an embeddable link to the item. .RE .RE .SS --onedrive-link-password .PP Set the password for links created by the link command. .PP At the time of writing this only works with OneDrive personal paid accounts. .PP Properties: .IP \[bu] 2 Config: link_password .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --onedrive-hash-type .PP Specify the hash in use for the backend. .PP This specifies the hash type in use. If set to \[dq]auto\[dq] it will use the default hash which is QuickXorHash. .PP Before rclone 1.62 an SHA1 hash was used by default for Onedrive Personal. For 1.62 and later the default is to use a QuickXorHash for all onedrive types. If an SHA1 hash is desired then set this option accordingly. .PP From July 2023 QuickXorHash will be the only available hash for both OneDrive for Business and OneDrive Personal. .PP This can be set to \[dq]none\[dq] to not use any hashes. .PP If the hash requested does not exist on the object, it will be returned as an empty string which is treated as a missing hash by rclone. .PP Properties: .IP \[bu] 2 Config: hash_type .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_HASH_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]auto\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]auto\[dq] .RS 2 .IP \[bu] 2 Rclone chooses the best hash .RE .IP \[bu] 2 \[dq]quickxor\[dq] .RS 2 .IP \[bu] 2 QuickXor .RE .IP \[bu] 2 \[dq]sha1\[dq] .RS 2 .IP \[bu] 2 SHA1 .RE .IP \[bu] 2 \[dq]sha256\[dq] .RS 2 .IP \[bu] 2 SHA256 .RE .IP \[bu] 2 \[dq]crc32\[dq] .RS 2 .IP \[bu] 2 CRC32 .RE .IP \[bu] 2 \[dq]none\[dq] .RS 2 .IP \[bu] 2 None - don\[aq]t use any hashes .RE .RE .SS --onedrive-av-override .PP Allows download of files the server thinks has a virus. .PP The onedrive/sharepoint server may check files uploaded with an Anti Virus checker. If it detects any potential viruses or malware it will block download of the file. .PP In this case you will see a message like this .IP .nf \f[C] server reports this file is infected with a virus - use --onedrive-av-override to download anyway: Infected (name of virus): 403 Forbidden: \f[R] .fi .PP If you are 100% sure you want to download this file anyway then use the --onedrive-av-override flag, or av_override = true in the config file. .PP Properties: .IP \[bu] 2 Config: av_override .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_AV_OVERRIDE .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-delta .PP If set rclone will use delta listing to implement recursive listings. .PP If this flag is set the onedrive backend will advertise \f[C]ListR\f[R] support for recursive listings. .PP Setting this flag speeds up these things greatly: .IP .nf \f[C] rclone lsf -R onedrive: rclone size onedrive: rclone rc vfs/refresh recursive=true \f[R] .fi .PP \f[B]However\f[R] the delta listing API \f[B]only\f[R] works at the root of the drive. If you use it not at the root then it recurses from the root and discards all the data that is not under the directory you asked for. So it will be correct but may not be very efficient. .PP This is why this flag is not set as the default. .PP As a rule of thumb if nearly all of your data is under rclone\[aq]s root directory (the \f[C]root/directory\f[R] in \f[C]onedrive:root/directory\f[R]) then using this flag will be be a big performance win. If your data is mostly not under the root then using this flag will be a big performance loss. .PP It is recommended if you are mounting your onedrive at the root (or near the root when using crypt) and using rclone \f[C]rc vfs/refresh\f[R]. .PP Properties: .IP \[bu] 2 Config: delta .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_DELTA .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --onedrive-metadata-permissions .PP Control whether permissions should be read or written in metadata. .PP Reading permissions metadata from files can be done quickly, but it isn\[aq]t always desirable to set the permissions from the metadata. .PP Properties: .IP \[bu] 2 Config: metadata_permissions .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_METADATA_PERMISSIONS .IP \[bu] 2 Type: Bits .IP \[bu] 2 Default: off .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]off\[dq] .RS 2 .IP \[bu] 2 Do not read or write the value .RE .IP \[bu] 2 \[dq]read\[dq] .RS 2 .IP \[bu] 2 Read the value only .RE .IP \[bu] 2 \[dq]write\[dq] .RS 2 .IP \[bu] 2 Write the value only .RE .IP \[bu] 2 \[dq]read,write\[dq] .RS 2 .IP \[bu] 2 Read and Write the value. .RE .IP \[bu] 2 \[dq]failok\[dq] .RS 2 .IP \[bu] 2 If writing fails log errors only, don\[aq]t fail the transfer .RE .RE .SS --onedrive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot .SS --onedrive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_ONEDRIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Metadata .PP OneDrive supports System Metadata (not User Metadata, as of this writing) for both files and directories. Much of the metadata is read-only, and there are some differences between OneDrive Personal and Business (see table below for details). .PP Permissions are also supported, if \f[C]--onedrive-metadata-permissions\f[R] is set. The accepted values for \f[C]--onedrive-metadata-permissions\f[R] are \[dq]\f[C]read\f[R]\[dq], \[dq]\f[C]write\f[R]\[dq], \[dq]\f[C]read,write\f[R]\[dq], and \[dq]\f[C]off\f[R]\[dq] (the default). \[dq]\f[C]write\f[R]\[dq] supports adding new permissions, updating the \[dq]role\[dq] of existing permissions, and removing permissions. Updating and removing require the Permission ID to be known, so it is recommended to use \[dq]\f[C]read,write\f[R]\[dq] instead of \[dq]\f[C]write\f[R]\[dq] if you wish to update/remove permissions. .PP Permissions are read/written in JSON format using the same schema as the OneDrive API (https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online), which differs slightly between OneDrive Personal and Business. .PP Example for OneDrive Personal: .IP .nf \f[C] [ { \[dq]id\[dq]: \[dq]1234567890ABC!123\[dq], \[dq]grantedTo\[dq]: { \[dq]user\[dq]: { \[dq]id\[dq]: \[dq]ryan\[at]contoso.com\[dq] }, \[dq]application\[dq]: {}, \[dq]device\[dq]: {} }, \[dq]invitation\[dq]: { \[dq]email\[dq]: \[dq]ryan\[at]contoso.com\[dq] }, \[dq]link\[dq]: { \[dq]webUrl\[dq]: \[dq]https://1drv.ms/t/s!1234567890ABC\[dq] }, \[dq]roles\[dq]: [ \[dq]read\[dq] ], \[dq]shareId\[dq]: \[dq]s!1234567890ABC\[dq] } ] \f[R] .fi .PP Example for OneDrive Business: .IP .nf \f[C] [ { \[dq]id\[dq]: \[dq]48d31887-5fad-4d73-a9f5-3c356e68a038\[dq], \[dq]grantedToIdentities\[dq]: [ { \[dq]user\[dq]: { \[dq]displayName\[dq]: \[dq]ryan\[at]contoso.com\[dq] }, \[dq]application\[dq]: {}, \[dq]device\[dq]: {} } ], \[dq]link\[dq]: { \[dq]type\[dq]: \[dq]view\[dq], \[dq]scope\[dq]: \[dq]users\[dq], \[dq]webUrl\[dq]: \[dq]https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s\[dq] }, \[dq]roles\[dq]: [ \[dq]read\[dq] ], \[dq]shareId\[dq]: \[dq]u!LKj1lkdlals90j1nlkascl\[dq] }, { \[dq]id\[dq]: \[dq]5D33DD65C6932946\[dq], \[dq]grantedTo\[dq]: { \[dq]user\[dq]: { \[dq]displayName\[dq]: \[dq]John Doe\[dq], \[dq]id\[dq]: \[dq]efee1b77-fb3b-4f65-99d6-274c11914d12\[dq] }, \[dq]application\[dq]: {}, \[dq]device\[dq]: {} }, \[dq]roles\[dq]: [ \[dq]owner\[dq] ], \[dq]shareId\[dq]: \[dq]FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U\[dq] } ] \f[R] .fi .PP To write permissions, pass in a \[dq]permissions\[dq] metadata key using this same format. The \f[C]--metadata-mapper\f[R] (https://rclone.org/docs/#metadata-mapper) tool can be very helpful for this. .PP When adding permissions, an email address can be provided in the \f[C]User.ID\f[R] or \f[C]DisplayName\f[R] properties of \f[C]grantedTo\f[R] or \f[C]grantedToIdentities\f[R]. Alternatively, an ObjectID can be provided in \f[C]User.ID\f[R]. At least one valid recipient must be provided in order to add a permission for a user. Creating a Public Link is also supported, if \f[C]Link.Scope\f[R] is set to \f[C]\[dq]anonymous\[dq]\f[R]. .PP Example request to add a \[dq]read\[dq] permission with \f[C]--metadata-mapper\f[R]: .IP .nf \f[C] { \[dq]Metadata\[dq]: { \[dq]permissions\[dq]: \[dq][{\[rs]\[dq]grantedToIdentities\[rs]\[dq]:[{\[rs]\[dq]user\[rs]\[dq]:{\[rs]\[dq]id\[rs]\[dq]:\[rs]\[dq]ryan\[at]contoso.com\[rs]\[dq]}}],\[rs]\[dq]roles\[rs]\[dq]:[\[rs]\[dq]read\[rs]\[dq]]}]\[dq] } } \f[R] .fi .PP Note that adding a permission can fail if a conflicting permission already exists for the file/folder. .PP To update an existing permission, include both the Permission ID and the new \f[C]roles\f[R] to be assigned. \f[C]roles\f[R] is the only property that can be changed. .PP To remove permissions, pass in a blob containing only the permissions you wish to keep (which can be empty, to remove all.) Note that the \f[C]owner\f[R] role will be ignored, as it cannot be removed. .PP Note that both reading and writing permissions requires extra API calls, so if you don\[aq]t need to read or write permissions it is recommended to omit \f[C]--onedrive-metadata-permissions\f[R]. .PP Metadata and permissions are supported for Folders (directories) as well as Files. Note that setting the \f[C]mtime\f[R] or \f[C]btime\f[R] on a Folder requires one extra API call on OneDrive Business only. .PP OneDrive does not currently support User Metadata. When writing metadata, only writeable system properties will be written -- any read-only or unrecognized keys passed in will be ignored. .PP TIP: to see the metadata and permissions for any file or folder, run: .IP .nf \f[C] rclone lsjson remote:path --stat -M --onedrive-metadata-permissions read \f[R] .fi .PP Here are the possible system metadata items for the onedrive backend. .PP .TS tab(@); lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n). T{ Name T}@T{ Help T}@T{ Type T}@T{ Example T}@T{ Read Only T} _ T{ btime T}@T{ Time of file birth (creation) with S accuracy (mS for OneDrive Personal). T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05Z T}@T{ N T} T{ content-type T}@T{ The MIME type of the file. T}@T{ string T}@T{ text/plain T}@T{ \f[B]Y\f[R] T} T{ created-by-display-name T}@T{ Display name of the user that created the item. T}@T{ string T}@T{ John Doe T}@T{ \f[B]Y\f[R] T} T{ created-by-id T}@T{ ID of the user that created the item. T}@T{ string T}@T{ 48d31887-5fad-4d73-a9f5-3c356e68a038 T}@T{ \f[B]Y\f[R] T} T{ description T}@T{ A short description of the file. Max 1024 characters. Only supported for OneDrive Personal. T}@T{ string T}@T{ Contract for signing T}@T{ N T} T{ id T}@T{ The unique identifier of the item within OneDrive. T}@T{ string T}@T{ 01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K T}@T{ \f[B]Y\f[R] T} T{ last-modified-by-display-name T}@T{ Display name of the user that last modified the item. T}@T{ string T}@T{ John Doe T}@T{ \f[B]Y\f[R] T} T{ last-modified-by-id T}@T{ ID of the user that last modified the item. T}@T{ string T}@T{ 48d31887-5fad-4d73-a9f5-3c356e68a038 T}@T{ \f[B]Y\f[R] T} T{ malware-detected T}@T{ Whether OneDrive has detected that the item contains malware. T}@T{ boolean T}@T{ true T}@T{ \f[B]Y\f[R] T} T{ mtime T}@T{ Time of last modification with S accuracy (mS for OneDrive Personal). T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05Z T}@T{ N T} T{ package-type T}@T{ If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. T}@T{ string T}@T{ oneNote T}@T{ \f[B]Y\f[R] T} T{ permissions T}@T{ Permissions in a JSON dump of OneDrive format. Enable with --onedrive-metadata-permissions. Properties: id, grantedTo, grantedToIdentities, invitation, inheritedFrom, link, roles, shareId T}@T{ JSON T}@T{ {} T}@T{ N T} T{ shared-by-id T}@T{ ID of the user that shared the item (if shared). T}@T{ string T}@T{ 48d31887-5fad-4d73-a9f5-3c356e68a038 T}@T{ \f[B]Y\f[R] T} T{ shared-owner-id T}@T{ ID of the owner of the shared item (if shared). T}@T{ string T}@T{ 48d31887-5fad-4d73-a9f5-3c356e68a038 T}@T{ \f[B]Y\f[R] T} T{ shared-scope T}@T{ If shared, indicates the scope of how the item is shared: anonymous, organization, or users. T}@T{ string T}@T{ users T}@T{ \f[B]Y\f[R] T} T{ shared-time T}@T{ Time when the item was shared, with S accuracy (mS for OneDrive Personal). T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05Z T}@T{ \f[B]Y\f[R] T} T{ utime T}@T{ Time of upload with S accuracy (mS for OneDrive Personal). T}@T{ RFC 3339 T}@T{ 2006-01-02T15:04:05Z T}@T{ \f[B]Y\f[R] T} .TE .PP See the metadata (https://rclone.org/docs/#metadata) docs for more info. .SS Impersonate other users as Admin .PP Unlike Google Drive and impersonating any domain user via service accounts, OneDrive requires you to authenticate as an admin account, and manually setup a remote per user you wish to impersonate. .IP "1." 3 In Microsoft 365 Admin Center (https://admin.microsoft.com), open each user you need to \[dq]impersonate\[dq] and go to the OneDrive section. There is a heading called \[dq]Get access to files\[dq], you need to click to create the link, this creates the link of the format \f[C]https://{tenant}-my.sharepoint.com/personal/{user_name_domain_tld}/\f[R] but also changes the permissions so you your admin user has access. .IP "2." 3 Then in powershell run the following commands: .IP .nf \f[C] Install-Module Microsoft.Graph -Scope CurrentUser -Repository PSGallery -Force Import-Module Microsoft.Graph.Files Connect-MgGraph -Scopes \[dq]Files.ReadWrite.All\[dq] # Follow the steps to allow access to your admin user # Then run this for each user you want to impersonate to get the Drive ID Get-MgUserDefaultDrive -UserId \[aq]{emailaddress}\[aq] # This will give you output of the format: # Name Id DriveType CreatedDateTime # ---- -- --------- --------------- # OneDrive b!XYZ123 business 14/10/2023 1:00:58\[u202F]pm \f[R] .fi .IP "3." 3 Then in rclone add a onedrive remote type, and use the \f[C]Type in driveID\f[R] with the DriveID you got in the previous step. One remote per user. It will then confirm the drive ID, and hopefully give you a message of \f[C]Found drive \[dq]root\[dq] of type \[dq]business\[dq]\f[R] and then include the URL of the format \f[C]https://{tenant}-my.sharepoint.com/personal/{user_name_domain_tld}/Documents\f[R] .SS Limitations .PP If you don\[aq]t use rclone for 90 days the refresh token will expire. This will result in authorization problems. This is easy to fix by running the \f[C]rclone config reconnect remote:\f[R] command to get a new token and refresh token. .SS Naming .PP Note that OneDrive is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP There are quite a few characters that can\[aq]t be in OneDrive file names. These can\[aq]t occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a \f[C]?\f[R] in it will be mapped to \f[C]\[uFF1F]\f[R] instead. .SS File sizes .PP The largest allowed file size is 250 GiB for both OneDrive Personal and OneDrive for Business (Updated 13 Jan 2021) (https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize). .SS Path length .PP The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones. .SS Number of files .PP OneDrive seems to be OK with at least 50,000 files in a folder, but at 100,000 rclone will get errors listing the directory like \f[C]couldn\[cq]t list files: UnknownError:\f[R]. See #2707 (https://github.com/rclone/rclone/issues/2707) for more info. .PP An official document about the limitations for different types of OneDrive can be found here (https://support.office.com/en-us/article/invalid-file-names-and-file-types-in-onedrive-onedrive-for-business-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa). .SS Versions .PP Every change in a file OneDrive causes the service to create a new version of the file. This counts against a users quota. For example changing the modification time of a file creates a second version, so the file apparently uses twice the space. .PP For example the \f[C]copy\f[R] command is affected by this as rclone copies the file and then afterwards sets the modification time to match the source file which uses another version. .PP You can use the \f[C]rclone cleanup\f[R] command (see below) to remove all old versions. .PP Or you can set the \f[C]no_versions\f[R] parameter to \f[C]true\f[R] and rclone will remove versions after operations which create new versions. This takes extra transactions so only enable it if you need it. .PP \f[B]Note\f[R] At the time of writing Onedrive Personal creates versions (but not for setting the modification time) but the API for removing them returns \[dq]API not found\[dq] so cleanup and \f[C]no_versions\f[R] should not be used on Onedrive Personal. .SS Disabling versioning .PP Starting October 2018, users will no longer be able to disable versioning by default. This is because Microsoft has brought an update (https://techcommunity.microsoft.com/t5/Microsoft-OneDrive-Blog/New-Updates-to-OneDrive-and-SharePoint-Team-Site-Versioning/ba-p/204390) to the mechanism. To change this new default setting, a PowerShell command is required to be run by a SharePoint admin. If you are an admin, you can run these commands in PowerShell to change that setting: .IP "1." 3 \f[C]Install-Module -Name Microsoft.Online.SharePoint.PowerShell\f[R] (in case you haven\[aq]t installed this already) .IP "2." 3 \f[C]Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking\f[R] .IP "3." 3 \f[C]Connect-SPOService -Url https://YOURSITE-admin.sharepoint.com -Credential YOU\[at]YOURSITE.COM\f[R] (replacing \f[C]YOURSITE\f[R], \f[C]YOU\f[R], \f[C]YOURSITE.COM\f[R] with the actual values; this will prompt for your credentials) .IP "4." 3 \f[C]Set-SPOTenant -EnableMinimumVersionRequirement $False\f[R] .IP "5." 3 \f[C]Disconnect-SPOService\f[R] (to disconnect from the server) .PP \f[I]Below are the steps for normal users to disable versioning. If you don\[aq]t see the \[dq]No Versioning\[dq] option, make sure the above requirements are met.\f[R] .PP User Weropol (https://github.com/Weropol) has found a method to disable versioning on OneDrive .IP "1." 3 Open the settings menu by clicking on the gear symbol at the top of the OneDrive Business page. .IP "2." 3 Click Site settings. .IP "3." 3 Once on the Site settings page, navigate to Site Administration > Site libraries and lists. .IP "4." 3 Click Customize \[dq]Documents\[dq]. .IP "5." 3 Click General Settings > Versioning Settings. .IP "6." 3 Under Document Version History select the option No versioning. Note: This will disable the creation of new file versions, but will not remove any previous versions. Your documents are safe. .IP "7." 3 Apply the changes by clicking OK. .IP "8." 3 Use rclone to upload or modify files. (I also use the --no-update-modtime flag) .IP "9." 3 Restore the versioning settings after using rclone. (Optional) .SS Cleanup .PP OneDrive supports \f[C]rclone cleanup\f[R] which causes rclone to look through every file under the path supplied and delete all version but the current version. Because this involves traversing all the files, then querying each file for versions it can be quite slow. Rclone does \f[C]--checkers\f[R] tests in parallel. The command also supports \f[C]--interactive\f[R]/\f[C]i\f[R] or \f[C]--dry-run\f[R] which is a great way to see what it would do. .IP .nf \f[C] rclone cleanup --interactive remote:path/subdir # interactively remove all old version for path/subdir rclone cleanup remote:path/subdir # unconditionally remove all old version for path/subdir \f[R] .fi .PP \f[B]NB\f[R] Onedrive personal can\[aq]t currently delete versions .SS Troubleshooting .SS Excessive throttling or blocked on SharePoint .PP If you experience excessive throttling or is being blocked on SharePoint then it may help to set the user agent explicitly with a flag like this: \f[C]--user-agent \[dq]ISV|rclone.org|rclone/v1.55.1\[dq]\f[R] .PP The specific details can be found in the Microsoft document: Avoid getting throttled or blocked in SharePoint Online (https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#how-to-decorate-your-http-traffic-to-avoid-throttling) .SS Unexpected file size/hash differences on Sharepoint .PP It is a known (https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631) issue that Sharepoint (not OneDrive or OneDrive for Business) silently modifies uploaded files, mainly Office files (.docx, .xlsx, etc.), causing file size and hash checks to fail. There are also other situations that will cause OneDrive to report inconsistent file sizes. To use rclone with such affected files on Sharepoint, you may disable these checks with the following command line arguments: .IP .nf \f[C] --ignore-checksum --ignore-size \f[R] .fi .PP Alternatively, if you have write access to the OneDrive files, it may be possible to fix this problem for certain files, by attempting the steps below. Open the web interface for OneDrive (https://onedrive.live.com) and find the affected files (which will be in the error messages/log for rclone). Simply click on each of these files, causing OneDrive to open them on the web. This will cause each file to be converted in place to a format that is functionally equivalent but which will no longer trigger the size discrepancy. Once all problematic files are converted you will no longer need the ignore options above. .SS Replacing/deleting existing files on Sharepoint gets \[dq]item not found\[dq] .PP It is a known (https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue that Sharepoint (not OneDrive or OneDrive for Business) may return \[dq]item not found\[dq] errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, etc.) and web files (.html, .aspx, etc.). As a workaround, you may use the \f[C]--backup-dir <BACKUP_DIR>\f[R] command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting them). For example, to instruct rclone to move the files into the directory \f[C]rclone-backup-dir\f[R] on backend \f[C]mysharepoint\f[R], you may use: .IP .nf \f[C] --backup-dir mysharepoint:rclone-backup-dir \f[R] .fi .SS access_denied (AADSTS65005) .IP .nf \f[C] Error: access_denied Code: AADSTS65005 Description: Using application \[aq]rclone\[aq] is currently not supported for your organization [YOUR_ORGANIZATION] because it is in an unmanaged state. An administrator needs to claim ownership of the company by DNS validation of [YOUR_ORGANIZATION] before the application rclone can be provisioned. \f[R] .fi .PP This means that rclone can\[aq]t use the OneDrive for Business API with your account. You can\[aq]t do much about it, maybe write an email to your admins. .PP However, there are other ways to interact with your OneDrive account. Have a look at the WebDAV backend: https://rclone.org/webdav/#sharepoint .SS invalid_grant (AADSTS50076) .IP .nf \f[C] Error: invalid_grant Code: AADSTS50076 Description: Due to a configuration change made by your administrator, or because you moved to a new location, you must use multi-factor authentication to access \[aq]...\[aq]. \f[R] .fi .PP If you see the error above after enabling multi-factor authentication for your account, you can fix it by refreshing your OAuth refresh token. To do that, run \f[C]rclone config\f[R], and choose to edit your OneDrive backend. Then, you don\[aq]t need to actually make any changes until you reach this question: \f[C]Already have a token - refresh?\f[R]. For this question, answer \f[C]y\f[R] and go through the process to refresh your token, just like the first time the backend is configured. After this, rclone should work again for this backend. .SS Invalid request when making public links .PP On Sharepoint and OneDrive for Business, \f[C]rclone link\f[R] may return an \[dq]Invalid request\[dq] error. A possible cause is that the organisation admin didn\[aq]t allow public links to be made for the organisation/sharepoint library. To fix the permissions as an admin, take a look at the docs: 1 (https://docs.microsoft.com/en-us/sharepoint/turn-external-sharing-on-or-off), 2 (https://support.microsoft.com/en-us/office/set-up-and-manage-access-requests-94b26e0b-2822-49d4-929a-8455698654b3). .SS Can not access \f[C]Shared\f[R] with me files .PP Shared with me files is not supported by rclone currently (https://github.com/rclone/rclone/issues/4062), but there is a workaround: .IP "1." 3 Visit https://onedrive.live.com (https://onedrive.live.com/) .IP "2." 3 Right click a item in \f[C]Shared\f[R], then click \f[C]Add shortcut to My files\f[R] in the context [IMAGE: make_shortcut (https://user-images.githubusercontent.com/60313789/206118040-7e762b3b-aa61-41a1-8649-cc18889f3572.png)] .IP "3." 3 The shortcut will appear in \f[C]My files\f[R], you can access it with rclone, it behaves like a normal folder/file. [IMAGE: in_my_files (https://i.imgur.com/0S8H3li.png)] [IMAGE: rclone_mount (https://i.imgur.com/2Iq66sW.png)] .SS Live Photos uploaded from iOS (small video clips in .heic files) .PP The iOS OneDrive app introduced upload and storage (https://techcommunity.microsoft.com/t5/microsoft-onedrive-blog/live-photos-come-to-onedrive/ba-p/1953452) of Live Photos (https://support.apple.com/en-gb/HT207310) in 2020. The usage and download of these uploaded Live Photos is unfortunately still work-in-progress and this introduces several issues when copying, synchronising and mounting \[en] both in rclone and in the native OneDrive client on Windows. .PP The root cause can easily be seen if you locate one of your Live Photos in the OneDrive web interface. Then download the photo from the web interface. You will then see that the size of downloaded .heic file is smaller than the size displayed in the web interface. The downloaded file is smaller because it only contains a single frame (still photo) extracted from the Live Photo (movie) stored in OneDrive. .PP The different sizes will cause \f[C]rclone copy/sync\f[R] to repeatedly recopy unmodified photos something like this: .IP .nf \f[C] DEBUG : 20230203_123826234_iOS.heic: Sizes differ (src 4470314 vs dst 1298667) DEBUG : 20230203_123826234_iOS.heic: sha1 = fc2edde7863b7a7c93ca6771498ac797f8460750 OK INFO : 20230203_123826234_iOS.heic: Copied (replaced existing) \f[R] .fi .PP These recopies can be worked around by adding \f[C]--ignore-size\f[R]. Please note that this workaround only syncs the still-picture not the movie clip, and relies on modification dates being correctly updated on all files in all situations. .PP The different sizes will also cause \f[C]rclone check\f[R] to report size errors something like this: .IP .nf \f[C] ERROR : 20230203_123826234_iOS.heic: sizes differ \f[R] .fi .PP These check errors can be suppressed by adding \f[C]--ignore-size\f[R]. .PP The different sizes will also cause \f[C]rclone mount\f[R] to fail downloading with an error something like this: .IP .nf \f[C] ERROR : 20230203_123826234_iOS.heic: ReadFileHandle.Read error: low level retry 1/10: unexpected EOF \f[R] .fi .PP or like this when using \f[C]--cache-mode=full\f[R]: .IP .nf \f[C] INFO : 20230203_123826234_iOS.heic: vfs cache: downloader: error count now 1: vfs reader: failed to write to cache file: 416 Requested Range Not Satisfiable: ERROR : 20230203_123826234_iOS.heic: vfs cache: failed to download: vfs reader: failed to write to cache file: 416 Requested Range Not Satisfiable: \f[R] .fi .SH OpenDrive .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Configuration .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] n) New remote d) Delete remote q) Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / OpenDrive \[rs] \[dq]opendrive\[dq] [snip] Storage> opendrive Username username> Password y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Configuration complete. Options: - type: opendrive - username: - password: *** ENCRYPTED *** Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP List directories in top level of your OpenDrive .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP List all the files in your OpenDrive .IP .nf \f[C] rclone ls remote: \f[R] .fi .PP To copy a local directory to an OpenDrive directory called backup .IP .nf \f[C] rclone copy /home/source remote:backup \f[R] .fi .SS Modification times and hashes .PP OpenDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. .PP The MD5 hash algorithm is supported. .SS Restricted filename characters .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ NUL T}@T{ 0x00 T}@T{ \[u2400] T} T{ / T}@T{ 0x2F T}@T{ \[uFF0F] T} T{ \[dq] T}@T{ 0x22 T}@T{ \[uFF02] T} T{ * T}@T{ 0x2A T}@T{ \[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ \[uFF1A] T} T{ < T}@T{ 0x3C T}@T{ \[uFF1C] T} T{ > T}@T{ 0x3E T}@T{ \[uFF1E] T} T{ ? T}@T{ 0x3F T}@T{ \[uFF1F] T} T{ \[rs] T}@T{ 0x5C T}@T{ \[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ \[uFF5C] T} .TE .PP File names can also not begin or end with the following characters. These only get replaced if they are the first or last character in the name: .PP .TS tab(@); l c c. T{ Character T}@T{ Value T}@T{ Replacement T} _ T{ SP T}@T{ 0x20 T}@T{ \[u2420] T} T{ HT T}@T{ 0x09 T}@T{ \[u2409] T} T{ LF T}@T{ 0x0A T}@T{ \[u240A] T} T{ VT T}@T{ 0x0B T}@T{ \[u240B] T} T{ CR T}@T{ 0x0D T}@T{ \[u240D] T} .TE .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to opendrive (OpenDrive). .SS --opendrive-username .PP Username. .PP Properties: .IP \[bu] 2 Config: username .IP \[bu] 2 Env Var: RCLONE_OPENDRIVE_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --opendrive-password .PP Password. .PP \f[B]NB\f[R] Input to this must be obscured - see rclone obscure (https://rclone.org/commands/rclone_obscure/). .PP Properties: .IP \[bu] 2 Config: password .IP \[bu] 2 Env Var: RCLONE_OPENDRIVE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS Advanced options .PP Here are the Advanced options specific to opendrive (OpenDrive). .SS --opendrive-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_OPENDRIVE_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot .SS --opendrive-chunk-size .PP Files will be uploaded in chunks this size. .PP Note that these chunks are buffered in memory so increasing them will increase memory use. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 10Mi .SS --opendrive-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_OPENDRIVE_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Limitations .PP Note that OpenDrive is case insensitive so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. .PP There are quite a few characters that can\[aq]t be in OpenDrive file names. These can\[aq]t occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a \f[C]?\f[R] in it will be mapped to \f[C]\[uFF1F]\f[R] instead. .PP \f[C]rclone about\f[R] is not supported by the OpenDrive backend. Backends without this capability cannot determine free space for an rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member of an rclone union remote. .PP 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/) .SH Oracle Object Storage .IP \[bu] 2 Oracle Object Storage Overview (https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm) .IP \[bu] 2 Oracle Object Storage FAQ (https://www.oracle.com/cloud/storage/object-storage/faq/) .IP \[bu] 2 Oracle Object Storage Limits (https://docs.oracle.com/en-us/iaas/Content/Resources/Assets/whitepapers/oci-object-storage-best-practices.pdf) .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .PP Sample command to transfer local artifacts to remote:bucket in oracle object storage: .PP \f[C]rclone -vvv --progress --stats-one-line --max-stats-groups 10 --log-format date,time,UTC,longfile --fast-list --buffer-size 256Mi --oos-no-check-bucket --oos-upload-cutoff 10Mi --multi-thread-cutoff 16Mi --multi-thread-streams 3000 --transfers 3000 --checkers 64 --retries 2 --oos-chunk-size 10Mi --oos-upload-concurrency 10000 --oos-attempt-resume-upload --oos-leave-parts-on-error sync ./artifacts remote:bucket -vv\f[R] .SS Configuration .PP Here is an example of making an oracle object storage configuration. \f[C]rclone config\f[R] walks you through it. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] 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> n Enter name for new remote. name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Oracle Cloud Infrastructure Object Storage \[rs] (oracleobjectstorage) Storage> oracleobjectstorage Option provider. Choose your Auth Provider Choose a number from below, or type in your own string value. Press Enter for the default (env_auth). 1 / automatically pickup the credentials from runtime(env), first one to provide auth wins \[rs] (env_auth) / use an OCI user and an API key for authentication. 2 | you\[cq]ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key. | https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm \[rs] (user_principal_auth) / use instance principals to authorize an instance to make API calls. 3 | each instance has its own identity, and authenticates using the certificates that are read from instance metadata. | https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm \[rs] (instance_principal_auth) / use workload identity to grant Kubernetes pods policy-driven access to Oracle Cloud 4 | Infrastructure (OCI) resources using OCI Identity and Access Management (IAM). | https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm \[rs] (workload_identity_auth) 5 / use resource principals to make API calls \[rs] (resource_principal_auth) 6 / no credentials needed, this is typically for reading public buckets \[rs] (no_auth) provider> 2 Option namespace. Object storage namespace Enter a value. namespace> idbamagbg734 Option compartment. Object storage compartment OCID Enter a value. compartment> ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba Option region. Object storage Region Enter a value. region> us-ashburn-1 Option endpoint. Endpoint for Object storage API. Leave blank to use the default endpoint for the region. Enter a value. Press Enter to leave empty. endpoint> Option config_file. Full Path to OCI config file Choose a number from below, or type in your own string value. Press Enter for the default (\[ti]/.oci/config). 1 / oci configuration file location \[rs] (\[ti]/.oci/config) config_file> /etc/oci/dev.conf Option config_profile. Profile name inside OCI config file Choose a number from below, or type in your own string value. Press Enter for the default (Default). 1 / Use the default profile \[rs] (Default) config_profile> Test Edit advanced config? y) Yes n) No (default) y/n> n Configuration complete. Options: - type: oracleobjectstorage - namespace: idbamagbg734 - compartment: ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba - region: us-ashburn-1 - provider: user_principal_auth - config_file: /etc/oci/dev.conf - config_profile: Test Keep this \[dq]remote\[dq] remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP See all buckets .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Create a new bucket .IP .nf \f[C] rclone mkdir remote:bucket \f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] rclone ls remote:bucket rclone ls remote:bucket --max-depth 1 \f[R] .fi .SS Authentication Providers .PP OCI has various authentication methods. To learn more about authentication methods please refer oci authentication methods (https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm) These choices can be specified in the rclone config file. .PP Rclone supports the following OCI authentication provider. .IP .nf \f[C] User Principal Instance Principal Resource Principal Workload Identity No authentication \f[R] .fi .SS User Principal .PP Sample rclone config file for Authentication Provider User Principal: .IP .nf \f[C] [oos] type = oracleobjectstorage namespace = id<redacted>34 compartment = ocid1.compartment.oc1..aa<redacted>ba region = us-ashburn-1 provider = user_principal_auth config_file = /home/opc/.oci/config config_profile = Default \f[R] .fi .PP Advantages: - One can use this method from any server within OCI or on-premises or from other cloud provider. .PP Considerations: - you need to configure user\[cq]s privileges / policy to allow access to object storage - Overhead of managing users and keys. - If the user is deleted, the config file will no longer work and may cause automation regressions that use the user\[aq]s credentials. .SS Instance Principal .PP An OCI compute instance can be authorized to use rclone by using it\[aq]s identity and certificates as an instance principal. With this approach no credentials have to be stored and managed. .PP Sample rclone configuration file for Authentication Provider Instance Principal: .IP .nf \f[C] [opc\[at]rclone \[ti]]$ cat \[ti]/.config/rclone/rclone.conf [oos] type = oracleobjectstorage namespace = id<redacted>fn compartment = ocid1.compartment.oc1..aa<redacted>k7a region = us-ashburn-1 provider = instance_principal_auth \f[R] .fi .PP Advantages: .IP \[bu] 2 With instance principals, you don\[aq]t need to configure user credentials and transfer/ save it to disk in your compute instances or rotate the credentials. .IP \[bu] 2 You don\[cq]t need to deal with users and keys. .IP \[bu] 2 Greatly helps in automation as you don\[aq]t have to manage access keys, user private keys, storing them in vault, using kms etc. .PP Considerations: .IP \[bu] 2 You need to configure a dynamic group having this instance as member and add policy to read object storage to that dynamic group. .IP \[bu] 2 Everyone who has access to this machine can execute the CLI commands. .IP \[bu] 2 It is applicable for oci compute instances only. It cannot be used on external instance or resources. .SS Resource Principal .PP Resource principal auth is very similar to instance principal auth but used for resources that are not compute instances such as serverless functions (https://docs.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm). To use resource principal ensure Rclone process is started with these environment variables set in its process. .IP .nf \f[C] export OCI_RESOURCE_PRINCIPAL_VERSION=2.2 export OCI_RESOURCE_PRINCIPAL_REGION=us-ashburn-1 export OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM=/usr/share/model-server/key.pem export OCI_RESOURCE_PRINCIPAL_RPST=/usr/share/model-server/security_token \f[R] .fi .PP Sample rclone configuration file for Authentication Provider Resource Principal: .IP .nf \f[C] [oos] type = oracleobjectstorage namespace = id<redacted>34 compartment = ocid1.compartment.oc1..aa<redacted>ba region = us-ashburn-1 provider = resource_principal_auth \f[R] .fi .SS Workload Identity .PP Workload Identity auth may be used when running Rclone from Kubernetes pod on a Container Engine for Kubernetes (OKE) cluster. For more details on configuring Workload Identity, see Granting Workloads Access to OCI Resources (https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm). To use workload identity, ensure Rclone is started with these environment variables set in its process. .IP .nf \f[C] export OCI_RESOURCE_PRINCIPAL_VERSION=2.2 export OCI_RESOURCE_PRINCIPAL_REGION=us-ashburn-1 \f[R] .fi .SS No authentication .PP Public buckets do not require any authentication mechanism to read objects. Sample rclone configuration file for No authentication: .IP .nf \f[C] [oos] type = oracleobjectstorage namespace = id<redacted>34 compartment = ocid1.compartment.oc1..aa<redacted>ba region = us-ashburn-1 provider = no_auth \f[R] .fi .SS Modification times and hashes .PP The modification time is stored as metadata on the object as \f[C]opc-meta-mtime\f[R] as floating point since the epoch, accurate to 1 ns. .PP 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, the object will be uploaded rather than copied. .PP Note that reading this from the object takes an additional \f[C]HEAD\f[R] request as the metadata isn\[aq]t returned in object listings. .PP The MD5 hash algorithm is supported. .SS Multipart uploads .PP rclone supports multipart uploads with OOS which means that it can upload files bigger than 5 GiB. .PP Note that files uploaded \f[I]both\f[R] with multipart upload \f[I]and\f[R] through crypt remotes do not have MD5 sums. .PP rclone switches from single part uploads to multipart uploads at the point specified by \f[C]--oos-upload-cutoff\f[R]. This can be a maximum of 5 GiB and a minimum of 0 (ie always upload multipart files). .PP The chunk sizes used in the multipart upload are specified by \f[C]--oos-chunk-size\f[R] and the number of chunks uploaded concurrently is specified by \f[C]--oos-upload-concurrency\f[R]. .PP Multipart uploads will use \f[C]--transfers\f[R] * \f[C]--oos-upload-concurrency\f[R] * \f[C]--oos-chunk-size\f[R] extra memory. Single part uploads to not use extra memory. .PP Single part transfers can be faster than multipart transfers or slower depending on your latency from oos - the more latency, the more likely single part transfers will be faster. .PP Increasing \f[C]--oos-upload-concurrency\f[R] will increase throughput (8 would be a sensible value) and increasing \f[C]--oos-chunk-size\f[R] 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. .SS Standard options .PP Here are the Standard options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage). .SS --oos-provider .PP Choose your Auth Provider .PP Properties: .IP \[bu] 2 Config: provider .IP \[bu] 2 Env Var: RCLONE_OOS_PROVIDER .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]env_auth\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]env_auth\[dq] .RS 2 .IP \[bu] 2 automatically pickup the credentials from runtime(env), first one to provide auth wins .RE .IP \[bu] 2 \[dq]user_principal_auth\[dq] .RS 2 .IP \[bu] 2 use an OCI user and an API key for authentication. .IP \[bu] 2 you\[cq]ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key. .IP \[bu] 2 https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm .RE .IP \[bu] 2 \[dq]instance_principal_auth\[dq] .RS 2 .IP \[bu] 2 use instance principals to authorize an instance to make API calls. .IP \[bu] 2 each instance has its own identity, and authenticates using the certificates that are read from instance metadata. .IP \[bu] 2 https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm .RE .IP \[bu] 2 \[dq]workload_identity_auth\[dq] .RS 2 .IP \[bu] 2 use workload identity to grant OCI Container Engine for Kubernetes workloads policy-driven access to OCI resources using OCI Identity and Access Management (IAM). .IP \[bu] 2 https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm .RE .IP \[bu] 2 \[dq]resource_principal_auth\[dq] .RS 2 .IP \[bu] 2 use resource principals to make API calls .RE .IP \[bu] 2 \[dq]no_auth\[dq] .RS 2 .IP \[bu] 2 no credentials needed, this is typically for reading public buckets .RE .RE .SS --oos-namespace .PP Object storage namespace .PP Properties: .IP \[bu] 2 Config: namespace .IP \[bu] 2 Env Var: RCLONE_OOS_NAMESPACE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --oos-compartment .PP Specify compartment OCID, if you need to list buckets. .PP List objects works without compartment OCID. .PP Properties: .IP \[bu] 2 Config: compartment .IP \[bu] 2 Env Var: RCLONE_OOS_COMPARTMENT .IP \[bu] 2 Provider: !no_auth .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --oos-region .PP Object storage Region .PP Properties: .IP \[bu] 2 Config: region .IP \[bu] 2 Env Var: RCLONE_OOS_REGION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: true .SS --oos-endpoint .PP Endpoint for Object storage API. .PP Leave blank to use the default endpoint for the region. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_OOS_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --oos-config-file .PP Path to OCI config file .PP Properties: .IP \[bu] 2 Config: config_file .IP \[bu] 2 Env Var: RCLONE_OOS_CONFIG_FILE .IP \[bu] 2 Provider: user_principal_auth .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]\[ti]/.oci/config\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[ti]/.oci/config\[dq] .RS 2 .IP \[bu] 2 oci configuration file location .RE .RE .SS --oos-config-profile .PP Profile name inside the oci config file .PP Properties: .IP \[bu] 2 Config: config_profile .IP \[bu] 2 Env Var: RCLONE_OOS_CONFIG_PROFILE .IP \[bu] 2 Provider: user_principal_auth .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]Default\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]Default\[dq] .RS 2 .IP \[bu] 2 Use the default profile .RE .RE .SS Advanced options .PP Here are the Advanced options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage). .SS --oos-storage-tier .PP The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm .PP Properties: .IP \[bu] 2 Config: storage_tier .IP \[bu] 2 Env Var: RCLONE_OOS_STORAGE_TIER .IP \[bu] 2 Type: string .IP \[bu] 2 Default: \[dq]Standard\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]Standard\[dq] .RS 2 .IP \[bu] 2 Standard storage tier, this is the default tier .RE .IP \[bu] 2 \[dq]InfrequentAccess\[dq] .RS 2 .IP \[bu] 2 InfrequentAccess storage tier .RE .IP \[bu] 2 \[dq]Archive\[dq] .RS 2 .IP \[bu] 2 Archive storage tier .RE .RE .SS --oos-upload-cutoff .PP Cutoff for switching to chunked upload. .PP Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_OOS_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 200Mi .SS --oos-chunk-size .PP Chunk size to use for uploading. .PP When uploading files larger than upload_cutoff or files with unknown size (e.g. from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone mount\[dq] they will be uploaded as multipart uploads using this chunk size. .PP Note that \[dq]upload_concurrency\[dq] chunks of this size are buffered in memory per transfer. .PP If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers. .PP Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit. .PP 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. .PP Increasing the chunk size decreases the accuracy of the progress statistics displayed with \[dq]-P\[dq] flag. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_OOS_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 5Mi .SS --oos-max-upload-parts .PP Maximum number of parts in a multipart upload. .PP This option defines the maximum number of multipart chunks to use when doing a multipart upload. .PP OCI has max parts limit of 10,000 chunks. .PP Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit. .PP Properties: .IP \[bu] 2 Config: max_upload_parts .IP \[bu] 2 Env Var: RCLONE_OOS_MAX_UPLOAD_PARTS .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 10000 .SS --oos-upload-concurrency .PP Concurrency for multipart uploads. .PP This is the number of chunks of the same file that are uploaded concurrently. .PP 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. .PP Properties: .IP \[bu] 2 Config: upload_concurrency .IP \[bu] 2 Env Var: RCLONE_OOS_UPLOAD_CONCURRENCY .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 10 .SS --oos-copy-cutoff .PP Cutoff for switching to multipart copy. .PP Any files larger than this that need to be server-side copied will be copied in chunks of this size. .PP The minimum is 0 and the maximum is 5 GiB. .PP Properties: .IP \[bu] 2 Config: copy_cutoff .IP \[bu] 2 Env Var: RCLONE_OOS_COPY_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4.656Gi .SS --oos-copy-timeout .PP Timeout for copy. .PP Copy is an asynchronous operation, specify timeout to wait for copy to succeed .PP Properties: .IP \[bu] 2 Config: copy_timeout .IP \[bu] 2 Env Var: RCLONE_OOS_COPY_TIMEOUT .IP \[bu] 2 Type: Duration .IP \[bu] 2 Default: 1m0s .SS --oos-disable-checksum .PP Don\[aq]t store MD5 checksum with object metadata. .PP 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. .PP Properties: .IP \[bu] 2 Config: disable_checksum .IP \[bu] 2 Env Var: RCLONE_OOS_DISABLE_CHECKSUM .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --oos-encoding .PP The encoding for the backend. .PP See the encoding section in the overview (https://rclone.org/overview/#encoding) for more info. .PP Properties: .IP \[bu] 2 Config: encoding .IP \[bu] 2 Env Var: RCLONE_OOS_ENCODING .IP \[bu] 2 Type: Encoding .IP \[bu] 2 Default: Slash,InvalidUtf8,Dot .SS --oos-leave-parts-on-error .PP If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery. .PP It should be set to true for resuming uploads across different sessions. .PP WARNING: Storing parts of an incomplete multipart upload counts towards space usage on object storage and will add additional costs if not cleaned up. .PP Properties: .IP \[bu] 2 Config: leave_parts_on_error .IP \[bu] 2 Env Var: RCLONE_OOS_LEAVE_PARTS_ON_ERROR .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --oos-attempt-resume-upload .PP If true attempt to resume previously started multipart upload for the object. This will be helpful to speed up multipart transfers by resuming uploads from past session. .PP WARNING: If chunk size differs in resumed session from past incomplete session, then the resumed multipart upload is aborted and a new multipart upload is started with the new chunk size. .PP The flag leave_parts_on_error must be true to resume and optimize to skip parts that were already uploaded successfully. .PP Properties: .IP \[bu] 2 Config: attempt_resume_upload .IP \[bu] 2 Env Var: RCLONE_OOS_ATTEMPT_RESUME_UPLOAD .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --oos-no-check-bucket .PP If set, don\[aq]t attempt to check the bucket exists or create it. .PP This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. .PP It can also be needed if the user you are using does not have bucket creation permissions. .PP Properties: .IP \[bu] 2 Config: no_check_bucket .IP \[bu] 2 Env Var: RCLONE_OOS_NO_CHECK_BUCKET .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .SS --oos-sse-customer-key-file .PP To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated with the object. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.\[aq] .PP Properties: .IP \[bu] 2 Config: sse_customer_key_file .IP \[bu] 2 Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --oos-sse-customer-key .PP To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed. For more information, see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm) .PP Properties: .IP \[bu] 2 Config: sse_customer_key .IP \[bu] 2 Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --oos-sse-customer-key-sha256 .PP If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm). .PP Properties: .IP \[bu] 2 Config: sse_customer_key_sha256 .IP \[bu] 2 Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY_SHA256 .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --oos-sse-kms-key-id .PP if using your own master key in vault, this header specifies the OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed. .PP Properties: .IP \[bu] 2 Config: sse_kms_key_id .IP \[bu] 2 Env Var: RCLONE_OOS_SSE_KMS_KEY_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .RE .SS --oos-sse-customer-algorithm .PP If using SSE-C, the optional header that specifies \[dq]AES256\[dq] as the encryption algorithm. Object Storage supports \[dq]AES256\[dq] as the encryption algorithm. For more information, see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm). .PP Properties: .IP \[bu] 2 Config: sse_customer_algorithm .IP \[bu] 2 Env Var: RCLONE_OOS_SSE_CUSTOMER_ALGORITHM .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]\[dq] .RS 2 .IP \[bu] 2 None .RE .IP \[bu] 2 \[dq]AES256\[dq] .RS 2 .IP \[bu] 2 AES256 .RE .RE .SS --oos-description .PP Description of the remote. .PP Properties: .IP \[bu] 2 Config: description .IP \[bu] 2 Env Var: RCLONE_OOS_DESCRIPTION .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS Backend commands .PP Here are the commands specific to the oracleobjectstorage backend. .PP Run them with .IP .nf \f[C] rclone backend COMMAND remote: \f[R] .fi .PP The help below will explain what arguments each command takes. .PP See the backend (https://rclone.org/commands/rclone_backend/) command for more info on how to pass options and arguments. .PP These can be run on a running backend using the rc command backend/command (https://rclone.org/rc/#backend-command). .SS rename .PP change the name of an object .IP .nf \f[C] rclone backend rename remote: [options] [<arguments>+] \f[R] .fi .PP This command can be used to rename a object. .PP Usage Examples: .IP .nf \f[C] rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name \f[R] .fi .SS list-multipart-uploads .PP List the unfinished multipart uploads .IP .nf \f[C] rclone backend list-multipart-uploads remote: [options] [<arguments>+] \f[R] .fi .PP This command lists the unfinished multipart uploads in JSON format. .IP .nf \f[C] rclone backend list-multipart-uploads oos:bucket/path/to/object \f[R] .fi .PP It returns a dictionary of buckets with values as lists of unfinished multipart uploads. .PP You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path. .IP .nf \f[C] { \[dq]test-bucket\[dq]: [ { \[dq]namespace\[dq]: \[dq]test-namespace\[dq], \[dq]bucket\[dq]: \[dq]test-bucket\[dq], \[dq]object\[dq]: \[dq]600m.bin\[dq], \[dq]uploadId\[dq]: \[dq]51dd8114-52a4-b2f2-c42f-5291f05eb3c8\[dq], \[dq]timeCreated\[dq]: \[dq]2022-07-29T06:21:16.595Z\[dq], \[dq]storageTier\[dq]: \[dq]Standard\[dq] } ] \f[R] .fi .SS cleanup .PP Remove unfinished multipart uploads. .IP .nf \f[C] rclone backend cleanup remote: [options] [<arguments>+] \f[R] .fi .PP This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours. .PP Note that you can use --interactive/-i or --dry-run with this command to see what it would do. .IP .nf \f[C] rclone backend cleanup oos:bucket/path/to/object rclone backend cleanup -o max-age=7w oos:bucket/path/to/object \f[R] .fi .PP Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. .PP Options: .IP \[bu] 2 \[dq]max-age\[dq]: Max age of upload to delete .SS restore .PP Restore objects from Archive to Standard storage .IP .nf \f[C] rclone backend restore remote: [options] [<arguments>+] \f[R] .fi .PP This command can be used to restore one or more objects from Archive to Standard storage. .IP .nf \f[C] Usage Examples: rclone backend restore oos:bucket/path/to/directory -o hours=HOURS rclone backend restore oos:bucket -o hours=HOURS \f[R] .fi .PP This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags .IP .nf \f[C] rclone --interactive backend restore --include \[dq]*.txt\[dq] oos:bucket/path -o hours=72 \f[R] .fi .PP All the objects shown will be marked for restore, then .IP .nf \f[C] rclone backend restore --include \[dq]*.txt\[dq] oos:bucket/path -o hours=72 It returns a list of status dictionaries with Object Name and Status keys. The Status will be \[dq]RESTORED\[dq]\[dq] if it was successful or an error message if not. [ { \[dq]Object\[dq]: \[dq]test.txt\[dq] \[dq]Status\[dq]: \[dq]RESTORED\[dq], }, { \[dq]Object\[dq]: \[dq]test/file4.txt\[dq] \[dq]Status\[dq]: \[dq]RESTORED\[dq], } ] \f[R] .fi .PP Options: .IP \[bu] 2 \[dq]hours\[dq]: The number of hours for which this object will be restored. Default is 24 hrs. .SS Tutorials .SS Mounting Buckets (https://rclone.org/oracleobjectstorage/tutorial_mount/) .SH QingStor .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .SS Configuration .PP Here is an example of making an QingStor configuration. First run .IP .nf \f[C] rclone config \f[R] .fi .PP This will guide you through an interactive setup process. .IP .nf \f[C] No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / QingStor Object Storage \[rs] \[dq]qingstor\[dq] [snip] Storage> qingstor Get QingStor credentials from runtime. 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 QingStor credentials in the next step \[rs] \[dq]false\[dq] 2 / Get QingStor credentials from the environment (env vars or IAM) \[rs] \[dq]true\[dq] env_auth> 1 QingStor Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> access_key QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> secret_key Enter an endpoint URL to connection QingStor API. Leave blank will use the default value \[dq]https://qingstor.com:443\[dq] endpoint> Zone connect to. Default is \[dq]pek3a\[dq]. Choose a number from below, or type in your own value / The Beijing (China) Three Zone 1 | Needs location constraint pek3a. \[rs] \[dq]pek3a\[dq] / The Shanghai (China) First Zone 2 | Needs location constraint sh1a. \[rs] \[dq]sh1a\[dq] zone> 1 Number of connection retry. Leave blank will use the default value \[dq]3\[dq]. connection_retries> Remote config Configuration complete. Options: - type: qingstor - env_auth: false - access_key_id: access_key - secret_access_key: secret_key - endpoint: - zone: pek3a - connection_retries: Keep this \[dq]remote\[dq] remote? y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y \f[R] .fi .PP This remote is called \f[C]remote\f[R] and can now be used like this .PP See all buckets .IP .nf \f[C] rclone lsd remote: \f[R] .fi .PP Make a new bucket .IP .nf \f[C] rclone mkdir remote:bucket \f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] rclone ls remote:bucket \f[R] .fi .PP Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. .IP .nf \f[C] rclone sync --interactive /home/local/directory remote:bucket \f[R] .fi .SS --fast-list .PP This remote supports \f[C]--fast-list\f[R] which allows you to use fewer transactions in exchange for more memory. See the rclone docs (https://rclone.org/docs/#fast-list) for more details. .SS Multipart uploads .PP rclone supports multipart uploads with QingStor which means that it can upload files bigger than 5 GiB. Note that files uploaded with multipart upload don\[aq]t have an MD5SUM. .PP Note that incomplete multipart uploads older than 24 hours can be removed with \f[C]rclone cleanup remote:bucket\f[R] just for one bucket \f[C]rclone cleanup remote:\f[R] for all buckets. QingStor does not ever remove incomplete multipart uploads so it may be necessary to run this from time to time. .SS Buckets and Zone .PP With QingStor you can list buckets (\f[C]rclone lsd\f[R]) using any zone, but you can only access the content of a bucket from the zone it was created in. If you attempt to access a bucket from the wrong zone, you will get an error, \f[C]incorrect zone, the bucket is not in \[aq]XXX\[aq] zone\f[R]. .SS Authentication .PP There are two ways to supply \f[C]rclone\f[R] with a set of QingStor credentials. In order of precedence: .IP \[bu] 2 Directly in the rclone configuration file (as configured by \f[C]rclone config\f[R]) .RS 2 .IP \[bu] 2 set \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] .RE .IP \[bu] 2 Runtime configuration: .RS 2 .IP \[bu] 2 set \f[C]env_auth\f[R] to \f[C]true\f[R] in the config file .IP \[bu] 2 Exporting the following environment variables before running \f[C]rclone\f[R] .RS 2 .IP \[bu] 2 Access Key ID: \f[C]QS_ACCESS_KEY_ID\f[R] or \f[C]QS_ACCESS_KEY\f[R] .IP \[bu] 2 Secret Access Key: \f[C]QS_SECRET_ACCESS_KEY\f[R] or \f[C]QS_SECRET_KEY\f[R] .RE .RE .SS Restricted filename characters .PP The control characters 0x00-0x1F and / are replaced as in the default restricted characters set (https://rclone.org/overview/#restricted-characters). Note that 0x7F is not replaced. .PP Invalid UTF-8 bytes will also be replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t be used in JSON strings. .SS Standard options .PP Here are the Standard options specific to qingstor (QingCloud Object Storage). .SS --qingstor-env-auth .PP Get QingStor credentials from runtime. .PP Only applies if access_key_id and secret_access_key is blank. .PP Properties: .IP \[bu] 2 Config: env_auth .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_ENV_AUTH .IP \[bu] 2 Type: bool .IP \[bu] 2 Default: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]false\[dq] .RS 2 .IP \[bu] 2 Enter QingStor credentials in the next step. .RE .IP \[bu] 2 \[dq]true\[dq] .RS 2 .IP \[bu] 2 Get QingStor credentials from the environment (env vars or IAM). .RE .RE .SS --qingstor-access-key-id .PP QingStor Access Key ID. .PP Leave blank for anonymous access or runtime credentials. .PP Properties: .IP \[bu] 2 Config: access_key_id .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --qingstor-secret-access-key .PP QingStor Secret Access Key (password). .PP Leave blank for anonymous access or runtime credentials. .PP Properties: .IP \[bu] 2 Config: secret_access_key .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --qingstor-endpoint .PP Enter an endpoint URL to connection QingStor API. .PP Leave blank will use the default value \[dq]https://qingstor.com:443\[dq]. .PP Properties: .IP \[bu] 2 Config: endpoint .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .SS --qingstor-zone .PP Zone to connect to. .PP Default is \[dq]pek3a\[dq]. .PP Properties: .IP \[bu] 2 Config: zone .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_ZONE .IP \[bu] 2 Type: string .IP \[bu] 2 Required: false .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 \[dq]pek3a\[dq] .RS 2 .IP \[bu] 2 The Beijing (China) Three Zone. .IP \[bu] 2 Needs location constraint pek3a. .RE .IP \[bu] 2 \[dq]sh1a\[dq] .RS 2 .IP \[bu] 2 The Shanghai (China) First Zone. .IP \[bu] 2 Needs location constraint sh1a. .RE .IP \[bu] 2 \[dq]gd2a\[dq] .RS 2 .IP \[bu] 2 The Guangdong (China) Second Zone. .IP \[bu] 2 Needs location constraint gd2a. .RE .RE .SS Advanced options .PP Here are the Advanced options specific to qingstor (QingCloud Object Storage). .SS --qingstor-connection-retries .PP Number of connection retries. .PP Properties: .IP \[bu] 2 Config: connection_retries .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES .IP \[bu] 2 Type: int .IP \[bu] 2 Default: 3 .SS --qingstor-upload-cutoff .PP Cutoff for switching to chunked upload. .PP Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB. .PP Properties: .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 200Mi .SS --qingstor-chunk-size .PP Chunk size to use for uploading. .PP When uploading files larger than upload_cutoff they will be uploaded as multipart uploads using this chunk size. .PP Note that \[dq]--qingstor-upload-concurrency\[dq] chunks of this size are buffered in memory per transfer. .PP If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers. .PP Properties: .IP \[bu] 2 Config: chunk_size .IP \[bu] 2 Env Var: RCLONE_QINGSTOR_CHUNK_SIZE .IP \[bu] 2 Type: SizeSuffix .IP \[bu] 2 Default: 4Mi .SS --qingstor-upload-concurrency .PP Concurrency for multipart uploads. .PP This is the number of chunks of the same file that are uploaded concurrently. .PP NB if you set this to > 1 then the checksums of multipart uploads become corrupted (the uploads themselves are not corrupted though). .PP If you are uploading sma