github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/MANUAL.html (about) 1 <!DOCTYPE html> 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> 3 <head> 4 <meta charset="utf-8" /> 5 <meta name="generator" content="pandoc" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> 7 <meta name="author" content="Nick Craig-Wood" /> 8 <title>rclone(1) User Manual</title> 9 <style type="text/css"> 10 code{white-space: pre-wrap;} 11 span.smallcaps{font-variant: small-caps;} 12 span.underline{text-decoration: underline;} 13 div.column{display: inline-block; vertical-align: top; width: 50%;} 14 </style> 15 </head> 16 <body> 17 <header id="title-block-header"> 18 <h1 class="title">rclone(1) User Manual</h1> 19 <p class="author">Nick Craig-Wood</p> 20 <p class="date">Jun 24, 2020</p> 21 </header> 22 <h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your files to cloud storage</h1> 23 <p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p> 24 <ul> 25 <li><a href="#about">About rclone</a></li> 26 <li><a href="#what">What can rclone do for you?</a></li> 27 <li><a href="#features">What features does rclone have?</a></li> 28 <li><a href="#providers">What providers does rclone support?</a></li> 29 <li><a href="https://rclone.org/downloads/">Download</a></li> 30 <li><a href="https://rclone.org/install/">Install</a></li> 31 <li><a href="https://rclone.org/donate/">Donate.</a></li> 32 </ul> 33 <h2 id="about">About rclone</h2> 34 <p>Rclone is a command line program to manage files on cloud storage. It is a feature rich alternative to cloud vendors’ web storage interfaces. <a href="#providers">Over 40 cloud storage products</a> support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols.</p> 35 <p>Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone’s familiar syntax includes shell pipeline support, and <code>--dry-run</code> protection. It is used at the command line, in scripts or via its <a href="/rc">API</a>.</p> 36 <p>Users call rclone <em>“The Swiss army knife of cloud storage”</em>, and <em>“Technology indistinguishable from magic”</em>.</p> 37 <p>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 <a href="https://rclone.org/commands/rclone_check/">check</a> 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.</p> 38 <p>Virtual backends wrap local and cloud file systems to apply <a href="https://rclone.org/crypt/">encryption</a>, <a href="https://rclone.org/cache/">caching</a>, <a href="https://rclone.org/chunker/">chunking</a> and <a href="https://rclone.org/union/">joining</a>.</p> 39 <p>Rclone <a href="https://rclone.org/commands/rclone_mount/">mounts</a> any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over <a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>, <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>, <a href="https://rclone.org/commands/rclone_serve_webdav/">WebDAV</a>, <a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a> and <a href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a>.</p> 40 <p>Rclone is mature, open source software originally inspired by rsync and written in <a href="https://golang.org">Go</a>. The friendly support community are familiar with varied use cases. Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos. include rclone. For the latest version <a href="https://rclone.org/downloads/">downloading from rclone.org</a> is recommended.</p> 41 <p>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.</p> 42 <p>Rclone does the heavy lifting of communicating with cloud storage.</p> 43 <h2 id="what">What can rclone do for you?</h2> 44 <p>Rclone helps you:</p> 45 <ul> 46 <li>Backup (and encrypt) files to cloud storage</li> 47 <li>Restore (and decrypt) files from cloud storage</li> 48 <li>Mirror cloud data to other cloud services or locally</li> 49 <li>Migrate data to cloud, or between cloud storage vendors</li> 50 <li>Mount multiple, encrypted, cached or diverse cloud storage as a disk</li> 51 <li>Analyse and account for data held on cloud storage using <a href="https://rclone.org/commands/rclone_lsf/">lsf</a>, <a href="https://rclone.org/commands/rclone_lsjson/">ljson</a>, <a href="https://rclone.org/commands/rclone_size/">size</a>, <a href="https://rclone.org/commands/rclone_ncdu/">ncdu</a></li> 52 <li><a href="https://rclone.org/union/">Union</a> file systems together to present multiple local and/or cloud file systems as one</li> 53 </ul> 54 <h2 id="features">Features</h2> 55 <ul> 56 <li>Transfers 57 <ul> 58 <li>MD5, SHA1 hashes are checked at all times for file integrity</li> 59 <li>Timestamps are preserved on files</li> 60 <li>Operations can be restarted at any time</li> 61 <li>Can be to and from network, eg two different cloud providers</li> 62 <li>Can use multi-threaded downloads to local disk</li> 63 </ul></li> 64 <li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> new or changed files to cloud storage</li> 65 <li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one way) to make a directory identical</li> 66 <li><a href="https://rclone.org/commands/rclone_move/">Move</a> files to cloud storage deleting the local after verification</li> 67 <li><a href="https://rclone.org/commands/rclone_check/">Check</a> hashes and for missing/extra files</li> 68 <li><a href="https://rclone.org/commands/rclone_mount/">Mount</a> your cloud storage as a network disk</li> 69 <li><a href="https://rclone.org/commands/rclone_serve/">Serve</a> local or remote files over <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>/<a href="https://rclone.org/commands/rclone_serve_webdav/">WebDav</a>/<a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a>/<a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>/<a href="https://rclone.org/commands/rclone_serve_dlna/">dlna</a></li> 70 <li>Experimental <a href="https://rclone.org/gui/">Web based GUI</a></li> 71 </ul> 72 <h2 id="providers">Supported providers</h2> 73 <p>(There are many others, built on standard protocols such as WebDAV or S3, that work out of the box.)</p> 74 <ul> 75 <li>1Fichier</li> 76 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 77 <li>Amazon Drive</li> 78 <li>Amazon S3</li> 79 <li>Backblaze B2</li> 80 <li>Box</li> 81 <li>Ceph</li> 82 <li>Citrix ShareFile</li> 83 <li>C14</li> 84 <li>DigitalOcean Spaces</li> 85 <li>Dreamhost</li> 86 <li>Dropbox</li> 87 <li>FTP</li> 88 <li>Google Cloud Storage</li> 89 <li>Google Drive</li> 90 <li>Google Photos</li> 91 <li>HTTP</li> 92 <li>Hubic</li> 93 <li>Jottacloud</li> 94 <li>IBM COS S3</li> 95 <li>Koofr</li> 96 <li>Mail.ru Cloud</li> 97 <li>Memset Memstore</li> 98 <li>Mega</li> 99 <li>Memory</li> 100 <li>Microsoft Azure Blob Storage</li> 101 <li>Microsoft OneDrive</li> 102 <li>Minio</li> 103 <li>Nextcloud</li> 104 <li>OVH</li> 105 <li>OpenDrive</li> 106 <li>OpenStack Swift</li> 107 <li>Oracle Cloud Storage</li> 108 <li>ownCloud</li> 109 <li>pCloud</li> 110 <li>premiumize.me</li> 111 <li>put.io</li> 112 <li>QingStor</li> 113 <li>Rackspace Cloud Files</li> 114 <li>rsync.net</li> 115 <li>Scaleway</li> 116 <li>Seafile</li> 117 <li>SFTP</li> 118 <li>StackPath</li> 119 <li>SugarSync</li> 120 <li>Tardigrade</li> 121 <li>Wasabi</li> 122 <li>WebDAV</li> 123 <li>Yandex Disk</li> 124 <li>The local filesystem</li> 125 </ul> 126 <p>Links</p> 127 <ul> 128 <li><a href="https://rclone.org/">Home page</a></li> 129 <li><a href="https://github.com/rclone/rclone">GitHub project page for source and bug tracker</a></li> 130 <li><a href="https://forum.rclone.org">Rclone Forum</a></li> 131 <li><a href="https://rclone.org/downloads/">Downloads</a></li> 132 </ul> 133 <h1 id="install">Install</h1> 134 <p>Rclone is a Go program and comes as a single binary file.</p> 135 <h2 id="quickstart">Quickstart</h2> 136 <ul> 137 <li><a href="https://rclone.org/downloads/">Download</a> the relevant binary.</li> 138 <li>Extract the <code>rclone</code> or <code>rclone.exe</code> binary from the archive</li> 139 <li>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</li> 140 </ul> 141 <p>See below for some expanded Linux / macOS instructions.</p> 142 <p>See the <a href="https://rclone.org/docs/#usage">Usage section</a> of the docs for how to use rclone, or run <code>rclone -h</code>.</p> 143 <h2 id="script-installation">Script installation</h2> 144 <p>To install rclone on Linux/macOS/BSD systems, run:</p> 145 <pre><code>curl https://rclone.org/install.sh | sudo bash</code></pre> 146 <p>For beta installation, run:</p> 147 <pre><code>curl https://rclone.org/install.sh | sudo bash -s beta</code></pre> 148 <p>Note that this script checks the version of rclone installed first and won’t re-download if not needed.</p> 149 <h2 id="linux-installation-from-precompiled-binary">Linux installation from precompiled binary</h2> 150 <p>Fetch and unpack</p> 151 <pre><code>curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip 152 unzip rclone-current-linux-amd64.zip 153 cd rclone-*-linux-amd64</code></pre> 154 <p>Copy binary file</p> 155 <pre><code>sudo cp rclone /usr/bin/ 156 sudo chown root:root /usr/bin/rclone 157 sudo chmod 755 /usr/bin/rclone</code></pre> 158 <p>Install manpage</p> 159 <pre><code>sudo mkdir -p /usr/local/share/man/man1 160 sudo cp rclone.1 /usr/local/share/man/man1/ 161 sudo mandb </code></pre> 162 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 163 <pre><code>rclone config</code></pre> 164 <h2 id="macos-installation-with-brew">macOS installation with brew</h2> 165 <pre><code>brew install rclone</code></pre> 166 <h2 id="macos-installation-from-precompiled-binary-using-curl">macOS installation from precompiled binary, using curl</h2> 167 <p>To avoid problems with macOS gatekeeper enforcing the binary to be signed and notarized it is enough to download with <code>curl</code>.</p> 168 <p>Download the latest version of rclone.</p> 169 <pre><code>cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip</code></pre> 170 <p>Unzip the download and cd to the extracted folder.</p> 171 <pre><code>unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64</code></pre> 172 <p>Move rclone to your $PATH. You will be prompted for your password.</p> 173 <pre><code>sudo mkdir -p /usr/local/bin 174 sudo mv rclone /usr/local/bin/</code></pre> 175 <p>(the <code>mkdir</code> command is safe to run, even if the directory already exists).</p> 176 <p>Remove the leftover files.</p> 177 <pre><code>cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip</code></pre> 178 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 179 <pre><code>rclone config</code></pre> 180 <h2 id="macos-installation-from-precompiled-binary-using-a-web-browser">macOS installation from precompiled binary, using a web browser</h2> 181 <p>When downloading a binary with a web browser, the browser will set the macOS gatekeeper quarantine attribute. Starting from Catalina, when attempting to run <code>rclone</code>, a pop-up will appear saying:</p> 182 <pre><code>“rclone” cannot be opened because the developer cannot be verified. 183 macOS cannot verify that this app is free from malware.</code></pre> 184 <p>The simplest fix is to run</p> 185 <pre><code>xattr -d com.apple.quarantine rclone</code></pre> 186 <h2 id="install-with-docker">Install with docker</h2> 187 <p>The rclone maintains a <a href="https://hub.docker.com/r/rclone/rclone">docker image for rclone</a>. These images are autobuilt by docker hub from the rclone source based on a minimal Alpine linux image.</p> 188 <p>The <code>:latest</code> tag will always point to the latest stable release. You can use the <code>:beta</code> tag to get the latest build from master. You can also use version tags, eg <code>:1.49.1</code>, <code>:1.49</code> or <code>:1</code>.</p> 189 <pre><code>$ docker pull rclone/rclone:latest 190 latest: Pulling from rclone/rclone 191 Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 192 ... 193 $ docker run --rm rclone/rclone:latest version 194 rclone v1.49.1 195 - os/arch: linux/amd64 196 - go version: go1.12.9</code></pre> 197 <p>There are a few command line options to consider when starting an rclone Docker container from the rclone image.</p> 198 <ul> 199 <li><p>You need to mount the host rclone config dir at <code>/config/rclone</code> 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.</p></li> 200 <li><p>You need to mount a host data dir at <code>/data</code> into the Docker container.</p></li> 201 <li><p>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.</p></li> 202 <li><p>It is possible to use <code>rclone mount</code> inside a userspace Docker container, and expose the resulting fuse mount to the host. The exact <code>docker run</code> options to do that might vary slightly between hosts. See, e.g. the discussion in this <a href="https://github.com/moby/moby/issues/9448">thread</a>.</p> 203 <p>You also need to mount the host <code>/etc/passwd</code> and <code>/etc/group</code> for fuse to work inside the container.</p></li> 204 </ul> 205 <p>Here are some commands tested on an Ubuntu 18.04.3 host:</p> 206 <pre><code># config on host at ~/.config/rclone/rclone.conf 207 # data on host at ~/data 208 209 # make sure the config is ok by listing the remotes 210 docker run --rm \ 211 --volume ~/.config/rclone:/config/rclone \ 212 --volume ~/data:/data:shared \ 213 --user $(id -u):$(id -g) \ 214 rclone/rclone \ 215 listremotes 216 217 # perform mount inside Docker container, expose result to host 218 mkdir -p ~/data/mount 219 docker run --rm \ 220 --volume ~/.config/rclone:/config/rclone \ 221 --volume ~/data:/data:shared \ 222 --user $(id -u):$(id -g) \ 223 --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \ 224 --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \ 225 rclone/rclone \ 226 mount dropbox:Photos /data/mount & 227 ls ~/data/mount 228 kill %1</code></pre> 229 <h2 id="install-from-source">Install from source</h2> 230 <p>Make sure you have at least <a href="https://golang.org/">Go</a> 1.7 installed. <a href="https://golang.org/dl/">Download go</a> if necessary. The latest release is recommended. Then</p> 231 <pre><code>git clone https://github.com/rclone/rclone.git 232 cd rclone 233 go build 234 ./rclone version</code></pre> 235 <p>You can also build and install rclone in the <a href="https://github.com/golang/go/wiki/GOPATH">GOPATH</a> (which defaults to <code>~/go</code>) with:</p> 236 <pre><code>go get -u -v github.com/rclone/rclone</code></pre> 237 <p>and this will build the binary in <code>$GOPATH/bin</code> (<code>~/go/bin/rclone</code> by default) after downloading the source to <code>$GOPATH/src/github.com/rclone/rclone</code> (<code>~/go/src/github.com/rclone/rclone</code> by default).</p> 238 <h2 id="installation-with-ansible">Installation with Ansible</h2> 239 <p>This can be done with <a href="https://github.com/stefangweichinger/ansible-rclone">Stefan Weichinger’s ansible role</a>.</p> 240 <p>Instructions</p> 241 <ol type="1"> 242 <li><code>git clone https://github.com/stefangweichinger/ansible-rclone.git</code> into your local roles-directory</li> 243 <li>add the role to the hosts you want rclone installed to:</li> 244 </ol> 245 <pre><code> - hosts: rclone-hosts 246 roles: 247 - rclone</code></pre> 248 <h2 id="configure">Configure</h2> 249 <p>First, you’ll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. (See the <code>--config</code> entry for how to find the config file and choose its location.)</p> 250 <p>The easiest way to make the config is to run rclone with the config option:</p> 251 <pre><code>rclone config</code></pre> 252 <p>See the following for detailed instructions for</p> 253 <ul> 254 <li><a href="https://rclone.org/fichier/">1Fichier</a></li> 255 <li><a href="https://rclone.org/alias/">Alias</a></li> 256 <li><a href="https://rclone.org/amazonclouddrive/">Amazon Drive</a></li> 257 <li><a href="https://rclone.org/s3/">Amazon S3</a></li> 258 <li><a href="https://rclone.org/b2/">Backblaze B2</a></li> 259 <li><a href="https://rclone.org/box/">Box</a></li> 260 <li><a href="https://rclone.org/cache/">Cache</a></li> 261 <li><a href="https://rclone.org/chunker/">Chunker</a> - transparently splits large files for other remotes</li> 262 <li><a href="https://rclone.org/sharefile/">Citrix ShareFile</a></li> 263 <li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other remotes</li> 264 <li><a href="https://rclone.org/s3/#digitalocean-spaces">DigitalOcean Spaces</a></li> 265 <li><a href="https://rclone.org/dropbox/">Dropbox</a></li> 266 <li><a href="https://rclone.org/ftp/">FTP</a></li> 267 <li><a href="https://rclone.org/googlecloudstorage/">Google Cloud Storage</a></li> 268 <li><a href="https://rclone.org/drive/">Google Drive</a></li> 269 <li><a href="https://rclone.org/googlephotos/">Google Photos</a></li> 270 <li><a href="https://rclone.org/http/">HTTP</a></li> 271 <li><a href="https://rclone.org/hubic/">Hubic</a></li> 272 <li><a href="https://rclone.org/jottacloud/">Jottacloud / GetSky.no</a></li> 273 <li><a href="https://rclone.org/koofr/">Koofr</a></li> 274 <li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a></li> 275 <li><a href="https://rclone.org/mega/">Mega</a></li> 276 <li><a href="https://rclone.org/memory/">Memory</a></li> 277 <li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob Storage</a></li> 278 <li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li> 279 <li><a href="https://rclone.org/swift/">OpenStack Swift / Rackspace Cloudfiles / Memset Memstore</a></li> 280 <li><a href="https://rclone.org/opendrive/">OpenDrive</a></li> 281 <li><a href="https://rclone.org/pcloud/">Pcloud</a></li> 282 <li><a href="https://rclone.org/premiumizeme/">premiumize.me</a></li> 283 <li><a href="https://rclone.org/putio/">put.io</a></li> 284 <li><a href="https://rclone.org/qingstor/">QingStor</a></li> 285 <li><a href="https://rclone.org/seafile/">Seafile</a></li> 286 <li><a href="https://rclone.org/sftp/">SFTP</a></li> 287 <li><a href="https://rclone.org/sugarsync/">SugarSync</a></li> 288 <li><a href="https://rclone.org/tardigrade/">Tardigrade</a></li> 289 <li><a href="https://rclone.org/union/">Union</a></li> 290 <li><a href="https://rclone.org/webdav/">WebDAV</a></li> 291 <li><a href="https://rclone.org/yandex/">Yandex Disk</a></li> 292 <li><a href="https://rclone.org/local/">The local filesystem</a></li> 293 </ul> 294 <h2 id="usage">Usage</h2> 295 <p>Rclone syncs a directory tree from one storage system to another.</p> 296 <p>Its syntax is like this</p> 297 <pre><code>Syntax: [options] subcommand <parameters> <parameters...></code></pre> 298 <p>Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, eg “drive:myfolder” to look at “myfolder” in Google drive.</p> 299 <p>You can define as many storage paths as you like in the config file.</p> 300 <h2 id="subcommands">Subcommands</h2> 301 <p>rclone uses a system of subcommands. For example</p> 302 <pre><code>rclone ls remote:path # lists a remote 303 rclone copy /local/path remote:path # copies /local/path to the remote 304 rclone sync /local/path remote:path # syncs /local/path to the remote</code></pre> 305 <h1 id="rclone-config">rclone config</h1> 306 <p>Enter an interactive configuration session.</p> 307 <h2 id="synopsis">Synopsis</h2> 308 <p>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.</p> 309 <pre><code>rclone config [flags]</code></pre> 310 <h2 id="options">Options</h2> 311 <pre><code> -h, --help help for config</code></pre> 312 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 313 <h2 id="see-also">SEE ALSO</h2> 314 <ul> 315 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 316 <li><a href="https://rclone.org/commands/rclone_config_create/">rclone config create</a> - Create a new remote with name, type and options.</li> 317 <li><a href="https://rclone.org/commands/rclone_config_delete/">rclone config delete</a> - Delete an existing remote <code>name</code>.</li> 318 <li><a href="https://rclone.org/commands/rclone_config_disconnect/">rclone config disconnect</a> - Disconnects user from remote</li> 319 <li><a href="https://rclone.org/commands/rclone_config_dump/">rclone config dump</a> - Dump the config file as JSON.</li> 320 <li><a href="https://rclone.org/commands/rclone_config_edit/">rclone config edit</a> - Enter an interactive configuration session.</li> 321 <li><a href="https://rclone.org/commands/rclone_config_file/">rclone config file</a> - Show path of configuration file in use.</li> 322 <li><a href="https://rclone.org/commands/rclone_config_password/">rclone config password</a> - Update password in an existing remote.</li> 323 <li><a href="https://rclone.org/commands/rclone_config_providers/">rclone config providers</a> - List in JSON format all the providers and options.</li> 324 <li><a href="https://rclone.org/commands/rclone_config_reconnect/">rclone config reconnect</a> - Re-authenticates user with remote.</li> 325 <li><a href="https://rclone.org/commands/rclone_config_show/">rclone config show</a> - Print (decrypted) config file, or the config for a single remote.</li> 326 <li><a href="https://rclone.org/commands/rclone_config_update/">rclone config update</a> - Update options in an existing remote.</li> 327 <li><a href="https://rclone.org/commands/rclone_config_userinfo/">rclone config userinfo</a> - Prints info about logged in user of remote.</li> 328 </ul> 329 <h1 id="rclone-copy">rclone copy</h1> 330 <p>Copy files from source to dest, skipping already copied</p> 331 <h2 id="synopsis-1">Synopsis</h2> 332 <p>Copy the source to the destination. Doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. Doesn’t delete files from the destination.</p> 333 <p>Note that it is always the contents of the directory that is synced, not the directory so when source:path is a directory, it’s the contents of source:path that are copied, not the directory name and contents.</p> 334 <p>If dest:path doesn’t exist, it is created and the source:path contents go there.</p> 335 <p>For example</p> 336 <pre><code>rclone copy source:sourcepath dest:destpath</code></pre> 337 <p>Let’s say there are two files in sourcepath</p> 338 <pre><code>sourcepath/one.txt 339 sourcepath/two.txt</code></pre> 340 <p>This copies them to</p> 341 <pre><code>destpath/one.txt 342 destpath/two.txt</code></pre> 343 <p>Not to</p> 344 <pre><code>destpath/sourcepath/one.txt 345 destpath/sourcepath/two.txt</code></pre> 346 <p>If you are familiar with <code>rsync</code>, rclone always works as if you had written a trailing / - meaning “copy the contents of this directory”. This applies to all commands and whether you are talking about the source or destination.</p> 347 <p>See the <a href="https://rclone.org/docs/#no-traverse">–no-traverse</a> 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.</p> 348 <p>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:</p> 349 <pre><code>rclone copy --max-age 24h --no-traverse /path/to/src remote:</code></pre> 350 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 351 <pre><code>rclone copy source:path dest:path [flags]</code></pre> 352 <h2 id="options-1">Options</h2> 353 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after copy 354 -h, --help help for copy</code></pre> 355 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 356 <h2 id="see-also-1">SEE ALSO</h2> 357 <ul> 358 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 359 </ul> 360 <h1 id="rclone-sync">rclone sync</h1> 361 <p>Make source and dest identical, modifying destination only.</p> 362 <h2 id="synopsis-2">Synopsis</h2> 363 <p>Sync the source to the destination, changing the destination only. Doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files if necessary.</p> 364 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> flag to see exactly what would be copied and deleted.</p> 365 <p>Note that files in the destination won’t be deleted if there were any errors at any point.</p> 366 <p>It is always the contents of the directory that is synced, not the directory so when source:path is a directory, it’s the contents of source:path that are copied, not the directory name and contents. See extended explanation in the <code>copy</code> command above if unsure.</p> 367 <p>If dest:path doesn’t exist, it is created and the source:path contents go there.</p> 368 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 369 <pre><code>rclone sync source:path dest:path [flags]</code></pre> 370 <h2 id="options-2">Options</h2> 371 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after sync 372 -h, --help help for sync</code></pre> 373 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 374 <h2 id="see-also-2">SEE ALSO</h2> 375 <ul> 376 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 377 </ul> 378 <h1 id="rclone-move">rclone move</h1> 379 <p>Move files from source to dest.</p> 380 <h2 id="synopsis-3">Synopsis</h2> 381 <p>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.</p> 382 <p>If no filters are in use and if possible this will server side move <code>source:path</code> into <code>dest:path</code>. After this <code>source:path</code> will no longer exist.</p> 383 <p>Otherwise for each file in <code>source:path</code> selected by the filters (if any) this will move it into <code>dest:path</code>. If possible a server side move will be used, otherwise it will copy it (server side if possible) into <code>dest:path</code> then delete the original (if no errors on copy) in <code>source:path</code>.</p> 384 <p>If you want to delete empty source directories after move, use the –delete-empty-src-dirs flag.</p> 385 <p>See the <a href="https://rclone.org/docs/#no-traverse">–no-traverse</a> 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.</p> 386 <p><strong>Important</strong>: Since this can cause data loss, test first with the –dry-run flag.</p> 387 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 388 <pre><code>rclone move source:path dest:path [flags]</code></pre> 389 <h2 id="options-3">Options</h2> 390 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after move 391 --delete-empty-src-dirs Delete empty source dirs after move 392 -h, --help help for move</code></pre> 393 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 394 <h2 id="see-also-3">SEE ALSO</h2> 395 <ul> 396 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 397 </ul> 398 <h1 id="rclone-delete">rclone delete</h1> 399 <p>Remove the contents of path.</p> 400 <h2 id="synopsis-4">Synopsis</h2> 401 <p>Remove the files in path. Unlike <code>purge</code> it obeys include/exclude filters so can be used to selectively delete files.</p> 402 <p><code>rclone delete</code> only deletes objects but leaves the directory structure alone. If you want to delete a directory and all of its contents use <code>rclone purge</code></p> 403 <p>If you supply the –rmdirs flag, it will remove all empty directories along with it.</p> 404 <p>Eg delete all files bigger than 100MBytes</p> 405 <p>Check what would be deleted first (use either)</p> 406 <pre><code>rclone --min-size 100M lsl remote:path 407 rclone --dry-run --min-size 100M delete remote:path</code></pre> 408 <p>Then delete</p> 409 <pre><code>rclone --min-size 100M delete remote:path</code></pre> 410 <p>That reads “delete everything with a minimum size of 100 MB”, hence delete all files bigger than 100MBytes.</p> 411 <pre><code>rclone delete remote:path [flags]</code></pre> 412 <h2 id="options-4">Options</h2> 413 <pre><code> -h, --help help for delete 414 --rmdirs rmdirs removes empty directories but leaves root intact</code></pre> 415 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 416 <h2 id="see-also-4">SEE ALSO</h2> 417 <ul> 418 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 419 </ul> 420 <h1 id="rclone-purge">rclone purge</h1> 421 <p>Remove the path and all of its contents.</p> 422 <h2 id="synopsis-5">Synopsis</h2> 423 <p>Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use <code>delete</code> if you want to selectively delete files.</p> 424 <pre><code>rclone purge remote:path [flags]</code></pre> 425 <h2 id="options-5">Options</h2> 426 <pre><code> -h, --help help for purge</code></pre> 427 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 428 <h2 id="see-also-5">SEE ALSO</h2> 429 <ul> 430 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 431 </ul> 432 <h1 id="rclone-mkdir">rclone mkdir</h1> 433 <p>Make the path if it doesn’t already exist.</p> 434 <h2 id="synopsis-6">Synopsis</h2> 435 <p>Make the path if it doesn’t already exist.</p> 436 <pre><code>rclone mkdir remote:path [flags]</code></pre> 437 <h2 id="options-6">Options</h2> 438 <pre><code> -h, --help help for mkdir</code></pre> 439 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 440 <h2 id="see-also-6">SEE ALSO</h2> 441 <ul> 442 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 443 </ul> 444 <h1 id="rclone-rmdir">rclone rmdir</h1> 445 <p>Remove the path if empty.</p> 446 <h2 id="synopsis-7">Synopsis</h2> 447 <p>Remove the path. Note that you can’t remove a path with objects in it, use purge for that.</p> 448 <pre><code>rclone rmdir remote:path [flags]</code></pre> 449 <h2 id="options-7">Options</h2> 450 <pre><code> -h, --help help for rmdir</code></pre> 451 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 452 <h2 id="see-also-7">SEE ALSO</h2> 453 <ul> 454 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 455 </ul> 456 <h1 id="rclone-check">rclone check</h1> 457 <p>Checks the files in the source and destination match.</p> 458 <h2 id="synopsis-8">Synopsis</h2> 459 <p>Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don’t match. It doesn’t alter the source or destination.</p> 460 <p>If you supply the –size-only flag, it will only compare the sizes not the hashes as well. Use this for a quick check.</p> 461 <p>If you supply the –download flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don’t support hashes or if you really want to check all the data.</p> 462 <p>If you supply the –one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p> 463 <pre><code>rclone check source:path dest:path [flags]</code></pre> 464 <h2 id="options-8">Options</h2> 465 <pre><code> --download Check by downloading rather than with hash. 466 -h, --help help for check 467 --one-way Check one way only, source files must exist on remote</code></pre> 468 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 469 <h2 id="see-also-8">SEE ALSO</h2> 470 <ul> 471 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 472 </ul> 473 <h1 id="rclone-ls">rclone ls</h1> 474 <p>List the objects in the path with size and path.</p> 475 <h2 id="synopsis-9">Synopsis</h2> 476 <p>Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default.</p> 477 <p>Eg</p> 478 <pre><code>$ rclone ls swift:bucket 479 60295 bevajer5jef 480 90613 canole 481 94467 diwogej7 482 37600 fubuwic</code></pre> 483 <p>Any of the filtering options can be applied to this command.</p> 484 <p>There are several related list commands</p> 485 <ul> 486 <li><code>ls</code> to list size and path of objects only</li> 487 <li><code>lsl</code> to list modification time, size and path of objects only</li> 488 <li><code>lsd</code> to list directories only</li> 489 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 490 <li><code>lsjson</code> to list objects and directories in JSON format</li> 491 </ul> 492 <p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p> 493 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 494 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use “-R” to make them recurse.</p> 495 <p>Listing a non existent directory will produce an error except for remotes which can’t have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p> 496 <pre><code>rclone ls remote:path [flags]</code></pre> 497 <h2 id="options-9">Options</h2> 498 <pre><code> -h, --help help for ls</code></pre> 499 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 500 <h2 id="see-also-9">SEE ALSO</h2> 501 <ul> 502 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 503 </ul> 504 <h1 id="rclone-lsd">rclone lsd</h1> 505 <p>List all directories/containers/buckets in the path.</p> 506 <h2 id="synopsis-10">Synopsis</h2> 507 <p>Lists the directories in the source path to standard output. Does not recurse by default. Use the -R flag to recurse.</p> 508 <p>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</p> 509 <pre><code>$ rclone lsd swift: 510 494000 2018-04-26 08:43:20 10000 10000files 511 65 2018-04-26 08:43:20 1 1File</code></pre> 512 <p>Or</p> 513 <pre><code>$ rclone lsd drive:test 514 -1 2016-10-17 17:41:53 -1 1000files 515 -1 2017-01-03 14:40:54 -1 2500files 516 -1 2017-07-08 14:39:28 -1 4000files</code></pre> 517 <p>If you just want the directory names use “rclone lsf –dirs-only”.</p> 518 <p>Any of the filtering options can be applied to this command.</p> 519 <p>There are several related list commands</p> 520 <ul> 521 <li><code>ls</code> to list size and path of objects only</li> 522 <li><code>lsl</code> to list modification time, size and path of objects only</li> 523 <li><code>lsd</code> to list directories only</li> 524 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 525 <li><code>lsjson</code> to list objects and directories in JSON format</li> 526 </ul> 527 <p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p> 528 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 529 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use “-R” to make them recurse.</p> 530 <p>Listing a non existent directory will produce an error except for remotes which can’t have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p> 531 <pre><code>rclone lsd remote:path [flags]</code></pre> 532 <h2 id="options-10">Options</h2> 533 <pre><code> -h, --help help for lsd 534 -R, --recursive Recurse into the listing.</code></pre> 535 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 536 <h2 id="see-also-10">SEE ALSO</h2> 537 <ul> 538 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 539 </ul> 540 <h1 id="rclone-lsl">rclone lsl</h1> 541 <p>List the objects in path with modification time, size and path.</p> 542 <h2 id="synopsis-11">Synopsis</h2> 543 <p>Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default.</p> 544 <p>Eg</p> 545 <pre><code>$ rclone lsl swift:bucket 546 60295 2016-06-25 18:55:41.062626927 bevajer5jef 547 90613 2016-06-25 18:55:43.302607074 canole 548 94467 2016-06-25 18:55:43.046609333 diwogej7 549 37600 2016-06-25 18:55:40.814629136 fubuwic</code></pre> 550 <p>Any of the filtering options can be applied to this command.</p> 551 <p>There are several related list commands</p> 552 <ul> 553 <li><code>ls</code> to list size and path of objects only</li> 554 <li><code>lsl</code> to list modification time, size and path of objects only</li> 555 <li><code>lsd</code> to list directories only</li> 556 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 557 <li><code>lsjson</code> to list objects and directories in JSON format</li> 558 </ul> 559 <p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p> 560 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 561 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use “-R” to make them recurse.</p> 562 <p>Listing a non existent directory will produce an error except for remotes which can’t have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p> 563 <pre><code>rclone lsl remote:path [flags]</code></pre> 564 <h2 id="options-11">Options</h2> 565 <pre><code> -h, --help help for lsl</code></pre> 566 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 567 <h2 id="see-also-11">SEE ALSO</h2> 568 <ul> 569 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 570 </ul> 571 <h1 id="rclone-md5sum">rclone md5sum</h1> 572 <p>Produces an md5sum file for all the objects in the path.</p> 573 <h2 id="synopsis-12">Synopsis</h2> 574 <p>Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces.</p> 575 <pre><code>rclone md5sum remote:path [flags]</code></pre> 576 <h2 id="options-12">Options</h2> 577 <pre><code> -h, --help help for md5sum</code></pre> 578 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 579 <h2 id="see-also-12">SEE ALSO</h2> 580 <ul> 581 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 582 </ul> 583 <h1 id="rclone-sha1sum">rclone sha1sum</h1> 584 <p>Produces an sha1sum file for all the objects in the path.</p> 585 <h2 id="synopsis-13">Synopsis</h2> 586 <p>Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces.</p> 587 <pre><code>rclone sha1sum remote:path [flags]</code></pre> 588 <h2 id="options-13">Options</h2> 589 <pre><code> -h, --help help for sha1sum</code></pre> 590 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 591 <h2 id="see-also-13">SEE ALSO</h2> 592 <ul> 593 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 594 </ul> 595 <h1 id="rclone-size">rclone size</h1> 596 <p>Prints the total size and number of objects in remote:path.</p> 597 <h2 id="synopsis-14">Synopsis</h2> 598 <p>Prints the total size and number of objects in remote:path.</p> 599 <pre><code>rclone size remote:path [flags]</code></pre> 600 <h2 id="options-14">Options</h2> 601 <pre><code> -h, --help help for size 602 --json format output as JSON</code></pre> 603 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 604 <h2 id="see-also-14">SEE ALSO</h2> 605 <ul> 606 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 607 </ul> 608 <h1 id="rclone-version">rclone version</h1> 609 <p>Show the version number.</p> 610 <h2 id="synopsis-15">Synopsis</h2> 611 <p>Show the version number, the go version and the architecture.</p> 612 <p>Eg</p> 613 <pre><code>$ rclone version 614 rclone v1.41 615 - os/arch: linux/amd64 616 - go version: go1.10</code></pre> 617 <p>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.</p> 618 <pre><code>$ rclone version --check 619 yours: 1.42.0.6 620 latest: 1.42 (released 2018-06-16) 621 beta: 1.42.0.5 (released 2018-06-17)</code></pre> 622 <p>Or</p> 623 <pre><code>$ rclone version --check 624 yours: 1.41 625 latest: 1.42 (released 2018-06-16) 626 upgrade: https://downloads.rclone.org/v1.42 627 beta: 1.42.0.5 (released 2018-06-17) 628 upgrade: https://beta.rclone.org/v1.42-005-g56e1e820</code></pre> 629 <pre><code>rclone version [flags]</code></pre> 630 <h2 id="options-15">Options</h2> 631 <pre><code> --check Check for new version. 632 -h, --help help for version</code></pre> 633 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 634 <h2 id="see-also-15">SEE ALSO</h2> 635 <ul> 636 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 637 </ul> 638 <h1 id="rclone-cleanup">rclone cleanup</h1> 639 <p>Clean up the remote if possible</p> 640 <h2 id="synopsis-16">Synopsis</h2> 641 <p>Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.</p> 642 <pre><code>rclone cleanup remote:path [flags]</code></pre> 643 <h2 id="options-16">Options</h2> 644 <pre><code> -h, --help help for cleanup</code></pre> 645 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 646 <h2 id="see-also-16">SEE ALSO</h2> 647 <ul> 648 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 649 </ul> 650 <h1 id="rclone-dedupe">rclone dedupe</h1> 651 <p>Interactively find duplicate files and delete/rename them.</p> 652 <h2 id="synopsis-17">Synopsis</h2> 653 <p>By default <code>dedupe</code> interactively finds duplicate files and offers to delete all but one or rename them to be different. Only useful with Google Drive which can have duplicate file names.</p> 654 <p>In the first pass it will merge directories with the same name. It will do this iteratively until all the identical directories have been merged.</p> 655 <p>The <code>dedupe</code> command will delete all but one of any identical (same md5sum) files it finds without confirmation. This means that for most duplicated files the <code>dedupe</code> command will not be interactive. You can use <code>--dry-run</code> to see what would happen without doing anything.</p> 656 <p>Here is an example run.</p> 657 <p>Before - with duplicates</p> 658 <pre><code>$ rclone lsl drive:dupes 659 6048320 2016-03-05 16:23:16.798000000 one.txt 660 6048320 2016-03-05 16:23:11.775000000 one.txt 661 564374 2016-03-05 16:23:06.731000000 one.txt 662 6048320 2016-03-05 16:18:26.092000000 one.txt 663 6048320 2016-03-05 16:22:46.185000000 two.txt 664 1744073 2016-03-05 16:22:38.104000000 two.txt 665 564374 2016-03-05 16:22:52.118000000 two.txt</code></pre> 666 <p>Now the <code>dedupe</code> session</p> 667 <pre><code>$ rclone dedupe drive:dupes 668 2016/03/05 16:24:37 Google drive root 'dupes': Looking for duplicates using interactive mode. 669 one.txt: Found 4 duplicates - deleting identical copies 670 one.txt: Deleting 2/3 identical duplicates (md5sum "1eedaa9fe86fd4b8632e2ac549403b36") 671 one.txt: 2 duplicates remain 672 1: 6048320 bytes, 2016-03-05 16:23:16.798000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 673 2: 564374 bytes, 2016-03-05 16:23:06.731000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 674 s) Skip and do nothing 675 k) Keep just one (choose which in next step) 676 r) Rename all to be different (by changing file.jpg to file-1.jpg) 677 s/k/r> k 678 Enter the number of the file to keep> 1 679 one.txt: Deleted 1 extra copies 680 two.txt: Found 3 duplicates - deleting identical copies 681 two.txt: 3 duplicates remain 682 1: 564374 bytes, 2016-03-05 16:22:52.118000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 683 2: 6048320 bytes, 2016-03-05 16:22:46.185000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 684 3: 1744073 bytes, 2016-03-05 16:22:38.104000000, md5sum 851957f7fb6f0bc4ce76be966d336802 685 s) Skip and do nothing 686 k) Keep just one (choose which in next step) 687 r) Rename all to be different (by changing file.jpg to file-1.jpg) 688 s/k/r> r 689 two-1.txt: renamed from: two.txt 690 two-2.txt: renamed from: two.txt 691 two-3.txt: renamed from: two.txt</code></pre> 692 <p>The result being</p> 693 <pre><code>$ rclone lsl drive:dupes 694 6048320 2016-03-05 16:23:16.798000000 one.txt 695 564374 2016-03-05 16:22:52.118000000 two-1.txt 696 6048320 2016-03-05 16:22:46.185000000 two-2.txt 697 1744073 2016-03-05 16:22:38.104000000 two-3.txt</code></pre> 698 <p>Dedupe can be run non interactively using the <code>--dedupe-mode</code> flag or by using an extra parameter with the same value</p> 699 <ul> 700 <li><code>--dedupe-mode interactive</code> - interactive as above.</li> 701 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 702 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 703 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 704 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 705 <li><code>--dedupe-mode largest</code> - removes identical files then keeps the largest one.</li> 706 <li><code>--dedupe-mode smallest</code> - removes identical files then keeps the smallest one.</li> 707 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 708 </ul> 709 <p>For example to rename all the identically named photos in your Google Photos directory, do</p> 710 <pre><code>rclone dedupe --dedupe-mode rename "drive:Google Photos"</code></pre> 711 <p>Or</p> 712 <pre><code>rclone dedupe rename "drive:Google Photos"</code></pre> 713 <pre><code>rclone dedupe [mode] remote:path [flags]</code></pre> 714 <h2 id="options-17">Options</h2> 715 <pre><code> --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") 716 -h, --help help for dedupe</code></pre> 717 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 718 <h2 id="see-also-17">SEE ALSO</h2> 719 <ul> 720 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 721 </ul> 722 <h1 id="rclone-about">rclone about</h1> 723 <p>Get quota information from the remote.</p> 724 <h2 id="synopsis-18">Synopsis</h2> 725 <p>Get quota information from the remote, like bytes used/free/quota and bytes used in the trash. Not supported by all remotes.</p> 726 <p>This will print to stdout something like this:</p> 727 <pre><code>Total: 17G 728 Used: 7.444G 729 Free: 1.315G 730 Trashed: 100.000M 731 Other: 8.241G</code></pre> 732 <p>Where the fields are:</p> 733 <ul> 734 <li>Total: total size available.</li> 735 <li>Used: total size used</li> 736 <li>Free: total amount this user could upload.</li> 737 <li>Trashed: total amount in the trash</li> 738 <li>Other: total amount in other storage (eg Gmail, Google Photos)</li> 739 <li>Objects: total number of objects in the storage</li> 740 </ul> 741 <p>Note that not all the backends provide all the fields - they will be missing if they are not known for that backend. Where it is known that the value is unlimited the value will also be omitted.</p> 742 <p>Use the –full flag to see the numbers written out in full, eg</p> 743 <pre><code>Total: 18253611008 744 Used: 7993453766 745 Free: 1411001220 746 Trashed: 104857602 747 Other: 8849156022</code></pre> 748 <p>Use the –json flag for a computer readable output, eg</p> 749 <pre><code>{ 750 "total": 18253611008, 751 "used": 7993453766, 752 "trashed": 104857602, 753 "other": 8849156022, 754 "free": 1411001220 755 }</code></pre> 756 <pre><code>rclone about remote: [flags]</code></pre> 757 <h2 id="options-18">Options</h2> 758 <pre><code> --full Full numbers instead of SI units 759 -h, --help help for about 760 --json Format output as JSON</code></pre> 761 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 762 <h2 id="see-also-18">SEE ALSO</h2> 763 <ul> 764 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 765 </ul> 766 <h1 id="rclone-authorize">rclone authorize</h1> 767 <p>Remote authorization.</p> 768 <h2 id="synopsis-19">Synopsis</h2> 769 <p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p> 770 <p>Use the –auth-no-open-browser to prevent rclone to open auth link in default browser automatically.</p> 771 <pre><code>rclone authorize [flags]</code></pre> 772 <h2 id="options-19">Options</h2> 773 <pre><code> --auth-no-open-browser Do not automatically open auth link in default browser 774 -h, --help help for authorize</code></pre> 775 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 776 <h2 id="see-also-19">SEE ALSO</h2> 777 <ul> 778 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 779 </ul> 780 <h1 id="rclone-backend">rclone backend</h1> 781 <p>Run a backend specific command.</p> 782 <h2 id="synopsis-20">Synopsis</h2> 783 <p>This runs a backend specific command. The commands themselves (except for “help” and “features”) are defined by the backends and you should see the backend docs for definitions.</p> 784 <p>You can discover what commands a backend implements by using</p> 785 <pre><code>rclone backend help remote: 786 rclone backend help <backendname></code></pre> 787 <p>You can also discover information about the backend using (see <a href="https://rclone.org/rc/#operations/fsinfo">operations/fsinfo</a> in the remote control docs for more info).</p> 788 <pre><code>rclone backend features remote:</code></pre> 789 <p>Pass options to the backend command with -o. This should be key=value or key, eg:</p> 790 <pre><code>rclone backend stats remote:path stats -o format=json -o long</code></pre> 791 <p>Pass arguments to the backend by placing them on the end of the line</p> 792 <pre><code>rclone backend cleanup remote:path file1 file2 file3</code></pre> 793 <p>Note to run these commands on a running backend then see <a href="https://rclone.org/rc/#backend/command">backend/command</a> in the rc docs.</p> 794 <pre><code>rclone backend <command> remote:path [opts] <args> [flags]</code></pre> 795 <h2 id="options-20">Options</h2> 796 <pre><code> -h, --help help for backend 797 --json Always output in JSON format. 798 -o, --option stringArray Option in the form name=value or name.</code></pre> 799 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 800 <h2 id="see-also-20">SEE ALSO</h2> 801 <ul> 802 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 803 </ul> 804 <h1 id="rclone-cat">rclone cat</h1> 805 <p>Concatenates any files and sends them to stdout.</p> 806 <h2 id="synopsis-21">Synopsis</h2> 807 <p>rclone cat sends any files to standard output.</p> 808 <p>You can use it like this to output a single file</p> 809 <pre><code>rclone cat remote:path/to/file</code></pre> 810 <p>Or like this to output any file in dir or its subdirectories.</p> 811 <pre><code>rclone cat remote:path/to/dir</code></pre> 812 <p>Or like this to output any .txt files in dir or its subdirectories.</p> 813 <pre><code>rclone --include "*.txt" cat remote:path/to/dir</code></pre> 814 <p>Use the –head flag to print characters only at the start, –tail for the end and –offset and –count to print a section in the middle. Note that if offset is negative it will count from the end, so –offset -1 –count 1 is equivalent to –tail 1.</p> 815 <pre><code>rclone cat remote:path [flags]</code></pre> 816 <h2 id="options-21">Options</h2> 817 <pre><code> --count int Only print N characters. (default -1) 818 --discard Discard the output instead of printing. 819 --head int Only print the first N characters. 820 -h, --help help for cat 821 --offset int Start printing at offset N (or from end if -ve). 822 --tail int Only print the last N characters.</code></pre> 823 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 824 <h2 id="see-also-21">SEE ALSO</h2> 825 <ul> 826 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 827 </ul> 828 <h1 id="rclone-config-create">rclone config create</h1> 829 <p>Create a new remote with name, type and options.</p> 830 <h2 id="synopsis-22">Synopsis</h2> 831 <p>Create a new remote of <code>name</code> with <code>type</code> and options. The options should be passed in pairs of <code>key</code> <code>value</code>.</p> 832 <p>For example to make a swift remote of name myremote using auto config you would do:</p> 833 <pre><code>rclone config create myremote swift env_auth true</code></pre> 834 <p>Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken.</p> 835 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren’t already obscured before putting them in the config file.</p> 836 <p><strong>NB</strong> If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the “–obscure” flag, or if you are 100% certain you are already passing obscured passwords then use “–no-obscure”. You can also set osbscured passwords using the “rclone config password” command.</p> 837 <p>So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this:</p> 838 <pre><code>rclone config create mydrive drive config_is_local false</code></pre> 839 <pre><code>rclone config create `name` `type` [`key` `value`]* [flags]</code></pre> 840 <h2 id="options-22">Options</h2> 841 <pre><code> -h, --help help for create 842 --no-obscure Force any passwords not to be obscured. 843 --obscure Force any passwords to be obscured.</code></pre> 844 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 845 <h2 id="see-also-22">SEE ALSO</h2> 846 <ul> 847 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 848 </ul> 849 <h1 id="rclone-config-delete">rclone config delete</h1> 850 <p>Delete an existing remote <code>name</code>.</p> 851 <h2 id="synopsis-23">Synopsis</h2> 852 <p>Delete an existing remote <code>name</code>.</p> 853 <pre><code>rclone config delete `name` [flags]</code></pre> 854 <h2 id="options-23">Options</h2> 855 <pre><code> -h, --help help for delete</code></pre> 856 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 857 <h2 id="see-also-23">SEE ALSO</h2> 858 <ul> 859 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 860 </ul> 861 <h1 id="rclone-config-disconnect">rclone config disconnect</h1> 862 <p>Disconnects user from remote</p> 863 <h2 id="synopsis-24">Synopsis</h2> 864 <p>This disconnects the remote: passed in to the cloud storage system.</p> 865 <p>This normally means revoking the oauth token.</p> 866 <p>To reconnect use “rclone config reconnect”.</p> 867 <pre><code>rclone config disconnect remote: [flags]</code></pre> 868 <h2 id="options-24">Options</h2> 869 <pre><code> -h, --help help for disconnect</code></pre> 870 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 871 <h2 id="see-also-24">SEE ALSO</h2> 872 <ul> 873 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 874 </ul> 875 <h1 id="rclone-config-dump">rclone config dump</h1> 876 <p>Dump the config file as JSON.</p> 877 <h2 id="synopsis-25">Synopsis</h2> 878 <p>Dump the config file as JSON.</p> 879 <pre><code>rclone config dump [flags]</code></pre> 880 <h2 id="options-25">Options</h2> 881 <pre><code> -h, --help help for dump</code></pre> 882 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 883 <h2 id="see-also-25">SEE ALSO</h2> 884 <ul> 885 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 886 </ul> 887 <h1 id="rclone-config-edit">rclone config edit</h1> 888 <p>Enter an interactive configuration session.</p> 889 <h2 id="synopsis-26">Synopsis</h2> 890 <p>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.</p> 891 <pre><code>rclone config edit [flags]</code></pre> 892 <h2 id="options-26">Options</h2> 893 <pre><code> -h, --help help for edit</code></pre> 894 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 895 <h2 id="see-also-26">SEE ALSO</h2> 896 <ul> 897 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 898 </ul> 899 <h1 id="rclone-config-file">rclone config file</h1> 900 <p>Show path of configuration file in use.</p> 901 <h2 id="synopsis-27">Synopsis</h2> 902 <p>Show path of configuration file in use.</p> 903 <pre><code>rclone config file [flags]</code></pre> 904 <h2 id="options-27">Options</h2> 905 <pre><code> -h, --help help for file</code></pre> 906 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 907 <h2 id="see-also-27">SEE ALSO</h2> 908 <ul> 909 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 910 </ul> 911 <h1 id="rclone-config-password">rclone config password</h1> 912 <p>Update password in an existing remote.</p> 913 <h2 id="synopsis-28">Synopsis</h2> 914 <p>Update an existing remote’s password. The password should be passed in pairs of <code>key</code> <code>value</code>.</p> 915 <p>For example to set password of a remote of name myremote you would do:</p> 916 <pre><code>rclone config password myremote fieldname mypassword</code></pre> 917 <p>This command is obsolete now that “config update” and “config create” both support obscuring passwords directly.</p> 918 <pre><code>rclone config password `name` [`key` `value`]+ [flags]</code></pre> 919 <h2 id="options-28">Options</h2> 920 <pre><code> -h, --help help for password</code></pre> 921 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 922 <h2 id="see-also-28">SEE ALSO</h2> 923 <ul> 924 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 925 </ul> 926 <h1 id="rclone-config-providers">rclone config providers</h1> 927 <p>List in JSON format all the providers and options.</p> 928 <h2 id="synopsis-29">Synopsis</h2> 929 <p>List in JSON format all the providers and options.</p> 930 <pre><code>rclone config providers [flags]</code></pre> 931 <h2 id="options-29">Options</h2> 932 <pre><code> -h, --help help for providers</code></pre> 933 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 934 <h2 id="see-also-29">SEE ALSO</h2> 935 <ul> 936 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 937 </ul> 938 <h1 id="rclone-config-reconnect">rclone config reconnect</h1> 939 <p>Re-authenticates user with remote.</p> 940 <h2 id="synopsis-30">Synopsis</h2> 941 <p>This reconnects remote: passed in to the cloud storage system.</p> 942 <p>To disconnect the remote use “rclone config disconnect”.</p> 943 <p>This normally means going through the interactive oauth flow again.</p> 944 <pre><code>rclone config reconnect remote: [flags]</code></pre> 945 <h2 id="options-30">Options</h2> 946 <pre><code> -h, --help help for reconnect</code></pre> 947 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 948 <h2 id="see-also-30">SEE ALSO</h2> 949 <ul> 950 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 951 </ul> 952 <h1 id="rclone-config-show">rclone config show</h1> 953 <p>Print (decrypted) config file, or the config for a single remote.</p> 954 <h2 id="synopsis-31">Synopsis</h2> 955 <p>Print (decrypted) config file, or the config for a single remote.</p> 956 <pre><code>rclone config show [<remote>] [flags]</code></pre> 957 <h2 id="options-31">Options</h2> 958 <pre><code> -h, --help help for show</code></pre> 959 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 960 <h2 id="see-also-31">SEE ALSO</h2> 961 <ul> 962 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 963 </ul> 964 <h1 id="rclone-config-update">rclone config update</h1> 965 <p>Update options in an existing remote.</p> 966 <h2 id="synopsis-32">Synopsis</h2> 967 <p>Update an existing remote’s options. The options should be passed in in pairs of <code>key</code> <code>value</code>.</p> 968 <p>For example to update the env_auth field of a remote of name myremote you would do:</p> 969 <pre><code>rclone config update myremote swift env_auth true</code></pre> 970 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren’t already obscured before putting them in the config file.</p> 971 <p><strong>NB</strong> If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the “–obscure” flag, or if you are 100% certain you are already passing obscured passwords then use “–no-obscure”. You can also set osbscured passwords using the “rclone config password” command.</p> 972 <p>If the remote uses OAuth the token will be updated, if you don’t require this add an extra parameter thus:</p> 973 <pre><code>rclone config update myremote swift env_auth true config_refresh_token false</code></pre> 974 <pre><code>rclone config update `name` [`key` `value`]+ [flags]</code></pre> 975 <h2 id="options-32">Options</h2> 976 <pre><code> -h, --help help for update 977 --no-obscure Force any passwords not to be obscured. 978 --obscure Force any passwords to be obscured.</code></pre> 979 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 980 <h2 id="see-also-32">SEE ALSO</h2> 981 <ul> 982 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 983 </ul> 984 <h1 id="rclone-config-userinfo">rclone config userinfo</h1> 985 <p>Prints info about logged in user of remote.</p> 986 <h2 id="synopsis-33">Synopsis</h2> 987 <p>This prints the details of the person logged in to the cloud storage system.</p> 988 <pre><code>rclone config userinfo remote: [flags]</code></pre> 989 <h2 id="options-33">Options</h2> 990 <pre><code> -h, --help help for userinfo 991 --json Format output as JSON</code></pre> 992 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 993 <h2 id="see-also-33">SEE ALSO</h2> 994 <ul> 995 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 996 </ul> 997 <h1 id="rclone-copyto">rclone copyto</h1> 998 <p>Copy files from source to dest, skipping already copied</p> 999 <h2 id="synopsis-34">Synopsis</h2> 1000 <p>If source:path is a file or directory then it copies it to a file or directory named dest:path.</p> 1001 <p>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 command.</p> 1002 <p>So</p> 1003 <pre><code>rclone copyto src dst</code></pre> 1004 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 1005 <p>This will:</p> 1006 <pre><code>if src is file 1007 copy it to dst, overwriting an existing file if it exists 1008 if src is directory 1009 copy it to dst, overwriting existing files if they exist 1010 see copy command for full details</code></pre> 1011 <p>This doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. It doesn’t delete files from the destination.</p> 1012 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 1013 <pre><code>rclone copyto source:path dest:path [flags]</code></pre> 1014 <h2 id="options-34">Options</h2> 1015 <pre><code> -h, --help help for copyto</code></pre> 1016 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1017 <h2 id="see-also-34">SEE ALSO</h2> 1018 <ul> 1019 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1020 </ul> 1021 <h1 id="rclone-copyurl">rclone copyurl</h1> 1022 <p>Copy url content to dest.</p> 1023 <h2 id="synopsis-35">Synopsis</h2> 1024 <p>Download a URL’s content and copy it to the destination without saving it in temporary storage.</p> 1025 <p>Setting –auto-filename will cause the file name to be retrieved from the from URL (after any redirections) and used in the destination path.</p> 1026 <p>Setting –no-clobber will prevent overwriting file on the destination if there is one with the same name.</p> 1027 <p>Setting –stdout or making the output file name “-” will cause the output to be written to standard output.</p> 1028 <pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre> 1029 <h2 id="options-35">Options</h2> 1030 <pre><code> -a, --auto-filename Get the file name from the URL and use it for destination file path 1031 -h, --help help for copyurl 1032 --no-clobber Prevent overwriting file with same name 1033 --stdout Write the output to stdout rather than a file</code></pre> 1034 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1035 <h2 id="see-also-35">SEE ALSO</h2> 1036 <ul> 1037 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1038 </ul> 1039 <h1 id="rclone-cryptcheck">rclone cryptcheck</h1> 1040 <p>Cryptcheck checks the integrity of a crypted remote.</p> 1041 <h2 id="synopsis-36">Synopsis</h2> 1042 <p>rclone cryptcheck checks a remote against a crypted remote. This is the equivalent of running rclone check, but able to check the checksums of the crypted remote.</p> 1043 <p>For it to work the underlying remote of the cryptedremote must support some kind of checksum.</p> 1044 <p>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.</p> 1045 <p>Use it like this</p> 1046 <pre><code>rclone cryptcheck /path/to/files encryptedremote:path</code></pre> 1047 <p>You can use it like this also, but that will involve downloading all the files in remote:path.</p> 1048 <pre><code>rclone cryptcheck remote:path encryptedremote:path</code></pre> 1049 <p>After it has run it will log the status of the encryptedremote:.</p> 1050 <p>If you supply the –one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p> 1051 <pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre> 1052 <h2 id="options-36">Options</h2> 1053 <pre><code> -h, --help help for cryptcheck 1054 --one-way Check one way only, source files must exist on destination</code></pre> 1055 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1056 <h2 id="see-also-36">SEE ALSO</h2> 1057 <ul> 1058 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1059 </ul> 1060 <h1 id="rclone-cryptdecode">rclone cryptdecode</h1> 1061 <p>Cryptdecode returns unencrypted file names.</p> 1062 <h2 id="synopsis-37">Synopsis</h2> 1063 <p>rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items.</p> 1064 <p>If you supply the –reverse flag, it will return encrypted file names.</p> 1065 <p>use it like this</p> 1066 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 1067 1068 rclone cryptdecode --reverse encryptedremote: filename1 filename2</code></pre> 1069 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre> 1070 <h2 id="options-37">Options</h2> 1071 <pre><code> -h, --help help for cryptdecode 1072 --reverse Reverse cryptdecode, encrypts filenames</code></pre> 1073 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1074 <h2 id="see-also-37">SEE ALSO</h2> 1075 <ul> 1076 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1077 </ul> 1078 <h1 id="rclone-deletefile">rclone deletefile</h1> 1079 <p>Remove a single file from remote.</p> 1080 <h2 id="synopsis-38">Synopsis</h2> 1081 <p>Remove a single file from remote. Unlike <code>delete</code> it cannot be used to remove a directory and it doesn’t obey include/exclude filters - if the specified file exists, it will always be removed.</p> 1082 <pre><code>rclone deletefile remote:path [flags]</code></pre> 1083 <h2 id="options-38">Options</h2> 1084 <pre><code> -h, --help help for deletefile</code></pre> 1085 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1086 <h2 id="see-also-38">SEE ALSO</h2> 1087 <ul> 1088 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1089 </ul> 1090 <h1 id="rclone-genautocomplete">rclone genautocomplete</h1> 1091 <p>Output completion script for a given shell.</p> 1092 <h2 id="synopsis-39">Synopsis</h2> 1093 <p>Generates a shell completion script for rclone. Run with –help to list the supported shells.</p> 1094 <h2 id="options-39">Options</h2> 1095 <pre><code> -h, --help help for genautocomplete</code></pre> 1096 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1097 <h2 id="see-also-39">SEE ALSO</h2> 1098 <ul> 1099 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1100 <li><a href="https://rclone.org/commands/rclone_genautocomplete_bash/">rclone genautocomplete bash</a> - Output bash completion script for rclone.</li> 1101 <li><a href="https://rclone.org/commands/rclone_genautocomplete_fish/">rclone genautocomplete fish</a> - Output fish completion script for rclone.</li> 1102 <li><a href="https://rclone.org/commands/rclone_genautocomplete_zsh/">rclone genautocomplete zsh</a> - Output zsh completion script for rclone.</li> 1103 </ul> 1104 <h1 id="rclone-genautocomplete-bash">rclone genautocomplete bash</h1> 1105 <p>Output bash completion script for rclone.</p> 1106 <h2 id="synopsis-40">Synopsis</h2> 1107 <p>Generates a bash shell autocompletion script for rclone.</p> 1108 <p>This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, eg</p> 1109 <pre><code>sudo rclone genautocomplete bash</code></pre> 1110 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1111 <pre><code>. /etc/bash_completion</code></pre> 1112 <p>If you supply a command line argument the script will be written there.</p> 1113 <pre><code>rclone genautocomplete bash [output_file] [flags]</code></pre> 1114 <h2 id="options-40">Options</h2> 1115 <pre><code> -h, --help help for bash</code></pre> 1116 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1117 <h2 id="see-also-40">SEE ALSO</h2> 1118 <ul> 1119 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 1120 </ul> 1121 <h1 id="rclone-genautocomplete-fish">rclone genautocomplete fish</h1> 1122 <p>Output fish completion script for rclone.</p> 1123 <h2 id="synopsis-41">Synopsis</h2> 1124 <p>Generates a fish autocompletion script for rclone.</p> 1125 <p>This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, eg</p> 1126 <pre><code>sudo rclone genautocomplete fish</code></pre> 1127 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1128 <pre><code>. /etc/fish/completions/rclone.fish</code></pre> 1129 <p>If you supply a command line argument the script will be written there.</p> 1130 <pre><code>rclone genautocomplete fish [output_file] [flags]</code></pre> 1131 <h2 id="options-41">Options</h2> 1132 <pre><code> -h, --help help for fish</code></pre> 1133 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1134 <h2 id="see-also-41">SEE ALSO</h2> 1135 <ul> 1136 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 1137 </ul> 1138 <h1 id="rclone-genautocomplete-zsh">rclone genautocomplete zsh</h1> 1139 <p>Output zsh completion script for rclone.</p> 1140 <h2 id="synopsis-42">Synopsis</h2> 1141 <p>Generates a zsh autocompletion script for rclone.</p> 1142 <p>This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, eg</p> 1143 <pre><code>sudo rclone genautocomplete zsh</code></pre> 1144 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1145 <pre><code>autoload -U compinit && compinit</code></pre> 1146 <p>If you supply a command line argument the script will be written there.</p> 1147 <pre><code>rclone genautocomplete zsh [output_file] [flags]</code></pre> 1148 <h2 id="options-42">Options</h2> 1149 <pre><code> -h, --help help for zsh</code></pre> 1150 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1151 <h2 id="see-also-42">SEE ALSO</h2> 1152 <ul> 1153 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 1154 </ul> 1155 <h1 id="rclone-gendocs">rclone gendocs</h1> 1156 <p>Output markdown docs for rclone to the directory supplied.</p> 1157 <h2 id="synopsis-43">Synopsis</h2> 1158 <p>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.</p> 1159 <pre><code>rclone gendocs output_directory [flags]</code></pre> 1160 <h2 id="options-43">Options</h2> 1161 <pre><code> -h, --help help for gendocs</code></pre> 1162 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1163 <h2 id="see-also-43">SEE ALSO</h2> 1164 <ul> 1165 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1166 </ul> 1167 <h1 id="rclone-hashsum">rclone hashsum</h1> 1168 <p>Produces a hashsum file for all the objects in the path.</p> 1169 <h2 id="synopsis-44">Synopsis</h2> 1170 <p>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.</p> 1171 <p>Run without a hash to see the list of supported hashes, eg</p> 1172 <pre><code>$ rclone hashsum 1173 Supported hashes are: 1174 * MD5 1175 * SHA-1 1176 * DropboxHash 1177 * QuickXorHash</code></pre> 1178 <p>Then</p> 1179 <pre><code>$ rclone hashsum MD5 remote:path</code></pre> 1180 <pre><code>rclone hashsum <hash> remote:path [flags]</code></pre> 1181 <h2 id="options-44">Options</h2> 1182 <pre><code> --base64 Output base64 encoded hashsum 1183 -h, --help help for hashsum</code></pre> 1184 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1185 <h2 id="see-also-44">SEE ALSO</h2> 1186 <ul> 1187 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1188 </ul> 1189 <h1 id="rclone-link">rclone link</h1> 1190 <p>Generate public link to file/folder.</p> 1191 <h2 id="synopsis-45">Synopsis</h2> 1192 <p>rclone link will create or retrieve a public link to the given file or folder.</p> 1193 <pre><code>rclone link remote:path/to/file 1194 rclone link remote:path/to/folder/</code></pre> 1195 <p>If successful, the last line of the output will contain the link. Exact capabilities depend on the remote, but the link will always be created with the least constraints – e.g. no expiry, no password protection, accessible without account.</p> 1196 <pre><code>rclone link remote:path [flags]</code></pre> 1197 <h2 id="options-45">Options</h2> 1198 <pre><code> -h, --help help for link</code></pre> 1199 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1200 <h2 id="see-also-45">SEE ALSO</h2> 1201 <ul> 1202 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1203 </ul> 1204 <h1 id="rclone-listremotes">rclone listremotes</h1> 1205 <p>List all the remotes in the config file.</p> 1206 <h2 id="synopsis-46">Synopsis</h2> 1207 <p>rclone listremotes lists all the available remotes from the config file.</p> 1208 <p>When uses with the -l flag it lists the types too.</p> 1209 <pre><code>rclone listremotes [flags]</code></pre> 1210 <h2 id="options-46">Options</h2> 1211 <pre><code> -h, --help help for listremotes 1212 --long Show the type as well as names.</code></pre> 1213 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1214 <h2 id="see-also-46">SEE ALSO</h2> 1215 <ul> 1216 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1217 </ul> 1218 <h1 id="rclone-lsf">rclone lsf</h1> 1219 <p>List directories and objects in remote:path formatted for parsing</p> 1220 <h2 id="synopsis-47">Synopsis</h2> 1221 <p>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.</p> 1222 <p>Eg</p> 1223 <pre><code>$ rclone lsf swift:bucket 1224 bevajer5jef 1225 canole 1226 diwogej7 1227 ferejej3gux/ 1228 fubuwic</code></pre> 1229 <p>Use the –format option to control what gets listed. By default this is just the path, but you can use these parameters to control the output:</p> 1230 <pre><code>p - path 1231 s - size 1232 t - modification time 1233 h - hash 1234 i - ID of object 1235 o - Original ID of underlying object 1236 m - MimeType of object if known 1237 e - encrypted name 1238 T - tier of storage if known, eg "Hot" or "Cool"</code></pre> 1239 <p>So if you wanted the path, size and modification time, you would use –format “pst”, or maybe –format “tsp” to put the path last.</p> 1240 <p>Eg</p> 1241 <pre><code>$ rclone lsf --format "tsp" swift:bucket 1242 2016-06-25 18:55:41;60295;bevajer5jef 1243 2016-06-25 18:55:43;90613;canole 1244 2016-06-25 18:55:43;94467;diwogej7 1245 2018-04-26 08:50:45;0;ferejej3gux/ 1246 2016-06-25 18:55:40;37600;fubuwic</code></pre> 1247 <p>If you specify “h” in the format you will get the MD5 hash by default, use the “–hash” flag to change which hash you want. Note that this can be returned as an empty string if it isn’t available on the object (and for directories), “ERROR” if there was an error reading it from the object and “UNSUPPORTED” if that object does not support that hash type.</p> 1248 <p>For example to emulate the md5sum command you can use</p> 1249 <pre><code>rclone lsf -R --hash MD5 --format hp --separator " " --files-only .</code></pre> 1250 <p>Eg</p> 1251 <pre><code>$ rclone lsf -R --hash MD5 --format hp --separator " " --files-only swift:bucket 1252 7908e352297f0f530b84a756f188baa3 bevajer5jef 1253 cd65ac234e6fea5925974a51cdd865cc canole 1254 03b5341b4f234b9d984d03ad076bae91 diwogej7 1255 8fd37c3810dd660778137ac3a66cc06d fubuwic 1256 99713e14a4c4ff553acaf1930fad985b gixacuh7ku</code></pre> 1257 <p>(Though “rclone md5sum .” is an easier way of typing this.)</p> 1258 <p>By default the separator is “;” this can be changed with the –separator flag. Note that separators aren’t escaped in the path so putting it last is a good strategy.</p> 1259 <p>Eg</p> 1260 <pre><code>$ rclone lsf --separator "," --format "tshp" swift:bucket 1261 2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef 1262 2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole 1263 2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 1264 2018-04-26 08:52:53,0,,ferejej3gux/ 1265 2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</code></pre> 1266 <p>You can output in CSV standard format. This will escape things in " if they contain ,</p> 1267 <p>Eg</p> 1268 <pre><code>$ rclone lsf --csv --files-only --format ps remote:path 1269 test.log,22355 1270 test.sh,449 1271 "this file contains a comma, in the file name.txt",6</code></pre> 1272 <p>Note that the –absolute parameter is useful for making lists of files to pass to an rclone copy with the –files-from-raw flag.</p> 1273 <p>For example to find all the files modified within one day and copy those only (without traversing the whole directory structure):</p> 1274 <pre><code>rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files 1275 rclone copy --files-from-raw new_files /path/to/local remote:path</code></pre> 1276 <p>Any of the filtering options can be applied to this command.</p> 1277 <p>There are several related list commands</p> 1278 <ul> 1279 <li><code>ls</code> to list size and path of objects only</li> 1280 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1281 <li><code>lsd</code> to list directories only</li> 1282 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1283 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1284 </ul> 1285 <p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p> 1286 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 1287 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use “-R” to make them recurse.</p> 1288 <p>Listing a non existent directory will produce an error except for remotes which can’t have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p> 1289 <pre><code>rclone lsf remote:path [flags]</code></pre> 1290 <h2 id="options-47">Options</h2> 1291 <pre><code> --absolute Put a leading / in front of path names. 1292 --csv Output in CSV format. 1293 -d, --dir-slash Append a slash to directory names. (default true) 1294 --dirs-only Only list directories. 1295 --files-only Only list files. 1296 -F, --format string Output format - see help for details (default "p") 1297 --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "MD5") 1298 -h, --help help for lsf 1299 -R, --recursive Recurse into the listing. 1300 -s, --separator string Separator for the items in the format. (default ";")</code></pre> 1301 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1302 <h2 id="see-also-47">SEE ALSO</h2> 1303 <ul> 1304 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1305 </ul> 1306 <h1 id="rclone-lsjson">rclone lsjson</h1> 1307 <p>List directories and objects in the path in JSON format.</p> 1308 <h2 id="synopsis-48">Synopsis</h2> 1309 <p>List directories and objects in the path in JSON format.</p> 1310 <p>The output is an array of Items, where each Item looks like this</p> 1311 <p>{ “Hashes” : { “SHA-1” : “f572d396fae9206628714fb2ce00f72e94f2258f”, “MD5” : “b1946ac92492d2347c6235b4d2611184”, “DropboxHash” : “ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc” }, “ID”: “y2djkhiujf83u33”, “OrigID”: “UYOJVTUW00Q1RzTDA”, “IsBucket” : false, “IsDir” : false, “MimeType” : “application/octet-stream”, “ModTime” : “2017-05-31T16:15:57.034468261+01:00”, “Name” : “file.txt”, “Encrypted” : “v0qpsdq8anpci8n929v3uu9338”, “EncryptedPath” : “kja9098349023498/v0qpsdq8anpci8n929v3uu9338”, “Path” : “full/path/goes/here/file.txt”, “Size” : 6, “Tier” : “hot”, }</p> 1312 <p>If –hash is not specified the Hashes property won’t be emitted. The types of hash can be specified with the –hash-type parameter (which may be repeated). If –hash-type is set then it implies –hash.</p> 1313 <p>If –no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (eg s3, swift).</p> 1314 <p>If –no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (eg s3, swift).</p> 1315 <p>If –encrypted is not specified the Encrypted won’t be emitted.</p> 1316 <p>If –dirs-only is not specified files in addition to directories are returned</p> 1317 <p>If –files-only is not specified directories in addition to the files will be returned.</p> 1318 <p>The Path field will only show folders below the remote path being listed. If “remote:path” contains the file “subfolder/file.txt”, the Path for “file.txt” will be “subfolder/file.txt”, not “remote:path/subfolder/file.txt”. When used without –recursive the Path will always be the same as Name.</p> 1319 <p>If the directory is a bucket in a bucket based backend, then “IsBucket” will be set to true. This key won’t be present unless it is “true”.</p> 1320 <p>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 (eg Google Drive) then 3 digits will always be shown (“2017-05-31T16:15:57.034+01:00”) whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav etc) no digits will be shown (“2017-05-31T16:15:57+01:00”).</p> 1321 <p>The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line.</p> 1322 <p>Any of the filtering options can be applied to this command.</p> 1323 <p>There are several related list commands</p> 1324 <ul> 1325 <li><code>ls</code> to list size and path of objects only</li> 1326 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1327 <li><code>lsd</code> to list directories only</li> 1328 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1329 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1330 </ul> 1331 <p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p> 1332 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 1333 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use “-R” to make them recurse.</p> 1334 <p>Listing a non existent directory will produce an error except for remotes which can’t have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p> 1335 <pre><code>rclone lsjson remote:path [flags]</code></pre> 1336 <h2 id="options-48">Options</h2> 1337 <pre><code> --dirs-only Show only directories in the listing. 1338 -M, --encrypted Show the encrypted names. 1339 --files-only Show only files in the listing. 1340 --hash Include hashes in the output (may take longer). 1341 --hash-type stringArray Show only this hash type (may be repeated). 1342 -h, --help help for lsjson 1343 --no-mimetype Don't read the mime type (can speed things up). 1344 --no-modtime Don't read the modification time (can speed things up). 1345 --original Show the ID of the underlying Object. 1346 -R, --recursive Recurse into the listing.</code></pre> 1347 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1348 <h2 id="see-also-48">SEE ALSO</h2> 1349 <ul> 1350 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1351 </ul> 1352 <h1 id="rclone-mount">rclone mount</h1> 1353 <p>Mount the remote as file system on a mountpoint.</p> 1354 <h2 id="synopsis-49">Synopsis</h2> 1355 <p>rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone’s cloud storage systems as a file system with FUSE.</p> 1356 <p>First set up your remote using <code>rclone config</code>. Check it works with <code>rclone ls</code> etc.</p> 1357 <p>You can either run mount in foreground mode or background (daemon) mode. Mount runs in foreground mode by default, use the –daemon flag to specify background mode mode. Background mode is only supported on Linux and OSX, you can only run mount in foreground mode on Windows.</p> 1358 <p>On Linux/macOS/FreeBSD Start the mount like this where <code>/path/to/local/mount</code> is an <strong>empty</strong> <strong>existing</strong> directory.</p> 1359 <pre><code>rclone mount remote:path/to/files /path/to/local/mount</code></pre> 1360 <p>Or on Windows like this where <code>X:</code> is an unused drive letter or use a path to <strong>non-existent</strong> directory.</p> 1361 <pre><code>rclone mount remote:path/to/files X: 1362 rclone mount remote:path/to/files C:\path\to\nonexistent\directory</code></pre> 1363 <p>When running in background mode the user will have to stop the mount manually (specified below).</p> 1364 <p>When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped.</p> 1365 <p>The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user’s responsibility to stop the mount manually.</p> 1366 <p>Stopping the mount manually:</p> 1367 <pre><code># Linux 1368 fusermount -u /path/to/local/mount 1369 # OS X 1370 umount /path/to/local/mount</code></pre> 1371 <h2 id="installing-on-windows">Installing on Windows</h2> 1372 <p>To run rclone mount on Windows, you will need to download and install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p> 1373 <p><a href="https://github.com/billziss-gh/winfsp">WinFsp</a> 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 <a href="https://github.com/billziss-gh/cgofuse">cgofuse</a>. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.</p> 1374 <h3 id="windows-caveats">Windows caveats</h3> 1375 <p>Note that drives created as Administrator are not visible by other accounts (including the account that was elevated as Administrator). So if you start a Windows drive from an Administrative Command Prompt and then try to access the same drive from Explorer (which does not run as Administrator), you will not be able to see the new drive.</p> 1376 <p>The easiest way around this is to start the drive from a normal command prompt. It is also possible to start a drive from the SYSTEM account (using <a href="https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture">the WinFsp.Launcher infrastructure</a>) which creates drives accessible for everyone on the system or alternatively using <a href="https://nssm.cc/usage">the nssm service manager</a>.</p> 1377 <h3 id="mount-as-a-network-drive">Mount as a network drive</h3> 1378 <p>By default, rclone will mount the remote as a normal drive. However, you can also mount it as a <strong>Network Drive</strong> (or <strong>Network Share</strong>, as mentioned in some places)</p> 1379 <p>Unlike other systems, Windows provides a different filesystem type for network drives. Windows and other programs treat the network drives and fixed/removable drives differently: In network drives, many I/O operations are optimized, as the high latency and low reliability (compared to a normal drive) of a network is expected.</p> 1380 <p>Although many people prefer network shares to be mounted as normal system drives, this might cause some issues, such as programs not working as expected or freezes and errors while operating with the mounted remote in Windows Explorer. If you experience any of those, consider mounting rclone remotes as network shares, as Windows expects normal drives to be fast and reliable, while cloud storage is far from that. See also <a href="#limitations">Limitations</a> section below for more info</p> 1381 <p>Add “–fuse-flag –VolumePrefix=” to your “mount” command, <strong>replacing “share” with any other name of your choice if you are mounting more than one remote</strong>. Otherwise, the mountpoints will conflict and your mounted filesystems will overlap.</p> 1382 <p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about drive mapping</a></p> 1383 <h2 id="limitations">Limitations</h2> 1384 <p>Without the use of “–vfs-cache-mode” this can only write files sequentially, it can only seek when reading. This means that many applications won’t work with their files on an rclone mount without “–vfs-cache-mode writes” or “–vfs-cache-mode full”. See the <a href="#file-caching">File Caching</a> section for more info.</p> 1385 <p>The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, Hubic) 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.</p> 1386 <p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p> 1387 <h2 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone sync/copy</h2> 1388 <p>File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can’t use retries in the same way without making local copies of the uploads. Look at the <a href="#file-caching">file caching</a> for solutions to make mount more reliable.</p> 1389 <h2 id="attribute-caching">Attribute caching</h2> 1390 <p>You can use the flag –attr-timeout to set the time the kernel caches the attributes (size, modification time etc) for directory entries.</p> 1391 <p>The default is “1s” which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p> 1392 <p>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 <a href="https://github.com/rclone/rclone/issues/2157">rclone using too much memory</a>, <a href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone not serving files to samba</a> and <a href="https://github.com/rclone/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p> 1393 <p>The kernel can cache the info about a file for the time given by “–attr-timeout”. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With “–attr-timeout 1s” this is very unlikely but not impossible. The higher you set “–attr-timeout” the more likely it is. The default setting of “1s” is the lowest setting which mitigates the problems above.</p> 1394 <p>If you set it higher (‘10s’ or ‘1m’ say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above.</p> 1395 <p>If files don’t change on the remote outside of the control of rclone then there is no chance of corruption.</p> 1396 <p>This is the same as setting the attr_timeout option in mount.fuse.</p> 1397 <h2 id="filters">Filters</h2> 1398 <p>Note that all the rclone filters can be used to select a subset of the files to be visible in the mount.</p> 1399 <h2 id="systemd">systemd</h2> 1400 <p>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.</p> 1401 <h2 id="chunked-reading">chunked reading</h2> 1402 <p>–vfs-read-chunk-size will enable reading the source objects in parts. 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.</p> 1403 <p>When –vfs-read-chunk-size-limit is also specified and greater than –vfs-read-chunk-size, the chunk size for each open file will get doubled for each chunk read, until the specified value is reached. A value of -1 will disable the limit and the chunk size will grow indefinitely.</p> 1404 <p>With –vfs-read-chunk-size 100M and –vfs-read-chunk-size-limit 0 the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When –vfs-read-chunk-size-limit 500M is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 1405 <p>Chunked reading will only work with –vfs-cache-mode < full, as the file will always be copied to the vfs cache before opening with –vfs-cache-mode full.</p> 1406 <h2 id="directory-cache">Directory Cache</h2> 1407 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 1408 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 1409 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1410 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 1411 <pre><code>rclone rc vfs/forget</code></pre> 1412 <p>Or individual files or directories:</p> 1413 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1414 <h2 id="file-buffering">File Buffering</h2> 1415 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1416 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 1417 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 1418 <h2 id="file-caching">File Caching</h2> 1419 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 1420 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 1421 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 1422 <pre><code>--cache-dir string Directory rclone will use for caching. 1423 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1424 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1425 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1426 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1427 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 1428 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 1429 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 1430 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 1431 <h3 id="vfs-cache-mode-off">–vfs-cache-mode off</h3> 1432 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1433 <p>This will mean some operations are not possible</p> 1434 <ul> 1435 <li>Files can’t be opened for both read AND write</li> 1436 <li>Files opened for write can’t be seeked</li> 1437 <li>Existing files opened for write must have O_TRUNC set</li> 1438 <li>Files open for read with O_TRUNC will be opened write only</li> 1439 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1440 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1441 <li>If an upload fails it can’t be retried</li> 1442 </ul> 1443 <h3 id="vfs-cache-mode-minimal">–vfs-cache-mode minimal</h3> 1444 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 1445 <p>These operations are not possible</p> 1446 <ul> 1447 <li>Files opened for write only can’t be seeked</li> 1448 <li>Existing files opened for write must have O_TRUNC set</li> 1449 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1450 <li>If an upload fails it can’t be retried</li> 1451 </ul> 1452 <h3 id="vfs-cache-mode-writes">–vfs-cache-mode writes</h3> 1453 <p>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.</p> 1454 <p>This mode should support all normal file system operations.</p> 1455 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1456 <h3 id="vfs-cache-mode-full">–vfs-cache-mode full</h3> 1457 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 1458 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 1459 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 1460 <p>This mode should support all normal file system operations.</p> 1461 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1462 <h2 id="case-sensitivity">Case Sensitivity</h2> 1463 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 1464 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 1465 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 1466 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 1467 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 1468 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 1469 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 1470 <pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre> 1471 <h2 id="options-49">Options</h2> 1472 <pre><code> --allow-non-empty Allow mounting over a non-empty directory (not Windows). 1473 --allow-other Allow access to other users. 1474 --allow-root Allow access to root user. 1475 --async-read Use asynchronous reads. (default true) 1476 --attr-timeout duration Time for which file/directory attributes are cached. (default 1s) 1477 --daemon Run mount as a daemon (background mode). 1478 --daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). 1479 --debug-fuse Debug the FUSE internals - needs -v. 1480 --default-permissions Makes kernel enforce access control based on the file mode. 1481 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1482 --dir-perms FileMode Directory permissions (default 0777) 1483 --file-perms FileMode File permissions (default 0666) 1484 --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. 1485 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1486 -h, --help help for mount 1487 --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) 1488 --no-checksum Don't compare checksums on up/download. 1489 --no-modtime Don't read/write the modification time (can speed things up). 1490 --no-seek Don't allow seeking in files. 1491 -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. 1492 --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) 1493 --read-only Mount read-only. 1494 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1495 --umask int Override the permission bits set by the filesystem. 1496 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1497 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1498 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1499 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1500 --vfs-case-insensitive If a file name not found, find a case insensitive match. 1501 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1502 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 1503 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 1504 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) 1505 --volname string Set the volume name (not supported by all OSes). 1506 --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used.</code></pre> 1507 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1508 <h2 id="see-also-49">SEE ALSO</h2> 1509 <ul> 1510 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1511 </ul> 1512 <h1 id="rclone-moveto">rclone moveto</h1> 1513 <p>Move file or directory from source to dest.</p> 1514 <h2 id="synopsis-50">Synopsis</h2> 1515 <p>If source:path is a file or directory then it moves it to a file or directory named dest:path.</p> 1516 <p>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 command.</p> 1517 <p>So</p> 1518 <pre><code>rclone moveto src dst</code></pre> 1519 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 1520 <p>This will:</p> 1521 <pre><code>if src is file 1522 move it to dst, overwriting an existing file if it exists 1523 if src is directory 1524 move it to dst, overwriting existing files if they exist 1525 see move command for full details</code></pre> 1526 <p>This doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. src will be deleted on successful transfer.</p> 1527 <p><strong>Important</strong>: Since this can cause data loss, test first with the –dry-run flag.</p> 1528 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 1529 <pre><code>rclone moveto source:path dest:path [flags]</code></pre> 1530 <h2 id="options-50">Options</h2> 1531 <pre><code> -h, --help help for moveto</code></pre> 1532 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1533 <h2 id="see-also-50">SEE ALSO</h2> 1534 <ul> 1535 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1536 </ul> 1537 <h1 id="rclone-ncdu">rclone ncdu</h1> 1538 <p>Explore a remote with a text based user interface.</p> 1539 <h2 id="synopsis-51">Synopsis</h2> 1540 <p>This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - “What is using all my disk space?”.</p> 1541 <p>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.</p> 1542 <p>Here are the keys - press ‘?’ to toggle the help on and off</p> 1543 <pre><code> ↑,↓ or k,j to Move 1544 →,l to enter 1545 ←,h to return 1546 c toggle counts 1547 g toggle graph 1548 n,s,C sort by name,size,count 1549 d delete file/directory 1550 y copy current path to clipbard 1551 Y display current path 1552 ^L refresh screen 1553 ? to toggle help on and off 1554 q/ESC/c-C to quit</code></pre> 1555 <p>This an homage to the <a href="https://dev.yorhel.nl/ncdu">ncdu tool</a> but for rclone remotes. It is missing lots of features at the moment but is useful as it stands.</p> 1556 <p>Note that it might take some time to delete big files/folders. The UI won’t respond in the meantime since the deletion is done synchronously.</p> 1557 <pre><code>rclone ncdu remote:path [flags]</code></pre> 1558 <h2 id="options-51">Options</h2> 1559 <pre><code> -h, --help help for ncdu</code></pre> 1560 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1561 <h2 id="see-also-51">SEE ALSO</h2> 1562 <ul> 1563 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1564 </ul> 1565 <h1 id="rclone-obscure">rclone obscure</h1> 1566 <p>Obscure password for use in the rclone config file</p> 1567 <h2 id="synopsis-52">Synopsis</h2> 1568 <p>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 <strong>not</strong> a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent “eyedropping” - namely someone seeing a password in the rclone config file by accident.</p> 1569 <p>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.</p> 1570 <p>If you want to encrypt the config file then please use config file encryption - see <a href="https://rclone.org/commands/rclone_config/">rclone config</a> for more info.</p> 1571 <pre><code>rclone obscure password [flags]</code></pre> 1572 <h2 id="options-52">Options</h2> 1573 <pre><code> -h, --help help for obscure</code></pre> 1574 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1575 <h2 id="see-also-52">SEE ALSO</h2> 1576 <ul> 1577 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1578 </ul> 1579 <h1 id="rclone-rc">rclone rc</h1> 1580 <p>Run a command against a running rclone.</p> 1581 <h2 id="synopsis-53">Synopsis</h2> 1582 <p>This runs a command against a running rclone. Use the –url flag to specify an non default URL to connect on. This can be either a “:port” which is taken to mean “http://localhost:port” or a “host:port” which is taken to mean “http://host:port”</p> 1583 <p>A username and password can be passed in with –user and –pass.</p> 1584 <p>Note that –rc-addr, –rc-user, –rc-pass will be read also for –url, –user, –pass.</p> 1585 <p>Arguments should be passed in as parameter=value.</p> 1586 <p>The result will be returned as a JSON object by default.</p> 1587 <p>The –json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values.</p> 1588 <p>The -o/–opt option can be used to set a key “opt” with key, value options in the form “-o key=value” or “-o key”. It can be repeated as many times as required. This is useful for rc commands which take the “opt” parameter which by convention is a dictionary of strings.</p> 1589 <pre><code>-o key=value -o key2</code></pre> 1590 <p>Will place this in the “opt” value</p> 1591 <pre><code>{"key":"value", "key2","")</code></pre> 1592 <p>The -a/–arg option can be used to set strings in the “arg” value. It can be repeated as many times as required. This is useful for rc commands which take the “arg” parameter which by convention is a list of strings.</p> 1593 <pre><code>-a value -a value2</code></pre> 1594 <p>Will place this in the “arg” value</p> 1595 <pre><code>["value", "value2"]</code></pre> 1596 <p>Use –loopback to connect to the rclone instance running “rclone rc”. This is very useful for testing commands without having to run an rclone rc server, eg:</p> 1597 <pre><code>rclone rc --loopback operations/about fs=/</code></pre> 1598 <p>Use “rclone rc” to see a list of all possible commands.</p> 1599 <pre><code>rclone rc commands parameter [flags]</code></pre> 1600 <h2 id="options-53">Options</h2> 1601 <pre><code> -a, --arg stringArray Argument placed in the "arg" array. 1602 -h, --help help for rc 1603 --json string Input JSON - use instead of key=value args. 1604 --loopback If set connect to this rclone instance not via HTTP. 1605 --no-output If set don't output the JSON result. 1606 -o, --opt stringArray Option in the form name=value or name placed in the "opt" array. 1607 --pass string Password to use to connect to rclone remote control. 1608 --url string URL to connect to rclone remote control. (default "http://localhost:5572/") 1609 --user string Username to use to rclone remote control.</code></pre> 1610 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1611 <h2 id="see-also-53">SEE ALSO</h2> 1612 <ul> 1613 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1614 </ul> 1615 <h1 id="rclone-rcat">rclone rcat</h1> 1616 <p>Copies standard input to file on remote.</p> 1617 <h2 id="synopsis-54">Synopsis</h2> 1618 <p>rclone rcat reads from standard input (stdin) and copies it to a single remote file.</p> 1619 <pre><code>echo "hello world" | rclone rcat remote:path/to/file 1620 ffmpeg - | rclone rcat remote:path/to/file</code></pre> 1621 <p>If the remote file already exists, it will be overwritten.</p> 1622 <p>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 <code>--streaming-upload-cutoff</code>. 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.</p> 1623 <p>Note that the upload can also not be retried because the data is not kept around until the upload succeeds. If you need to transfer a lot of data, you’re better off caching locally and then <code>rclone move</code> it to the destination.</p> 1624 <pre><code>rclone rcat remote:path [flags]</code></pre> 1625 <h2 id="options-54">Options</h2> 1626 <pre><code> -h, --help help for rcat</code></pre> 1627 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1628 <h2 id="see-also-54">SEE ALSO</h2> 1629 <ul> 1630 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1631 </ul> 1632 <h1 id="rclone-rcd">rclone rcd</h1> 1633 <p>Run rclone listening to remote control commands only.</p> 1634 <h2 id="synopsis-55">Synopsis</h2> 1635 <p>This runs rclone so that it only listens to remote control commands.</p> 1636 <p>This is useful if you are controlling rclone via the rc API.</p> 1637 <p>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.</p> 1638 <p>See the <a href="https://rclone.org/rc/">rc documentation</a> for more info on the rc flags.</p> 1639 <pre><code>rclone rcd <path to files to serve>* [flags]</code></pre> 1640 <h2 id="options-55">Options</h2> 1641 <pre><code> -h, --help help for rcd</code></pre> 1642 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1643 <h2 id="see-also-55">SEE ALSO</h2> 1644 <ul> 1645 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1646 </ul> 1647 <h1 id="rclone-rmdirs">rclone rmdirs</h1> 1648 <p>Remove empty directories under the path.</p> 1649 <h2 id="synopsis-56">Synopsis</h2> 1650 <p>This removes any empty directories (or directories that only contain empty directories) under the path that it finds, including the path if it has nothing in.</p> 1651 <p>If you supply the –leave-root flag, it will not remove the root directory.</p> 1652 <p>This is useful for tidying up remotes that rclone has left a lot of empty directories in.</p> 1653 <pre><code>rclone rmdirs remote:path [flags]</code></pre> 1654 <h2 id="options-56">Options</h2> 1655 <pre><code> -h, --help help for rmdirs 1656 --leave-root Do not remove root directory if empty</code></pre> 1657 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1658 <h2 id="see-also-56">SEE ALSO</h2> 1659 <ul> 1660 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1661 </ul> 1662 <h1 id="rclone-serve">rclone serve</h1> 1663 <p>Serve a remote over a protocol.</p> 1664 <h2 id="synopsis-57">Synopsis</h2> 1665 <p>rclone serve is used to serve a remote over a given protocol. This command requires the use of a subcommand to specify the protocol, eg</p> 1666 <pre><code>rclone serve http remote:</code></pre> 1667 <p>Each subcommand has its own options which you can see in their help.</p> 1668 <pre><code>rclone serve <protocol> [opts] <remote> [flags]</code></pre> 1669 <h2 id="options-57">Options</h2> 1670 <pre><code> -h, --help help for serve</code></pre> 1671 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1672 <h2 id="see-also-57">SEE ALSO</h2> 1673 <ul> 1674 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1675 <li><a href="https://rclone.org/commands/rclone_serve_dlna/">rclone serve dlna</a> - Serve remote:path over DLNA</li> 1676 <li><a href="https://rclone.org/commands/rclone_serve_ftp/">rclone serve ftp</a> - Serve remote:path over FTP.</li> 1677 <li><a href="https://rclone.org/commands/rclone_serve_http/">rclone serve http</a> - Serve the remote over HTTP.</li> 1678 <li><a href="https://rclone.org/commands/rclone_serve_restic/">rclone serve restic</a> - Serve the remote for restic’s REST API.</li> 1679 <li><a href="https://rclone.org/commands/rclone_serve_sftp/">rclone serve sftp</a> - Serve the remote over SFTP.</li> 1680 <li><a href="https://rclone.org/commands/rclone_serve_webdav/">rclone serve webdav</a> - Serve remote:path over webdav.</li> 1681 </ul> 1682 <h1 id="rclone-serve-dlna">rclone serve dlna</h1> 1683 <p>Serve remote:path over DLNA</p> 1684 <h2 id="synopsis-58">Synopsis</h2> 1685 <p>rclone serve dlna is 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.</p> 1686 <p>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.</p> 1687 <h2 id="server-options">Server options</h2> 1688 <p>Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs.</p> 1689 <p>Use –name to choose the friendly server name, which is by default “rclone (hostname)”.</p> 1690 <p>Use –log-trace in conjunction with -vv to enable additional debug logging of all UPNP traffic.</p> 1691 <h2 id="directory-cache-1">Directory Cache</h2> 1692 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 1693 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 1694 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1695 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 1696 <pre><code>rclone rc vfs/forget</code></pre> 1697 <p>Or individual files or directories:</p> 1698 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1699 <h2 id="file-buffering-1">File Buffering</h2> 1700 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1701 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 1702 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 1703 <h2 id="file-caching-1">File Caching</h2> 1704 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 1705 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 1706 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 1707 <pre><code>--cache-dir string Directory rclone will use for caching. 1708 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1709 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1710 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1711 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1712 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 1713 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 1714 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 1715 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 1716 <h3 id="vfs-cache-mode-off-1">–vfs-cache-mode off</h3> 1717 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1718 <p>This will mean some operations are not possible</p> 1719 <ul> 1720 <li>Files can’t be opened for both read AND write</li> 1721 <li>Files opened for write can’t be seeked</li> 1722 <li>Existing files opened for write must have O_TRUNC set</li> 1723 <li>Files open for read with O_TRUNC will be opened write only</li> 1724 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1725 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1726 <li>If an upload fails it can’t be retried</li> 1727 </ul> 1728 <h3 id="vfs-cache-mode-minimal-1">–vfs-cache-mode minimal</h3> 1729 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 1730 <p>These operations are not possible</p> 1731 <ul> 1732 <li>Files opened for write only can’t be seeked</li> 1733 <li>Existing files opened for write must have O_TRUNC set</li> 1734 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1735 <li>If an upload fails it can’t be retried</li> 1736 </ul> 1737 <h3 id="vfs-cache-mode-writes-1">–vfs-cache-mode writes</h3> 1738 <p>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.</p> 1739 <p>This mode should support all normal file system operations.</p> 1740 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1741 <h3 id="vfs-cache-mode-full-1">–vfs-cache-mode full</h3> 1742 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 1743 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 1744 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 1745 <p>This mode should support all normal file system operations.</p> 1746 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1747 <h2 id="case-sensitivity-1">Case Sensitivity</h2> 1748 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 1749 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 1750 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 1751 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 1752 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 1753 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 1754 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 1755 <pre><code>rclone serve dlna remote:path [flags]</code></pre> 1756 <h2 id="options-58">Options</h2> 1757 <pre><code> --addr string ip:port or :port to bind the DLNA http server to. (default ":7879") 1758 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1759 --dir-perms FileMode Directory permissions (default 0777) 1760 --file-perms FileMode File permissions (default 0666) 1761 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1762 -h, --help help for dlna 1763 --log-trace enable trace logging of SOAP traffic 1764 --name string name of DLNA server 1765 --no-checksum Don't compare checksums on up/download. 1766 --no-modtime Don't read/write the modification time (can speed things up). 1767 --no-seek Don't allow seeking in files. 1768 --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) 1769 --read-only Mount read-only. 1770 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1771 --umask int Override the permission bits set by the filesystem. (default 2) 1772 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1773 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1774 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1775 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1776 --vfs-case-insensitive If a file name not found, find a case insensitive match. 1777 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1778 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 1779 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 1780 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)</code></pre> 1781 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1782 <h2 id="see-also-58">SEE ALSO</h2> 1783 <ul> 1784 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1785 </ul> 1786 <h1 id="rclone-serve-ftp">rclone serve ftp</h1> 1787 <p>Serve remote:path over FTP.</p> 1788 <h2 id="synopsis-59">Synopsis</h2> 1789 <p>rclone serve ftp implements a basic ftp server to serve the 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.</p> 1790 <h2 id="server-options-1">Server options</h2> 1791 <p>Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p> 1792 <p>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.</p> 1793 <h3 id="authentication">Authentication</h3> 1794 <p>By default this will serve files without needing a login.</p> 1795 <p>You can set a single username and password with the –user and –pass flags.</p> 1796 <h2 id="directory-cache-2">Directory Cache</h2> 1797 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 1798 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 1799 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1800 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 1801 <pre><code>rclone rc vfs/forget</code></pre> 1802 <p>Or individual files or directories:</p> 1803 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1804 <h2 id="file-buffering-2">File Buffering</h2> 1805 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1806 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 1807 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 1808 <h2 id="file-caching-2">File Caching</h2> 1809 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 1810 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 1811 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 1812 <pre><code>--cache-dir string Directory rclone will use for caching. 1813 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1814 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1815 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1816 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1817 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 1818 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 1819 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 1820 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 1821 <h3 id="vfs-cache-mode-off-2">–vfs-cache-mode off</h3> 1822 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1823 <p>This will mean some operations are not possible</p> 1824 <ul> 1825 <li>Files can’t be opened for both read AND write</li> 1826 <li>Files opened for write can’t be seeked</li> 1827 <li>Existing files opened for write must have O_TRUNC set</li> 1828 <li>Files open for read with O_TRUNC will be opened write only</li> 1829 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1830 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1831 <li>If an upload fails it can’t be retried</li> 1832 </ul> 1833 <h3 id="vfs-cache-mode-minimal-2">–vfs-cache-mode minimal</h3> 1834 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 1835 <p>These operations are not possible</p> 1836 <ul> 1837 <li>Files opened for write only can’t be seeked</li> 1838 <li>Existing files opened for write must have O_TRUNC set</li> 1839 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1840 <li>If an upload fails it can’t be retried</li> 1841 </ul> 1842 <h3 id="vfs-cache-mode-writes-2">–vfs-cache-mode writes</h3> 1843 <p>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.</p> 1844 <p>This mode should support all normal file system operations.</p> 1845 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1846 <h3 id="vfs-cache-mode-full-2">–vfs-cache-mode full</h3> 1847 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 1848 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 1849 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 1850 <p>This mode should support all normal file system operations.</p> 1851 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1852 <h2 id="case-sensitivity-2">Case Sensitivity</h2> 1853 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 1854 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 1855 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 1856 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 1857 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 1858 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 1859 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 1860 <h2 id="auth-proxy">Auth Proxy</h2> 1861 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> 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 protocl with input on STDIN and output on STDOUT.</p> 1862 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 1863 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 1864 <p>The program’s job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won’t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 1865 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 1866 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 1867 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 1868 <pre><code>{ 1869 "user": "me", 1870 "pass": "mypassword" 1871 }</code></pre> 1872 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 1873 <pre><code>{ 1874 "user": "me", 1875 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 1876 }</code></pre> 1877 <p>And as an example return this on STDOUT</p> 1878 <pre><code>{ 1879 "type": "sftp", 1880 "_root": "", 1881 "_obscure": "pass", 1882 "user": "me", 1883 "pass": "mypassword", 1884 "host": "sftp.example.com" 1885 }</code></pre> 1886 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 1887 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you’d probably want to restrict the <code>host</code> to a limited list.</p> 1888 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don’t use <code>pass</code> or <code>public_key</code>. This also means that if a user’s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 1889 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 1890 <pre><code>rclone serve ftp remote:path [flags]</code></pre> 1891 <h2 id="options-59">Options</h2> 1892 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") 1893 --auth-proxy string A program to use to create the backend from the auth. 1894 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1895 --dir-perms FileMode Directory permissions (default 0777) 1896 --file-perms FileMode File permissions (default 0666) 1897 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1898 -h, --help help for ftp 1899 --no-checksum Don't compare checksums on up/download. 1900 --no-modtime Don't read/write the modification time (can speed things up). 1901 --no-seek Don't allow seeking in files. 1902 --pass string Password for authentication. (empty value allow every password) 1903 --passive-port string Passive port range to use. (default "30000-32000") 1904 --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) 1905 --public-ip string Public IP address to advertise for passive connections. 1906 --read-only Mount read-only. 1907 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1908 --umask int Override the permission bits set by the filesystem. (default 2) 1909 --user string User name for authentication. (default "anonymous") 1910 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1911 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1912 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1913 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1914 --vfs-case-insensitive If a file name not found, find a case insensitive match. 1915 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1916 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 1917 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 1918 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)</code></pre> 1919 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1920 <h2 id="see-also-59">SEE ALSO</h2> 1921 <ul> 1922 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1923 </ul> 1924 <h1 id="rclone-serve-http">rclone serve http</h1> 1925 <p>Serve the remote over HTTP.</p> 1926 <h2 id="synopsis-60">Synopsis</h2> 1927 <p>rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it.</p> 1928 <p>You can use the filter flags (eg –include, –exclude) to control what is served.</p> 1929 <p>The server will log errors. Use -v to see access logs.</p> 1930 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 1931 <h2 id="server-options-2">Server options</h2> 1932 <p>Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p> 1933 <p>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.</p> 1934 <p>–server-read-timeout and –server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 1935 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 1936 <p>–baseurl controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used –baseurl “/rclone” then rclone would serve from a URL starting with “/rclone/”. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing “/” on –baseurl, so –baseurl “rclone”, –baseurl “/rclone” and –baseurl “/rclone/” are all treated identically.</p> 1937 <p>–template allows a user to specify a custom markup template for http and webdav serve functions. The server exports the following markup to be used within the template to server pages:</p> 1938 <table> 1939 <colgroup> 1940 <col style="width: 50%" /> 1941 <col style="width: 50%" /> 1942 </colgroup> 1943 <thead> 1944 <tr class="header"> 1945 <th style="text-align: left;">Parameter</th> 1946 <th style="text-align: left;">Description</th> 1947 </tr> 1948 </thead> 1949 <tbody> 1950 <tr class="odd"> 1951 <td style="text-align: left;">.Name</td> 1952 <td style="text-align: left;">The full path of a file/directory.</td> 1953 </tr> 1954 <tr class="even"> 1955 <td style="text-align: left;">.Title</td> 1956 <td style="text-align: left;">Directory listing of .Name</td> 1957 </tr> 1958 <tr class="odd"> 1959 <td style="text-align: left;">.Sort</td> 1960 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 1961 </tr> 1962 <tr class="even"> 1963 <td style="text-align: left;"></td> 1964 <td style="text-align: left;">Sort Options: namedirfist,name,size,time (default namedirfirst)</td> 1965 </tr> 1966 <tr class="odd"> 1967 <td style="text-align: left;">.Order</td> 1968 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 1969 </tr> 1970 <tr class="even"> 1971 <td style="text-align: left;"></td> 1972 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 1973 </tr> 1974 <tr class="odd"> 1975 <td style="text-align: left;">.Query</td> 1976 <td style="text-align: left;">Currently unused.</td> 1977 </tr> 1978 <tr class="even"> 1979 <td style="text-align: left;">.Breadcrumb</td> 1980 <td style="text-align: left;">Allows for creating a relative navigation</td> 1981 </tr> 1982 <tr class="odd"> 1983 <td style="text-align: left;">– .Link</td> 1984 <td style="text-align: left;">The relative to the root link of the Text.</td> 1985 </tr> 1986 <tr class="even"> 1987 <td style="text-align: left;">– .Text</td> 1988 <td style="text-align: left;">The Name of the directory.</td> 1989 </tr> 1990 <tr class="odd"> 1991 <td style="text-align: left;">.Entries</td> 1992 <td style="text-align: left;">Information about a specific file/directory.</td> 1993 </tr> 1994 <tr class="even"> 1995 <td style="text-align: left;">– .URL</td> 1996 <td style="text-align: left;">The ‘url’ of an entry.</td> 1997 </tr> 1998 <tr class="odd"> 1999 <td style="text-align: left;">– .Leaf</td> 2000 <td style="text-align: left;">Currently same as ‘URL’ but intended to be ‘just’ the name.</td> 2001 </tr> 2002 <tr class="even"> 2003 <td style="text-align: left;">– .IsDir</td> 2004 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 2005 </tr> 2006 <tr class="odd"> 2007 <td style="text-align: left;">– .Size</td> 2008 <td style="text-align: left;">Size in Bytes of the entry.</td> 2009 </tr> 2010 <tr class="even"> 2011 <td style="text-align: left;">– .ModTime</td> 2012 <td style="text-align: left;">The UTC timestamp of an entry.</td> 2013 </tr> 2014 </tbody> 2015 </table> 2016 <h3 id="authentication-1">Authentication</h3> 2017 <p>By default this will serve files without needing a login.</p> 2018 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the –user and –pass flags.</p> 2019 <p>Use –htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 2020 <p>To create an htpasswd file:</p> 2021 <pre><code>touch htpasswd 2022 htpasswd -B htpasswd user 2023 htpasswd -B htpasswd anotherUser</code></pre> 2024 <p>The password file can be updated while rclone is running.</p> 2025 <p>Use –realm to set the authentication realm.</p> 2026 <h3 id="ssltls">SSL/TLS</h3> 2027 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the –cert and –key flags. If you wish to do client side certificate validation then you will need to supply –client-ca also.</p> 2028 <p>–cert should be either a PEM encoded certificate or a concatenation of that with the CA certificate. –key should be the PEM encoded private key and –client-ca should be the PEM encoded client certificate authority certificate.</p> 2029 <h2 id="directory-cache-3">Directory Cache</h2> 2030 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 2031 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 2032 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 2033 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 2034 <pre><code>rclone rc vfs/forget</code></pre> 2035 <p>Or individual files or directories:</p> 2036 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 2037 <h2 id="file-buffering-3">File Buffering</h2> 2038 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 2039 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 2040 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 2041 <h2 id="file-caching-3">File Caching</h2> 2042 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 2043 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 2044 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 2045 <pre><code>--cache-dir string Directory rclone will use for caching. 2046 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2047 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 2048 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2049 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 2050 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 2051 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 2052 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 2053 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 2054 <h3 id="vfs-cache-mode-off-3">–vfs-cache-mode off</h3> 2055 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 2056 <p>This will mean some operations are not possible</p> 2057 <ul> 2058 <li>Files can’t be opened for both read AND write</li> 2059 <li>Files opened for write can’t be seeked</li> 2060 <li>Existing files opened for write must have O_TRUNC set</li> 2061 <li>Files open for read with O_TRUNC will be opened write only</li> 2062 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 2063 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 2064 <li>If an upload fails it can’t be retried</li> 2065 </ul> 2066 <h3 id="vfs-cache-mode-minimal-3">–vfs-cache-mode minimal</h3> 2067 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 2068 <p>These operations are not possible</p> 2069 <ul> 2070 <li>Files opened for write only can’t be seeked</li> 2071 <li>Existing files opened for write must have O_TRUNC set</li> 2072 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 2073 <li>If an upload fails it can’t be retried</li> 2074 </ul> 2075 <h3 id="vfs-cache-mode-writes-3">–vfs-cache-mode writes</h3> 2076 <p>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.</p> 2077 <p>This mode should support all normal file system operations.</p> 2078 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 2079 <h3 id="vfs-cache-mode-full-3">–vfs-cache-mode full</h3> 2080 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 2081 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 2082 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 2083 <p>This mode should support all normal file system operations.</p> 2084 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 2085 <h2 id="case-sensitivity-3">Case Sensitivity</h2> 2086 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 2087 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 2088 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 2089 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 2090 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 2091 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 2092 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 2093 <pre><code>rclone serve http remote:path [flags]</code></pre> 2094 <h2 id="options-60">Options</h2> 2095 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 2096 --baseurl string Prefix for URLs - leave blank for root. 2097 --cert string SSL PEM key (concatenation of certificate and CA certificate) 2098 --client-ca string Client certificate authority to verify clients with 2099 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 2100 --dir-perms FileMode Directory permissions (default 0777) 2101 --file-perms FileMode File permissions (default 0666) 2102 --gid uint32 Override the gid field set by the filesystem. (default 1000) 2103 -h, --help help for http 2104 --htpasswd string htpasswd file - if not provided no authentication is done 2105 --key string SSL PEM Private key 2106 --max-header-bytes int Maximum size of request header (default 4096) 2107 --no-checksum Don't compare checksums on up/download. 2108 --no-modtime Don't read/write the modification time (can speed things up). 2109 --no-seek Don't allow seeking in files. 2110 --pass string Password for authentication. 2111 --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) 2112 --read-only Mount read-only. 2113 --realm string realm for authentication (default "rclone") 2114 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 2115 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 2116 --template string User Specified Template. 2117 --uid uint32 Override the uid field set by the filesystem. (default 1000) 2118 --umask int Override the permission bits set by the filesystem. (default 2) 2119 --user string User name for authentication. 2120 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2121 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 2122 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 2123 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2124 --vfs-case-insensitive If a file name not found, find a case insensitive match. 2125 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 2126 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 2127 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 2128 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)</code></pre> 2129 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2130 <h2 id="see-also-60">SEE ALSO</h2> 2131 <ul> 2132 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 2133 </ul> 2134 <h1 id="rclone-serve-restic">rclone serve restic</h1> 2135 <p>Serve the remote for restic’s REST API.</p> 2136 <h2 id="synopsis-61">Synopsis</h2> 2137 <p>rclone serve restic implements restic’s REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly.</p> 2138 <p><a href="https://restic.net/">Restic</a> is a command line program for doing backups.</p> 2139 <p>The server will log errors. Use -v to see access logs.</p> 2140 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 2141 <h2 id="setting-up-rclone-for-use-by-restic">Setting up rclone for use by restic</h2> 2142 <p>First <a href="https://rclone.org/docs/#configure">set up a remote for your chosen cloud provider</a>.</p> 2143 <p>Once you have set up the remote, check it is working with, for example “rclone lsd remote:”. You may have called the remote something other than “remote:” - just substitute whatever you called it in the following instructions.</p> 2144 <p>Now start the rclone restic server</p> 2145 <pre><code>rclone serve restic -v remote:backup</code></pre> 2146 <p>Where you can replace “backup” in the above by whatever path in the remote you wish to use.</p> 2147 <p>By default this will serve on “localhost:8080” you can change this with use of the “–addr” flag.</p> 2148 <p>You might wish to start this server on boot.</p> 2149 <h2 id="setting-up-restic-to-use-rclone">Setting up restic to use rclone</h2> 2150 <p>Now you can <a href="http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server">follow the restic instructions</a> on setting up restic.</p> 2151 <p>Note that you will need restic 0.8.2 or later to interoperate with rclone.</p> 2152 <p>For the example above you will want to use “http://localhost:8080/” as the URL for the REST server.</p> 2153 <p>For example:</p> 2154 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/ 2155 $ export RESTIC_PASSWORD=yourpassword 2156 $ restic init 2157 created restic backend 8b1a4b56ae at rest:http://localhost:8080/ 2158 2159 Please note that knowledge of your password is required to access 2160 the repository. Losing your password means that your data is 2161 irrecoverably lost. 2162 $ restic backup /path/to/files/to/backup 2163 scan [/path/to/files/to/backup] 2164 scanned 189 directories, 312 files in 0:00 2165 [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 2166 duration: 0:00 2167 snapshot 45c8fdd8 saved</code></pre> 2168 <h3 id="multiple-repositories">Multiple repositories</h3> 2169 <p>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 <strong>must</strong> end with /. Eg</p> 2170 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ 2171 # backup user1 stuff 2172 $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ 2173 # backup user2 stuff</code></pre> 2174 <h3 id="private-repositories">Private repositories</h3> 2175 <p>The “–private-repos” flag can be used to limit users to repositories starting with a path of <code>/<username>/</code>.</p> 2176 <h2 id="server-options-3">Server options</h2> 2177 <p>Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p> 2178 <p>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.</p> 2179 <p>–server-read-timeout and –server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 2180 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 2181 <p>–baseurl controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used –baseurl “/rclone” then rclone would serve from a URL starting with “/rclone/”. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing “/” on –baseurl, so –baseurl “rclone”, –baseurl “/rclone” and –baseurl “/rclone/” are all treated identically.</p> 2182 <p>–template allows a user to specify a custom markup template for http and webdav serve functions. The server exports the following markup to be used within the template to server pages:</p> 2183 <table> 2184 <colgroup> 2185 <col style="width: 50%" /> 2186 <col style="width: 50%" /> 2187 </colgroup> 2188 <thead> 2189 <tr class="header"> 2190 <th style="text-align: left;">Parameter</th> 2191 <th style="text-align: left;">Description</th> 2192 </tr> 2193 </thead> 2194 <tbody> 2195 <tr class="odd"> 2196 <td style="text-align: left;">.Name</td> 2197 <td style="text-align: left;">The full path of a file/directory.</td> 2198 </tr> 2199 <tr class="even"> 2200 <td style="text-align: left;">.Title</td> 2201 <td style="text-align: left;">Directory listing of .Name</td> 2202 </tr> 2203 <tr class="odd"> 2204 <td style="text-align: left;">.Sort</td> 2205 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 2206 </tr> 2207 <tr class="even"> 2208 <td style="text-align: left;"></td> 2209 <td style="text-align: left;">Sort Options: namedirfist,name,size,time (default namedirfirst)</td> 2210 </tr> 2211 <tr class="odd"> 2212 <td style="text-align: left;">.Order</td> 2213 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 2214 </tr> 2215 <tr class="even"> 2216 <td style="text-align: left;"></td> 2217 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 2218 </tr> 2219 <tr class="odd"> 2220 <td style="text-align: left;">.Query</td> 2221 <td style="text-align: left;">Currently unused.</td> 2222 </tr> 2223 <tr class="even"> 2224 <td style="text-align: left;">.Breadcrumb</td> 2225 <td style="text-align: left;">Allows for creating a relative navigation</td> 2226 </tr> 2227 <tr class="odd"> 2228 <td style="text-align: left;">– .Link</td> 2229 <td style="text-align: left;">The relative to the root link of the Text.</td> 2230 </tr> 2231 <tr class="even"> 2232 <td style="text-align: left;">– .Text</td> 2233 <td style="text-align: left;">The Name of the directory.</td> 2234 </tr> 2235 <tr class="odd"> 2236 <td style="text-align: left;">.Entries</td> 2237 <td style="text-align: left;">Information about a specific file/directory.</td> 2238 </tr> 2239 <tr class="even"> 2240 <td style="text-align: left;">– .URL</td> 2241 <td style="text-align: left;">The ‘url’ of an entry.</td> 2242 </tr> 2243 <tr class="odd"> 2244 <td style="text-align: left;">– .Leaf</td> 2245 <td style="text-align: left;">Currently same as ‘URL’ but intended to be ‘just’ the name.</td> 2246 </tr> 2247 <tr class="even"> 2248 <td style="text-align: left;">– .IsDir</td> 2249 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 2250 </tr> 2251 <tr class="odd"> 2252 <td style="text-align: left;">– .Size</td> 2253 <td style="text-align: left;">Size in Bytes of the entry.</td> 2254 </tr> 2255 <tr class="even"> 2256 <td style="text-align: left;">– .ModTime</td> 2257 <td style="text-align: left;">The UTC timestamp of an entry.</td> 2258 </tr> 2259 </tbody> 2260 </table> 2261 <h3 id="authentication-2">Authentication</h3> 2262 <p>By default this will serve files without needing a login.</p> 2263 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the –user and –pass flags.</p> 2264 <p>Use –htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 2265 <p>To create an htpasswd file:</p> 2266 <pre><code>touch htpasswd 2267 htpasswd -B htpasswd user 2268 htpasswd -B htpasswd anotherUser</code></pre> 2269 <p>The password file can be updated while rclone is running.</p> 2270 <p>Use –realm to set the authentication realm.</p> 2271 <h3 id="ssltls-1">SSL/TLS</h3> 2272 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the –cert and –key flags. If you wish to do client side certificate validation then you will need to supply –client-ca also.</p> 2273 <p>–cert should be either a PEM encoded certificate or a concatenation of that with the CA certificate. –key should be the PEM encoded private key and –client-ca should be the PEM encoded client certificate authority certificate.</p> 2274 <pre><code>rclone serve restic remote:path [flags]</code></pre> 2275 <h2 id="options-61">Options</h2> 2276 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 2277 --append-only disallow deletion of repository data 2278 --baseurl string Prefix for URLs - leave blank for root. 2279 --cert string SSL PEM key (concatenation of certificate and CA certificate) 2280 --client-ca string Client certificate authority to verify clients with 2281 -h, --help help for restic 2282 --htpasswd string htpasswd file - if not provided no authentication is done 2283 --key string SSL PEM Private key 2284 --max-header-bytes int Maximum size of request header (default 4096) 2285 --pass string Password for authentication. 2286 --private-repos users can only access their private repo 2287 --realm string realm for authentication (default "rclone") 2288 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 2289 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 2290 --stdio run an HTTP2 server on stdin/stdout 2291 --template string User Specified Template. 2292 --user string User name for authentication.</code></pre> 2293 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2294 <h2 id="see-also-61">SEE ALSO</h2> 2295 <ul> 2296 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 2297 </ul> 2298 <h1 id="rclone-serve-sftp">rclone serve sftp</h1> 2299 <p>Serve the remote over SFTP.</p> 2300 <h2 id="synopsis-62">Synopsis</h2> 2301 <p>rclone serve sftp implements an SFTP server to serve the remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it.</p> 2302 <p>You can use the filter flags (eg –include, –exclude) to control what is served.</p> 2303 <p>The server will log errors. Use -v to see access logs.</p> 2304 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 2305 <p>You must provide some means of authentication, either with –user/–pass, an authorized keys file (specify location with –authorized-keys - the default is the same as ssh), an –auth-proxy, or set the –no-auth flag for no authentication when logging in.</p> 2306 <p>Note that this also implements a small number of shell commands so that it can provide md5sum/sha1sum/df information for the rclone sftp backend. This means that is can support SHA1SUMs, MD5SUMs and the about command when paired with the rclone sftp backend.</p> 2307 <p>If you don’t supply a –key then rclone will generate one and cache it for later use.</p> 2308 <p>By default the server binds to localhost:2022 - if you want it to be reachable externally then supply “–addr :2022” for example.</p> 2309 <p>Note that the default of “–vfs-cache-mode off” is fine for the rclone sftp backend, but it may not be with other SFTP clients.</p> 2310 <h2 id="directory-cache-4">Directory Cache</h2> 2311 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 2312 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 2313 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 2314 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 2315 <pre><code>rclone rc vfs/forget</code></pre> 2316 <p>Or individual files or directories:</p> 2317 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 2318 <h2 id="file-buffering-4">File Buffering</h2> 2319 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 2320 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 2321 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 2322 <h2 id="file-caching-4">File Caching</h2> 2323 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 2324 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 2325 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 2326 <pre><code>--cache-dir string Directory rclone will use for caching. 2327 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2328 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 2329 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2330 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 2331 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 2332 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 2333 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 2334 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 2335 <h3 id="vfs-cache-mode-off-4">–vfs-cache-mode off</h3> 2336 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 2337 <p>This will mean some operations are not possible</p> 2338 <ul> 2339 <li>Files can’t be opened for both read AND write</li> 2340 <li>Files opened for write can’t be seeked</li> 2341 <li>Existing files opened for write must have O_TRUNC set</li> 2342 <li>Files open for read with O_TRUNC will be opened write only</li> 2343 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 2344 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 2345 <li>If an upload fails it can’t be retried</li> 2346 </ul> 2347 <h3 id="vfs-cache-mode-minimal-4">–vfs-cache-mode minimal</h3> 2348 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 2349 <p>These operations are not possible</p> 2350 <ul> 2351 <li>Files opened for write only can’t be seeked</li> 2352 <li>Existing files opened for write must have O_TRUNC set</li> 2353 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 2354 <li>If an upload fails it can’t be retried</li> 2355 </ul> 2356 <h3 id="vfs-cache-mode-writes-4">–vfs-cache-mode writes</h3> 2357 <p>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.</p> 2358 <p>This mode should support all normal file system operations.</p> 2359 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 2360 <h3 id="vfs-cache-mode-full-4">–vfs-cache-mode full</h3> 2361 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 2362 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 2363 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 2364 <p>This mode should support all normal file system operations.</p> 2365 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 2366 <h2 id="case-sensitivity-4">Case Sensitivity</h2> 2367 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 2368 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 2369 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 2370 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 2371 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 2372 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 2373 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 2374 <h2 id="auth-proxy-1">Auth Proxy</h2> 2375 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> 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 protocl with input on STDIN and output on STDOUT.</p> 2376 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 2377 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 2378 <p>The program’s job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won’t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 2379 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 2380 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 2381 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 2382 <pre><code>{ 2383 "user": "me", 2384 "pass": "mypassword" 2385 }</code></pre> 2386 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 2387 <pre><code>{ 2388 "user": "me", 2389 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 2390 }</code></pre> 2391 <p>And as an example return this on STDOUT</p> 2392 <pre><code>{ 2393 "type": "sftp", 2394 "_root": "", 2395 "_obscure": "pass", 2396 "user": "me", 2397 "pass": "mypassword", 2398 "host": "sftp.example.com" 2399 }</code></pre> 2400 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 2401 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you’d probably want to restrict the <code>host</code> to a limited list.</p> 2402 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don’t use <code>pass</code> or <code>public_key</code>. This also means that if a user’s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 2403 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 2404 <pre><code>rclone serve sftp remote:path [flags]</code></pre> 2405 <h2 id="options-62">Options</h2> 2406 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022") 2407 --auth-proxy string A program to use to create the backend from the auth. 2408 --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") 2409 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 2410 --dir-perms FileMode Directory permissions (default 0777) 2411 --file-perms FileMode File permissions (default 0666) 2412 --gid uint32 Override the gid field set by the filesystem. (default 1000) 2413 -h, --help help for sftp 2414 --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) 2415 --no-auth Allow connections with no authentication if set. 2416 --no-checksum Don't compare checksums on up/download. 2417 --no-modtime Don't read/write the modification time (can speed things up). 2418 --no-seek Don't allow seeking in files. 2419 --pass string Password for authentication. 2420 --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) 2421 --read-only Mount read-only. 2422 --uid uint32 Override the uid field set by the filesystem. (default 1000) 2423 --umask int Override the permission bits set by the filesystem. (default 2) 2424 --user string User name for authentication. 2425 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2426 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 2427 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 2428 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2429 --vfs-case-insensitive If a file name not found, find a case insensitive match. 2430 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 2431 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 2432 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 2433 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)</code></pre> 2434 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2435 <h2 id="see-also-62">SEE ALSO</h2> 2436 <ul> 2437 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 2438 </ul> 2439 <h1 id="rclone-serve-webdav">rclone serve webdav</h1> 2440 <p>Serve remote:path over webdav.</p> 2441 <h2 id="synopsis-63">Synopsis</h2> 2442 <p>rclone serve webdav implements a basic webdav server to serve the 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.</p> 2443 <h2 id="webdav-options">Webdav options</h2> 2444 <h3 id="etag-hash">–etag-hash</h3> 2445 <p>This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object.</p> 2446 <p>If this flag is set to “auto” then rclone will choose the first supported hash on the backend or you can use a named hash such as “MD5” or “SHA-1”.</p> 2447 <p>Use “rclone hashsum” to see the full list.</p> 2448 <h2 id="server-options-4">Server options</h2> 2449 <p>Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p> 2450 <p>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.</p> 2451 <p>–server-read-timeout and –server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 2452 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 2453 <p>–baseurl controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used –baseurl “/rclone” then rclone would serve from a URL starting with “/rclone/”. This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing “/” on –baseurl, so –baseurl “rclone”, –baseurl “/rclone” and –baseurl “/rclone/” are all treated identically.</p> 2454 <p>–template allows a user to specify a custom markup template for http and webdav serve functions. The server exports the following markup to be used within the template to server pages:</p> 2455 <table> 2456 <colgroup> 2457 <col style="width: 50%" /> 2458 <col style="width: 50%" /> 2459 </colgroup> 2460 <thead> 2461 <tr class="header"> 2462 <th style="text-align: left;">Parameter</th> 2463 <th style="text-align: left;">Description</th> 2464 </tr> 2465 </thead> 2466 <tbody> 2467 <tr class="odd"> 2468 <td style="text-align: left;">.Name</td> 2469 <td style="text-align: left;">The full path of a file/directory.</td> 2470 </tr> 2471 <tr class="even"> 2472 <td style="text-align: left;">.Title</td> 2473 <td style="text-align: left;">Directory listing of .Name</td> 2474 </tr> 2475 <tr class="odd"> 2476 <td style="text-align: left;">.Sort</td> 2477 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 2478 </tr> 2479 <tr class="even"> 2480 <td style="text-align: left;"></td> 2481 <td style="text-align: left;">Sort Options: namedirfist,name,size,time (default namedirfirst)</td> 2482 </tr> 2483 <tr class="odd"> 2484 <td style="text-align: left;">.Order</td> 2485 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 2486 </tr> 2487 <tr class="even"> 2488 <td style="text-align: left;"></td> 2489 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 2490 </tr> 2491 <tr class="odd"> 2492 <td style="text-align: left;">.Query</td> 2493 <td style="text-align: left;">Currently unused.</td> 2494 </tr> 2495 <tr class="even"> 2496 <td style="text-align: left;">.Breadcrumb</td> 2497 <td style="text-align: left;">Allows for creating a relative navigation</td> 2498 </tr> 2499 <tr class="odd"> 2500 <td style="text-align: left;">– .Link</td> 2501 <td style="text-align: left;">The relative to the root link of the Text.</td> 2502 </tr> 2503 <tr class="even"> 2504 <td style="text-align: left;">– .Text</td> 2505 <td style="text-align: left;">The Name of the directory.</td> 2506 </tr> 2507 <tr class="odd"> 2508 <td style="text-align: left;">.Entries</td> 2509 <td style="text-align: left;">Information about a specific file/directory.</td> 2510 </tr> 2511 <tr class="even"> 2512 <td style="text-align: left;">– .URL</td> 2513 <td style="text-align: left;">The ‘url’ of an entry.</td> 2514 </tr> 2515 <tr class="odd"> 2516 <td style="text-align: left;">– .Leaf</td> 2517 <td style="text-align: left;">Currently same as ‘URL’ but intended to be ‘just’ the name.</td> 2518 </tr> 2519 <tr class="even"> 2520 <td style="text-align: left;">– .IsDir</td> 2521 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 2522 </tr> 2523 <tr class="odd"> 2524 <td style="text-align: left;">– .Size</td> 2525 <td style="text-align: left;">Size in Bytes of the entry.</td> 2526 </tr> 2527 <tr class="even"> 2528 <td style="text-align: left;">– .ModTime</td> 2529 <td style="text-align: left;">The UTC timestamp of an entry.</td> 2530 </tr> 2531 </tbody> 2532 </table> 2533 <h3 id="authentication-3">Authentication</h3> 2534 <p>By default this will serve files without needing a login.</p> 2535 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the –user and –pass flags.</p> 2536 <p>Use –htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 2537 <p>To create an htpasswd file:</p> 2538 <pre><code>touch htpasswd 2539 htpasswd -B htpasswd user 2540 htpasswd -B htpasswd anotherUser</code></pre> 2541 <p>The password file can be updated while rclone is running.</p> 2542 <p>Use –realm to set the authentication realm.</p> 2543 <h3 id="ssltls-2">SSL/TLS</h3> 2544 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the –cert and –key flags. If you wish to do client side certificate validation then you will need to supply –client-ca also.</p> 2545 <p>–cert should be either a PEM encoded certificate or a concatenation of that with the CA certificate. –key should be the PEM encoded private key and –client-ca should be the PEM encoded client certificate authority certificate.</p> 2546 <h2 id="directory-cache-5">Directory Cache</h2> 2547 <p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up on within the polling interval.</p> 2548 <p>Alternatively, you can send a <code>SIGHUP</code> 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:</p> 2549 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 2550 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p> 2551 <pre><code>rclone rc vfs/forget</code></pre> 2552 <p>Or individual files or directories:</p> 2553 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 2554 <h2 id="file-buffering-5">File Buffering</h2> 2555 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 2556 <p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won’t be shared between multiple open file descriptors of the same file.</p> 2557 <p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 2558 <h2 id="file-caching-5">File Caching</h2> 2559 <p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p> 2560 <p>You’ll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p> 2561 <p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p> 2562 <pre><code>--cache-dir string Directory rclone will use for caching. 2563 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2564 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 2565 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2566 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 2567 <p>If run with <code>-vv</code> 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 <code>--cache-dir</code> or setting the appropriate environment variable.</p> 2568 <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> 2569 <p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won’t get written back to the remote. However they will still be in the on disk cache.</p> 2570 <p>If using –vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every –vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p> 2571 <h3 id="vfs-cache-mode-off-5">–vfs-cache-mode off</h3> 2572 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 2573 <p>This will mean some operations are not possible</p> 2574 <ul> 2575 <li>Files can’t be opened for both read AND write</li> 2576 <li>Files opened for write can’t be seeked</li> 2577 <li>Existing files opened for write must have O_TRUNC set</li> 2578 <li>Files open for read with O_TRUNC will be opened write only</li> 2579 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 2580 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 2581 <li>If an upload fails it can’t be retried</li> 2582 </ul> 2583 <h3 id="vfs-cache-mode-minimal-5">–vfs-cache-mode minimal</h3> 2584 <p>This is very similar to “off” except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 2585 <p>These operations are not possible</p> 2586 <ul> 2587 <li>Files opened for write only can’t be seeked</li> 2588 <li>Existing files opened for write must have O_TRUNC set</li> 2589 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 2590 <li>If an upload fails it can’t be retried</li> 2591 </ul> 2592 <h3 id="vfs-cache-mode-writes-5">–vfs-cache-mode writes</h3> 2593 <p>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.</p> 2594 <p>This mode should support all normal file system operations.</p> 2595 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 2596 <h3 id="vfs-cache-mode-full-5">–vfs-cache-mode full</h3> 2597 <p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p> 2598 <p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p> 2599 <p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p> 2600 <p>This mode should support all normal file system operations.</p> 2601 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 2602 <h2 id="case-sensitivity-5">Case Sensitivity</h2> 2603 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 2604 <p>Windows is not like most other operating systems supported by rclone. 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.</p> 2605 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default</p> 2606 <p>The “–vfs-case-insensitive” mount flag controls how rclone handles these two cases. If its value is “false”, rclone passes file names to the mounted file system as is. If the flag is “true” (or appears without a value on command line), rclone may perform a “fixup” as explained below.</p> 2607 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on mounted file system. 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 an underlying mounted file system.</p> 2608 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system mounted by rclone (the source). The flag controls whether “fixup” is performed to satisfy the target.</p> 2609 <p>If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: “true” on Windows and macOS, “false” otherwise. If the flag is provided without a value, then it is “true”.</p> 2610 <h2 id="auth-proxy-2">Auth Proxy</h2> 2611 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> 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 protocl with input on STDIN and output on STDOUT.</p> 2612 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 2613 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 2614 <p>The program’s job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won’t use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 2615 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 2616 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 2617 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 2618 <pre><code>{ 2619 "user": "me", 2620 "pass": "mypassword" 2621 }</code></pre> 2622 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 2623 <pre><code>{ 2624 "user": "me", 2625 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 2626 }</code></pre> 2627 <p>And as an example return this on STDOUT</p> 2628 <pre><code>{ 2629 "type": "sftp", 2630 "_root": "", 2631 "_obscure": "pass", 2632 "user": "me", 2633 "pass": "mypassword", 2634 "host": "sftp.example.com" 2635 }</code></pre> 2636 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 2637 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you’d probably want to restrict the <code>host</code> to a limited list.</p> 2638 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don’t use <code>pass</code> or <code>public_key</code>. This also means that if a user’s password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 2639 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 2640 <pre><code>rclone serve webdav remote:path [flags]</code></pre> 2641 <h2 id="options-63">Options</h2> 2642 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 2643 --auth-proxy string A program to use to create the backend from the auth. 2644 --baseurl string Prefix for URLs - leave blank for root. 2645 --cert string SSL PEM key (concatenation of certificate and CA certificate) 2646 --client-ca string Client certificate authority to verify clients with 2647 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 2648 --dir-perms FileMode Directory permissions (default 0777) 2649 --disable-dir-list Disable HTML directory list on GET request for a directory 2650 --etag-hash string Which hash to use for the ETag, or auto or blank for off 2651 --file-perms FileMode File permissions (default 0666) 2652 --gid uint32 Override the gid field set by the filesystem. (default 1000) 2653 -h, --help help for webdav 2654 --htpasswd string htpasswd file - if not provided no authentication is done 2655 --key string SSL PEM Private key 2656 --max-header-bytes int Maximum size of request header (default 4096) 2657 --no-checksum Don't compare checksums on up/download. 2658 --no-modtime Don't read/write the modification time (can speed things up). 2659 --no-seek Don't allow seeking in files. 2660 --pass string Password for authentication. 2661 --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) 2662 --read-only Mount read-only. 2663 --realm string realm for authentication (default "rclone") 2664 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 2665 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 2666 --template string User Specified Template. 2667 --uid uint32 Override the uid field set by the filesystem. (default 1000) 2668 --umask int Override the permission bits set by the filesystem. (default 2) 2669 --user string User name for authentication. 2670 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2671 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 2672 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 2673 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2674 --vfs-case-insensitive If a file name not found, find a case insensitive match. 2675 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 2676 --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) 2677 --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) 2678 --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)</code></pre> 2679 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2680 <h2 id="see-also-63">SEE ALSO</h2> 2681 <ul> 2682 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 2683 </ul> 2684 <h1 id="rclone-settier">rclone settier</h1> 2685 <p>Changes storage class/tier of objects in remote.</p> 2686 <h2 id="synopsis-64">Synopsis</h2> 2687 <p>rclone settier 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.</p> 2688 <p>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</p> 2689 <p>You can use it to tier single object</p> 2690 <pre><code>rclone settier Cool remote:path/file</code></pre> 2691 <p>Or use rclone filters to set tier on only specific files</p> 2692 <pre><code>rclone --include "*.txt" settier Hot remote:path/dir</code></pre> 2693 <p>Or just provide remote directory and all files in directory will be tiered</p> 2694 <pre><code>rclone settier tier remote:path/dir</code></pre> 2695 <pre><code>rclone settier tier remote:path [flags]</code></pre> 2696 <h2 id="options-64">Options</h2> 2697 <pre><code> -h, --help help for settier</code></pre> 2698 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2699 <h2 id="see-also-64">SEE ALSO</h2> 2700 <ul> 2701 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2702 </ul> 2703 <h1 id="rclone-touch">rclone touch</h1> 2704 <p>Create new file or change file modification time.</p> 2705 <h2 id="synopsis-65">Synopsis</h2> 2706 <p>Set the modification time on object(s) as specified by remote:path to have the current time.</p> 2707 <p>If remote:path does not exist then a zero sized object will be created unless the –no-create flag is provided.</p> 2708 <p>If –timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of:</p> 2709 <ul> 2710 <li>‘YYMMDD’ - eg. 17.10.30</li> 2711 <li>‘YYYY-MM-DDTHH:MM:SS’ - eg. 2006-01-02T15:04:05</li> 2712 </ul> 2713 <p>Note that –timestamp is in UTC if you want local time then add the –localtime flag.</p> 2714 <pre><code>rclone touch remote:path [flags]</code></pre> 2715 <h2 id="options-65">Options</h2> 2716 <pre><code> -h, --help help for touch 2717 --localtime Use localtime for timestamp, not UTC. 2718 -C, --no-create Do not create the file if it does not exist. 2719 -t, --timestamp string Use specified time instead of the current time of day.</code></pre> 2720 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2721 <h2 id="see-also-65">SEE ALSO</h2> 2722 <ul> 2723 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2724 </ul> 2725 <h1 id="rclone-tree">rclone tree</h1> 2726 <p>List the contents of the remote in a tree like fashion.</p> 2727 <h2 id="synopsis-66">Synopsis</h2> 2728 <p>rclone tree lists the contents of a remote in a similar way to the unix tree command.</p> 2729 <p>For example</p> 2730 <pre><code>$ rclone tree remote:path 2731 / 2732 ├── file1 2733 ├── file2 2734 ├── file3 2735 └── subdir 2736 ├── file4 2737 └── file5 2738 2739 1 directories, 5 files</code></pre> 2740 <p>You can use any of the filtering options with the tree command (eg –include and –exclude). You can also use –fast-list.</p> 2741 <p>The tree command has many options for controlling the listing which are compatible with the tree command. Note that not all of them have short options as they conflict with rclone’s short options.</p> 2742 <pre><code>rclone tree remote:path [flags]</code></pre> 2743 <h2 id="options-66">Options</h2> 2744 <pre><code> -a, --all All files are listed (list . files too). 2745 -C, --color Turn colorization on always. 2746 -d, --dirs-only List directories only. 2747 --dirsfirst List directories before files (-U disables). 2748 --full-path Print the full path prefix for each file. 2749 -h, --help help for tree 2750 --human Print the size in a more human readable way. 2751 --level int Descend only level directories deep. 2752 -D, --modtime Print the date of last modification. 2753 -i, --noindent Don't print indentation lines. 2754 --noreport Turn off file/directory count at end of tree listing. 2755 -o, --output string Output to file instead of stdout. 2756 -p, --protections Print the protections for each file. 2757 -Q, --quote Quote filenames with double quotes. 2758 -s, --size Print the size in bytes of each file. 2759 --sort string Select sort: name,version,size,mtime,ctime. 2760 --sort-ctime Sort files by last status change time. 2761 -t, --sort-modtime Sort files by last modification time. 2762 -r, --sort-reverse Reverse the order of the sort. 2763 -U, --unsorted Leave files unsorted. 2764 --version Sort files alphanumerically by version.</code></pre> 2765 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2766 <h2 id="see-also-66">SEE ALSO</h2> 2767 <ul> 2768 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2769 </ul> 2770 <h2 id="copying-single-files">Copying single files</h2> 2771 <p>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 <code>Failed to create file system for "remote:file": is a file not a directory</code> if it isn’t.</p> 2772 <p>For example, suppose you have a remote with a file in called <code>test.jpg</code>, then you could copy just that file like this</p> 2773 <pre><code>rclone copy remote:test.jpg /tmp/download</code></pre> 2774 <p>The file <code>test.jpg</code> will be placed inside <code>/tmp/download</code>.</p> 2775 <p>This is equivalent to specifying</p> 2776 <pre><code>rclone copy --files-from /tmp/files remote: /tmp/download</code></pre> 2777 <p>Where <code>/tmp/files</code> contains the single line</p> 2778 <pre><code>test.jpg</code></pre> 2779 <p>It is recommended to use <code>copy</code> when copying individual files, not <code>sync</code>. They have pretty much the same effect but <code>copy</code> will use a lot less memory.</p> 2780 <h2 id="syntax-of-remote-paths">Syntax of remote paths</h2> 2781 <p>The syntax of the paths passed to the rclone command are as follows.</p> 2782 <h3 id="pathtodir">/path/to/dir</h3> 2783 <p>This refers to the local file system.</p> 2784 <p>On Windows only <code>\</code> may be used instead of <code>/</code> in local paths <strong>only</strong>, non local paths must use <code>/</code>.</p> 2785 <p>These paths needn’t start with a leading <code>/</code> - if they don’t then they will be relative to the current directory.</p> 2786 <h3 id="remotepathtodir">remote:path/to/dir</h3> 2787 <p>This refers to a directory <code>path/to/dir</code> on <code>remote:</code> as defined in the config file (configured with <code>rclone config</code>).</p> 2788 <h3 id="remotepathtodir-1">remote:/path/to/dir</h3> 2789 <p>On most backends this is refers to the same directory as <code>remote:path/to/dir</code> 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 <code>/</code> will refer to your “home” directory and paths with a leading <code>/</code> will refer to the root.</p> 2790 <h3 id="backendpathtodir">:backend:path/to/dir</h3> 2791 <p>This is an advanced form for creating remotes on the fly. <code>backend</code> should be the name or prefix of a backend (the <code>type</code> in the config file) and all the configuration for the backend should be provided on the command line (or in environment variables).</p> 2792 <p>Here are some examples:</p> 2793 <pre><code>rclone lsd --http-url https://pub.rclone.org :http:</code></pre> 2794 <p>To list all the directories in the root of <code>https://pub.rclone.org/</code>.</p> 2795 <pre><code>rclone lsf --http-url https://example.com :http:path/to/dir</code></pre> 2796 <p>To list files and directories in <code>https://example.com/path/to/dir/</code></p> 2797 <pre><code>rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir</code></pre> 2798 <p>To copy files and directories in <code>https://example.com/path/to/dir</code> to <code>/tmp/dir</code>.</p> 2799 <pre><code>rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir</code></pre> 2800 <p>To copy files and directories from <code>example.com</code> in the relative directory <code>path/to/dir</code> to <code>/tmp/dir</code> using sftp.</p> 2801 <h2 id="quoting-and-the-shell">Quoting and the shell</h2> 2802 <p>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.</p> 2803 <p>Here are some gotchas which may help users unfamiliar with the shell rules</p> 2804 <h3 id="linux-osx">Linux / OSX</h3> 2805 <p>If your names have spaces or shell metacharacters (eg <code>*</code>, <code>?</code>, <code>$</code>, <code>'</code>, <code>"</code> etc) then you must quote them. Use single quotes <code>'</code> by default.</p> 2806 <pre><code>rclone copy 'Important files?' remote:backup</code></pre> 2807 <p>If you want to send a <code>'</code> you will need to use <code>"</code>, eg</p> 2808 <pre><code>rclone copy "O'Reilly Reviews" remote:backup</code></pre> 2809 <p>The rules for quoting metacharacters are complicated and if you want the full details you’ll have to consult the manual page for your shell.</p> 2810 <h3 id="windows">Windows</h3> 2811 <p>If your names have spaces in you need to put them in <code>"</code>, eg</p> 2812 <pre><code>rclone copy "E:\folder name\folder name\folder name" remote:backup</code></pre> 2813 <p>If you are using the root directory on its own then don’t quote it (see <a href="https://github.com/rclone/rclone/issues/464">#464</a> for why), eg</p> 2814 <pre><code>rclone copy E:\ remote:backup</code></pre> 2815 <h2 id="copying-files-or-directories-with-in-the-names">Copying files or directories with <code>:</code> in the names</h2> 2816 <p>rclone uses <code>:</code> 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 <code>:</code> up to the first <code>/</code> so if you need to act on a file or directory like this then use the full path starting with a <code>/</code>, or use <code>./</code> as a current directory prefix.</p> 2817 <p>So to sync a directory called <code>sync:me</code> to a remote called <code>remote:</code> use</p> 2818 <pre><code>rclone sync ./sync:me remote:path</code></pre> 2819 <p>or</p> 2820 <pre><code>rclone sync /full/path/to/sync:me remote:path</code></pre> 2821 <h2 id="server-side-copy">Server Side Copy</h2> 2822 <p>Most remotes (but not all - see <a href="https://rclone.org/overview/#optional-features">the overview</a>) support server side copy.</p> 2823 <p>This means if you want to copy one folder to another then rclone won’t download all the files and re-upload them; it will instruct the server to copy them in place.</p> 2824 <p>Eg</p> 2825 <pre><code>rclone copy s3:oldbucket s3:newbucket</code></pre> 2826 <p>Will copy the contents of <code>oldbucket</code> to <code>newbucket</code> without downloading and re-uploading.</p> 2827 <p>Remotes which don’t support server side copy <strong>will</strong> download and re-upload in this case.</p> 2828 <p>Server side copies are used with <code>sync</code> and <code>copy</code> and will be identified in the log when using the <code>-v</code> flag. The <code>move</code> command may also use them if remote doesn’t support server side move directly. This is done by issuing a server side copy then a delete which is much quicker than a download and re-upload.</p> 2829 <p>Server side copies will only be attempted if the remote names are the same.</p> 2830 <p>This can be used when scripting to make aged backups efficiently, eg</p> 2831 <pre><code>rclone sync remote:current-backup remote:previous-backup 2832 rclone sync /path/to/files remote:current-backup</code></pre> 2833 <h2 id="options-67">Options</h2> 2834 <p>Rclone has a number of options to control its behaviour.</p> 2835 <p>Options that take parameters can have the values passed in two ways, <code>--option=value</code> or <code>--option value</code>. However boolean (true/false) options behave slightly differently to the other options in that <code>--boolean</code> sets the option to <code>true</code> and the absence of the flag sets it to <code>false</code>. It is also possible to specify <code>--boolean=false</code> or <code>--boolean=true</code>. Note that <code>--boolean false</code> is not valid - this is parsed as <code>--boolean</code> and the <code>false</code> is parsed as an extra command line argument for rclone.</p> 2836 <p>Options which use TIME use the go time parser. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “-1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.</p> 2837 <p>Options which use SIZE use kByte by default. However, a suffix of <code>b</code> for bytes, <code>k</code> for kBytes, <code>M</code> for MBytes, <code>G</code> for GBytes, <code>T</code> for TBytes and <code>P</code> for PBytes may be used. These are the binary units, eg 1, 2**10, 2**20, 2**30 respectively.</p> 2838 <h3 id="backup-dirdir">–backup-dir=DIR</h3> 2839 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> any files which would have been overwritten or deleted are moved in their original hierarchy into this directory.</p> 2840 <p>If <code>--suffix</code> 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.</p> 2841 <p>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.</p> 2842 <p>For example</p> 2843 <pre><code>rclone sync /path/to/local remote:current --backup-dir remote:old</code></pre> 2844 <p>will sync <code>/path/to/local</code> to <code>remote:current</code>, but for any files which would have been updated or deleted will be stored in <code>remote:old</code>.</p> 2845 <p>If running rclone from a script you might want to use today’s date as the directory name passed to <code>--backup-dir</code> to store the old files, or you might want to pass <code>--suffix</code> with today’s date.</p> 2846 <p>See <code>--compare-dest</code> and <code>--copy-dest</code>.</p> 2847 <h3 id="bind-string">–bind string</h3> 2848 <p>Local address to bind to for outgoing connections. This can be an IPv4 address (1.2.3.4), an IPv6 address (1234::789A) or host name. If the host name doesn’t resolve or resolves to more than one IP address it will give an error.</p> 2849 <h3 id="bwlimitbandwidth_spec">–bwlimit=BANDWIDTH_SPEC</h3> 2850 <p>This option controls the bandwidth limit. Limits can be specified in two ways: As a single limit, or as a timetable.</p> 2851 <p>Single limits last for the duration of the session. To use a single limit, specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The default is <code>0</code> which means to not limit bandwidth.</p> 2852 <p>For example, to limit bandwidth usage to 10 MBytes/s use <code>--bwlimit 10M</code></p> 2853 <p>It is also possible to specify a “timetable” of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as <code>WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...</code> where: <code>WEEKDAY</code> is optional element. It could be written as whole world or only using 3 first characters. <code>HH:MM</code> is an hour from 00:00 to 23:59.</p> 2854 <p>An example of a typical timetable to avoid link saturation during daytime working hours could be:</p> 2855 <p><code>--bwlimit "08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off"</code></p> 2856 <p>In this example, the transfer bandwidth will be every day set to 512kBytes/sec at 8am. At noon, it will raise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited.</p> 2857 <p>An example of timetable with <code>WEEKDAY</code> could be:</p> 2858 <p><code>--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"</code></p> 2859 <p>It mean that, the transfer bandwidth will be set to 512kBytes/sec on Monday. It will raise to 10Mbytes/s before the end of Friday. At 10:00 on Sunday it will be set to 1Mbyte/s. From 20:00 at Sunday will be unlimited.</p> 2860 <p>Timeslots without weekday are extended to whole week. So this one example:</p> 2861 <p><code>--bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"</code></p> 2862 <p>Is equal to this:</p> 2863 <p><code>--bwlimit "Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off"</code></p> 2864 <p>Bandwidth limits only apply to the data transfer. They don’t apply to the bandwidth of the directory listings etc.</p> 2865 <p>Note that the units are Bytes/s, not Bits/s. Typically connections are measured in Bits/s - to convert divide by 8. For example, let’s say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a <code>--bwlimit 0.625M</code> parameter for rclone.</p> 2866 <p>On Unix systems (Linux, macOS, …) the bandwidth limiter can be toggled by sending a <code>SIGUSR2</code> 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 <code>--bwlimit</code> quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this:</p> 2867 <pre><code>kill -SIGUSR2 $(pidof rclone)</code></pre> 2868 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use change the bwlimit dynamically:</p> 2869 <pre><code>rclone rc core/bwlimit rate=1M</code></pre> 2870 <h3 id="buffer-sizesize">–buffer-size=SIZE</h3> 2871 <p>Use this sized buffer to speed up file transfers. Each <code>--transfer</code> will use this much memory for buffering.</p> 2872 <p>When using <code>mount</code> or <code>cmount</code> each open file descriptor will use this much memory for buffering. See the <a href="https://rclone.org/commands/rclone_mount/#file-buffering">mount</a> documentation for more details.</p> 2873 <p>Set to <code>0</code> to disable the buffering for the minimum memory usage.</p> 2874 <p>Note that the memory allocation of the buffers is influenced by the <a href="#use-mmap">–use-mmap</a> flag.</p> 2875 <h3 id="check-first">–check-first</h3> 2876 <p>If this flag is set then in a <code>sync</code>, <code>copy</code> or <code>move</code>, 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.</p> 2877 <p>This flag can be useful on IO limited systems where transfers interfere with checking.</p> 2878 <p>Using this flag can use more memory as it effectively sets <code>--max-backlog</code> to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start.</p> 2879 <h3 id="checkersn">–checkers=N</h3> 2880 <p>The number of checkers to run in parallel. Checkers do the equality checking of files during a sync. For some storage systems (eg S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel.</p> 2881 <p>The default is to run 8 checkers in parallel.</p> 2882 <h3 id="c-checksum">-c, –checksum</h3> 2883 <p>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.</p> 2884 <p>This is useful when the remote doesn’t support setting modified time and a more accurate sync is desired than just checking the file size.</p> 2885 <p>This is very useful when transferring between remotes which store the same hash type on the object, eg Drive and Swift. For details of which remotes support which hash type see the table in the <a href="https://rclone.org/overview/">overview section</a>.</p> 2886 <p>Eg <code>rclone --checksum sync s3:/bucket swift:/bucket</code> would run much quicker than without the <code>--checksum</code> flag.</p> 2887 <p>When using this flag, rclone won’t update mtimes of remote files if they are incorrect as it would normally.</p> 2888 <h3 id="compare-destdir">–compare-dest=DIR</h3> 2889 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> 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.</p> 2890 <p>You must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory.</p> 2891 <p>See <code>--copy-dest</code> and <code>--backup-dir</code>.</p> 2892 <h3 id="configconfig_file">–config=CONFIG_FILE</h3> 2893 <p>Specify the location of the rclone config file.</p> 2894 <p>Normally the config file is in your home directory as a file called <code>.config/rclone/rclone.conf</code> (or <code>.rclone.conf</code> if created with an older version). If <code>$XDG_CONFIG_HOME</code> is set it will be at <code>$XDG_CONFIG_HOME/rclone/rclone.conf</code>.</p> 2895 <p>If there is a file <code>rclone.conf</code> in the same directory as the rclone executable it will be preferred. This file must be created manually for Rclone to use it, it will never be created automatically.</p> 2896 <p>If you run <code>rclone config file</code> you will see where the default location is for you.</p> 2897 <p>Use this flag to override the config location, eg <code>rclone --config=".myconfig" .config</code>.</p> 2898 <h3 id="contimeouttime">–contimeout=TIME</h3> 2899 <p>Set the connection timeout. This should be in go time format which looks like <code>5s</code> for 5 seconds, <code>10m</code> for 10 minutes, or <code>3h30m</code>.</p> 2900 <p>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 <code>1m</code> by default.</p> 2901 <h3 id="copy-destdir">–copy-dest=DIR</h3> 2902 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> 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.</p> 2903 <p>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.</p> 2904 <p>See <code>--compare-dest</code> and <code>--backup-dir</code>.</p> 2905 <h3 id="dedupe-mode-mode">–dedupe-mode MODE</h3> 2906 <p>Mode to run dedupe command in. One of <code>interactive</code>, <code>skip</code>, <code>first</code>, <code>newest</code>, <code>oldest</code>, <code>rename</code>. The default is <code>interactive</code>. See the dedupe command for more information as to what these options mean.</p> 2907 <h3 id="disable-featurefeature">–disable FEATURE,FEATURE,…</h3> 2908 <p>This disables a comma separated list of optional features. For example to disable server side move and server side copy use:</p> 2909 <pre><code>--disable move,copy</code></pre> 2910 <p>The features can be put in any case.</p> 2911 <p>To see a list of which features can be disabled use:</p> 2912 <pre><code>--disable help</code></pre> 2913 <p>See the overview <a href="https://rclone.org/overview/#features">features</a> and <a href="https://rclone.org/overview/#optional-features">optional features</a> to get an idea of which feature does what.</p> 2914 <p>This flag can be useful for debugging and in exceptional circumstances (eg Google Drive limiting the total volume of Server Side Copies to 100GB/day).</p> 2915 <h3 id="n-dry-run">-n, –dry-run</h3> 2916 <p>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 <code>sync</code> command which deletes files in the destination.</p> 2917 <h3 id="expect-continue-timeouttime">–expect-continue-timeout=TIME</h3> 2918 <p>This specifies the amount of time to wait for a server’s first response headers after fully writing the request headers if the request has an “Expect: 100-continue” header. Not all backends support using this.</p> 2919 <p>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.</p> 2920 <p>The default is <code>1s</code>. Set to <code>0</code> to disable.</p> 2921 <h3 id="error-on-no-transfer">–error-on-no-transfer</h3> 2922 <p>By default, rclone will exit with return code 0 if there were no errors.</p> 2923 <p>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.</p> 2924 <p>NB: Enabling this option turns a usually non-fatal error into a potentially fatal one - please check and adjust your scripts accordingly!</p> 2925 <h3 id="header">–header</h3> 2926 <p>Add an HTTP header for all transactions. The flag can be repeated to add multiple headers.</p> 2927 <p>If you want to add headers only for uploads use <code>--header-upload</code> and if you want to add headers only for downloads use <code>--header-download</code>.</p> 2928 <p>This flag is supported for all HTTP based backends even those not supported by <code>--header-upload</code> and <code>--header-download</code> so may be used as a workaround for those with care.</p> 2929 <pre><code>rclone ls remote:test --header "X-Rclone: Foo" --header "X-LetMeIn: Yes"</code></pre> 2930 <h3 id="header-download">–header-download</h3> 2931 <p>Add an HTTP header for all download transactions. The flag can be repeated to add multiple headers.</p> 2932 <pre><code>rclone sync s3:test/src ~/dst --header-download "X-Amz-Meta-Test: Foo" --header-download "X-Amz-Meta-Test2: Bar"</code></pre> 2933 <p>See the GitHub issue <a href="https://github.com/rclone/rclone/issues/59">here</a> for currently supported backends.</p> 2934 <h3 id="header-upload">–header-upload</h3> 2935 <p>Add an HTTP header for all upload transactions. The flag can be repeated to add multiple headers.</p> 2936 <pre><code>rclone sync ~/src s3:test/dst --header-upload "Content-Disposition: attachment; filename='cool.html'" --header-upload "X-Amz-Meta-Test: FooBar"</code></pre> 2937 <p>See the GitHub issue <a href="https://github.com/rclone/rclone/issues/59">here</a> for currently supported backends.</p> 2938 <h3 id="ignore-case-sync">–ignore-case-sync</h3> 2939 <p>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.</p> 2940 <h3 id="ignore-checksum">–ignore-checksum</h3> 2941 <p>Normally rclone will check that the checksums of transferred files match, and give an error “corrupted on transfer” if they don’t.</p> 2942 <p>You can use this option to skip that check. You should only use it if you have had the “corrupted on transfer” error message and you are sure you might want to transfer potentially corrupted data.</p> 2943 <h3 id="ignore-existing">–ignore-existing</h3> 2944 <p>Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files.</p> 2945 <p>While this isn’t a generally recommended option, it can be useful in cases where your files change due to encryption. However, it cannot correct partial transfers in case a transfer was interrupted.</p> 2946 <h3 id="ignore-size">–ignore-size</h3> 2947 <p>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 <code>--checksum</code> is set then it only checks the checksum.</p> 2948 <p>It will also cause rclone to skip verifying the sizes are the same after transfer.</p> 2949 <p>This can be useful for transferring files to and from OneDrive which occasionally misreports the size of image files (see <a href="https://github.com/rclone/rclone/issues/399">#399</a> for more info).</p> 2950 <h3 id="i-ignore-times">-I, –ignore-times</h3> 2951 <p>Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination.</p> 2952 <p>Normally rclone would skip any files that have the same modification time and are the same size (or have the same checksum if using <code>--checksum</code>).</p> 2953 <h3 id="immutable">–immutable</h3> 2954 <p>Treat source and destination files as immutable and disallow modification.</p> 2955 <p>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 <code>Source and destination exist but do not match: immutable file modified</code>.</p> 2956 <p>Note that only commands which transfer files (e.g. <code>sync</code>, <code>copy</code>, <code>move</code>) are affected by this behavior, and only modification is disallowed. Files may still be deleted explicitly (e.g. <code>delete</code>, <code>purge</code>) or implicitly (e.g. <code>sync</code>, <code>move</code>). Use <code>copy --immutable</code> if it is desired to avoid deletion as well as modification.</p> 2957 <p>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.</p> 2958 <h2 id="leave-root">–leave-root</h2> 2959 <p>During rmdirs it will not remove root directory, even if it’s empty.</p> 2960 <h3 id="log-filefile">–log-file=FILE</h3> 2961 <p>Log all of rclone’s output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the <code>-v</code> flag. See the <a href="#logging">Logging section</a> for more info.</p> 2962 <p>Note that if you are using the <code>logrotate</code> program to manage rclone’s logs, then you should use the <code>copytruncate</code> option as rclone doesn’t have a signal to rotate logs.</p> 2963 <h3 id="log-format-list">–log-format LIST</h3> 2964 <p>Comma separated list of log format options. <code>date</code>, <code>time</code>, <code>microseconds</code>, <code>longfile</code>, <code>shortfile</code>, <code>UTC</code>. The default is “<code>date</code>,<code>time</code>”.</p> 2965 <h3 id="log-level-level">–log-level LEVEL</h3> 2966 <p>This sets the log level for rclone. The default log level is <code>NOTICE</code>.</p> 2967 <p><code>DEBUG</code> is equivalent to <code>-vv</code>. It outputs lots of debug info - useful for bug reports and really finding out what rclone is doing.</p> 2968 <p><code>INFO</code> is equivalent to <code>-v</code>. It outputs information about each transfer and prints stats once a minute by default.</p> 2969 <p><code>NOTICE</code> 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.</p> 2970 <p><code>ERROR</code> is equivalent to <code>-q</code>. It only outputs error messages.</p> 2971 <h3 id="use-json-log">–use-json-log</h3> 2972 <p>This switches the log format to JSON for rclone. The fields of json log are level, msg, source, time.</p> 2973 <h3 id="low-level-retries-number">–low-level-retries NUMBER</h3> 2974 <p>This controls the number of low level retries rclone does.</p> 2975 <p>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 <code>-v</code> flag.</p> 2976 <p>This shouldn’t need to be changed from the default in normal operations. However, if you get a lot of low level retries you may wish to reduce the value so rclone moves on to a high level retry (see the <code>--retries</code> flag) quicker.</p> 2977 <p>Disable low level retries with <code>--low-level-retries 1</code>.</p> 2978 <h3 id="max-backlogn">–max-backlog=N</h3> 2979 <p>This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred.</p> 2980 <p>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 kB of memory when the backlog is in use.</p> 2981 <p>Setting this large allows rclone to calculate how many files are pending more accurately, give a more accurate estimated finish time and make <code>--order-by</code> work more accurately.</p> 2982 <p>Setting this small will make rclone more synchronous to the listings of the remote which may be desirable.</p> 2983 <p>Setting this to a negative number will make the backlog as large as possible.</p> 2984 <h3 id="max-deleten">–max-delete=N</h3> 2985 <p>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.</p> 2986 <h3 id="max-depthn">–max-depth=N</h3> 2987 <p>This modifies the recursion depth for all the commands except purge.</p> 2988 <p>So if you do <code>rclone --max-depth 1 ls remote:path</code> you will see only the files in the top level directory. Using <code>--max-depth 2</code> means you will see all the files in first two directory levels and so on.</p> 2989 <p>For historical reasons the <code>lsd</code> command defaults to using a <code>--max-depth</code> of 1 - you can override this with the command line flag.</p> 2990 <p>You can use this command to disable recursion (with <code>--max-depth 1</code>).</p> 2991 <p>Note that if you use this with <code>sync</code> and <code>--delete-excluded</code> the files not recursed through are considered excluded and will be deleted on the destination. Test first with <code>--dry-run</code> if you are not sure what will happen.</p> 2992 <h3 id="max-durationtime">–max-duration=TIME</h3> 2993 <p>Rclone will stop scheduling new transfers when it has run for the duration specified.</p> 2994 <p>Defaults to off.</p> 2995 <p>When the limit is reached any existing transfers will complete.</p> 2996 <p>Rclone won’t exit with an error if the transfer limit is reached.</p> 2997 <h3 id="max-transfersize">–max-transfer=SIZE</h3> 2998 <p>Rclone will stop transferring when it has reached the size specified. Defaults to off.</p> 2999 <p>When the limit is reached all transfers will stop immediately.</p> 3000 <p>Rclone will exit with exit code 8 if the transfer limit is reached.</p> 3001 <h3 id="cutoff-modehardsoftcautious">–cutoff-mode=hard|soft|cautious</h3> 3002 <p>This modifies the behavior of <code>--max-transfer</code> Defaults to <code>--cutoff-mode=hard</code>.</p> 3003 <p>Specifying <code>--cutoff-mode=hard</code> will stop transferring immediately when Rclone reaches the limit.</p> 3004 <p>Specifying <code>--cutoff-mode=soft</code> will stop starting new transfers when Rclone reaches the limit.</p> 3005 <p>Specifying <code>--cutoff-mode=cautious</code> will try to prevent Rclone from reaching the limit.</p> 3006 <h3 id="modify-windowtime">–modify-window=TIME</h3> 3007 <p>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.</p> 3008 <p>The default is <code>1ns</code> 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 <code>1s</code> by default.</p> 3009 <p>This command line flag allows you to override that computed default.</p> 3010 <h3 id="multi-thread-cutoffsize">–multi-thread-cutoff=SIZE</h3> 3011 <p>When downloading files to the local backend above this size, rclone will use multiple threads to download the file (default 250M).</p> 3012 <p>Rclone preallocates the file (using <code>fallocate(FALLOC_FL_KEEP_SIZE)</code> on unix or <code>NTSetInformationFile</code> on Windows both of which takes no time) then each thread writes directly into the file at the correct place. This means that rclone won’t create fragmented or sparse files and there won’t be any assembly time at the end of the transfer.</p> 3013 <p>The number of threads used to download is controlled by <code>--multi-thread-streams</code>.</p> 3014 <p>Use <code>-vv</code> if you wish to see info about the threads.</p> 3015 <p>This will work with the <code>sync</code>/<code>copy</code>/<code>move</code> commands and friends <code>copyto</code>/<code>moveto</code>. Multi thread downloads will be used with <code>rclone mount</code> and <code>rclone serve</code> if <code>--vfs-cache-mode</code> is set to <code>writes</code> or above.</p> 3016 <p><strong>NB</strong> that this <strong>only</strong> works for a local destination but will work with any source.</p> 3017 <p><strong>NB</strong> that multi thread copies are disabled for local to local copies as they are faster without unless <code>--multi-thread-streams</code> is set explicitly.</p> 3018 <p><strong>NB</strong> on Windows using multi-thread downloads will cause the resulting files to be <a href="https://en.wikipedia.org/wiki/Sparse_file">sparse</a>. Use <code>--local-no-sparse</code> to disable sparse files (which may cause long delays at the start of downloads) or disable multi-thread downloads with <code>--multi-thread-streams 0</code></p> 3019 <h3 id="multi-thread-streamsn">–multi-thread-streams=N</h3> 3020 <p>When using multi thread downloads (see above <code>--multi-thread-cutoff</code>) this sets the maximum number of streams to use. Set to <code>0</code> to disable multi thread downloads (Default 4).</p> 3021 <p>Exactly how many streams rclone uses for the download depends on the size of the file. To calculate the number of download streams Rclone divides the size of the file by the <code>--multi-thread-cutoff</code> and rounds up, up to the maximum set with <code>--multi-thread-streams</code>.</p> 3022 <p>So if <code>--multi-thread-cutoff 250MB</code> and <code>--multi-thread-streams 4</code> are in effect (the defaults):</p> 3023 <ul> 3024 <li>0MB..250MB files will be downloaded with 1 stream</li> 3025 <li>250MB..500MB files will be downloaded with 2 streams</li> 3026 <li>500MB..750MB files will be downloaded with 3 streams</li> 3027 <li>750MB+ files will be downloaded with 4 streams</li> 3028 </ul> 3029 <h3 id="no-check-dest">–no-check-dest</h3> 3030 <p>The <code>--no-check-dest</code> can be used with <code>move</code> or <code>copy</code> and it causes rclone not to check the destination at all when copying files.</p> 3031 <p>This means that:</p> 3032 <ul> 3033 <li>the destination is not listed minimising the API calls</li> 3034 <li>files are always transferred</li> 3035 <li>this can cause duplicates on remotes which allow it (eg Google Drive)</li> 3036 <li><code>--retries 1</code> is recommended otherwise you’ll transfer everything again on a retry</li> 3037 </ul> 3038 <p>This flag is useful to minimise the transactions if you know that none of the files are on the destination.</p> 3039 <p>This is a specialized flag which should be ignored by most users!</p> 3040 <h3 id="no-gzip-encoding">–no-gzip-encoding</h3> 3041 <p>Don’t set <code>Accept-Encoding: gzip</code>. This means that rclone won’t ask the server for compressed files automatically. Useful if you’ve set the server to return files with <code>Content-Encoding: gzip</code> but you uploaded compressed files.</p> 3042 <p>There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone.</p> 3043 <h3 id="no-traverse">–no-traverse</h3> 3044 <p>The <code>--no-traverse</code> flag controls whether the destination file system is traversed when using the <code>copy</code> or <code>move</code> commands. <code>--no-traverse</code> is not compatible with <code>sync</code> and will be ignored if you supply it with <code>sync</code>.</p> 3045 <p>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 <code>--no-traverse</code> will stop rclone listing the destination and save time.</p> 3046 <p>However, if you are copying a large number of files, especially if you are doing a copy where lots of the files under consideration haven’t changed and won’t need copying then you shouldn’t use <code>--no-traverse</code>.</p> 3047 <p>See <a href="https://rclone.org/commands/rclone_copy/">rclone copy</a> for an example of how to use it.</p> 3048 <h3 id="no-unicode-normalization">–no-unicode-normalization</h3> 3049 <p>Don’t normalize unicode characters in filenames during the sync routine.</p> 3050 <p>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.</p> 3051 <p>Using this flag will disable that functionality, treating each unicode character as unique. For example, by default é and é will be normalized into the same character. With <code>--no-unicode-normalization</code> they will be treated as unique characters.</p> 3052 <h3 id="no-update-modtime">–no-update-modtime</h3> 3053 <p>When using this flag, rclone won’t update modification times of remote files if they are incorrect as it would normally.</p> 3054 <p>This can be used if the remote is being synced with another tool also (eg the Google Drive client).</p> 3055 <h3 id="order-by-string">–order-by string</h3> 3056 <p>The <code>--order-by</code> flag controls the order in which files in the backlog are processed in <code>rclone sync</code>, <code>rclone copy</code> and <code>rclone move</code>.</p> 3057 <p>The order by string is constructed like this. The first part describes what aspect is being measured:</p> 3058 <ul> 3059 <li><code>size</code> - order by the size of the files</li> 3060 <li><code>name</code> - order by the full path of the files</li> 3061 <li><code>modtime</code> - order by the modification date of the files</li> 3062 </ul> 3063 <p>This can have a modifier appended with a comma:</p> 3064 <ul> 3065 <li><code>ascending</code> or <code>asc</code> - order so that the smallest (or oldest) is processed first</li> 3066 <li><code>descending</code> or <code>desc</code> - order so that the largest (or newest) is processed first</li> 3067 <li><code>mixed</code> - order so that the smallest is processed first for some threads and the largest for others</li> 3068 </ul> 3069 <p>If the modifier is <code>mixed</code> then it can have an optional percentage (which defaults to <code>50</code>), eg <code>size,mixed,25</code> 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 <code>mixed</code> 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.</p> 3070 <p>If no modifier is supplied then the order is <code>ascending</code>.</p> 3071 <p>For example</p> 3072 <ul> 3073 <li><code>--order-by size,desc</code> - send the largest files first</li> 3074 <li><code>--order-by modtime,ascending</code> - send the oldest files first</li> 3075 <li><code>--order-by name</code> - send the files with alphabetically by path first</li> 3076 </ul> 3077 <p>If the <code>--order-by</code> flag is not supplied or it is supplied with an empty string then the default ordering will be used which is as scanned. With <code>--checkers 1</code> this is mostly alphabetical, however with the default <code>--checkers 8</code> it is somewhat random.</p> 3078 <h4 id="limitations-1">Limitations</h4> 3079 <p>The <code>--order-by</code> flag does not do a separate pass over the data. This means that it may transfer some files out of the order specified if</p> 3080 <ul> 3081 <li>there are no files in the backlog or the source has not been fully scanned yet</li> 3082 <li>there are more than <a href="#max-backlog-n">–max-backlog</a> files in the backlog</li> 3083 </ul> 3084 <p>Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of <code>--order-by</code> as being more of a best efforts flag rather than a perfect ordering.</p> 3085 <h3 id="password-command-spaceseplist">–password-command SpaceSepList</h3> 3086 <p>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 <code>RCLONE_CONFIG_PASS</code> variable.</p> 3087 <p>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 <code>"</code>, if you want a literal <code>"</code> in an argument then enclose the argument in <code>"</code> and double the <code>"</code>. See <a href="https://godoc.org/encoding/csv">CSV encoding</a> for more info.</p> 3088 <p>Eg</p> 3089 <pre><code>--password-command echo hello 3090 --password-command echo "hello with space" 3091 --password-command echo "hello with ""quotes"" and space"</code></pre> 3092 <p>See the <a href="#configuration-encryption">Configuration Encryption</a> for more info.</p> 3093 <p>See a <a href="https://github.com/rclone/rclone/wiki/Windows-Powershell-use-rclone-password-command-for-Config-file-password">Windows PowerShell example on the Wiki</a>.</p> 3094 <h3 id="p-progress">-P, –progress</h3> 3095 <p>This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer.</p> 3096 <p>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.</p> 3097 <p>Normally this is updated every 500mS but this period can be overridden with the <code>--stats</code> flag.</p> 3098 <p>This can be used with the <code>--stats-one-line</code> flag for a simpler display.</p> 3099 <p>Note: On Windows until <a href="https://github.com/Azure/go-ansiterm/issues/26">this bug</a> is fixed all non-ASCII characters will be replaced with <code>.</code> when <code>--progress</code> is in use.</p> 3100 <h3 id="q-quiet">-q, –quiet</h3> 3101 <p>This flag will limit rclone’s output to error messages only.</p> 3102 <h3 id="retries-int">–retries int</h3> 3103 <p>Retry the entire sync if it fails this many times it fails (default 3).</p> 3104 <p>Some remotes can be unreliable and a few retries help pick up the files which didn’t get transferred because of errors.</p> 3105 <p>Disable retries with <code>--retries 1</code>.</p> 3106 <h3 id="retries-sleeptime">–retries-sleep=TIME</h3> 3107 <p>This sets the interval between each retry specified by <code>--retries</code></p> 3108 <p>The default is <code>0</code>. Use <code>0</code> to disable.</p> 3109 <h3 id="size-only">–size-only</h3> 3110 <p>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.</p> 3111 <p>This can be useful transferring files from Dropbox which have been modified by the desktop sync client which doesn’t set checksums of modification times in the same way as rclone.</p> 3112 <h3 id="statstime">–stats=TIME</h3> 3113 <p>Commands which transfer data (<code>sync</code>, <code>copy</code>, <code>copyto</code>, <code>move</code>, <code>moveto</code>) will print data transfer stats at regular intervals to show their progress.</p> 3114 <p>This sets the interval.</p> 3115 <p>The default is <code>1m</code>. Use <code>0</code> to disable.</p> 3116 <p>If you set the stats interval then all commands can show stats. This can be useful when running other commands, <code>check</code> or <code>mount</code> for example.</p> 3117 <p>Stats are logged at <code>INFO</code> level by default which means they won’t show at default log level <code>NOTICE</code>. Use <code>--stats-log-level NOTICE</code> or <code>-v</code> to make them show. See the <a href="#logging">Logging section</a> for more info on log levels.</p> 3118 <p>Note that on macOS you can send a SIGINFO (which is normally ctrl-T in the terminal) to make the stats print immediately.</p> 3119 <h3 id="stats-file-name-length-integer">–stats-file-name-length integer</h3> 3120 <p>By default, the <code>--stats</code> output will truncate file names and paths longer than 40 characters. This is equivalent to providing <code>--stats-file-name-length 40</code>. Use <code>--stats-file-name-length 0</code> to disable any truncation of file names printed by stats.</p> 3121 <h3 id="stats-log-level-string">–stats-log-level string</h3> 3122 <p>Log level to show <code>--stats</code> output at. This can be <code>DEBUG</code>, <code>INFO</code>, <code>NOTICE</code>, or <code>ERROR</code>. The default is <code>INFO</code>. This means at the default level of logging which is <code>NOTICE</code> the stats won’t show - if you want them to then use <code>--stats-log-level NOTICE</code>. See the <a href="#logging">Logging section</a> for more info on log levels.</p> 3123 <h3 id="stats-one-line">–stats-one-line</h3> 3124 <p>When this is specified, rclone condenses the stats into a single line showing the most important stats only.</p> 3125 <h3 id="stats-one-line-date">–stats-one-line-date</h3> 3126 <p>When this is specified, rclone enables the single-line stats and prepends the display with a date string. The default is <code>2006/01/02 15:04:05 -</code></p> 3127 <h3 id="stats-one-line-date-format">–stats-one-line-date-format</h3> 3128 <p>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 <a href="https://golang.org/pkg/time/#Time.Format">golang specs</a> for date formatting syntax.</p> 3129 <h3 id="stats-unitbitsbytes">–stats-unit=bits|bytes</h3> 3130 <p>By default, data transfer rates will be printed in bytes/second.</p> 3131 <p>This option allows the data rate to be printed in bits/second.</p> 3132 <p>Data transfer volume will still be reported in bytes.</p> 3133 <p>The rate is reported as a binary unit, not SI unit. So 1 Mbit/s equals 1,048,576 bits/s and not 1,000,000 bits/s.</p> 3134 <p>The default is <code>bytes</code>.</p> 3135 <h3 id="suffixsuffix">–suffix=SUFFIX</h3> 3136 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> 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.</p> 3137 <p>The remote in use must support server side move or copy and you must use the same remote as the destination of the sync.</p> 3138 <p>This is for use with files to add the suffix in the current directory or with <code>--backup-dir</code>. See <code>--backup-dir</code> for more info.</p> 3139 <p>For example</p> 3140 <pre><code>rclone sync /path/to/local/file remote:current --suffix .bak</code></pre> 3141 <p>will sync <code>/path/to/local</code> to <code>remote:current</code>, but for any files which would have been updated or deleted have .bak added.</p> 3142 <h3 id="suffix-keep-extension">–suffix-keep-extension</h3> 3143 <p>When using <code>--suffix</code>, setting this causes rclone put the SUFFIX before the extension of the files that it backs up rather than after.</p> 3144 <p>So let’s say we had <code>--suffix -2019-01-01</code>, without the flag <code>file.txt</code> would be backed up to <code>file.txt-2019-01-01</code> and with the flag it would be backed up to <code>file-2019-01-01.txt</code>. This can be helpful to make sure the suffixed files can still be opened.</p> 3145 <h3 id="syslog">–syslog</h3> 3146 <p>On capable OSes (not Windows or Plan9) send all log output to syslog.</p> 3147 <p>This can be useful for running rclone in a script or <code>rclone mount</code>.</p> 3148 <h3 id="syslog-facility-string">–syslog-facility string</h3> 3149 <p>If using <code>--syslog</code> this sets the syslog facility (eg <code>KERN</code>, <code>USER</code>). See <code>man syslog</code> for a list of possible facilities. The default facility is <code>DAEMON</code>.</p> 3150 <h3 id="tpslimit-float">–tpslimit float</h3> 3151 <p>Limit HTTP transactions per second to this. Default is 0 which is used to mean unlimited transactions per second.</p> 3152 <p>For example to limit rclone to 10 HTTP transactions per second use <code>--tpslimit 10</code>, or to 1 transaction every 2 seconds use <code>--tpslimit 0.5</code>.</p> 3153 <p>Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (eg getting you banned or rate limited).</p> 3154 <p>This can be very useful for <code>rclone mount</code> to control the behaviour of applications using it.</p> 3155 <p>See also <code>--tpslimit-burst</code>.</p> 3156 <h3 id="tpslimit-burst-int">–tpslimit-burst int</h3> 3157 <p>Max burst of transactions for <code>--tpslimit</code> (default <code>1</code>).</p> 3158 <p>Normally <code>--tpslimit</code> will do exactly the number of transaction per second specified. However if you supply <code>--tps-burst</code> then rclone can save up some transactions from when it was idle giving a burst of up to the parameter supplied.</p> 3159 <p>For example if you provide <code>--tpslimit-burst 10</code> then if rclone has been idle for more than 10*<code>--tpslimit</code> then it can do 10 transactions very quickly before they are limited again.</p> 3160 <p>This may be used to increase performance of <code>--tpslimit</code> without changing the long term average number of transactions per second.</p> 3161 <h3 id="track-renames">–track-renames</h3> 3162 <p>By default, rclone doesn’t keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy.</p> 3163 <p>If you use this flag, and the remote supports server side copy or server side move, and the source and destination have a compatible hash, then this will track renames during <code>sync</code> operations and perform renaming server-side.</p> 3164 <p>Files will be matched by size and hash - if both match then a rename will be considered.</p> 3165 <p>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. Note: Encrypted destinations are not supported by <code>--track-renames</code>.</p> 3166 <p>Note that <code>--track-renames</code> is incompatible with <code>--no-traverse</code> and that it uses extra memory to keep track of all the rename candidates.</p> 3167 <p>Note also that <code>--track-renames</code> is incompatible with <code>--delete-before</code> and will select <code>--delete-after</code> instead of <code>--delete-during</code>.</p> 3168 <h3 id="track-renames-strategy-hashmodtime">–track-renames-strategy (hash,modtime)</h3> 3169 <p>This option changes the matching criteria for <code>--track-renames</code> to match by any combination of modtime, hash, size. Matching by size is always enabled no matter what option is selected here. This also means that it enables <code>--track-renames</code> support for encrypted destinations. If nothing is specified, the default option is matching by hashes.</p> 3170 <h3 id="delete-beforeduringafter">–delete-(before,during,after)</h3> 3171 <p>This option allows you to specify when files on your destination are deleted when you sync folders.</p> 3172 <p>Specifying the value <code>--delete-before</code> will delete all files present on the destination, but not on the source <em>before</em> 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.</p> 3173 <p>Specifying <code>--delete-during</code> will delete files while checking and uploading files. This is the fastest option and uses the least memory.</p> 3174 <p>Specifying <code>--delete-after</code> (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 <code>not deleting files as there were IO errors</code>.</p> 3175 <h3 id="fast-list">–fast-list</h3> 3176 <p>When doing anything which involves a directory listing (eg <code>sync</code>, <code>copy</code>, <code>ls</code> - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very quickly using the least amount of memory.</p> 3177 <p>However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to be the bucket based remotes (eg S3, B2, GCS, Swift, Hubic).</p> 3178 <p>If you use the <code>--fast-list</code> flag then rclone will use this method for listing directories. This will have the following consequences for the listing:</p> 3179 <ul> 3180 <li>It <strong>will</strong> use fewer transactions (important if you pay for them)</li> 3181 <li>It <strong>will</strong> use more memory. Rclone has to load the whole listing into memory.</li> 3182 <li>It <em>may</em> be faster because it uses fewer transactions</li> 3183 <li>It <em>may</em> be slower because it can’t be parallelized</li> 3184 </ul> 3185 <p>rclone should always give identical results with and without <code>--fast-list</code>.</p> 3186 <p>If you pay for transactions and can fit your entire sync listing into memory then <code>--fast-list</code> is recommended. If you have a very big sync to do then don’t use <code>--fast-list</code> otherwise you will run out of memory.</p> 3187 <p>If you use <code>--fast-list</code> on a remote which doesn’t support it, then rclone will just ignore it.</p> 3188 <h3 id="timeouttime">–timeout=TIME</h3> 3189 <p>This sets the IO idle timeout. If a transfer has started but then becomes idle for this long it is considered broken and disconnected.</p> 3190 <p>The default is <code>5m</code>. Set to <code>0</code> to disable.</p> 3191 <h3 id="transfersn">–transfers=N</h3> 3192 <p>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.</p> 3193 <p>The default is to run 4 file transfers in parallel.</p> 3194 <h3 id="u-update">-u, –update</h3> 3195 <p>This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file.</p> 3196 <p>This can be useful when transferring to a remote which doesn’t support mod times directly (or when using <code>--use-server-modtime</code> to avoid extra API calls) as it is more accurate than a <code>--size-only</code> check and faster than using <code>--checksum</code>.</p> 3197 <p>If an existing destination file has a modification time equal (within the computed modify window precision) to the source file’s, it will be updated if the sizes are different. If <code>--checksum</code> is set then rclone will update the destination if the checksums differ too.</p> 3198 <p>If an existing destination file is older than the source file then it will be updated if the size or checksum differs from the source file.</p> 3199 <p>On remotes which don’t support mod time directly (or when using <code>--use-server-modtime</code>) the time checked will be the uploaded time. This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file.</p> 3200 <h3 id="use-mmap">–use-mmap</h3> 3201 <p>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 <code>--buffer-size</code>). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with.</p> 3202 <p>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.</p> 3203 <p>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.</p> 3204 <h3 id="use-server-modtime">–use-server-modtime</h3> 3205 <p>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.</p> 3206 <p>Use this flag to disable the extra API call and rely instead on the server’s modified time. In cases such as a local to remote sync using <code>--update</code>, 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.</p> 3207 <p>Using this flag on a sync operation without also using <code>--update</code> 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.</p> 3208 <h3 id="v--vv-verbose">-v, -vv, –verbose</h3> 3209 <p>With <code>-v</code> rclone will tell you about each file that is transferred and a small number of significant events.</p> 3210 <p>With <code>-vv</code> rclone will become very verbose telling you about every file it considers and transfers. Please send bug reports with a log with this setting.</p> 3211 <h3 id="v-version">-V, –version</h3> 3212 <p>Prints the version number</p> 3213 <h2 id="ssltls-options">SSL/TLS options</h2> 3214 <p>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.</p> 3215 <h3 id="ca-cert-string">–ca-cert string</h3> 3216 <p>This loads the PEM encoded certificate authority certificate and uses it to verify the certificates of the servers rclone connects to.</p> 3217 <p>If you have generated certificates signed with a local CA then you will need this flag to connect to servers using those certificates.</p> 3218 <h3 id="client-cert-string">–client-cert string</h3> 3219 <p>This loads the PEM encoded client side certificate.</p> 3220 <p>This is used for <a href="https://en.wikipedia.org/wiki/Mutual_authentication">mutual TLS authentication</a>.</p> 3221 <p>The <code>--client-key</code> flag is required too when using this.</p> 3222 <h3 id="client-key-string">–client-key string</h3> 3223 <p>This loads the PEM encoded client side private key used for mutual TLS authentication. Used in conjunction with <code>--client-cert</code>.</p> 3224 <h3 id="no-check-certificatetruefalse">–no-check-certificate=true/false</h3> 3225 <p><code>--no-check-certificate</code> controls whether a client verifies the server’s certificate chain and host name. If <code>--no-check-certificate</code> 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.</p> 3226 <p>This option defaults to <code>false</code>.</p> 3227 <p><strong>This should be used only for testing.</strong></p> 3228 <h2 id="configuration-encryption">Configuration Encryption</h2> 3229 <p>Your configuration file contains information for logging in to your cloud services. This means that you should keep your <code>.rclone.conf</code> file in a secure location.</p> 3230 <p>If you are in an environment where that isn’t possible, you can add a password to your configuration. This means that you will have to supply the password every time you start rclone.</p> 3231 <p>To add a password to your rclone configuration, execute <code>rclone config</code>.</p> 3232 <pre><code>>rclone config 3233 Current remotes: 3234 3235 e) Edit existing remote 3236 n) New remote 3237 d) Delete remote 3238 s) Set configuration password 3239 q) Quit config 3240 e/n/d/s/q></code></pre> 3241 <p>Go into <code>s</code>, Set configuration password:</p> 3242 <pre><code>e/n/d/s/q> s 3243 Your configuration is not encrypted. 3244 If you add a password, you will protect your login information to cloud services. 3245 a) Add Password 3246 q) Quit to main menu 3247 a/q> a 3248 Enter NEW configuration password: 3249 password: 3250 Confirm NEW password: 3251 password: 3252 Password set 3253 Your configuration is encrypted. 3254 c) Change Password 3255 u) Unencrypt configuration 3256 q) Quit to main menu 3257 c/u/q></code></pre> 3258 <p>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.</p> 3259 <p>There is no way to recover the configuration if you lose your password.</p> 3260 <p>rclone uses <a href="https://godoc.org/golang.org/x/crypto/nacl/secretbox">nacl secretbox</a> 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.</p> 3261 <p>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.</p> 3262 <p>If it is safe in your environment, you can set the <code>RCLONE_CONFIG_PASS</code> environment variable to contain your password, in which case it will be used for decrypting the configuration.</p> 3263 <p>You can set this for a session from a script. For unix like systems save this to a file called <code>set-rclone-password</code>:</p> 3264 <pre><code>#!/bin/echo Source this file don't run it 3265 3266 read -s RCLONE_CONFIG_PASS 3267 export RCLONE_CONFIG_PASS</code></pre> 3268 <p>Then source the file when you want to use it. From the shell you would do <code>source set-rclone-password</code>. It will then ask you for the password and set it in the environment variable.</p> 3269 <p>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 <code>--password-command="..."</code> command line argument or via the <code>RCLONE_PASSWORD_COMMAND</code> environment variable.</p> 3270 <p>One useful example of this is using the <code>passwordstore</code> application to retrieve the password:</p> 3271 <pre><code>export RCLONE_PASSWORD_COMMAND="pass rclone/config"</code></pre> 3272 <p>If the <code>passwordstore</code> password manager holds the password for the rclone configuration, using the script method means the password is primarily protected by the <code>passwordstore</code> 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.</p> 3273 <p>If you are running rclone inside a script, unless you are using the <code>--password-command</code> method, you might want to disable password prompts. To do that, pass the parameter <code>--ask-password=false</code> to rclone. This will make rclone fail instead of asking for a password if <code>RCLONE_CONFIG_PASS</code> doesn’t contain a valid password, and <code>--password-command</code> has not been supplied.</p> 3274 <h2 id="developer-options">Developer options</h2> 3275 <p>These options are useful when developing or debugging rclone. There are also some more remote specific options which aren’t documented here which are used for testing. These start with remote name eg <code>--drive-test-option</code> - see the docs for the remote in question.</p> 3276 <h3 id="cpuprofilefile">–cpuprofile=FILE</h3> 3277 <p>Write CPU profile to file. This can be analysed with <code>go tool pprof</code>.</p> 3278 <h4 id="dump-flagflagflag">–dump flag,flag,flag</h4> 3279 <p>The <code>--dump</code> flag takes a comma separated list of flags to dump info about.</p> 3280 <p>Note that some headers including <code>Accept-Encoding</code> as shown may not be correct in the request and the response may not show <code>Content-Encoding</code> 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.</p> 3281 <p>The available flags are:</p> 3282 <h4 id="dump-headers">–dump headers</h4> 3283 <p>Dump HTTP headers with <code>Authorization:</code> lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only.</p> 3284 <p>Use <code>--dump auth</code> if you do want the <code>Authorization:</code> headers.</p> 3285 <h4 id="dump-bodies">–dump bodies</h4> 3286 <p>Dump HTTP headers and bodies - may contain sensitive info. Can be very verbose. Useful for debugging only.</p> 3287 <p>Note that the bodies are buffered in memory so don’t use this for enormous files.</p> 3288 <h4 id="dump-requests">–dump requests</h4> 3289 <p>Like <code>--dump bodies</code> but dumps the request bodies and the response headers. Useful for debugging download problems.</p> 3290 <h4 id="dump-responses">–dump responses</h4> 3291 <p>Like <code>--dump bodies</code> but dumps the response bodies and the request headers. Useful for debugging upload problems.</p> 3292 <h4 id="dump-auth">–dump auth</h4> 3293 <p>Dump HTTP headers - will contain sensitive info such as <code>Authorization:</code> headers - use <code>--dump headers</code> to dump without <code>Authorization:</code> headers. Can be very verbose. Useful for debugging only.</p> 3294 <h4 id="dump-filters">–dump filters</h4> 3295 <p>Dump the filters to the output. Useful to see exactly what include and exclude options are filtering on.</p> 3296 <h4 id="dump-goroutines">–dump goroutines</h4> 3297 <p>This dumps a list of the running go-routines at the end of the command to standard output.</p> 3298 <h4 id="dump-openfiles">–dump openfiles</h4> 3299 <p>This dumps a list of the open files at the end of the command. It uses the <code>lsof</code> command to do that so you’ll need that installed to use it.</p> 3300 <h3 id="memprofilefile">–memprofile=FILE</h3> 3301 <p>Write memory profile to file. This can be analysed with <code>go tool pprof</code>.</p> 3302 <h2 id="filtering">Filtering</h2> 3303 <p>For the filtering options</p> 3304 <ul> 3305 <li><code>--delete-excluded</code></li> 3306 <li><code>--filter</code></li> 3307 <li><code>--filter-from</code></li> 3308 <li><code>--exclude</code></li> 3309 <li><code>--exclude-from</code></li> 3310 <li><code>--include</code></li> 3311 <li><code>--include-from</code></li> 3312 <li><code>--files-from</code></li> 3313 <li><code>--files-from-raw</code></li> 3314 <li><code>--min-size</code></li> 3315 <li><code>--max-size</code></li> 3316 <li><code>--min-age</code></li> 3317 <li><code>--max-age</code></li> 3318 <li><code>--dump filters</code></li> 3319 </ul> 3320 <p>See the <a href="https://rclone.org/filtering/">filtering section</a>.</p> 3321 <h2 id="remote-control">Remote control</h2> 3322 <p>For the remote control options and for instructions on how to remote control rclone</p> 3323 <ul> 3324 <li><code>--rc</code></li> 3325 <li>and anything starting with <code>--rc-</code></li> 3326 </ul> 3327 <p>See <a href="https://rclone.org/rc/">the remote control section</a>.</p> 3328 <h2 id="logging">Logging</h2> 3329 <p>rclone has 4 levels of logging, <code>ERROR</code>, <code>NOTICE</code>, <code>INFO</code> and <code>DEBUG</code>.</p> 3330 <p>By default, rclone logs to standard error. This means you can redirect standard error and still see the normal output of rclone commands (eg <code>rclone ls</code>).</p> 3331 <p>By default, rclone will produce <code>Error</code> and <code>Notice</code> level messages.</p> 3332 <p>If you use the <code>-q</code> flag, rclone will only produce <code>Error</code> messages.</p> 3333 <p>If you use the <code>-v</code> flag, rclone will produce <code>Error</code>, <code>Notice</code> and <code>Info</code> messages.</p> 3334 <p>If you use the <code>-vv</code> flag, rclone will produce <code>Error</code>, <code>Notice</code>, <code>Info</code> and <code>Debug</code> messages.</p> 3335 <p>You can also control the log levels with the <code>--log-level</code> flag.</p> 3336 <p>If you use the <code>--log-file=FILE</code> option, rclone will redirect <code>Error</code>, <code>Info</code> and <code>Debug</code> messages along with standard error to FILE.</p> 3337 <p>If you use the <code>--syslog</code> flag then rclone will log to syslog and the <code>--syslog-facility</code> control which facility it uses.</p> 3338 <p>Rclone prefixes all log messages with their level in capitals, eg INFO which makes it easy to grep the log file for different kinds of information.</p> 3339 <h2 id="exit-code">Exit Code</h2> 3340 <p>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.</p> 3341 <p>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.</p> 3342 <p>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 <code>-q</code>) 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.</p> 3343 <h3 id="list-of-exit-codes">List of exit codes</h3> 3344 <ul> 3345 <li><code>0</code> - success</li> 3346 <li><code>1</code> - Syntax or usage error</li> 3347 <li><code>2</code> - Error not otherwise categorised</li> 3348 <li><code>3</code> - Directory not found</li> 3349 <li><code>4</code> - File not found</li> 3350 <li><code>5</code> - Temporary error (one that more retries might fix) (Retry errors)</li> 3351 <li><code>6</code> - Less serious errors (like 461 errors from dropbox) (NoRetry errors)</li> 3352 <li><code>7</code> - Fatal error (one that more retries won’t fix, like account suspended) (Fatal errors)</li> 3353 <li><code>8</code> - Transfer exceeded - limit set by –max-transfer reached</li> 3354 <li><code>9</code> - Operation successful, but no files transferred</li> 3355 </ul> 3356 <h2 id="environment-variables">Environment Variables</h2> 3357 <p>Rclone can be configured entirely using environment variables. These can be used to set defaults for options or config file entries.</p> 3358 <h3 id="options-68">Options</h3> 3359 <p>Every option in rclone can have its default set by environment variable.</p> 3360 <p>To find the name of the environment variable, first, take the long option name, strip the leading <code>--</code>, change <code>-</code> to <code>_</code>, make upper case and prepend <code>RCLONE_</code>.</p> 3361 <p>For example, to always set <code>--stats 5s</code>, set the environment variable <code>RCLONE_STATS=5s</code>. If you set stats on the command line this will override the environment variable setting.</p> 3362 <p>Or to always use the trash in drive <code>--drive-use-trash</code>, set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p> 3363 <p>The same parser is used for the options and the environment variables so they take exactly the same form.</p> 3364 <h3 id="config-file">Config file</h3> 3365 <p>You can set defaults for values in the config file on an individual remote basis. If you want to use this feature, you will need to discover the name of the config items that you want. The easiest way is to run through <code>rclone config</code> by hand, then look in the config file to see what the values are (the config file can be found by looking at the help for <code>--config</code> in <code>rclone help</code>).</p> 3366 <p>To find the name of the environment variable, you need to set, take <code>RCLONE_CONFIG_</code> + name of remote + <code>_</code> + name of config file option and make it all uppercase.</p> 3367 <p>For example, to configure an S3 remote named <code>mys3:</code> without a config file (using unix ways of setting environment variables):</p> 3368 <pre><code>$ export RCLONE_CONFIG_MYS3_TYPE=s3 3369 $ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX 3370 $ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX 3371 $ rclone lsd MYS3: 3372 -1 2016-09-21 12:54:21 -1 my-bucket 3373 $ rclone listremotes | grep mys3 3374 mys3:</code></pre> 3375 <p>Note that if you want to create a remote using environment variables you must create the <code>..._TYPE</code> variable as above.</p> 3376 <h3 id="other-environment-variables">Other environment variables</h3> 3377 <ul> 3378 <li><code>RCLONE_CONFIG_PASS</code> set to contain your config file password (see <a href="#configuration-encryption">Configuration Encryption</a> section)</li> 3379 <li><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code> and <code>NO_PROXY</code> (or the lowercase versions thereof). 3380 <ul> 3381 <li><code>HTTPS_PROXY</code> takes precedence over <code>HTTP_PROXY</code> for https requests.</li> 3382 <li>The environment values may be either a complete URL or a “host[:port]” for, in which case the “http” scheme is assumed.</li> 3383 </ul></li> 3384 </ul> 3385 <h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring rclone on a remote / headless machine</h1> 3386 <p>Some of the configurations (those involving oauth2) require an Internet connected web browser.</p> 3387 <p>If you are trying to set rclone up on a remote or headless box with no browser available on it (eg 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.</p> 3388 <h2 id="configuring-using-rclone-authorize">Configuring using rclone authorize</h2> 3389 <p>On the headless box run <code>rclone</code> config but answer <code>N</code> to the <code>Use auto config?</code> question.</p> 3390 <pre><code>... 3391 Remote config 3392 Use auto config? 3393 * Say Y if not sure 3394 * Say N if you are working on a remote or headless machine 3395 y) Yes (default) 3396 n) No 3397 y/n> n 3398 For this to work, you will need rclone available on a machine that has 3399 a web browser available. 3400 3401 For more help and alternate methods see: https://rclone.org/remote_setup/ 3402 3403 Execute the following on the machine with the web browser (same rclone 3404 version recommended): 3405 3406 rclone authorize "amazon cloud drive" 3407 3408 Then paste the result below: 3409 result></code></pre> 3410 <p>Then on your main desktop machine</p> 3411 <pre><code>rclone authorize "amazon cloud drive" 3412 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 3413 Log in and authorize rclone for access 3414 Waiting for code... 3415 Got code 3416 Paste the following into your remote machine ---> 3417 SECRET_TOKEN 3418 <---End paste</code></pre> 3419 <p>Then back to the headless box, paste in the code</p> 3420 <pre><code>result> SECRET_TOKEN 3421 -------------------- 3422 [acd12] 3423 client_id = 3424 client_secret = 3425 token = SECRET_TOKEN 3426 -------------------- 3427 y) Yes this is OK 3428 e) Edit this remote 3429 d) Delete this remote 3430 y/e/d></code></pre> 3431 <h2 id="configuring-by-copying-the-config-file">Configuring by copying the config file</h2> 3432 <p>Rclone stores all of its config in a single configuration file. This can easily be copied to configure a remote rclone.</p> 3433 <p>So first configure rclone on your desktop machine with</p> 3434 <pre><code>rclone config</code></pre> 3435 <p>to set up the config file.</p> 3436 <p>Find the config file by running <code>rclone config file</code>, for example</p> 3437 <pre><code>$ rclone config file 3438 Configuration file is stored at: 3439 /home/user/.rclone.conf</code></pre> 3440 <p>Now transfer it to the remote box (scp, cut paste, ftp, sftp etc) and place it in the correct place (use <code>rclone config file</code> on the remote box to find out where).</p> 3441 <h1 id="filtering-includes-and-excludes">Filtering, includes and excludes</h1> 3442 <p>Rclone has a sophisticated set of include and exclude rules. Some of these are based on patterns and some on other things like file size.</p> 3443 <p>The filters are applied for the <code>copy</code>, <code>sync</code>, <code>move</code>, <code>ls</code>, <code>lsl</code>, <code>md5sum</code>, <code>sha1sum</code>, <code>size</code>, <code>delete</code> and <code>check</code> operations. Note that <code>purge</code> does not obey the filters.</p> 3444 <p>Each path as it passes through rclone is matched against the include and exclude rules like <code>--include</code>, <code>--exclude</code>, <code>--include-from</code>, <code>--exclude-from</code>, <code>--filter</code>, or <code>--filter-from</code>. The simplest way to try them out is using the <code>ls</code> command, or <code>--dry-run</code> together with <code>-v</code>. <code>--filter-from</code>, <code>--exclude-from</code>, <code>--include-from</code>, <code>--files-from</code>, <code>--files-from-raw</code> understand <code>-</code> as a file name to mean read from standard input.</p> 3445 <h2 id="patterns">Patterns</h2> 3446 <p>The patterns used to match files for inclusion or exclusion are based on “file globs” as used by the unix shell.</p> 3447 <p>If the pattern starts with a <code>/</code> then it only matches at the top level of the directory tree, <strong>relative to the root of the remote</strong> (not necessarily the root of the local drive). If it doesn’t start with <code>/</code> then it is matched starting at the <strong>end of the path</strong>, but it will only match a complete path element:</p> 3448 <pre><code>file.jpg - matches "file.jpg" 3449 - matches "directory/file.jpg" 3450 - doesn't match "afile.jpg" 3451 - doesn't match "directory/afile.jpg" 3452 /file.jpg - matches "file.jpg" in the root directory of the remote 3453 - doesn't match "afile.jpg" 3454 - doesn't match "directory/file.jpg"</code></pre> 3455 <p><strong>Important</strong> Note that you must use <code>/</code> in patterns and not <code>\</code> even if running on Windows.</p> 3456 <p>A <code>*</code> matches anything but not a <code>/</code>.</p> 3457 <pre><code>*.jpg - matches "file.jpg" 3458 - matches "directory/file.jpg" 3459 - doesn't match "file.jpg/something"</code></pre> 3460 <p>Use <code>**</code> to match anything, including slashes (<code>/</code>).</p> 3461 <pre><code>dir/** - matches "dir/file.jpg" 3462 - matches "dir/dir1/dir2/file.jpg" 3463 - doesn't match "directory/file.jpg" 3464 - doesn't match "adir/file.jpg"</code></pre> 3465 <p>A <code>?</code> matches any character except a slash <code>/</code>.</p> 3466 <pre><code>l?ss - matches "less" 3467 - matches "lass" 3468 - doesn't match "floss"</code></pre> 3469 <p>A <code>[</code> and <code>]</code> together make a character class, such as <code>[a-z]</code> or <code>[aeiou]</code> or <code>[[:alpha:]]</code>. See the <a href="https://golang.org/pkg/regexp/syntax/">go regexp docs</a> for more info on these.</p> 3470 <pre><code>h[ae]llo - matches "hello" 3471 - matches "hallo" 3472 - doesn't match "hullo"</code></pre> 3473 <p>A <code>{</code> and <code>}</code> define a choice between elements. It should contain a comma separated list of patterns, any of which might match. These patterns can contain wildcards.</p> 3474 <pre><code>{one,two}_potato - matches "one_potato" 3475 - matches "two_potato" 3476 - doesn't match "three_potato" 3477 - doesn't match "_potato"</code></pre> 3478 <p>Special characters can be escaped with a <code>\</code> before them.</p> 3479 <pre><code>\*.jpg - matches "*.jpg" 3480 \\.jpg - matches "\.jpg" 3481 \[one\].jpg - matches "[one].jpg"</code></pre> 3482 <p>Patterns are case sensitive unless the <code>--ignore-case</code> flag is used.</p> 3483 <p>Without <code>--ignore-case</code> (default)</p> 3484 <pre><code>potato - matches "potato" 3485 - doesn't match "POTATO"</code></pre> 3486 <p>With <code>--ignore-case</code></p> 3487 <pre><code>potato - matches "potato" 3488 - matches "POTATO"</code></pre> 3489 <p>Note also that rclone filter globs can only be used in one of the filter command line flags, not in the specification of the remote, so <code>rclone copy "remote:dir*.jpg" /path/to/dir</code> won’t work - what is required is <code>rclone --include "*.jpg" copy remote:dir /path/to/dir</code></p> 3490 <h3 id="directories">Directories</h3> 3491 <p>Rclone keeps track of directories that could match any file patterns.</p> 3492 <p>Eg if you add the include rule</p> 3493 <pre><code>/a/*.jpg</code></pre> 3494 <p>Rclone will synthesize the directory include rule</p> 3495 <pre><code>/a/</code></pre> 3496 <p>If you put any rules which end in <code>/</code> then it will only match directories.</p> 3497 <p>Directory matches are <strong>only</strong> used to optimise directory access patterns - you must still match the files that you want to match. Directory matches won’t optimise anything on bucket based remotes (eg s3, swift, google compute storage, b2) which don’t have a concept of directory.</p> 3498 <h3 id="differences-between-rsync-and-rclone-patterns">Differences between rsync and rclone patterns</h3> 3499 <p>Rclone implements bash style <code>{a,b,c}</code> glob matching which rsync doesn’t.</p> 3500 <p>Rclone always does a wildcard match so <code>\</code> must always escape a <code>\</code>.</p> 3501 <h2 id="how-the-rules-are-used">How the rules are used</h2> 3502 <p>Rclone maintains a combined list of include rules and exclude rules.</p> 3503 <p>Each file is matched in order, starting from the top, against the rule in the list until it finds a match. The file is then included or excluded according to the rule type.</p> 3504 <p>If the matcher fails to find a match after testing against all the entries in the list then the path is included.</p> 3505 <p>For example given the following rules, <code>+</code> being include, <code>-</code> being exclude,</p> 3506 <pre><code>- secret*.jpg 3507 + *.jpg 3508 + *.png 3509 + file2.avi 3510 - *</code></pre> 3511 <p>This would include</p> 3512 <ul> 3513 <li><code>file1.jpg</code></li> 3514 <li><code>file3.png</code></li> 3515 <li><code>file2.avi</code></li> 3516 </ul> 3517 <p>This would exclude</p> 3518 <ul> 3519 <li><code>secret17.jpg</code></li> 3520 <li>non <code>*.jpg</code> and <code>*.png</code></li> 3521 </ul> 3522 <p>A similar process is done on directory entries before recursing into them. This only works on remotes which have a concept of directory (Eg local, google drive, onedrive, amazon drive) and not on bucket based remotes (eg s3, swift, google compute storage, b2).</p> 3523 <h2 id="adding-filtering-rules">Adding filtering rules</h2> 3524 <p>Filtering rules are added with the following command line flags.</p> 3525 <h3 id="repeating-options">Repeating options</h3> 3526 <p>You can repeat the following options to add more than one rule of that type.</p> 3527 <ul> 3528 <li><code>--include</code></li> 3529 <li><code>--include-from</code></li> 3530 <li><code>--exclude</code></li> 3531 <li><code>--exclude-from</code></li> 3532 <li><code>--filter</code></li> 3533 <li><code>--filter-from</code></li> 3534 <li><code>--filter-from-raw</code></li> 3535 </ul> 3536 <p><strong>Important</strong> You should not use <code>--include*</code> together with <code>--exclude*</code>. It may produce different results than you expected. In that case try to use: <code>--filter*</code>.</p> 3537 <p>Note that all the options of the same type are processed together in the order above, regardless of what order they were placed on the command line.</p> 3538 <p>So all <code>--include</code> options are processed first in the order they appeared on the command line, then all <code>--include-from</code> options etc.</p> 3539 <p>To mix up the order includes and excludes, the <code>--filter</code> flag can be used.</p> 3540 <h3 id="exclude---exclude-files-matching-pattern"><code>--exclude</code> - Exclude files matching pattern</h3> 3541 <p>Add a single exclude rule with <code>--exclude</code>.</p> 3542 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3543 <p>Eg <code>--exclude *.bak</code> to exclude all bak files from the sync.</p> 3544 <h3 id="exclude-from---read-exclude-patterns-from-file"><code>--exclude-from</code> - Read exclude patterns from file</h3> 3545 <p>Add exclude rules from a file.</p> 3546 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3547 <p>Prepare a file like this <code>exclude-file.txt</code></p> 3548 <pre><code># a sample exclude rule file 3549 *.bak 3550 file2.jpg</code></pre> 3551 <p>Then use as <code>--exclude-from exclude-file.txt</code>. This will sync all files except those ending in <code>bak</code> and <code>file2.jpg</code>.</p> 3552 <p>This is useful if you have a lot of rules.</p> 3553 <h3 id="include---include-files-matching-pattern"><code>--include</code> - Include files matching pattern</h3> 3554 <p>Add a single include rule with <code>--include</code>.</p> 3555 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3556 <p>Eg <code>--include *.{png,jpg}</code> to include all <code>png</code> and <code>jpg</code> files in the backup and no others.</p> 3557 <p>This adds an implicit <code>--exclude *</code> at the very end of the filter list. This means you can mix <code>--include</code> and <code>--include-from</code> with the other filters (eg <code>--exclude</code>) but you must include all the files you want in the include statement. If this doesn’t provide enough flexibility then you must use <code>--filter-from</code>.</p> 3558 <h3 id="include-from---read-include-patterns-from-file"><code>--include-from</code> - Read include patterns from file</h3> 3559 <p>Add include rules from a file.</p> 3560 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3561 <p>Prepare a file like this <code>include-file.txt</code></p> 3562 <pre><code># a sample include rule file 3563 *.jpg 3564 *.png 3565 file2.avi</code></pre> 3566 <p>Then use as <code>--include-from include-file.txt</code>. This will sync all <code>jpg</code>, <code>png</code> files and <code>file2.avi</code>.</p> 3567 <p>This is useful if you have a lot of rules.</p> 3568 <p>This adds an implicit <code>--exclude *</code> at the very end of the filter list. This means you can mix <code>--include</code> and <code>--include-from</code> with the other filters (eg <code>--exclude</code>) but you must include all the files you want in the include statement. If this doesn’t provide enough flexibility then you must use <code>--filter-from</code>.</p> 3569 <h3 id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add a file-filtering rule</h3> 3570 <p>This can be used to add a single include or exclude rule. Include rules start with <code>+</code> and exclude rules start with <code>-</code>. A special rule called <code>!</code> can be used to clear the existing rules.</p> 3571 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3572 <p>Eg <code>--filter "- *.bak"</code> to exclude all bak files from the sync.</p> 3573 <h3 id="filter-from---read-filtering-patterns-from-a-file"><code>--filter-from</code> - Read filtering patterns from a file</h3> 3574 <p>Add include/exclude rules from a file.</p> 3575 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 3576 <p>Prepare a file like this <code>filter-file.txt</code></p> 3577 <pre><code># a sample filter rule file 3578 - secret*.jpg 3579 + *.jpg 3580 + *.png 3581 + file2.avi 3582 - /dir/Trash/** 3583 + /dir/** 3584 # exclude everything else 3585 - *</code></pre> 3586 <p>Then use as <code>--filter-from filter-file.txt</code>. The rules are processed in the order that they are defined.</p> 3587 <p>This example will include all <code>jpg</code> and <code>png</code> files, exclude any files matching <code>secret*.jpg</code> and include <code>file2.avi</code>. It will also include everything in the directory <code>dir</code> at the root of the sync, except <code>dir/Trash</code> which it will exclude. Everything else will be excluded from the sync.</p> 3588 <h3 id="files-from---read-list-of-source-file-names"><code>--files-from</code> - Read list of source-file names</h3> 3589 <p>This reads a list of file names from the file passed in and <strong>only</strong> these files are transferred. The <strong>filtering rules are ignored</strong> completely if you use this option.</p> 3590 <p><code>--files-from</code> expects a list of files as its input. Leading / trailing whitespace is stripped from the input lines and lines starting with <code>#</code> and <code>;</code> are ignored.</p> 3591 <p>Rclone will traverse the file system if you use <code>--files-from</code>, effectively using the files in <code>--files-from</code> as a set of filters. Rclone will not error if any of the files are missing.</p> 3592 <p>If you use <code>--no-traverse</code> as well as <code>--files-from</code> then rclone will not traverse the destination file system, it will find each file individually using approximately 1 API call. This can be more efficient for small lists of files.</p> 3593 <p>This option can be repeated to read from more than one file. These are read in the order that they are placed on the command line.</p> 3594 <p>Paths within the <code>--files-from</code> file will be interpreted as starting with the root specified in the command. Leading <code>/</code> characters are ignored. See <a href="#files-from-raw-read-list-of-source-file-names-without-any-processing">–files-from-raw</a> if you need the input to be processed in a raw manner.</p> 3595 <p>For example, suppose you had <code>files-from.txt</code> with this content:</p> 3596 <pre><code># comment 3597 file1.jpg 3598 subdir/file2.jpg</code></pre> 3599 <p>You could then use it like this:</p> 3600 <pre><code>rclone copy --files-from files-from.txt /home/me/pics remote:pics</code></pre> 3601 <p>This will transfer these files only (if they exist)</p> 3602 <pre><code>/home/me/pics/file1.jpg → remote:pics/file1.jpg 3603 /home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg</code></pre> 3604 <p>To take a more complicated example, let’s say you had a few files you want to back up regularly with these absolute paths:</p> 3605 <pre><code>/home/user1/important 3606 /home/user1/dir/file 3607 /home/user2/stuff</code></pre> 3608 <p>To copy these you’d find a common subdirectory - in this case <code>/home</code> and put the remaining files in <code>files-from.txt</code> with or without leading <code>/</code>, eg</p> 3609 <pre><code>user1/important 3610 user1/dir/file 3611 user2/stuff</code></pre> 3612 <p>You could then copy these to a remote like this</p> 3613 <pre><code>rclone copy --files-from files-from.txt /home remote:backup</code></pre> 3614 <p>The 3 files will arrive in <code>remote:backup</code> with the paths as in the <code>files-from.txt</code> like this:</p> 3615 <pre><code>/home/user1/important → remote:backup/user1/important 3616 /home/user1/dir/file → remote:backup/user1/dir/file 3617 /home/user2/stuff → remote:backup/user2/stuff</code></pre> 3618 <p>You could of course choose <code>/</code> as the root too in which case your <code>files-from.txt</code> might look like this.</p> 3619 <pre><code>/home/user1/important 3620 /home/user1/dir/file 3621 /home/user2/stuff</code></pre> 3622 <p>And you would transfer it like this</p> 3623 <pre><code>rclone copy --files-from files-from.txt / remote:backup</code></pre> 3624 <p>In this case there will be an extra <code>home</code> directory on the remote:</p> 3625 <pre><code>/home/user1/important → remote:backup/home/user1/important 3626 /home/user1/dir/file → remote:backup/home/user1/dir/file 3627 /home/user2/stuff → remote:backup/home/user2/stuff</code></pre> 3628 <h3 id="files-from-raw---read-list-of-source-file-names-without-any-processing"><code>--files-from-raw</code> - Read list of source-file names without any processing</h3> 3629 <p>This option is same as <code>--files-from</code> with the only difference being that the input is read in a raw manner. This means that lines with leading/trailing whitespace and lines starting with <code>;</code> or <code>#</code> are read without any processing. <a href="https://rclone.org/commands/rclone_lsf/">rclone lsf</a> has a compatible format that can be used to export file lists from remotes, which can then be used as an input to <code>--files-from-raw</code>.</p> 3630 <h3 id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code> - Don’t transfer any file smaller than this</h3> 3631 <p>This option controls the minimum size file which will be transferred. This defaults to <code>kBytes</code> but a suffix of <code>k</code>, <code>M</code>, or <code>G</code> can be used.</p> 3632 <p>For example <code>--min-size 50k</code> means no files smaller than 50kByte will be transferred.</p> 3633 <h3 id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code> - Don’t transfer any file larger than this</h3> 3634 <p>This option controls the maximum size file which will be transferred. This defaults to <code>kBytes</code> but a suffix of <code>k</code>, <code>M</code>, or <code>G</code> can be used.</p> 3635 <p>For example <code>--max-size 1G</code> means no files larger than 1GByte will be transferred.</p> 3636 <h3 id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code> - Don’t transfer any file older than this</h3> 3637 <p>This option controls the maximum age of files to transfer. Give in seconds or with a suffix of:</p> 3638 <ul> 3639 <li><code>ms</code> - Milliseconds</li> 3640 <li><code>s</code> - Seconds</li> 3641 <li><code>m</code> - Minutes</li> 3642 <li><code>h</code> - Hours</li> 3643 <li><code>d</code> - Days</li> 3644 <li><code>w</code> - Weeks</li> 3645 <li><code>M</code> - Months</li> 3646 <li><code>y</code> - Years</li> 3647 </ul> 3648 <p>For example <code>--max-age 2d</code> means no files older than 2 days will be transferred.</p> 3649 <p>This can also be an absolute time in one of these formats</p> 3650 <ul> 3651 <li>RFC3339 - eg “2006-01-02T15:04:05Z07:00”</li> 3652 <li>ISO8601 Date and time, local timezone - “2006-01-02T15:04:05”</li> 3653 <li>ISO8601 Date and time, local timezone - “2006-01-02 15:04:05”</li> 3654 <li>ISO8601 Date - “2006-01-02” (YYYY-MM-DD)</li> 3655 </ul> 3656 <h3 id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code> - Don’t transfer any file younger than this</h3> 3657 <p>This option controls the minimum age of files to transfer. Give in seconds or with a suffix (see <code>--max-age</code> for list of suffixes)</p> 3658 <p>For example <code>--min-age 2d</code> means no files younger than 2 days will be transferred.</p> 3659 <h3 id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code> - Delete files on dest excluded from sync</h3> 3660 <p><strong>Important</strong> this flag is dangerous - use with <code>--dry-run</code> and <code>-v</code> first.</p> 3661 <p>When doing <code>rclone sync</code> this will delete any files which are excluded from the sync on the destination.</p> 3662 <p>If for example you did a sync from <code>A</code> to <code>B</code> without the <code>--min-size 50k</code> flag</p> 3663 <pre><code>rclone sync A: B:</code></pre> 3664 <p>Then you repeated it like this with the <code>--delete-excluded</code></p> 3665 <pre><code>rclone --min-size 50k --delete-excluded sync A: B:</code></pre> 3666 <p>This would delete all files on <code>B</code> which are less than 50 kBytes as these are now excluded from the sync.</p> 3667 <p>Always test first with <code>--dry-run</code> and <code>-v</code> before using this flag.</p> 3668 <h3 id="dump-filters---dump-the-filters-to-the-output"><code>--dump filters</code> - dump the filters to the output</h3> 3669 <p>This dumps the defined filters to the output as regular expressions.</p> 3670 <p>Useful for debugging.</p> 3671 <h3 id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code> - make searches case insensitive</h3> 3672 <p>Normally filter patterns are case sensitive. If this flag is supplied then filter patterns become case insensitive.</p> 3673 <p>Normally a <code>--include "file.txt"</code> will not match a file called <code>FILE.txt</code>. However if you use the <code>--ignore-case</code> flag then <code>--include "file.txt"</code> this will match a file called <code>FILE.txt</code>.</p> 3674 <h2 id="quoting-shell-metacharacters">Quoting shell metacharacters</h2> 3675 <p>The examples above may not work verbatim in your shell as they have shell metacharacters in them (eg <code>*</code>), and may require quoting.</p> 3676 <p>Eg linux, OSX</p> 3677 <ul> 3678 <li><code>--include \*.jpg</code></li> 3679 <li><code>--include '*.jpg'</code></li> 3680 <li><code>--include='*.jpg'</code></li> 3681 </ul> 3682 <p>In Windows the expansion is done by the command not the shell so this should work fine</p> 3683 <ul> 3684 <li><code>--include *.jpg</code></li> 3685 </ul> 3686 <h2 id="exclude-directory-based-on-a-file">Exclude directory based on a file</h2> 3687 <p>It is possible to exclude a directory based on a file, which is present in this directory. Filename should be specified using the <code>--exclude-if-present</code> flag. This flag has a priority over the other filtering flags.</p> 3688 <p>Imagine, you have the following directory structure:</p> 3689 <pre><code>dir1/file1 3690 dir1/dir2/file2 3691 dir1/dir2/dir3/file3 3692 dir1/dir2/dir3/.ignore</code></pre> 3693 <p>You can exclude <code>dir3</code> from sync by running the following command:</p> 3694 <pre><code>rclone sync --exclude-if-present .ignore dir1 remote:backup</code></pre> 3695 <p>Currently only one filename is supported, i.e. <code>--exclude-if-present</code> should not be used multiple times.</p> 3696 <h1 id="gui-experimental">GUI (Experimental)</h1> 3697 <p>Rclone can serve a web based GUI (graphical user interface). This is somewhat experimental at the moment so things may be subject to change.</p> 3698 <p>Run this command in a terminal and rclone will download and then display the GUI in a web browser.</p> 3699 <pre><code>rclone rcd --rc-web-gui</code></pre> 3700 <p>This will produce logs like this and rclone needs to continue to run to serve the GUI:</p> 3701 <pre><code>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 3702 2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path : /home/USER/.cache/rclone/webgui/v0.0.6.zip] 3703 2019/08/25 11:40:16 NOTICE: Unzipping 3704 2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/</code></pre> 3705 <p>This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI - see below for details.</p> 3706 <p>If you wish to check for updates then you can add <code>--rc-web-gui-update</code> to the command line.</p> 3707 <p>If you find your GUI broken, you may force it to update by add <code>--rc-web-gui-force-update</code>.</p> 3708 <p>By default, rclone will open your browser. Add <code>--rc-web-gui-no-open-browser</code> to disable this feature.</p> 3709 <h2 id="using-the-gui">Using the GUI</h2> 3710 <p>Once the GUI opens, you will be looking at the dashboard which has an overall overview.</p> 3711 <p>On the left hand side you will see a series of view buttons you can click on:</p> 3712 <ul> 3713 <li>Dashboard - main overview</li> 3714 <li>Configs - examine and create new configurations</li> 3715 <li>Explorer - view, download and upload files to the cloud storage systems</li> 3716 <li>Backend - view or alter the backend config</li> 3717 <li>Log out</li> 3718 </ul> 3719 <p>(More docs and walkthrough video to come!)</p> 3720 <h2 id="how-it-works">How it works</h2> 3721 <p>When you run the <code>rclone rcd --rc-web-gui</code> this is what happens</p> 3722 <ul> 3723 <li>Rclone starts but only runs the remote control API (“rc”).</li> 3724 <li>The API is bound to localhost with an auto generated username and password.</li> 3725 <li>If the API bundle is missing then rclone will download it.</li> 3726 <li>rclone will start serving the files from the API bundle over the same port as the API</li> 3727 <li>rclone will open the browser with a <code>login_token</code> so it can log straight in.</li> 3728 </ul> 3729 <h2 id="advanced-use">Advanced use</h2> 3730 <p>The <code>rclone rcd</code> may use any of the <a href="https://rclone.org/rc/#supported-parameters">flags documented on the rc page</a>.</p> 3731 <p>The flag <code>--rc-web-gui</code> is shorthand for</p> 3732 <ul> 3733 <li>Download the web GUI if necessary</li> 3734 <li>Check we are using some authentication</li> 3735 <li><code>--rc-user gui</code></li> 3736 <li><code>--rc-pass <random password></code></li> 3737 <li><code>--rc-serve</code></li> 3738 </ul> 3739 <p>These flags can be overridden as desired.</p> 3740 <p>See also the <a href="https://rclone.org/commands/rclone_rcd/">rclone rcd documentation</a>.</p> 3741 <h3 id="example-running-a-public-gui">Example: Running a public GUI</h3> 3742 <p>For example the GUI could be served on a public port over SSL using an htpasswd file using the following flags:</p> 3743 <ul> 3744 <li><code>--rc-web-gui</code></li> 3745 <li><code>--rc-addr :443</code></li> 3746 <li><code>--rc-htpasswd /path/to/htpasswd</code></li> 3747 <li><code>--rc-cert /path/to/ssl.crt</code></li> 3748 <li><code>--rc-key /path/to/ssl.key</code></li> 3749 </ul> 3750 <h3 id="example-running-a-gui-behind-a-proxy">Example: Running a GUI behind a proxy</h3> 3751 <p>If you want to run the GUI behind a proxy at <code>/rclone</code> you could use these flags:</p> 3752 <ul> 3753 <li><code>--rc-web-gui</code></li> 3754 <li><code>--rc-baseurl rclone</code></li> 3755 <li><code>--rc-htpasswd /path/to/htpasswd</code></li> 3756 </ul> 3757 <p>Or instead of htpasswd if you just want a single user and password:</p> 3758 <ul> 3759 <li><code>--rc-user me</code></li> 3760 <li><code>--rc-pass mypassword</code></li> 3761 </ul> 3762 <h2 id="project">Project</h2> 3763 <p>The GUI is being developed in the: <a href="https://github.com/rclone/rclone-webui-react">rclone/rclone-webui-react repository</a>.</p> 3764 <p>Bug reports and contributions are very welcome :-)</p> 3765 <p>If you have questions then please ask them on the <a href="https://forum.rclone.org/">rclone forum</a>.</p> 3766 <h1 id="remote-controlling-rclone-with-its-api">Remote controlling rclone with its API</h1> 3767 <p>If rclone is run with the <code>--rc</code> flag then it starts an http server which can be used to remote control rclone using its API.</p> 3768 <p>If you just want to run a remote control then see the <a href="https://rclone.org/commands/rclone_rcd/">rcd command</a>.</p> 3769 <h2 id="supported-parameters">Supported parameters</h2> 3770 <h3 id="rc">–rc</h3> 3771 <p>Flag to start the http server listen on remote requests</p> 3772 <h3 id="rc-addrip">–rc-addr=IP</h3> 3773 <p>IPaddress:Port or :Port to bind server to. (default “localhost:5572”)</p> 3774 <h3 id="rc-certkey">–rc-cert=KEY</h3> 3775 <p>SSL PEM key (concatenation of certificate and CA certificate)</p> 3776 <h3 id="rc-client-capath">–rc-client-ca=PATH</h3> 3777 <p>Client certificate authority to verify clients with</p> 3778 <h3 id="rc-htpasswdpath">–rc-htpasswd=PATH</h3> 3779 <p>htpasswd file - if not provided no authentication is done</p> 3780 <h3 id="rc-keypath">–rc-key=PATH</h3> 3781 <p>SSL PEM Private key</p> 3782 <h3 id="rc-max-header-bytesvalue">–rc-max-header-bytes=VALUE</h3> 3783 <p>Maximum size of request header (default 4096)</p> 3784 <h3 id="rc-uservalue">–rc-user=VALUE</h3> 3785 <p>User name for authentication.</p> 3786 <h3 id="rc-passvalue">–rc-pass=VALUE</h3> 3787 <p>Password for authentication.</p> 3788 <h3 id="rc-realmvalue">–rc-realm=VALUE</h3> 3789 <p>Realm for authentication (default “rclone”)</p> 3790 <h3 id="rc-server-read-timeoutduration">–rc-server-read-timeout=DURATION</h3> 3791 <p>Timeout for server reading data (default 1h0m0s)</p> 3792 <h3 id="rc-server-write-timeoutduration">–rc-server-write-timeout=DURATION</h3> 3793 <p>Timeout for server writing data (default 1h0m0s)</p> 3794 <h3 id="rc-serve">–rc-serve</h3> 3795 <p>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</p> 3796 <p>Default Off.</p> 3797 <h3 id="rc-files-pathtodirectory">–rc-files /path/to/directory</h3> 3798 <p>Path to local files to serve on the HTTP server.</p> 3799 <p>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.</p> 3800 <p>If <code>--rc-user</code> or <code>--rc-pass</code> is set then the URL that is opened will have the authorization in the URL in the <code>http://user:pass@localhost/</code> style.</p> 3801 <p>Default Off.</p> 3802 <h3 id="rc-enable-metrics">–rc-enable-metrics</h3> 3803 <p>Enable OpenMetrics/Prometheus compatible endpoint at <code>/metrics</code>.</p> 3804 <p>Default Off.</p> 3805 <h3 id="rc-web-gui">–rc-web-gui</h3> 3806 <p>Set this flag to serve the default web gui on the same port as rclone.</p> 3807 <p>Default Off.</p> 3808 <h3 id="rc-allow-origin">–rc-allow-origin</h3> 3809 <p>Set the allowed Access-Control-Allow-Origin for rc requests.</p> 3810 <p>Can be used with –rc-web-gui if the rclone is running on different IP than the web-gui.</p> 3811 <p>Default is IP address on which rc is running.</p> 3812 <h3 id="rc-web-fetch-url">–rc-web-fetch-url</h3> 3813 <p>Set the URL to fetch the rclone-web-gui files from.</p> 3814 <p>Default https://api.github.com/repos/rclone/rclone-webui-react/releases/latest.</p> 3815 <h3 id="rc-web-gui-update">–rc-web-gui-update</h3> 3816 <p>Set this flag to check and update rclone-webui-react from the rc-web-fetch-url.</p> 3817 <p>Default Off.</p> 3818 <h3 id="rc-web-gui-force-update">–rc-web-gui-force-update</h3> 3819 <p>Set this flag to force update rclone-webui-react from the rc-web-fetch-url.</p> 3820 <p>Default Off.</p> 3821 <h3 id="rc-web-gui-no-open-browser">–rc-web-gui-no-open-browser</h3> 3822 <p>Set this flag to disable opening browser automatically when using web-gui.</p> 3823 <p>Default Off.</p> 3824 <h3 id="rc-job-expire-durationduration">–rc-job-expire-duration=DURATION</h3> 3825 <p>Expire finished async jobs older than DURATION (default 60s).</p> 3826 <h3 id="rc-job-expire-intervalduration">–rc-job-expire-interval=DURATION</h3> 3827 <p>Interval duration to check for expired async jobs (default 10s).</p> 3828 <h3 id="rc-no-auth">–rc-no-auth</h3> 3829 <p>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 <code>operations/list</code> is denied as it involved creating a remote as is <code>sync/copy</code>.</p> 3830 <p>If this is set then no authorisation will be required on the server to use these methods. The alternative is to use <code>--rc-user</code> and <code>--rc-pass</code> and use these credentials in the request.</p> 3831 <p>Default Off.</p> 3832 <h2 id="accessing-the-remote-control-via-the-rclone-rc-command">Accessing the remote control via the rclone rc command</h2> 3833 <p>Rclone itself implements the remote control protocol in its <code>rclone rc</code> command.</p> 3834 <p>You can use it like this</p> 3835 <pre><code>$ rclone rc rc/noop param1=one param2=two 3836 { 3837 "param1": "one", 3838 "param2": "two" 3839 }</code></pre> 3840 <p>Run <code>rclone rc</code> on its own to see the help for the installed remote control commands.</p> 3841 <p><code>rclone rc</code> also supports a <code>--json</code> flag which can be used to send more complicated input parameters.</p> 3842 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 } }' rc/noop 3843 { 3844 "p1": [ 3845 1, 3846 "2", 3847 null, 3848 4 3849 ], 3850 "p2": { 3851 "a": 1, 3852 "b": 2 3853 } 3854 }</code></pre> 3855 <h2 id="special-parameters">Special parameters</h2> 3856 <p>The rc interface supports some special parameters which apply to <strong>all</strong> commands. These start with <code>_</code> to show they are different.</p> 3857 <h3 id="running-asynchronous-jobs-with-_async-true">Running asynchronous jobs with _async = true</h3> 3858 <p>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.</p> 3859 <p>If <code>_async</code> 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 <code>job/status</code> 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.</p> 3860 <p>It is recommended that potentially long running jobs, eg <code>sync/sync</code>, <code>sync/copy</code>, <code>sync/move</code>, <code>operations/purge</code> are run with the <code>_async</code> flag to avoid any potential problems with the HTTP request and response timing out.</p> 3861 <p>Starting a job with the <code>_async</code> flag:</p> 3862 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 }, "_async": true }' rc/noop 3863 { 3864 "jobid": 2 3865 }</code></pre> 3866 <p>Query the status to see if the job has finished. For more information on the meaning of these return parameters see the <code>job/status</code> call.</p> 3867 <pre><code>$ rclone rc --json '{ "jobid":2 }' job/status 3868 { 3869 "duration": 0.000124163, 3870 "endTime": "2018-10-27T11:38:07.911245881+01:00", 3871 "error": "", 3872 "finished": true, 3873 "id": 2, 3874 "output": { 3875 "_async": true, 3876 "p1": [ 3877 1, 3878 "2", 3879 null, 3880 4 3881 ], 3882 "p2": { 3883 "a": 1, 3884 "b": 2 3885 } 3886 }, 3887 "startTime": "2018-10-27T11:38:07.911121728+01:00", 3888 "success": true 3889 }</code></pre> 3890 <p><code>job/list</code> can be used to show the running or recently completed jobs</p> 3891 <pre><code>$ rclone rc job/list 3892 { 3893 "jobids": [ 3894 2 3895 ] 3896 }</code></pre> 3897 <h3 id="assigning-operations-to-groups-with-_group-value">Assigning operations to groups with _group = value</h3> 3898 <p>Each rc call has its own stats group for tracking its metrics. By default grouping is done by the composite group name from prefix <code>job/</code> and id of the job like so <code>job/1</code>.</p> 3899 <p>If <code>_group</code> has a value then stats for that request will be grouped under that value. This allows caller to group stats under their own name.</p> 3900 <p>Stats for specific group can be accessed by passing <code>group</code> to <code>core/stats</code>:</p> 3901 <pre><code>$ rclone rc --json '{ "group": "job/1" }' core/stats 3902 { 3903 "speed": 12345 3904 ... 3905 }</code></pre> 3906 <h2 id="supported-commands">Supported commands</h2> 3907 <h3 id="backend-command">backend/command: Runs a backend command.</h3> 3908 <p>This takes the following parameters</p> 3909 <ul> 3910 <li>command - a string with the command name</li> 3911 <li>fs - a remote name string eg “drive:”</li> 3912 <li>arg - a list of arguments for the backend command</li> 3913 <li>opt - a map of string to string of options</li> 3914 </ul> 3915 <p>Returns</p> 3916 <ul> 3917 <li>result - result from the backend command</li> 3918 </ul> 3919 <p>For example</p> 3920 <pre><code>rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2</code></pre> 3921 <p>Returns</p> 3922 <pre><code>{ 3923 "result": { 3924 "arg": [ 3925 "path1", 3926 "path2" 3927 ], 3928 "name": "noop", 3929 "opt": { 3930 "blue": "", 3931 "echo": "yes" 3932 } 3933 } 3934 }</code></pre> 3935 <p>Note that this is the direct equivalent of using this “backend” command:</p> 3936 <pre><code>rclone backend noop . -o echo=yes -o blue path1 path2</code></pre> 3937 <p>Note that arguments must be preceded by the “-a” flag</p> 3938 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more information.</p> 3939 <p><strong>Authentication is required for this call.</strong></p> 3940 <h3 id="cache-expire">cache/expire: Purge a remote from cache</h3> 3941 <p>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)</p> 3942 <p>Eg</p> 3943 <pre><code>rclone rc cache/expire remote=path/to/sub/folder/ 3944 rclone rc cache/expire remote=/ withData=true</code></pre> 3945 <h3 id="cache-fetch">cache/fetch: Fetch file chunks</h3> 3946 <p>Ensure the specified file chunks are cached on disk.</p> 3947 <p>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]</p> 3948 <p>start is the 0 based chunk number from the beginning of the file to fetch inclusive. end is 0 based chunk number from the beginning of the file to fetch exclusive. Both values can be negative, in which case they count from the back of the file. The value “-5:” represents the last 5 chunks of a file.</p> 3949 <p>Some valid examples are: “:5,-5:” -> the first and last five chunks “0,-2” -> the first and the second last chunk “0:10” -> the first ten chunks</p> 3950 <p>Any parameter with a key that starts with “file” can be used to specify files to fetch, eg</p> 3951 <pre><code>rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye</code></pre> 3952 <p>File names will automatically be encrypted when the a crypt remote is used on top of the cache.</p> 3953 <h3 id="cache-stats">cache/stats: Get cache stats</h3> 3954 <p>Show statistics for the cache remote.</p> 3955 <h3 id="config-create">config/create: create the config for a remote.</h3> 3956 <p>This takes the following parameters</p> 3957 <ul> 3958 <li>name - name of remote</li> 3959 <li>parameters - a map of { “key”: “value” } pairs</li> 3960 <li>type - type of the new remote</li> 3961 <li>obscure - optional bool - forces obscuring of passwords</li> 3962 <li>noObscure - optional bool - forces passwords not to be obscured</li> 3963 </ul> 3964 <p>See the <a href="https://rclone.org/commands/rclone_config_create/">config create command</a> command for more information on the above.</p> 3965 <p><strong>Authentication is required for this call.</strong></p> 3966 <h3 id="config-delete">config/delete: Delete a remote in the config file.</h3> 3967 <p>Parameters:</p> 3968 <ul> 3969 <li>name - name of remote to delete</li> 3970 </ul> 3971 <p>See the <a href="https://rclone.org/commands/rclone_config_delete/">config delete command</a> command for more information on the above.</p> 3972 <p><strong>Authentication is required for this call.</strong></p> 3973 <h3 id="config-dump">config/dump: Dumps the config file.</h3> 3974 <p>Returns a JSON object: - key: value</p> 3975 <p>Where keys are remote names and values are the config parameters.</p> 3976 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p> 3977 <p><strong>Authentication is required for this call.</strong></p> 3978 <h3 id="config-get">config/get: Get a remote in the config file.</h3> 3979 <p>Parameters:</p> 3980 <ul> 3981 <li>name - name of remote to get</li> 3982 </ul> 3983 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p> 3984 <p><strong>Authentication is required for this call.</strong></p> 3985 <h3 id="config-listremotes">config/listremotes: Lists the remotes in the config file.</h3> 3986 <p>Returns - remotes - array of remote names</p> 3987 <p>See the <a href="https://rclone.org/commands/rclone_listremotes/">listremotes command</a> command for more information on the above.</p> 3988 <p><strong>Authentication is required for this call.</strong></p> 3989 <h3 id="config-password">config/password: password the config for a remote.</h3> 3990 <p>This takes the following parameters</p> 3991 <ul> 3992 <li>name - name of remote</li> 3993 <li>parameters - a map of { “key”: “value” } pairs</li> 3994 </ul> 3995 <p>See the <a href="https://rclone.org/commands/rclone_config_password/">config password command</a> command for more information on the above.</p> 3996 <p><strong>Authentication is required for this call.</strong></p> 3997 <h3 id="config-providers">config/providers: Shows how providers are configured in the config file.</h3> 3998 <p>Returns a JSON object: - providers - array of objects</p> 3999 <p>See the <a href="https://rclone.org/commands/rclone_config_providers/">config providers command</a> command for more information on the above.</p> 4000 <p><strong>Authentication is required for this call.</strong></p> 4001 <h3 id="config-update">config/update: update the config for a remote.</h3> 4002 <p>This takes the following parameters</p> 4003 <ul> 4004 <li>name - name of remote</li> 4005 <li>parameters - a map of { “key”: “value” } pairs</li> 4006 <li>obscure - optional bool - forces obscuring of passwords</li> 4007 <li>noObscure - optional bool - forces passwords not to be obscured</li> 4008 </ul> 4009 <p>See the <a href="https://rclone.org/commands/rclone_config_update/">config update command</a> command for more information on the above.</p> 4010 <p><strong>Authentication is required for this call.</strong></p> 4011 <h3 id="core-bwlimit">core/bwlimit: Set the bandwidth limit.</h3> 4012 <p>This sets the bandwidth limit to that passed in.</p> 4013 <p>Eg</p> 4014 <pre><code>rclone rc core/bwlimit rate=off 4015 { 4016 "bytesPerSecond": -1, 4017 "rate": "off" 4018 } 4019 rclone rc core/bwlimit rate=1M 4020 { 4021 "bytesPerSecond": 1048576, 4022 "rate": "1M" 4023 }</code></pre> 4024 <p>If the rate parameter is not supplied then the bandwidth is queried</p> 4025 <pre><code>rclone rc core/bwlimit 4026 { 4027 "bytesPerSecond": 1048576, 4028 "rate": "1M" 4029 }</code></pre> 4030 <p>The format of the parameter is exactly the same as passed to –bwlimit except only one bandwidth may be specified.</p> 4031 <p>In either case “rate” is returned as a human readable string, and “bytesPerSecond” is returned as a number.</p> 4032 <h3 id="core-gc">core/gc: Runs a garbage collection.</h3> 4033 <p>This tells the go runtime to do a garbage collection run. It isn’t necessary to call this normally, but it can be useful for debugging memory problems.</p> 4034 <h3 id="core-group-list">core/group-list: Returns list of stats.</h3> 4035 <p>This returns list of stats groups currently in memory.</p> 4036 <p>Returns the following values:</p> 4037 <pre><code>{ 4038 "groups": an array of group names: 4039 [ 4040 "group1", 4041 "group2", 4042 ... 4043 ] 4044 }</code></pre> 4045 <h3 id="core-memstats">core/memstats: Returns the memory statistics</h3> 4046 <p>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</p> 4047 <p>The most interesting values for most people are:</p> 4048 <ul> 4049 <li>HeapAlloc: This is the amount of memory rclone is actually using</li> 4050 <li>HeapSys: This is the amount of memory rclone has obtained from the OS</li> 4051 <li>Sys: this is the total amount of memory requested from the OS 4052 <ul> 4053 <li>It is virtual memory so may include unused memory</li> 4054 </ul></li> 4055 </ul> 4056 <h3 id="core-obscure">core/obscure: Obscures a string passed in.</h3> 4057 <p>Pass a clear string and rclone will obscure it for the config file: - clear - string</p> 4058 <p>Returns - obscured - string</p> 4059 <h3 id="core-pid">core/pid: Return PID of current process</h3> 4060 <p>This returns PID of current process. Useful for stopping rclone process.</p> 4061 <h3 id="core-quit">core/quit: Terminates the app.</h3> 4062 <p>(optional) Pass an exit code to be used for terminating the app: - exitCode - int</p> 4063 <h3 id="core-stats">core/stats: Returns stats about current transfers.</h3> 4064 <p>This returns all available stats:</p> 4065 <pre><code>rclone rc core/stats</code></pre> 4066 <p>If group is not provided then summed up stats for all groups will be returned.</p> 4067 <p>Parameters</p> 4068 <ul> 4069 <li>group - name of the stats group (string)</li> 4070 </ul> 4071 <p>Returns the following values:</p> 4072 <pre><code>{ 4073 "speed": average speed in bytes/sec since start of the process, 4074 "bytes": total transferred bytes since the start of the process, 4075 "errors": number of errors, 4076 "fatalError": whether there has been at least one FatalError, 4077 "retryError": whether there has been at least one non-NoRetryError, 4078 "checks": number of checked files, 4079 "transfers": number of transferred files, 4080 "deletes" : number of deleted files, 4081 "renames" : number of renamed files, 4082 "elapsedTime": time in seconds since the start of the process, 4083 "lastError": last occurred error, 4084 "transferring": an array of currently active file transfers: 4085 [ 4086 { 4087 "bytes": total transferred bytes for this file, 4088 "eta": estimated time in seconds until file transfer completion 4089 "name": name of the file, 4090 "percentage": progress of the file transfer in percent, 4091 "speed": speed in bytes/sec, 4092 "speedAvg": speed in bytes/sec as an exponentially weighted moving average, 4093 "size": size of the file in bytes 4094 } 4095 ], 4096 "checking": an array of names of currently active file checks 4097 [] 4098 }</code></pre> 4099 <p>Values for “transferring”, “checking” and “lastError” are only assigned if data is available. The value for “eta” is null if an eta cannot be determined.</p> 4100 <h3 id="core-stats-delete">core/stats-delete: Delete stats group.</h3> 4101 <p>This deletes entire stats group</p> 4102 <p>Parameters</p> 4103 <ul> 4104 <li>group - name of the stats group (string)</li> 4105 </ul> 4106 <h3 id="core-stats-reset">core/stats-reset: Reset stats.</h3> 4107 <p>This clears counters, errors and finished transfers for all stats or specific stats group if group is provided.</p> 4108 <p>Parameters</p> 4109 <ul> 4110 <li>group - name of the stats group (string)</li> 4111 </ul> 4112 <h3 id="core-transferred">core/transferred: Returns stats about completed transfers.</h3> 4113 <p>This returns stats about completed transfers:</p> 4114 <pre><code>rclone rc core/transferred</code></pre> 4115 <p>If group is not provided then completed transfers for all groups will be returned.</p> 4116 <p>Note only the last 100 completed transfers are returned.</p> 4117 <p>Parameters</p> 4118 <ul> 4119 <li>group - name of the stats group (string)</li> 4120 </ul> 4121 <p>Returns the following values:</p> 4122 <pre><code>{ 4123 "transferred": an array of completed transfers (including failed ones): 4124 [ 4125 { 4126 "name": name of the file, 4127 "size": size of the file in bytes, 4128 "bytes": total transferred bytes for this file, 4129 "checked": if the transfer is only checked (skipped, deleted), 4130 "timestamp": integer representing millisecond unix epoch, 4131 "error": string description of the error (empty if successful), 4132 "jobid": id of the job that this transfer belongs to 4133 } 4134 ] 4135 }</code></pre> 4136 <h3 id="core-version">core/version: Shows the current version of rclone and the go runtime.</h3> 4137 <p>This shows the current version of go and the go runtime</p> 4138 <ul> 4139 <li>version - rclone version, eg “v1.44”</li> 4140 <li>decomposed - version number as [major, minor, patch, subpatch] 4141 <ul> 4142 <li>note patch and subpatch will be 999 for a git compiled version</li> 4143 </ul></li> 4144 <li>isGit - boolean - true if this was compiled from the git version</li> 4145 <li>os - OS in use as according to Go</li> 4146 <li>arch - cpu architecture in use according to Go</li> 4147 <li>goVersion - version of Go runtime in use</li> 4148 </ul> 4149 <h3 id="debug-set-block-profile-rate">debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.</h3> 4150 <p>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.</p> 4151 <p>To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0.</p> 4152 <p>After calling this you can use this to see the blocking profile:</p> 4153 <pre><code>go tool pprof http://localhost:5572/debug/pprof/block</code></pre> 4154 <p>Parameters</p> 4155 <ul> 4156 <li>rate - int</li> 4157 </ul> 4158 <h3 id="debug-set-mutex-profile-fraction">debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling.</h3> 4159 <p>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.</p> 4160 <p>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.)</p> 4161 <p>Once this is set you can look use this to profile the mutex contention:</p> 4162 <pre><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></pre> 4163 <p>Parameters</p> 4164 <ul> 4165 <li>rate - int</li> 4166 </ul> 4167 <p>Results</p> 4168 <ul> 4169 <li>previousRate - int</li> 4170 </ul> 4171 <h3 id="job-list">job/list: Lists the IDs of the running jobs</h3> 4172 <p>Parameters - None</p> 4173 <p>Results</p> 4174 <ul> 4175 <li>jobids - array of integer job ids</li> 4176 </ul> 4177 <h3 id="job-status">job/status: Reads the status of the job ID</h3> 4178 <p>Parameters</p> 4179 <ul> 4180 <li>jobid - id of the job (integer)</li> 4181 </ul> 4182 <p>Results</p> 4183 <ul> 4184 <li>finished - boolean</li> 4185 <li>duration - time in seconds that the job ran for</li> 4186 <li>endTime - time the job finished (eg “2018-10-26T18:50:20.528746884+01:00”)</li> 4187 <li>error - error from the job or empty string for no error</li> 4188 <li>finished - boolean whether the job has finished or not</li> 4189 <li>id - as passed in above</li> 4190 <li>startTime - time the job started (eg “2018-10-26T18:50:20.528336039+01:00”)</li> 4191 <li>success - boolean - true for success false otherwise</li> 4192 <li>output - output of the job as would have been returned if called synchronously</li> 4193 <li>progress - output of the progress related to the underlying job</li> 4194 </ul> 4195 <h3 id="job-stop">job/stop: Stop the running job</h3> 4196 <p>Parameters</p> 4197 <ul> 4198 <li>jobid - id of the job (integer)</li> 4199 </ul> 4200 <h3 id="mount-mount">mount/mount: Create a new mount point</h3> 4201 <p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone’s cloud storage systems as a file system with FUSE.</p> 4202 <p>If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2</p> 4203 <p>This takes the following parameters</p> 4204 <ul> 4205 <li>fs - a remote path to be mounted (required)</li> 4206 <li>mountPoint: valid path on the local machine (required)</li> 4207 <li>mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use</li> 4208 </ul> 4209 <p>Eg</p> 4210 <pre><code>rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint 4211 rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount</code></pre> 4212 <p><strong>Authentication is required for this call.</strong></p> 4213 <h3 id="mount-types">mount/types: Show all possible mount types</h3> 4214 <p>This shows all possible mount types and returns them as a list.</p> 4215 <p>This takes no parameters and returns</p> 4216 <ul> 4217 <li>mountTypes: list of mount types</li> 4218 </ul> 4219 <p>The mount types are strings like “mount”, “mount2”, “cmount” and can be passed to mount/mount as the mountType parameter.</p> 4220 <p>Eg</p> 4221 <pre><code>rclone rc mount/types</code></pre> 4222 <p><strong>Authentication is required for this call.</strong></p> 4223 <h3 id="mount-unmount">mount/unmount: Unmount all active mounts</h3> 4224 <p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone’s cloud storage systems as a file system with FUSE.</p> 4225 <p>This takes the following parameters</p> 4226 <ul> 4227 <li>mountPoint: valid path on the local machine where the mount was created (required)</li> 4228 </ul> 4229 <p>Eg</p> 4230 <pre><code>rclone rc mount/unmount mountPoint=/home/<user>/mountPoint</code></pre> 4231 <p><strong>Authentication is required for this call.</strong></p> 4232 <h3 id="operations-about">operations/about: Return the space used on the remote</h3> 4233 <p>This takes the following parameters</p> 4234 <ul> 4235 <li>fs - a remote name string eg “drive:”</li> 4236 </ul> 4237 <p>The result is as returned from rclone about –json</p> 4238 <p>See the <a href="https://rclone.org/commands/rclone_size/">about command</a> command for more information on the above.</p> 4239 <p><strong>Authentication is required for this call.</strong></p> 4240 <h3 id="operations-cleanup">operations/cleanup: Remove trashed files in the remote or path</h3> 4241 <p>This takes the following parameters</p> 4242 <ul> 4243 <li>fs - a remote name string eg “drive:”</li> 4244 </ul> 4245 <p>See the <a href="https://rclone.org/commands/rclone_cleanup/">cleanup command</a> command for more information on the above.</p> 4246 <p><strong>Authentication is required for this call.</strong></p> 4247 <h3 id="operations-copyfile">operations/copyfile: Copy a file from source remote to destination remote</h3> 4248 <p>This takes the following parameters</p> 4249 <ul> 4250 <li>srcFs - a remote name string eg “drive:” for the source</li> 4251 <li>srcRemote - a path within that remote eg “file.txt” for the source</li> 4252 <li>dstFs - a remote name string eg “drive2:” for the destination</li> 4253 <li>dstRemote - a path within that remote eg “file2.txt” for the destination</li> 4254 </ul> 4255 <p><strong>Authentication is required for this call.</strong></p> 4256 <h3 id="operations-copyurl">operations/copyurl: Copy the URL to the object</h3> 4257 <p>This takes the following parameters</p> 4258 <ul> 4259 <li>fs - a remote name string eg “drive:”</li> 4260 <li>remote - a path within that remote eg “dir”</li> 4261 <li>url - string, URL to read from</li> 4262 <li>autoFilename - boolean, set to true to retrieve destination file name from url See the <a href="https://rclone.org/commands/rclone_copyurl/">copyurl command</a> command for more information on the above.</li> 4263 </ul> 4264 <p><strong>Authentication is required for this call.</strong></p> 4265 <h3 id="operations-delete">operations/delete: Remove files in the path</h3> 4266 <p>This takes the following parameters</p> 4267 <ul> 4268 <li>fs - a remote name string eg “drive:”</li> 4269 </ul> 4270 <p>See the <a href="https://rclone.org/commands/rclone_delete/">delete command</a> command for more information on the above.</p> 4271 <p><strong>Authentication is required for this call.</strong></p> 4272 <h3 id="operations-deletefile">operations/deletefile: Remove the single file pointed to</h3> 4273 <p>This takes the following parameters</p> 4274 <ul> 4275 <li>fs - a remote name string eg “drive:”</li> 4276 <li>remote - a path within that remote eg “dir”</li> 4277 </ul> 4278 <p>See the <a href="https://rclone.org/commands/rclone_deletefile/">deletefile command</a> command for more information on the above.</p> 4279 <p><strong>Authentication is required for this call.</strong></p> 4280 <h3 id="operations-fsinfo">operations/fsinfo: Return information about the remote</h3> 4281 <p>This takes the following parameters</p> 4282 <ul> 4283 <li>fs - a remote name string eg “drive:”</li> 4284 </ul> 4285 <p>This returns info about the remote passed in;</p> 4286 <pre><code>{ 4287 // optional features and whether they are available or not 4288 "Features": { 4289 "About": true, 4290 "BucketBased": false, 4291 "CanHaveEmptyDirectories": true, 4292 "CaseInsensitive": false, 4293 "ChangeNotify": false, 4294 "CleanUp": false, 4295 "Copy": false, 4296 "DirCacheFlush": false, 4297 "DirMove": true, 4298 "DuplicateFiles": false, 4299 "GetTier": false, 4300 "ListR": false, 4301 "MergeDirs": false, 4302 "Move": true, 4303 "OpenWriterAt": true, 4304 "PublicLink": false, 4305 "Purge": true, 4306 "PutStream": true, 4307 "PutUnchecked": false, 4308 "ReadMimeType": false, 4309 "ServerSideAcrossConfigs": false, 4310 "SetTier": false, 4311 "SetWrapper": false, 4312 "UnWrap": false, 4313 "WrapFs": false, 4314 "WriteMimeType": false 4315 }, 4316 // Names of hashes available 4317 "Hashes": [ 4318 "MD5", 4319 "SHA-1", 4320 "DropboxHash", 4321 "QuickXorHash" 4322 ], 4323 "Name": "local", // Name as created 4324 "Precision": 1, // Precision of timestamps in ns 4325 "Root": "/", // Path as created 4326 "String": "Local file system at /" // how the remote will appear in logs 4327 }</code></pre> 4328 <p>This command does not have a command line equivalent so use this instead:</p> 4329 <pre><code>rclone rc --loopback operations/fsinfo fs=remote:</code></pre> 4330 <h3 id="operations-list">operations/list: List the given remote and path in JSON format</h3> 4331 <p>This takes the following parameters</p> 4332 <ul> 4333 <li>fs - a remote name string eg “drive:”</li> 4334 <li>remote - a path within that remote eg “dir”</li> 4335 <li>opt - a dictionary of options to control the listing (optional) 4336 <ul> 4337 <li>recurse - If set recurse directories</li> 4338 <li>noModTime - If set return modification time</li> 4339 <li>showEncrypted - If set show decrypted names</li> 4340 <li>showOrigIDs - If set show the IDs for each item if known</li> 4341 <li>showHash - If set return a dictionary of hashes</li> 4342 </ul></li> 4343 </ul> 4344 <p>The result is</p> 4345 <ul> 4346 <li>list 4347 <ul> 4348 <li>This is an array of objects as described in the lsjson command</li> 4349 </ul></li> 4350 </ul> 4351 <p>See the <a href="https://rclone.org/commands/rclone_lsjson/">lsjson command</a> for more information on the above and examples.</p> 4352 <p><strong>Authentication is required for this call.</strong></p> 4353 <h3 id="operations-mkdir">operations/mkdir: Make a destination directory or container</h3> 4354 <p>This takes the following parameters</p> 4355 <ul> 4356 <li>fs - a remote name string eg “drive:”</li> 4357 <li>remote - a path within that remote eg “dir”</li> 4358 </ul> 4359 <p>See the <a href="https://rclone.org/commands/rclone_mkdir/">mkdir command</a> command for more information on the above.</p> 4360 <p><strong>Authentication is required for this call.</strong></p> 4361 <h3 id="operations-movefile">operations/movefile: Move a file from source remote to destination remote</h3> 4362 <p>This takes the following parameters</p> 4363 <ul> 4364 <li>srcFs - a remote name string eg “drive:” for the source</li> 4365 <li>srcRemote - a path within that remote eg “file.txt” for the source</li> 4366 <li>dstFs - a remote name string eg “drive2:” for the destination</li> 4367 <li>dstRemote - a path within that remote eg “file2.txt” for the destination</li> 4368 </ul> 4369 <p><strong>Authentication is required for this call.</strong></p> 4370 <h3 id="operations-publiclink">operations/publiclink: Create or retrieve a public link to the given file or folder.</h3> 4371 <p>This takes the following parameters</p> 4372 <ul> 4373 <li>fs - a remote name string eg “drive:”</li> 4374 <li>remote - a path within that remote eg “dir”</li> 4375 </ul> 4376 <p>Returns</p> 4377 <ul> 4378 <li>url - URL of the resource</li> 4379 </ul> 4380 <p>See the <a href="https://rclone.org/commands/rclone_link/">link command</a> command for more information on the above.</p> 4381 <p><strong>Authentication is required for this call.</strong></p> 4382 <h3 id="operations-purge">operations/purge: Remove a directory or container and all of its contents</h3> 4383 <p>This takes the following parameters</p> 4384 <ul> 4385 <li>fs - a remote name string eg “drive:”</li> 4386 <li>remote - a path within that remote eg “dir”</li> 4387 </ul> 4388 <p>See the <a href="https://rclone.org/commands/rclone_purge/">purge command</a> command for more information on the above.</p> 4389 <p><strong>Authentication is required for this call.</strong></p> 4390 <h3 id="operations-rmdir">operations/rmdir: Remove an empty directory or container</h3> 4391 <p>This takes the following parameters</p> 4392 <ul> 4393 <li>fs - a remote name string eg “drive:”</li> 4394 <li>remote - a path within that remote eg “dir”</li> 4395 </ul> 4396 <p>See the <a href="https://rclone.org/commands/rclone_rmdir/">rmdir command</a> command for more information on the above.</p> 4397 <p><strong>Authentication is required for this call.</strong></p> 4398 <h3 id="operations-rmdirs">operations/rmdirs: Remove all the empty directories in the path</h3> 4399 <p>This takes the following parameters</p> 4400 <ul> 4401 <li>fs - a remote name string eg “drive:”</li> 4402 <li>remote - a path within that remote eg “dir”</li> 4403 <li>leaveRoot - boolean, set to true not to delete the root</li> 4404 </ul> 4405 <p>See the <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs command</a> command for more information on the above.</p> 4406 <p><strong>Authentication is required for this call.</strong></p> 4407 <h3 id="operations-size">operations/size: Count the number of bytes and files in remote</h3> 4408 <p>This takes the following parameters</p> 4409 <ul> 4410 <li>fs - a remote name string eg “drive:path/to/dir”</li> 4411 </ul> 4412 <p>Returns</p> 4413 <ul> 4414 <li>count - number of files</li> 4415 <li>bytes - number of bytes in those files</li> 4416 </ul> 4417 <p>See the <a href="https://rclone.org/commands/rclone_size/">size command</a> command for more information on the above.</p> 4418 <p><strong>Authentication is required for this call.</strong></p> 4419 <h3 id="options-blocks">options/blocks: List all the option blocks</h3> 4420 <p>Returns - options - a list of the options block names</p> 4421 <h3 id="options-get">options/get: Get all the options</h3> 4422 <p>Returns an object where keys are option block names and values are an object with the current option values in.</p> 4423 <p>This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions.</p> 4424 <h3 id="options-set">options/set: Set an option</h3> 4425 <p>Parameters</p> 4426 <ul> 4427 <li>option block name containing an object with 4428 <ul> 4429 <li>key: value</li> 4430 </ul></li> 4431 </ul> 4432 <p>Repeated as often as required.</p> 4433 <p>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.</p> 4434 <p>For example:</p> 4435 <p>This sets DEBUG level logs (-vv)</p> 4436 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 8}}'</code></pre> 4437 <p>And this sets INFO level logs (-v)</p> 4438 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 7}}'</code></pre> 4439 <p>And this sets NOTICE level logs (normal without -v)</p> 4440 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 6}}'</code></pre> 4441 <h3 id="rc-error">rc/error: This returns an error</h3> 4442 <p>This returns an error with the input as part of its error string. Useful for testing error handling.</p> 4443 <h3 id="rc-list">rc/list: List all the registered remote control commands</h3> 4444 <p>This lists all the registered remote control commands as a JSON map in the commands response.</p> 4445 <h3 id="rc-noop">rc/noop: Echo the input to the output parameters</h3> 4446 <p>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.</p> 4447 <h3 id="rc-noopauth">rc/noopauth: Echo the input to the output parameters requiring auth</h3> 4448 <p>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.</p> 4449 <p><strong>Authentication is required for this call.</strong></p> 4450 <h3 id="sync-copy">sync/copy: copy a directory from source remote to destination remote</h3> 4451 <p>This takes the following parameters</p> 4452 <ul> 4453 <li>srcFs - a remote name string eg “drive:src” for the source</li> 4454 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 4455 </ul> 4456 <p>See the <a href="https://rclone.org/commands/rclone_copy/">copy command</a> command for more information on the above.</p> 4457 <p><strong>Authentication is required for this call.</strong></p> 4458 <h3 id="sync-move">sync/move: move a directory from source remote to destination remote</h3> 4459 <p>This takes the following parameters</p> 4460 <ul> 4461 <li>srcFs - a remote name string eg “drive:src” for the source</li> 4462 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 4463 <li>deleteEmptySrcDirs - delete empty src directories if set</li> 4464 </ul> 4465 <p>See the <a href="https://rclone.org/commands/rclone_move/">move command</a> command for more information on the above.</p> 4466 <p><strong>Authentication is required for this call.</strong></p> 4467 <h3 id="sync-sync">sync/sync: sync a directory from source remote to destination remote</h3> 4468 <p>This takes the following parameters</p> 4469 <ul> 4470 <li>srcFs - a remote name string eg “drive:src” for the source</li> 4471 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 4472 </ul> 4473 <p>See the <a href="https://rclone.org/commands/rclone_sync/">sync command</a> command for more information on the above.</p> 4474 <p><strong>Authentication is required for this call.</strong></p> 4475 <h3 id="vfs-forget">vfs/forget: Forget files or directories in the directory cache.</h3> 4476 <p>This forgets the paths in the directory cache causing them to be re-read from the remote when needed.</p> 4477 <p>If no paths are passed in then it will forget all the paths in the directory cache.</p> 4478 <pre><code>rclone rc vfs/forget</code></pre> 4479 <p>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, eg</p> 4480 <pre><code>rclone rc vfs/forget file=hello file2=goodbye dir=home/junk</code></pre> 4481 <h3 id="vfs-poll-interval">vfs/poll-interval: Get the status or update the value of the poll-interval option.</h3> 4482 <p>Without any parameter given this returns the current status of the poll-interval setting.</p> 4483 <p>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.</p> 4484 <pre><code>rclone rc vfs/poll-interval interval=5m</code></pre> 4485 <p>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.</p> 4486 <p>The new poll-interval value will only be active when the timeout is not reached.</p> 4487 <p>If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote.</p> 4488 <h3 id="vfs-refresh">vfs/refresh: Refresh the directory cache.</h3> 4489 <p>This reads the directories for the specified paths and freshens the directory cache.</p> 4490 <p>If no paths are passed in then it will refresh the root directory.</p> 4491 <pre><code>rclone rc vfs/refresh</code></pre> 4492 <p>Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, eg</p> 4493 <pre><code>rclone rc vfs/refresh dir=home/junk dir2=data/misc</code></pre> 4494 <p>If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use –fast-list if enabled.</p> 4495 <h2 id="accessing-the-remote-control-via-http">Accessing the remote control via HTTP</h2> 4496 <p>Rclone implements a simple HTTP based protocol.</p> 4497 <p>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.</p> 4498 <p>All calls must made using POST.</p> 4499 <p>The input objects can be supplied using URL parameters, POST parameters or by supplying “Content-Type: application/json” and a JSON blob in the body. There are examples of these below using <code>curl</code>.</p> 4500 <p>The response will be a JSON blob in the body of the response. This is formatted to be reasonably human readable.</p> 4501 <h3 id="error-returns">Error returns</h3> 4502 <p>If an error occurs then there will be an HTTP error status (eg 500) and the body of the response will contain a JSON encoded error object, eg</p> 4503 <pre><code>{ 4504 "error": "Expecting string value for key \"remote\" (was float64)", 4505 "input": { 4506 "fs": "/tmp", 4507 "remote": 3 4508 }, 4509 "status": 400 4510 "path": "operations/rmdir", 4511 }</code></pre> 4512 <p>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</p> 4513 <h3 id="cors">CORS</h3> 4514 <p>The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested “Access-Control-Request-Headers” back.</p> 4515 <h3 id="using-post-with-url-parameters-only">Using POST with URL parameters only</h3> 4516 <pre><code>curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'</code></pre> 4517 <p>Response</p> 4518 <pre><code>{ 4519 "potato": "1", 4520 "sausage": "2" 4521 }</code></pre> 4522 <p>Here is what an error response looks like:</p> 4523 <pre><code>curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'</code></pre> 4524 <pre><code>{ 4525 "error": "arbitrary error on input map[potato:1 sausage:2]", 4526 "input": { 4527 "potato": "1", 4528 "sausage": "2" 4529 } 4530 }</code></pre> 4531 <p>Note that curl doesn’t return errors to the shell unless you use the <code>-f</code> option</p> 4532 <pre><code>$ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' 4533 curl: (22) The requested URL returned error: 400 Bad Request 4534 $ echo $? 4535 22</code></pre> 4536 <h3 id="using-post-with-a-form">Using POST with a form</h3> 4537 <pre><code>curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop</code></pre> 4538 <p>Response</p> 4539 <pre><code>{ 4540 "potato": "1", 4541 "sausage": "2" 4542 }</code></pre> 4543 <p>Note that you can combine these with URL parameters too with the POST parameters taking precedence.</p> 4544 <pre><code>curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"</code></pre> 4545 <p>Response</p> 4546 <pre><code>{ 4547 "potato": "1", 4548 "rutabaga": "3", 4549 "sausage": "4" 4550 } 4551 </code></pre> 4552 <h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3> 4553 <pre><code>curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop</code></pre> 4554 <p>response</p> 4555 <pre><code>{ 4556 "password": "xyz", 4557 "username": "xyz" 4558 }</code></pre> 4559 <p>This can be combined with URL parameters too if required. The JSON blob takes precedence.</p> 4560 <pre><code>curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4'</code></pre> 4561 <pre><code>{ 4562 "potato": 2, 4563 "rutabaga": "3", 4564 "sausage": 1 4565 }</code></pre> 4566 <h2 id="debugging-rclone-with-pprof">Debugging rclone with pprof</h2> 4567 <p>If you use the <code>--rc</code> flag this will also enable the use of the go profiling tools on the same port.</p> 4568 <p>To use these, first <a href="https://golang.org/doc/install">install go</a>.</p> 4569 <h3 id="debugging-memory-use">Debugging memory use</h3> 4570 <p>To profile rclone’s memory use you can run:</p> 4571 <pre><code>go tool pprof -web http://localhost:5572/debug/pprof/heap</code></pre> 4572 <p>This should open a page in your browser showing what is using what memory.</p> 4573 <p>You can also use the <code>-text</code> flag to produce a textual summary</p> 4574 <pre><code>$ go tool pprof -text http://localhost:5572/debug/pprof/heap 4575 Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total 4576 flat flat% sum% cum cum% 4577 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 4578 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 4579 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 4580 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 4581 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 4582 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 4583 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 4584 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 4585 0 0% 100% 1024.03kB 66.62% main.init 4586 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest 4587 0 0% 100% 513kB 33.38% net/http.(*conn).serve 4588 0 0% 100% 1024.03kB 66.62% runtime.main</code></pre> 4589 <h3 id="debugging-go-routine-leaks">Debugging go routine leaks</h3> 4590 <p>Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected.</p> 4591 <p>See all active go routines using</p> 4592 <pre><code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></pre> 4593 <p>Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.</p> 4594 <h3 id="other-profiles-to-look-at">Other profiles to look at</h3> 4595 <p>You can see a summary of profiles available at http://localhost:5572/debug/pprof/</p> 4596 <p>Here is how to use some of them:</p> 4597 <ul> 4598 <li>Memory: <code>go tool pprof http://localhost:5572/debug/pprof/heap</code></li> 4599 <li>Go routines: <code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></li> 4600 <li>30-second CPU profile: <code>go tool pprof http://localhost:5572/debug/pprof/profile</code></li> 4601 <li>5-second execution trace: <code>wget http://localhost:5572/debug/pprof/trace?seconds=5</code></li> 4602 <li>Goroutine blocking profile 4603 <ul> 4604 <li>Enable first with: <code>rclone rc debug/set-block-profile-rate rate=1</code> (<a href="#debug/set-block-profile-rate">docs</a>)</li> 4605 <li><code>go tool pprof http://localhost:5572/debug/pprof/block</code></li> 4606 </ul></li> 4607 <li>Contended mutexes: 4608 <ul> 4609 <li>Enable first with: <code>rclone rc debug/set-mutex-profile-fraction rate=1</code> (<a href="#debug/set-mutex-profile-fraction">docs</a>)</li> 4610 <li><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></li> 4611 </ul></li> 4612 </ul> 4613 <p>See the <a href="https://golang.org/pkg/net/http/pprof/">net/http/pprof docs</a> for more info on how to use the profiling and for a general overview see <a href="https://blog.golang.org/profiling-go-programs">the Go team’s blog post on profiling go programs</a>.</p> 4614 <p>The profiling hook is <a href="https://stackoverflow.com/q/26545159/164234">zero overhead unless it is used</a>.</p> 4615 <h1 id="overview-of-cloud-storage-systems">Overview of cloud storage systems</h1> 4616 <p>Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.</p> 4617 <h2 id="features-1">Features</h2> 4618 <p>Here is an overview of the major features of each cloud storage system.</p> 4619 <table> 4620 <thead> 4621 <tr class="header"> 4622 <th>Name</th> 4623 <th style="text-align: center;">Hash</th> 4624 <th style="text-align: center;">ModTime</th> 4625 <th style="text-align: center;">Case Insensitive</th> 4626 <th style="text-align: center;">Duplicate Files</th> 4627 <th style="text-align: center;">MIME Type</th> 4628 </tr> 4629 </thead> 4630 <tbody> 4631 <tr class="odd"> 4632 <td>1Fichier</td> 4633 <td style="text-align: center;">Whirlpool</td> 4634 <td style="text-align: center;">No</td> 4635 <td style="text-align: center;">No</td> 4636 <td style="text-align: center;">Yes</td> 4637 <td style="text-align: center;">R</td> 4638 </tr> 4639 <tr class="even"> 4640 <td>Amazon Drive</td> 4641 <td style="text-align: center;">MD5</td> 4642 <td style="text-align: center;">No</td> 4643 <td style="text-align: center;">Yes</td> 4644 <td style="text-align: center;">No</td> 4645 <td style="text-align: center;">R</td> 4646 </tr> 4647 <tr class="odd"> 4648 <td>Amazon S3</td> 4649 <td style="text-align: center;">MD5</td> 4650 <td style="text-align: center;">Yes</td> 4651 <td style="text-align: center;">No</td> 4652 <td style="text-align: center;">No</td> 4653 <td style="text-align: center;">R/W</td> 4654 </tr> 4655 <tr class="even"> 4656 <td>Backblaze B2</td> 4657 <td style="text-align: center;">SHA1</td> 4658 <td style="text-align: center;">Yes</td> 4659 <td style="text-align: center;">No</td> 4660 <td style="text-align: center;">No</td> 4661 <td style="text-align: center;">R/W</td> 4662 </tr> 4663 <tr class="odd"> 4664 <td>Box</td> 4665 <td style="text-align: center;">SHA1</td> 4666 <td style="text-align: center;">Yes</td> 4667 <td style="text-align: center;">Yes</td> 4668 <td style="text-align: center;">No</td> 4669 <td style="text-align: center;">-</td> 4670 </tr> 4671 <tr class="even"> 4672 <td>Citrix ShareFile</td> 4673 <td style="text-align: center;">MD5</td> 4674 <td style="text-align: center;">Yes</td> 4675 <td style="text-align: center;">Yes</td> 4676 <td style="text-align: center;">No</td> 4677 <td style="text-align: center;">-</td> 4678 </tr> 4679 <tr class="odd"> 4680 <td>Dropbox</td> 4681 <td style="text-align: center;">DBHASH †</td> 4682 <td style="text-align: center;">Yes</td> 4683 <td style="text-align: center;">Yes</td> 4684 <td style="text-align: center;">No</td> 4685 <td style="text-align: center;">-</td> 4686 </tr> 4687 <tr class="even"> 4688 <td>FTP</td> 4689 <td style="text-align: center;">-</td> 4690 <td style="text-align: center;">No</td> 4691 <td style="text-align: center;">No</td> 4692 <td style="text-align: center;">No</td> 4693 <td style="text-align: center;">-</td> 4694 </tr> 4695 <tr class="odd"> 4696 <td>Google Cloud Storage</td> 4697 <td style="text-align: center;">MD5</td> 4698 <td style="text-align: center;">Yes</td> 4699 <td style="text-align: center;">No</td> 4700 <td style="text-align: center;">No</td> 4701 <td style="text-align: center;">R/W</td> 4702 </tr> 4703 <tr class="even"> 4704 <td>Google Drive</td> 4705 <td style="text-align: center;">MD5</td> 4706 <td style="text-align: center;">Yes</td> 4707 <td style="text-align: center;">No</td> 4708 <td style="text-align: center;">Yes</td> 4709 <td style="text-align: center;">R/W</td> 4710 </tr> 4711 <tr class="odd"> 4712 <td>Google Photos</td> 4713 <td style="text-align: center;">-</td> 4714 <td style="text-align: center;">No</td> 4715 <td style="text-align: center;">No</td> 4716 <td style="text-align: center;">Yes</td> 4717 <td style="text-align: center;">R</td> 4718 </tr> 4719 <tr class="even"> 4720 <td>HTTP</td> 4721 <td style="text-align: center;">-</td> 4722 <td style="text-align: center;">No</td> 4723 <td style="text-align: center;">No</td> 4724 <td style="text-align: center;">No</td> 4725 <td style="text-align: center;">R</td> 4726 </tr> 4727 <tr class="odd"> 4728 <td>Hubic</td> 4729 <td style="text-align: center;">MD5</td> 4730 <td style="text-align: center;">Yes</td> 4731 <td style="text-align: center;">No</td> 4732 <td style="text-align: center;">No</td> 4733 <td style="text-align: center;">R/W</td> 4734 </tr> 4735 <tr class="even"> 4736 <td>Jottacloud</td> 4737 <td style="text-align: center;">MD5</td> 4738 <td style="text-align: center;">Yes</td> 4739 <td style="text-align: center;">Yes</td> 4740 <td style="text-align: center;">No</td> 4741 <td style="text-align: center;">R/W</td> 4742 </tr> 4743 <tr class="odd"> 4744 <td>Koofr</td> 4745 <td style="text-align: center;">MD5</td> 4746 <td style="text-align: center;">No</td> 4747 <td style="text-align: center;">Yes</td> 4748 <td style="text-align: center;">No</td> 4749 <td style="text-align: center;">-</td> 4750 </tr> 4751 <tr class="even"> 4752 <td>Mail.ru Cloud</td> 4753 <td style="text-align: center;">Mailru ‡‡‡</td> 4754 <td style="text-align: center;">Yes</td> 4755 <td style="text-align: center;">Yes</td> 4756 <td style="text-align: center;">No</td> 4757 <td style="text-align: center;">-</td> 4758 </tr> 4759 <tr class="odd"> 4760 <td>Mega</td> 4761 <td style="text-align: center;">-</td> 4762 <td style="text-align: center;">No</td> 4763 <td style="text-align: center;">No</td> 4764 <td style="text-align: center;">Yes</td> 4765 <td style="text-align: center;">-</td> 4766 </tr> 4767 <tr class="even"> 4768 <td>Memory</td> 4769 <td style="text-align: center;">MD5</td> 4770 <td style="text-align: center;">Yes</td> 4771 <td style="text-align: center;">No</td> 4772 <td style="text-align: center;">No</td> 4773 <td style="text-align: center;">-</td> 4774 </tr> 4775 <tr class="odd"> 4776 <td>Microsoft Azure Blob Storage</td> 4777 <td style="text-align: center;">MD5</td> 4778 <td style="text-align: center;">Yes</td> 4779 <td style="text-align: center;">No</td> 4780 <td style="text-align: center;">No</td> 4781 <td style="text-align: center;">R/W</td> 4782 </tr> 4783 <tr class="even"> 4784 <td>Microsoft OneDrive</td> 4785 <td style="text-align: center;">SHA1 ‡‡</td> 4786 <td style="text-align: center;">Yes</td> 4787 <td style="text-align: center;">Yes</td> 4788 <td style="text-align: center;">No</td> 4789 <td style="text-align: center;">R</td> 4790 </tr> 4791 <tr class="odd"> 4792 <td>OpenDrive</td> 4793 <td style="text-align: center;">MD5</td> 4794 <td style="text-align: center;">Yes</td> 4795 <td style="text-align: center;">Yes</td> 4796 <td style="text-align: center;">No</td> 4797 <td style="text-align: center;">-</td> 4798 </tr> 4799 <tr class="even"> 4800 <td>OpenStack Swift</td> 4801 <td style="text-align: center;">MD5</td> 4802 <td style="text-align: center;">Yes</td> 4803 <td style="text-align: center;">No</td> 4804 <td style="text-align: center;">No</td> 4805 <td style="text-align: center;">R/W</td> 4806 </tr> 4807 <tr class="odd"> 4808 <td>pCloud</td> 4809 <td style="text-align: center;">MD5, SHA1</td> 4810 <td style="text-align: center;">Yes</td> 4811 <td style="text-align: center;">No</td> 4812 <td style="text-align: center;">No</td> 4813 <td style="text-align: center;">W</td> 4814 </tr> 4815 <tr class="even"> 4816 <td>premiumize.me</td> 4817 <td style="text-align: center;">-</td> 4818 <td style="text-align: center;">No</td> 4819 <td style="text-align: center;">Yes</td> 4820 <td style="text-align: center;">No</td> 4821 <td style="text-align: center;">R</td> 4822 </tr> 4823 <tr class="odd"> 4824 <td>put.io</td> 4825 <td style="text-align: center;">CRC-32</td> 4826 <td style="text-align: center;">Yes</td> 4827 <td style="text-align: center;">No</td> 4828 <td style="text-align: center;">Yes</td> 4829 <td style="text-align: center;">R</td> 4830 </tr> 4831 <tr class="even"> 4832 <td>QingStor</td> 4833 <td style="text-align: center;">MD5</td> 4834 <td style="text-align: center;">No</td> 4835 <td style="text-align: center;">No</td> 4836 <td style="text-align: center;">No</td> 4837 <td style="text-align: center;">R/W</td> 4838 </tr> 4839 <tr class="odd"> 4840 <td>Seafile</td> 4841 <td style="text-align: center;">-</td> 4842 <td style="text-align: center;">No</td> 4843 <td style="text-align: center;">No</td> 4844 <td style="text-align: center;">No</td> 4845 <td style="text-align: center;">-</td> 4846 </tr> 4847 <tr class="even"> 4848 <td>SFTP</td> 4849 <td style="text-align: center;">MD5, SHA1 ‡</td> 4850 <td style="text-align: center;">Yes</td> 4851 <td style="text-align: center;">Depends</td> 4852 <td style="text-align: center;">No</td> 4853 <td style="text-align: center;">-</td> 4854 </tr> 4855 <tr class="odd"> 4856 <td>SugarSync</td> 4857 <td style="text-align: center;">-</td> 4858 <td style="text-align: center;">No</td> 4859 <td style="text-align: center;">No</td> 4860 <td style="text-align: center;">No</td> 4861 <td style="text-align: center;">-</td> 4862 </tr> 4863 <tr class="even"> 4864 <td>Tardigrade</td> 4865 <td style="text-align: center;">-</td> 4866 <td style="text-align: center;">Yes</td> 4867 <td style="text-align: center;">No</td> 4868 <td style="text-align: center;">No</td> 4869 <td style="text-align: center;">-</td> 4870 </tr> 4871 <tr class="odd"> 4872 <td>WebDAV</td> 4873 <td style="text-align: center;">MD5, SHA1 ††</td> 4874 <td style="text-align: center;">Yes †††</td> 4875 <td style="text-align: center;">Depends</td> 4876 <td style="text-align: center;">No</td> 4877 <td style="text-align: center;">-</td> 4878 </tr> 4879 <tr class="even"> 4880 <td>Yandex Disk</td> 4881 <td style="text-align: center;">MD5</td> 4882 <td style="text-align: center;">Yes</td> 4883 <td style="text-align: center;">No</td> 4884 <td style="text-align: center;">No</td> 4885 <td style="text-align: center;">R/W</td> 4886 </tr> 4887 <tr class="odd"> 4888 <td>The local filesystem</td> 4889 <td style="text-align: center;">All</td> 4890 <td style="text-align: center;">Yes</td> 4891 <td style="text-align: center;">Depends</td> 4892 <td style="text-align: center;">No</td> 4893 <td style="text-align: center;">-</td> 4894 </tr> 4895 </tbody> 4896 </table> 4897 <h3 id="hash">Hash</h3> 4898 <p>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 <code>--checksum</code> flag in syncs and in the <code>check</code> command.</p> 4899 <p>To use the verify checksums when transferring between cloud storage systems they must support a common hash type.</p> 4900 <p>† Note that Dropbox supports <a href="https://www.dropbox.com/developers/reference/content-hash">its own custom hash</a>. This is an SHA256 sum of all the 4MB block SHA256s.</p> 4901 <p>‡ SFTP supports checksums if the same login has shell access and <code>md5sum</code> or <code>sha1sum</code> as well as <code>echo</code> are in the remote’s PATH.</p> 4902 <p>†† WebDAV supports hashes when used with Owncloud and Nextcloud only.</p> 4903 <p>††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.</p> 4904 <p>‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft’s own <a href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p> 4905 <p>‡‡‡ Mail.ru uses its own modified SHA1 hash</p> 4906 <h3 id="modtime">ModTime</h3> 4907 <p>The cloud storage system supports setting modification times on objects. If it does then this enables a using the modification times as part of the sync. If not then only the size will be checked by default, though the MD5SUM can be checked with the <code>--checksum</code> flag.</p> 4908 <p>All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system.</p> 4909 <h3 id="case-insensitive">Case Insensitive</h3> 4910 <p>If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, eg <code>file.txt</code> and <code>FILE.txt</code>. If a cloud storage system is case insensitive then that isn’t possible.</p> 4911 <p>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.</p> 4912 <p>The local filesystem and SFTP may or may not be case sensitive depending on OS.</p> 4913 <ul> 4914 <li>Windows - usually case insensitive, though case is preserved</li> 4915 <li>OSX - usually case insensitive, though it is possible to format case sensitive</li> 4916 <li>Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys)</li> 4917 </ul> 4918 <p>Most of the time this doesn’t cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems.</p> 4919 <h3 id="duplicate-files">Duplicate files</h3> 4920 <p>If a cloud storage system allows duplicate files then it can have two objects with the same name.</p> 4921 <p>This confuses rclone greatly when syncing - use the <code>rclone dedupe</code> command to rename or remove duplicates.</p> 4922 <h3 id="restricted-filenames">Restricted filenames</h3> 4923 <p>Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When <code>rclone</code> detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters.</p> 4924 <p>This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently.</p> 4925 <p>The name shown by <code>rclone</code> to the user or during log output will only contain a minimal set of <a href="#restricted-characters">replaced characters</a> to ensure correct formatting and not necessarily the actual name used on the cloud storage.</p> 4926 <p>This transformation is reversed when downloading a file or parsing <code>rclone</code> arguments. For example, when uploading a file named <code>my file?.txt</code> to Onedrive will be displayed as <code>my file?.txt</code> on the console, but stored as <code>my file？.txt</code> (the <code>?</code> gets replaced by the similar looking <code>？</code> character) to Onedrive. The reverse transformation allows to read a file<code>unusual/name.txt</code> from Google Drive, by passing the name <code>unusual／name.txt</code> (the <code>/</code> needs to be replaced by the similar looking <code>／</code> character) on the command line.</p> 4927 <h4 id="restricted-characters">Default restricted characters</h4> 4928 <p>The table below shows the characters that are replaced by default.</p> 4929 <p>When a replacement character is found in a filename, this character will be escaped with the <code>‛</code> character to avoid ambiguous file names. (e.g. a file named <code>␀.txt</code> would shown as <code>‛␀.txt</code>)</p> 4930 <p>Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend.</p> 4931 <table> 4932 <thead> 4933 <tr class="header"> 4934 <th>Character</th> 4935 <th style="text-align: center;">Value</th> 4936 <th style="text-align: center;">Replacement</th> 4937 </tr> 4938 </thead> 4939 <tbody> 4940 <tr class="odd"> 4941 <td>NUL</td> 4942 <td style="text-align: center;">0x00</td> 4943 <td style="text-align: center;">␀</td> 4944 </tr> 4945 <tr class="even"> 4946 <td>SOH</td> 4947 <td style="text-align: center;">0x01</td> 4948 <td style="text-align: center;">␁</td> 4949 </tr> 4950 <tr class="odd"> 4951 <td>STX</td> 4952 <td style="text-align: center;">0x02</td> 4953 <td style="text-align: center;">␂</td> 4954 </tr> 4955 <tr class="even"> 4956 <td>ETX</td> 4957 <td style="text-align: center;">0x03</td> 4958 <td style="text-align: center;">␃</td> 4959 </tr> 4960 <tr class="odd"> 4961 <td>EOT</td> 4962 <td style="text-align: center;">0x04</td> 4963 <td style="text-align: center;">␄</td> 4964 </tr> 4965 <tr class="even"> 4966 <td>ENQ</td> 4967 <td style="text-align: center;">0x05</td> 4968 <td style="text-align: center;">␅</td> 4969 </tr> 4970 <tr class="odd"> 4971 <td>ACK</td> 4972 <td style="text-align: center;">0x06</td> 4973 <td style="text-align: center;">␆</td> 4974 </tr> 4975 <tr class="even"> 4976 <td>BEL</td> 4977 <td style="text-align: center;">0x07</td> 4978 <td style="text-align: center;">␇</td> 4979 </tr> 4980 <tr class="odd"> 4981 <td>BS</td> 4982 <td style="text-align: center;">0x08</td> 4983 <td style="text-align: center;">␈</td> 4984 </tr> 4985 <tr class="even"> 4986 <td>HT</td> 4987 <td style="text-align: center;">0x09</td> 4988 <td style="text-align: center;">␉</td> 4989 </tr> 4990 <tr class="odd"> 4991 <td>LF</td> 4992 <td style="text-align: center;">0x0A</td> 4993 <td style="text-align: center;">␊</td> 4994 </tr> 4995 <tr class="even"> 4996 <td>VT</td> 4997 <td style="text-align: center;">0x0B</td> 4998 <td style="text-align: center;">␋</td> 4999 </tr> 5000 <tr class="odd"> 5001 <td>FF</td> 5002 <td style="text-align: center;">0x0C</td> 5003 <td style="text-align: center;">␌</td> 5004 </tr> 5005 <tr class="even"> 5006 <td>CR</td> 5007 <td style="text-align: center;">0x0D</td> 5008 <td style="text-align: center;">␍</td> 5009 </tr> 5010 <tr class="odd"> 5011 <td>SO</td> 5012 <td style="text-align: center;">0x0E</td> 5013 <td style="text-align: center;">␎</td> 5014 </tr> 5015 <tr class="even"> 5016 <td>SI</td> 5017 <td style="text-align: center;">0x0F</td> 5018 <td style="text-align: center;">␏</td> 5019 </tr> 5020 <tr class="odd"> 5021 <td>DLE</td> 5022 <td style="text-align: center;">0x10</td> 5023 <td style="text-align: center;">␐</td> 5024 </tr> 5025 <tr class="even"> 5026 <td>DC1</td> 5027 <td style="text-align: center;">0x11</td> 5028 <td style="text-align: center;">␑</td> 5029 </tr> 5030 <tr class="odd"> 5031 <td>DC2</td> 5032 <td style="text-align: center;">0x12</td> 5033 <td style="text-align: center;">␒</td> 5034 </tr> 5035 <tr class="even"> 5036 <td>DC3</td> 5037 <td style="text-align: center;">0x13</td> 5038 <td style="text-align: center;">␓</td> 5039 </tr> 5040 <tr class="odd"> 5041 <td>DC4</td> 5042 <td style="text-align: center;">0x14</td> 5043 <td style="text-align: center;">␔</td> 5044 </tr> 5045 <tr class="even"> 5046 <td>NAK</td> 5047 <td style="text-align: center;">0x15</td> 5048 <td style="text-align: center;">␕</td> 5049 </tr> 5050 <tr class="odd"> 5051 <td>SYN</td> 5052 <td style="text-align: center;">0x16</td> 5053 <td style="text-align: center;">␖</td> 5054 </tr> 5055 <tr class="even"> 5056 <td>ETB</td> 5057 <td style="text-align: center;">0x17</td> 5058 <td style="text-align: center;">␗</td> 5059 </tr> 5060 <tr class="odd"> 5061 <td>CAN</td> 5062 <td style="text-align: center;">0x18</td> 5063 <td style="text-align: center;">␘</td> 5064 </tr> 5065 <tr class="even"> 5066 <td>EM</td> 5067 <td style="text-align: center;">0x19</td> 5068 <td style="text-align: center;">␙</td> 5069 </tr> 5070 <tr class="odd"> 5071 <td>SUB</td> 5072 <td style="text-align: center;">0x1A</td> 5073 <td style="text-align: center;">␚</td> 5074 </tr> 5075 <tr class="even"> 5076 <td>ESC</td> 5077 <td style="text-align: center;">0x1B</td> 5078 <td style="text-align: center;">␛</td> 5079 </tr> 5080 <tr class="odd"> 5081 <td>FS</td> 5082 <td style="text-align: center;">0x1C</td> 5083 <td style="text-align: center;">␜</td> 5084 </tr> 5085 <tr class="even"> 5086 <td>GS</td> 5087 <td style="text-align: center;">0x1D</td> 5088 <td style="text-align: center;">␝</td> 5089 </tr> 5090 <tr class="odd"> 5091 <td>RS</td> 5092 <td style="text-align: center;">0x1E</td> 5093 <td style="text-align: center;">␞</td> 5094 </tr> 5095 <tr class="even"> 5096 <td>US</td> 5097 <td style="text-align: center;">0x1F</td> 5098 <td style="text-align: center;">␟</td> 5099 </tr> 5100 <tr class="odd"> 5101 <td>/</td> 5102 <td style="text-align: center;">0x2F</td> 5103 <td style="text-align: center;">／</td> 5104 </tr> 5105 <tr class="even"> 5106 <td>DEL</td> 5107 <td style="text-align: center;">0x7F</td> 5108 <td style="text-align: center;">␡</td> 5109 </tr> 5110 </tbody> 5111 </table> 5112 <p>The default encoding will also encode these file names as they are problematic with many cloud storage systems.</p> 5113 <table> 5114 <thead> 5115 <tr class="header"> 5116 <th>File name</th> 5117 <th style="text-align: center;">Replacement</th> 5118 </tr> 5119 </thead> 5120 <tbody> 5121 <tr class="odd"> 5122 <td>.</td> 5123 <td style="text-align: center;">．</td> 5124 </tr> 5125 <tr class="even"> 5126 <td>..</td> 5127 <td style="text-align: center;">．．</td> 5128 </tr> 5129 </tbody> 5130 </table> 5131 <h4 id="invalid-utf8">Invalid UTF-8 bytes</h4> 5132 <p>Some backends only support a sequence of well formed UTF-8 bytes as file or directory names.</p> 5133 <p>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 <code>0xFE</code> will be encoded as <code>‛FE</code>.</p> 5134 <p>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 <a href="https://rclone.org/local/#filenames">local filenames</a> section for details.</p> 5135 <h4 id="encoding">Encoding option</h4> 5136 <p>Most backends have an encoding options, specified as a flag <code>--backend-encoding</code> where <code>backend</code> is the name of the backend, or as a config parameter <code>encoding</code> (you’ll need to select the Advanced config in <code>rclone config</code> to see it).</p> 5137 <p>This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above).</p> 5138 <p>However this can be incorrect in some scenarios, for example if you have a Windows file system with characters such as <code>＊</code> and <code>？</code> that you want to remain as those characters on the remote rather than being translated to <code>*</code> and <code>?</code>.</p> 5139 <p>The <code>--backend-encoding</code> flags allow you to change that. You can disable the encoding completely with <code>--backend-encoding None</code> or set <code>encoding = None</code> in the config file.</p> 5140 <p>Encoding takes a comma separated list of encodings. You can see the list of all available characters by passing an invalid value to this flag, eg <code>--local-encoding "help"</code> and <code>rclone help flags encoding</code> will show you the defaults for the backends.</p> 5141 <table> 5142 <thead> 5143 <tr class="header"> 5144 <th>Encoding</th> 5145 <th>Characters</th> 5146 </tr> 5147 </thead> 5148 <tbody> 5149 <tr class="odd"> 5150 <td>Asterisk</td> 5151 <td><code>*</code></td> 5152 </tr> 5153 <tr class="even"> 5154 <td>BackQuote</td> 5155 <td><code>`</code></td> 5156 </tr> 5157 <tr class="odd"> 5158 <td>BackSlash</td> 5159 <td><code>\</code></td> 5160 </tr> 5161 <tr class="even"> 5162 <td>Colon</td> 5163 <td><code>:</code></td> 5164 </tr> 5165 <tr class="odd"> 5166 <td>CrLf</td> 5167 <td>CR 0x0D, LF 0x0A</td> 5168 </tr> 5169 <tr class="even"> 5170 <td>Ctl</td> 5171 <td>All control characters 0x00-0x1F</td> 5172 </tr> 5173 <tr class="odd"> 5174 <td>Del</td> 5175 <td>DEL 0x7F</td> 5176 </tr> 5177 <tr class="even"> 5178 <td>Dollar</td> 5179 <td><code>$</code></td> 5180 </tr> 5181 <tr class="odd"> 5182 <td>Dot</td> 5183 <td><code>.</code></td> 5184 </tr> 5185 <tr class="even"> 5186 <td>DoubleQuote</td> 5187 <td><code>"</code></td> 5188 </tr> 5189 <tr class="odd"> 5190 <td>Hash</td> 5191 <td><code>#</code></td> 5192 </tr> 5193 <tr class="even"> 5194 <td>InvalidUtf8</td> 5195 <td>An invalid UTF-8 character (eg latin1)</td> 5196 </tr> 5197 <tr class="odd"> 5198 <td>LeftCrLfHtVt</td> 5199 <td>CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string</td> 5200 </tr> 5201 <tr class="even"> 5202 <td>LeftPeriod</td> 5203 <td><code>.</code> on the left of a string</td> 5204 </tr> 5205 <tr class="odd"> 5206 <td>LeftSpace</td> 5207 <td>SPACE on the left of a string</td> 5208 </tr> 5209 <tr class="even"> 5210 <td>LeftTilde</td> 5211 <td><code>~</code> on the left of a string</td> 5212 </tr> 5213 <tr class="odd"> 5214 <td>LtGt</td> 5215 <td><code><</code>, <code>></code></td> 5216 </tr> 5217 <tr class="even"> 5218 <td>None</td> 5219 <td>No characters are encoded</td> 5220 </tr> 5221 <tr class="odd"> 5222 <td>Percent</td> 5223 <td><code>%</code></td> 5224 </tr> 5225 <tr class="even"> 5226 <td>Pipe</td> 5227 <td>|</td> 5228 </tr> 5229 <tr class="odd"> 5230 <td>Question</td> 5231 <td><code>?</code></td> 5232 </tr> 5233 <tr class="even"> 5234 <td>RightCrLfHtVt</td> 5235 <td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string</td> 5236 </tr> 5237 <tr class="odd"> 5238 <td>RightPeriod</td> 5239 <td><code>.</code> on the right of a string</td> 5240 </tr> 5241 <tr class="even"> 5242 <td>RightSpace</td> 5243 <td>SPACE on the right of a string</td> 5244 </tr> 5245 <tr class="odd"> 5246 <td>SingleQuote</td> 5247 <td><code>'</code></td> 5248 </tr> 5249 <tr class="even"> 5250 <td>Slash</td> 5251 <td><code>/</code></td> 5252 </tr> 5253 </tbody> 5254 </table> 5255 <p>To take a specific example, the FTP backend’s default encoding is</p> 5256 <pre><code>--ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"</code></pre> 5257 <p>However, let’s say the FTP server is running on Windows and can’t have any of the invalid Windows characters in file names. You are backing up Linux servers to this FTP server which do have those characters in file names. So you would add the Windows set which are</p> 5258 <pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</code></pre> 5259 <p>to the existing ones, giving:</p> 5260 <pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace</code></pre> 5261 <p>This can be specified using the <code>--ftp-encoding</code> flag or using an <code>encoding</code> parameter in the config file.</p> 5262 <p>Or let’s say you have a Windows server but you want to preserve <code>＊</code> and <code>？</code>, you would then have this as the encoding (the Windows encoding minus <code>Asterisk</code> and <code>Question</code>).</p> 5263 <pre><code>Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</code></pre> 5264 <p>This can be specified using the <code>--local-encoding</code> flag or using an <code>encoding</code> parameter in the config file.</p> 5265 <h3 id="mime-type">MIME Type</h3> 5266 <p>MIME types (also known as media types) classify types of documents using a simple text classification, eg <code>text/html</code> or <code>application/pdf</code>.</p> 5267 <p>Some cloud storage systems support reading (<code>R</code>) the MIME type of objects and some support writing (<code>W</code>) the MIME type of objects.</p> 5268 <p>The MIME type can be important if you are serving files directly to HTTP from the storage system.</p> 5269 <p>If you are copying from a remote which supports reading (<code>R</code>) to a remote which supports writing (<code>W</code>) then rclone will preserve the MIME types. Otherwise they will be guessed from the extension, or the remote itself may assign the MIME type.</p> 5270 <h2 id="optional-features">Optional Features</h2> 5271 <p>All the remotes support a basic set of features, but there are some optional features supported by some remotes used to make some operations more efficient.</p> 5272 <table> 5273 <thead> 5274 <tr class="header"> 5275 <th>Name</th> 5276 <th style="text-align: center;">Purge</th> 5277 <th style="text-align: center;">Copy</th> 5278 <th style="text-align: center;">Move</th> 5279 <th style="text-align: center;">DirMove</th> 5280 <th style="text-align: center;">CleanUp</th> 5281 <th style="text-align: center;">ListR</th> 5282 <th style="text-align: center;">StreamUpload</th> 5283 <th style="text-align: center;">LinkSharing</th> 5284 <th style="text-align: center;">About</th> 5285 <th style="text-align: center;">EmptyDir</th> 5286 </tr> 5287 </thead> 5288 <tbody> 5289 <tr class="odd"> 5290 <td>1Fichier</td> 5291 <td style="text-align: center;">No</td> 5292 <td style="text-align: center;">No</td> 5293 <td style="text-align: center;">No</td> 5294 <td style="text-align: center;">No</td> 5295 <td style="text-align: center;">No</td> 5296 <td style="text-align: center;">No</td> 5297 <td style="text-align: center;">No</td> 5298 <td style="text-align: center;">No</td> 5299 <td style="text-align: center;">No</td> 5300 <td style="text-align: center;">Yes</td> 5301 </tr> 5302 <tr class="even"> 5303 <td>Amazon Drive</td> 5304 <td style="text-align: center;">Yes</td> 5305 <td style="text-align: center;">No</td> 5306 <td style="text-align: center;">Yes</td> 5307 <td style="text-align: center;">Yes</td> 5308 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/575">#575</a></td> 5309 <td style="text-align: center;">No</td> 5310 <td style="text-align: center;">No</td> 5311 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5312 <td style="text-align: center;">No</td> 5313 <td style="text-align: center;">Yes</td> 5314 </tr> 5315 <tr class="odd"> 5316 <td>Amazon S3</td> 5317 <td style="text-align: center;">No</td> 5318 <td style="text-align: center;">Yes</td> 5319 <td style="text-align: center;">No</td> 5320 <td style="text-align: center;">No</td> 5321 <td style="text-align: center;">No</td> 5322 <td style="text-align: center;">Yes</td> 5323 <td style="text-align: center;">Yes</td> 5324 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5325 <td style="text-align: center;">No</td> 5326 <td style="text-align: center;">No</td> 5327 </tr> 5328 <tr class="even"> 5329 <td>Backblaze B2</td> 5330 <td style="text-align: center;">No</td> 5331 <td style="text-align: center;">Yes</td> 5332 <td style="text-align: center;">No</td> 5333 <td style="text-align: center;">No</td> 5334 <td style="text-align: center;">Yes</td> 5335 <td style="text-align: center;">Yes</td> 5336 <td style="text-align: center;">Yes</td> 5337 <td style="text-align: center;">Yes</td> 5338 <td style="text-align: center;">No</td> 5339 <td style="text-align: center;">No</td> 5340 </tr> 5341 <tr class="odd"> 5342 <td>Box</td> 5343 <td style="text-align: center;">Yes</td> 5344 <td style="text-align: center;">Yes</td> 5345 <td style="text-align: center;">Yes</td> 5346 <td style="text-align: center;">Yes</td> 5347 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/575">#575</a></td> 5348 <td style="text-align: center;">No</td> 5349 <td style="text-align: center;">Yes</td> 5350 <td style="text-align: center;">Yes</td> 5351 <td style="text-align: center;">No</td> 5352 <td style="text-align: center;">Yes</td> 5353 </tr> 5354 <tr class="even"> 5355 <td>Citrix ShareFile</td> 5356 <td style="text-align: center;">Yes</td> 5357 <td style="text-align: center;">Yes</td> 5358 <td style="text-align: center;">Yes</td> 5359 <td style="text-align: center;">Yes</td> 5360 <td style="text-align: center;">No</td> 5361 <td style="text-align: center;">No</td> 5362 <td style="text-align: center;">Yes</td> 5363 <td style="text-align: center;">No</td> 5364 <td style="text-align: center;">No</td> 5365 <td style="text-align: center;">Yes</td> 5366 </tr> 5367 <tr class="odd"> 5368 <td>Dropbox</td> 5369 <td style="text-align: center;">Yes</td> 5370 <td style="text-align: center;">Yes</td> 5371 <td style="text-align: center;">Yes</td> 5372 <td style="text-align: center;">Yes</td> 5373 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/575">#575</a></td> 5374 <td style="text-align: center;">No</td> 5375 <td style="text-align: center;">Yes</td> 5376 <td style="text-align: center;">Yes</td> 5377 <td style="text-align: center;">Yes</td> 5378 <td style="text-align: center;">Yes</td> 5379 </tr> 5380 <tr class="even"> 5381 <td>FTP</td> 5382 <td style="text-align: center;">No</td> 5383 <td style="text-align: center;">No</td> 5384 <td style="text-align: center;">Yes</td> 5385 <td style="text-align: center;">Yes</td> 5386 <td style="text-align: center;">No</td> 5387 <td style="text-align: center;">No</td> 5388 <td style="text-align: center;">Yes</td> 5389 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5390 <td style="text-align: center;">No</td> 5391 <td style="text-align: center;">Yes</td> 5392 </tr> 5393 <tr class="odd"> 5394 <td>Google Cloud Storage</td> 5395 <td style="text-align: center;">Yes</td> 5396 <td style="text-align: center;">Yes</td> 5397 <td style="text-align: center;">No</td> 5398 <td style="text-align: center;">No</td> 5399 <td style="text-align: center;">No</td> 5400 <td style="text-align: center;">Yes</td> 5401 <td style="text-align: center;">Yes</td> 5402 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5403 <td style="text-align: center;">No</td> 5404 <td style="text-align: center;">No</td> 5405 </tr> 5406 <tr class="even"> 5407 <td>Google Drive</td> 5408 <td style="text-align: center;">Yes</td> 5409 <td style="text-align: center;">Yes</td> 5410 <td style="text-align: center;">Yes</td> 5411 <td style="text-align: center;">Yes</td> 5412 <td style="text-align: center;">Yes</td> 5413 <td style="text-align: center;">Yes</td> 5414 <td style="text-align: center;">Yes</td> 5415 <td style="text-align: center;">Yes</td> 5416 <td style="text-align: center;">Yes</td> 5417 <td style="text-align: center;">Yes</td> 5418 </tr> 5419 <tr class="odd"> 5420 <td>Google Photos</td> 5421 <td style="text-align: center;">No</td> 5422 <td style="text-align: center;">No</td> 5423 <td style="text-align: center;">No</td> 5424 <td style="text-align: center;">No</td> 5425 <td style="text-align: center;">No</td> 5426 <td style="text-align: center;">No</td> 5427 <td style="text-align: center;">No</td> 5428 <td style="text-align: center;">No</td> 5429 <td style="text-align: center;">No</td> 5430 <td style="text-align: center;">No</td> 5431 </tr> 5432 <tr class="even"> 5433 <td>HTTP</td> 5434 <td style="text-align: center;">No</td> 5435 <td style="text-align: center;">No</td> 5436 <td style="text-align: center;">No</td> 5437 <td style="text-align: center;">No</td> 5438 <td style="text-align: center;">No</td> 5439 <td style="text-align: center;">No</td> 5440 <td style="text-align: center;">No</td> 5441 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5442 <td style="text-align: center;">No</td> 5443 <td style="text-align: center;">Yes</td> 5444 </tr> 5445 <tr class="odd"> 5446 <td>Hubic</td> 5447 <td style="text-align: center;">Yes †</td> 5448 <td style="text-align: center;">Yes</td> 5449 <td style="text-align: center;">No</td> 5450 <td style="text-align: center;">No</td> 5451 <td style="text-align: center;">No</td> 5452 <td style="text-align: center;">Yes</td> 5453 <td style="text-align: center;">Yes</td> 5454 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5455 <td style="text-align: center;">Yes</td> 5456 <td style="text-align: center;">No</td> 5457 </tr> 5458 <tr class="even"> 5459 <td>Jottacloud</td> 5460 <td style="text-align: center;">Yes</td> 5461 <td style="text-align: center;">Yes</td> 5462 <td style="text-align: center;">Yes</td> 5463 <td style="text-align: center;">Yes</td> 5464 <td style="text-align: center;">Yes</td> 5465 <td style="text-align: center;">Yes</td> 5466 <td style="text-align: center;">No</td> 5467 <td style="text-align: center;">Yes</td> 5468 <td style="text-align: center;">Yes</td> 5469 <td style="text-align: center;">Yes</td> 5470 </tr> 5471 <tr class="odd"> 5472 <td>Mail.ru Cloud</td> 5473 <td style="text-align: center;">Yes</td> 5474 <td style="text-align: center;">Yes</td> 5475 <td style="text-align: center;">Yes</td> 5476 <td style="text-align: center;">Yes</td> 5477 <td style="text-align: center;">Yes</td> 5478 <td style="text-align: center;">No</td> 5479 <td style="text-align: center;">No</td> 5480 <td style="text-align: center;">Yes</td> 5481 <td style="text-align: center;">Yes</td> 5482 <td style="text-align: center;">Yes</td> 5483 </tr> 5484 <tr class="even"> 5485 <td>Mega</td> 5486 <td style="text-align: center;">Yes</td> 5487 <td style="text-align: center;">No</td> 5488 <td style="text-align: center;">Yes</td> 5489 <td style="text-align: center;">Yes</td> 5490 <td style="text-align: center;">Yes</td> 5491 <td style="text-align: center;">No</td> 5492 <td style="text-align: center;">No</td> 5493 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5494 <td style="text-align: center;">Yes</td> 5495 <td style="text-align: center;">Yes</td> 5496 </tr> 5497 <tr class="odd"> 5498 <td>Memory</td> 5499 <td style="text-align: center;">No</td> 5500 <td style="text-align: center;">Yes</td> 5501 <td style="text-align: center;">No</td> 5502 <td style="text-align: center;">No</td> 5503 <td style="text-align: center;">No</td> 5504 <td style="text-align: center;">Yes</td> 5505 <td style="text-align: center;">Yes</td> 5506 <td style="text-align: center;">No</td> 5507 <td style="text-align: center;">No</td> 5508 <td style="text-align: center;">No</td> 5509 </tr> 5510 <tr class="even"> 5511 <td>Microsoft Azure Blob Storage</td> 5512 <td style="text-align: center;">Yes</td> 5513 <td style="text-align: center;">Yes</td> 5514 <td style="text-align: center;">No</td> 5515 <td style="text-align: center;">No</td> 5516 <td style="text-align: center;">No</td> 5517 <td style="text-align: center;">Yes</td> 5518 <td style="text-align: center;">Yes</td> 5519 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5520 <td style="text-align: center;">No</td> 5521 <td style="text-align: center;">No</td> 5522 </tr> 5523 <tr class="odd"> 5524 <td>Microsoft OneDrive</td> 5525 <td style="text-align: center;">Yes</td> 5526 <td style="text-align: center;">Yes</td> 5527 <td style="text-align: center;">Yes</td> 5528 <td style="text-align: center;">Yes</td> 5529 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/575">#575</a></td> 5530 <td style="text-align: center;">No</td> 5531 <td style="text-align: center;">No</td> 5532 <td style="text-align: center;">Yes</td> 5533 <td style="text-align: center;">Yes</td> 5534 <td style="text-align: center;">Yes</td> 5535 </tr> 5536 <tr class="even"> 5537 <td>OpenDrive</td> 5538 <td style="text-align: center;">Yes</td> 5539 <td style="text-align: center;">Yes</td> 5540 <td style="text-align: center;">Yes</td> 5541 <td style="text-align: center;">Yes</td> 5542 <td style="text-align: center;">No</td> 5543 <td style="text-align: center;">No</td> 5544 <td style="text-align: center;">No</td> 5545 <td style="text-align: center;">No</td> 5546 <td style="text-align: center;">No</td> 5547 <td style="text-align: center;">Yes</td> 5548 </tr> 5549 <tr class="odd"> 5550 <td>OpenStack Swift</td> 5551 <td style="text-align: center;">Yes †</td> 5552 <td style="text-align: center;">Yes</td> 5553 <td style="text-align: center;">No</td> 5554 <td style="text-align: center;">No</td> 5555 <td style="text-align: center;">No</td> 5556 <td style="text-align: center;">Yes</td> 5557 <td style="text-align: center;">Yes</td> 5558 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5559 <td style="text-align: center;">Yes</td> 5560 <td style="text-align: center;">No</td> 5561 </tr> 5562 <tr class="even"> 5563 <td>pCloud</td> 5564 <td style="text-align: center;">Yes</td> 5565 <td style="text-align: center;">Yes</td> 5566 <td style="text-align: center;">Yes</td> 5567 <td style="text-align: center;">Yes</td> 5568 <td style="text-align: center;">Yes</td> 5569 <td style="text-align: center;">No</td> 5570 <td style="text-align: center;">No</td> 5571 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5572 <td style="text-align: center;">Yes</td> 5573 <td style="text-align: center;">Yes</td> 5574 </tr> 5575 <tr class="odd"> 5576 <td>premiumize.me</td> 5577 <td style="text-align: center;">Yes</td> 5578 <td style="text-align: center;">No</td> 5579 <td style="text-align: center;">Yes</td> 5580 <td style="text-align: center;">Yes</td> 5581 <td style="text-align: center;">No</td> 5582 <td style="text-align: center;">No</td> 5583 <td style="text-align: center;">No</td> 5584 <td style="text-align: center;">Yes</td> 5585 <td style="text-align: center;">Yes</td> 5586 <td style="text-align: center;">Yes</td> 5587 </tr> 5588 <tr class="even"> 5589 <td>put.io</td> 5590 <td style="text-align: center;">Yes</td> 5591 <td style="text-align: center;">No</td> 5592 <td style="text-align: center;">Yes</td> 5593 <td style="text-align: center;">Yes</td> 5594 <td style="text-align: center;">Yes</td> 5595 <td style="text-align: center;">No</td> 5596 <td style="text-align: center;">Yes</td> 5597 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5598 <td style="text-align: center;">Yes</td> 5599 <td style="text-align: center;">Yes</td> 5600 </tr> 5601 <tr class="odd"> 5602 <td>QingStor</td> 5603 <td style="text-align: center;">No</td> 5604 <td style="text-align: center;">Yes</td> 5605 <td style="text-align: center;">No</td> 5606 <td style="text-align: center;">No</td> 5607 <td style="text-align: center;">Yes</td> 5608 <td style="text-align: center;">Yes</td> 5609 <td style="text-align: center;">No</td> 5610 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5611 <td style="text-align: center;">No</td> 5612 <td style="text-align: center;">No</td> 5613 </tr> 5614 <tr class="even"> 5615 <td>Seafile</td> 5616 <td style="text-align: center;">Yes</td> 5617 <td style="text-align: center;">Yes</td> 5618 <td style="text-align: center;">Yes</td> 5619 <td style="text-align: center;">Yes</td> 5620 <td style="text-align: center;">Yes</td> 5621 <td style="text-align: center;">Yes</td> 5622 <td style="text-align: center;">Yes</td> 5623 <td style="text-align: center;">Yes</td> 5624 <td style="text-align: center;">Yes</td> 5625 <td style="text-align: center;">Yes</td> 5626 </tr> 5627 <tr class="odd"> 5628 <td>SFTP</td> 5629 <td style="text-align: center;">No</td> 5630 <td style="text-align: center;">No</td> 5631 <td style="text-align: center;">Yes</td> 5632 <td style="text-align: center;">Yes</td> 5633 <td style="text-align: center;">No</td> 5634 <td style="text-align: center;">No</td> 5635 <td style="text-align: center;">Yes</td> 5636 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5637 <td style="text-align: center;">Yes</td> 5638 <td style="text-align: center;">Yes</td> 5639 </tr> 5640 <tr class="even"> 5641 <td>SugarSync</td> 5642 <td style="text-align: center;">Yes</td> 5643 <td style="text-align: center;">Yes</td> 5644 <td style="text-align: center;">Yes</td> 5645 <td style="text-align: center;">Yes</td> 5646 <td style="text-align: center;">No</td> 5647 <td style="text-align: center;">No</td> 5648 <td style="text-align: center;">Yes</td> 5649 <td style="text-align: center;">Yes</td> 5650 <td style="text-align: center;">No</td> 5651 <td style="text-align: center;">Yes</td> 5652 </tr> 5653 <tr class="odd"> 5654 <td>Tardigrade</td> 5655 <td style="text-align: center;">Yes †</td> 5656 <td style="text-align: center;">No</td> 5657 <td style="text-align: center;">No</td> 5658 <td style="text-align: center;">No</td> 5659 <td style="text-align: center;">No</td> 5660 <td style="text-align: center;">Yes</td> 5661 <td style="text-align: center;">Yes</td> 5662 <td style="text-align: center;">No</td> 5663 <td style="text-align: center;">No</td> 5664 <td style="text-align: center;">No</td> 5665 </tr> 5666 <tr class="even"> 5667 <td>WebDAV</td> 5668 <td style="text-align: center;">Yes</td> 5669 <td style="text-align: center;">Yes</td> 5670 <td style="text-align: center;">Yes</td> 5671 <td style="text-align: center;">Yes</td> 5672 <td style="text-align: center;">No</td> 5673 <td style="text-align: center;">No</td> 5674 <td style="text-align: center;">Yes ‡</td> 5675 <td style="text-align: center;">No <a href="https://github.com/rclone/rclone/issues/2178">#2178</a></td> 5676 <td style="text-align: center;">Yes</td> 5677 <td style="text-align: center;">Yes</td> 5678 </tr> 5679 <tr class="odd"> 5680 <td>Yandex Disk</td> 5681 <td style="text-align: center;">Yes</td> 5682 <td style="text-align: center;">Yes</td> 5683 <td style="text-align: center;">Yes</td> 5684 <td style="text-align: center;">Yes</td> 5685 <td style="text-align: center;">Yes</td> 5686 <td style="text-align: center;">No</td> 5687 <td style="text-align: center;">Yes</td> 5688 <td style="text-align: center;">Yes</td> 5689 <td style="text-align: center;">Yes</td> 5690 <td style="text-align: center;">Yes</td> 5691 </tr> 5692 <tr class="even"> 5693 <td>The local filesystem</td> 5694 <td style="text-align: center;">Yes</td> 5695 <td style="text-align: center;">No</td> 5696 <td style="text-align: center;">Yes</td> 5697 <td style="text-align: center;">Yes</td> 5698 <td style="text-align: center;">No</td> 5699 <td style="text-align: center;">No</td> 5700 <td style="text-align: center;">Yes</td> 5701 <td style="text-align: center;">No</td> 5702 <td style="text-align: center;">Yes</td> 5703 <td style="text-align: center;">Yes</td> 5704 </tr> 5705 </tbody> 5706 </table> 5707 <h3 id="purge">Purge</h3> 5708 <p>This deletes a directory quicker than just deleting all the files in the directory.</p> 5709 <p>† Note Swift, Hubic, and Tardigrade implement this in order to delete directory markers but they don’t actually have a quicker way of deleting files other than deleting them individually.</p> 5710 <p>‡ StreamUpload is not supported with Nextcloud</p> 5711 <h3 id="copy">Copy</h3> 5712 <p>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 <code>rclone copy</code> or <code>rclone move</code> if the remote doesn’t support <code>Move</code> directly.</p> 5713 <p>If the server doesn’t support <code>Copy</code> directly then for copy operations the file is downloaded then re-uploaded.</p> 5714 <h3 id="move">Move</h3> 5715 <p>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 <code>rclone move</code> if the server doesn’t support <code>DirMove</code>.</p> 5716 <p>If the server isn’t capable of <code>Move</code> then rclone simulates it with <code>Copy</code> then delete. If the server doesn’t support <code>Copy</code> then rclone will download the file and re-upload it.</p> 5717 <h3 id="dirmove">DirMove</h3> 5718 <p>This is used to implement <code>rclone move</code> to move a directory if possible. If it isn’t then it will use <code>Move</code> on each file (which falls back to <code>Copy</code> then download and upload - see <code>Move</code> section).</p> 5719 <h3 id="cleanup">CleanUp</h3> 5720 <p>This is used for emptying the trash for a remote by <code>rclone cleanup</code>.</p> 5721 <p>If the server can’t do <code>CleanUp</code> then <code>rclone cleanup</code> will return an error.</p> 5722 <h3 id="listr">ListR</h3> 5723 <p>The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the <code>--fast-list</code> flag to work. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 5724 <h3 id="streamupload">StreamUpload</h3> 5725 <p>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. <code>rclone rcat</code>.</p> 5726 <h3 id="linksharing">LinkSharing</h3> 5727 <p>Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don’t have an account on the particular cloud provider.</p> 5728 <h3 id="about-1">About</h3> 5729 <p>This is used to fetch quota information from the remote, like bytes used/free/quota and bytes used in the trash.</p> 5730 <p>This is also used to return the space used, available for <code>rclone mount</code>.</p> 5731 <p>If the server can’t do <code>About</code> then <code>rclone about</code> will return an error.</p> 5732 <h3 id="emptydir">EmptyDir</h3> 5733 <p>The remote supports empty directories. See <a href="https://rclone.org/bugs/#limitations">Limitations</a> for details. Most Object/Bucket based remotes do not support this.</p> 5734 <h1 id="global-flags">Global Flags</h1> 5735 <p>This describes the global flags available to every rclone command split into two groups, non backend and backend flags.</p> 5736 <h2 id="non-backend-flags">Non Backend Flags</h2> 5737 <p>These flags are available for every command.</p> 5738 <pre><code> --ask-password Allow prompt for password for encrypted configuration. (default true) 5739 --auto-confirm If enabled, do not request console confirmation. 5740 --backup-dir string Make backups into hierarchy based in DIR. 5741 --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. 5742 --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) 5743 --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. 5744 --ca-cert string CA certificate used to verify servers 5745 --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") 5746 --check-first Do all the checks before starting transfers. 5747 --checkers int Number of checkers to run in parallel. (default 8) 5748 -c, --checksum Skip based on checksum (if available) & size, not mod-time & size 5749 --client-cert string Client SSL certificate (PEM) for mutual TLS auth 5750 --client-key string Client SSL private key (PEM) for mutual TLS auth 5751 --compare-dest string Include additional server-side path during comparison. 5752 --config string Config file. (default "$HOME/.config/rclone/rclone.conf") 5753 --contimeout duration Connect timeout (default 1m0s) 5754 --copy-dest string Implies --compare-dest but also copies files from path into destination. 5755 --cpuprofile string Write cpu profile to file 5756 --cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") 5757 --delete-after When synchronizing, delete files on destination after transferring (default) 5758 --delete-before When synchronizing, delete files on destination before transferring 5759 --delete-during When synchronizing, delete files during transfer 5760 --delete-excluded Delete files on dest excluded from sync 5761 --disable string Disable a comma separated list of features. Use help to see a list. 5762 -n, --dry-run Do a trial run with no permanent changes 5763 --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles 5764 --dump-bodies Dump HTTP headers and bodies - may contain sensitive info 5765 --dump-headers Dump HTTP headers - may contain sensitive info 5766 --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts 5767 --exclude stringArray Exclude files matching pattern 5768 --exclude-from stringArray Read exclude patterns from file (use - to read from stdin) 5769 --exclude-if-present string Exclude directories if filename is present 5770 --expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s) 5771 --fast-list Use recursive list if available. Uses more memory but fewer transactions. 5772 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 5773 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 5774 -f, --filter stringArray Add a file-filtering rule 5775 --filter-from stringArray Read filtering patterns from a file (use - to read from stdin) 5776 --header stringArray Set HTTP header for all transactions 5777 --header-download stringArray Set HTTP header for download transactions 5778 --header-upload stringArray Set HTTP header for upload transactions 5779 --ignore-case Ignore case in filters (case insensitive) 5780 --ignore-case-sync Ignore case when synchronizing 5781 --ignore-checksum Skip post copy check of checksums. 5782 --ignore-errors delete even if there are I/O errors 5783 --ignore-existing Skip all files that exist on destination 5784 --ignore-size Ignore size when skipping use mod-time or checksum. 5785 -I, --ignore-times Don't skip files that match size and time - transfer all files 5786 --immutable Do not modify files. Fail if existing files have been modified. 5787 --include stringArray Include files matching pattern 5788 --include-from stringArray Read include patterns from file (use - to read from stdin) 5789 --log-file string Log everything to this file 5790 --log-format string Comma separated list of log format options (default "date,time") 5791 --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") 5792 --low-level-retries int Number of low level retries to do. (default 10) 5793 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5794 --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) 5795 --max-delete int When synchronizing, limit the number of deletes (default -1) 5796 --max-depth int If set limits the recursion depth to this. (default -1) 5797 --max-duration duration Maximum duration rclone will transfer data for. 5798 --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) 5799 --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) 5800 --max-transfer SizeSuffix Maximum size of data to transfer. (default off) 5801 --memprofile string Write memory profile to file 5802 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5803 --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) 5804 --modify-window duration Max time diff to be considered the same (default 1ns) 5805 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) 5806 --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) 5807 --no-check-certificate Do not verify the server SSL certificate. Insecure. 5808 --no-check-dest Don't check the destination, copy regardless. 5809 --no-gzip-encoding Don't set Accept-Encoding: gzip. 5810 --no-traverse Don't traverse destination file system on copy. 5811 --no-unicode-normalization Don't normalize unicode characters in filenames. 5812 --no-update-modtime Don't update destination mod-time if files identical. 5813 --order-by string Instructions on how to order the transfers, eg 'size,descending' 5814 --password-command SpaceSepList Command for supplying password for encrypted configuration. 5815 -P, --progress Show progress during transfer. 5816 -q, --quiet Print as little stuff as possible 5817 --rc Enable the remote control server. 5818 --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") 5819 --rc-allow-origin string Set the allowed origin for CORS. 5820 --rc-baseurl string Prefix for URLs - leave blank for root. 5821 --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) 5822 --rc-client-ca string Client certificate authority to verify clients with 5823 --rc-enable-metrics Enable prometheus metrics on /metrics 5824 --rc-files string Path to local files to serve on the HTTP server. 5825 --rc-htpasswd string htpasswd file - if not provided no authentication is done 5826 --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) 5827 --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) 5828 --rc-key string SSL PEM Private key 5829 --rc-max-header-bytes int Maximum size of request header (default 4096) 5830 --rc-no-auth Don't require auth for certain methods. 5831 --rc-pass string Password for authentication. 5832 --rc-realm string realm for authentication (default "rclone") 5833 --rc-serve Enable the serving of remote objects. 5834 --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) 5835 --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) 5836 --rc-template string User Specified Template. 5837 --rc-user string User name for authentication. 5838 --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") 5839 --rc-web-gui Launch WebGUI on localhost 5840 --rc-web-gui-force-update Force update to latest version of web gui 5841 --rc-web-gui-no-open-browser Don't open the browser automatically 5842 --rc-web-gui-update Check and update to latest version of web gui 5843 --retries int Retry operations this many times if they fail (default 3) 5844 --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) 5845 --size-only Skip based on size only, not mod-time or checksum 5846 --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) 5847 --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) 5848 --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") 5849 --stats-one-line Make the stats fit on one line. 5850 --stats-one-line-date Enables --stats-one-line and add current date/time prefix. 5851 --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format 5852 --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") 5853 --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 100k) 5854 --suffix string Suffix to add to changed files. 5855 --suffix-keep-extension Preserve the extension when using --suffix. 5856 --syslog Use Syslog for logging 5857 --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") 5858 --timeout duration IO idle timeout (default 5m0s) 5859 --tpslimit float Limit HTTP transactions per second to this. 5860 --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) 5861 --track-renames When synchronizing, track file renames and do a server side move if possible 5862 --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime (default "hash") 5863 --transfers int Number of file transfers to run in parallel. (default 4) 5864 -u, --update Skip files that are newer on the destination. 5865 --use-cookies Enable session cookiejar. 5866 --use-json-log Use json log format. 5867 --use-mmap Use mmap allocator (see docs). 5868 --use-server-modtime Use server modified time instead of object metadata 5869 --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.2") 5870 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 5871 <h2 id="backend-flags">Backend Flags</h2> 5872 <p>These flags are available for every command. They control the backends and may be set in the config file.</p> 5873 <pre><code> --acd-auth-url string Auth server URL. 5874 --acd-client-id string Amazon Application Client ID. 5875 --acd-client-secret string Amazon Application Client Secret. 5876 --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) 5877 --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) 5878 --acd-token-url string Token server url. 5879 --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) 5880 --alias-remote string Remote or path to alias. 5881 --azureblob-access-tier string Access tier of blob: hot, cool or archive. 5882 --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) 5883 --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) 5884 --azureblob-disable-checksum Don't store MD5 checksum with object metadata. 5885 --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) 5886 --azureblob-endpoint string Endpoint for the service 5887 --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) 5888 --azureblob-list-chunk int Size of blob list. (default 5000) 5889 --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) 5890 --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. 5891 --azureblob-sas-url string SAS URL for container level access only 5892 --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) 5893 --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) 5894 --b2-account string Account ID or Application Key ID 5895 --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) 5896 --b2-disable-checksum Disable checksums for large (> upload cutoff) files 5897 --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) 5898 --b2-download-url string Custom endpoint for downloads. 5899 --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 5900 --b2-endpoint string Endpoint for the service. 5901 --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. 5902 --b2-key string Application Key 5903 --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. 5904 --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) 5905 --b2-versions Include old versions in directory listings. 5906 --box-box-config-file string Box App config.json location 5907 --box-box-sub-type string (default "user") 5908 --box-client-id string Box App Client Id. 5909 --box-client-secret string Box App Client Secret 5910 --box-commit-retries int Max number of times to try committing a multipart file. (default 100) 5911 --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) 5912 --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. 5913 --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) 5914 --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) 5915 --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. 5916 --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") 5917 --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) 5918 --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) 5919 --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") 5920 --cache-db-purge Clear all the cached data for this remote on start. 5921 --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) 5922 --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) 5923 --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server 5924 --cache-plex-password string The password of the Plex user (obscured) 5925 --cache-plex-url string The URL of the Plex server 5926 --cache-plex-username string The username of the Plex user 5927 --cache-read-retries int How many times to retry a read from a cache storage. (default 10) 5928 --cache-remote string Remote to cache. 5929 --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) 5930 --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. 5931 --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) 5932 --cache-workers int How many workers should run in parallel to download chunks. (default 4) 5933 --cache-writes Cache file data on writes through the FS 5934 --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) 5935 --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. 5936 --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") 5937 --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") 5938 --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") 5939 --chunker-remote string Remote to chunk/unchunk. 5940 --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) 5941 -L, --copy-links Follow symlinks and copy the pointed to item. 5942 --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) 5943 --crypt-filename-encryption string How to encrypt the filenames. (default "standard") 5944 --crypt-password string Password or pass phrase for encryption. (obscured) 5945 --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) 5946 --crypt-remote string Remote to encrypt/decrypt. 5947 --crypt-show-mapping For all files listed show how the names encrypt. 5948 --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. 5949 --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. 5950 --drive-alternate-export Use alternate export URLs for google documents export., 5951 --drive-auth-owner-only Only consider files owned by the authenticated user. 5952 --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) 5953 --drive-client-id string Google Application Client Id 5954 --drive-client-secret string Google Application Client Secret 5955 --drive-disable-http2 Disable drive using http2 (default true) 5956 --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) 5957 --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") 5958 --drive-formats string Deprecated: see export_formats 5959 --drive-impersonate string Impersonate this user when using a service account. 5960 --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. 5961 --drive-keep-revision-forever Keep new head revision of each file forever. 5962 --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) 5963 --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) 5964 --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) 5965 --drive-root-folder-id string ID of the root folder 5966 --drive-scope string Scope that rclone should use when requesting access from drive. 5967 --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. 5968 --drive-service-account-credentials string Service Account Credentials JSON blob 5969 --drive-service-account-file string Service Account Credentials JSON file path 5970 --drive-shared-with-me Only show files that are shared with me. 5971 --drive-size-as-quota Show sizes as storage quota usage, not actual size. 5972 --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. 5973 --drive-skip-gdocs Skip google documents in all listings. 5974 --drive-skip-shortcuts If set skip shortcut files 5975 --drive-stop-on-upload-limit Make upload limit errors be fatal 5976 --drive-team-drive string ID of the Team Drive 5977 --drive-trashed-only Only show files that are in the trash. 5978 --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) 5979 --drive-use-created-date Use file created date instead of modified date., 5980 --drive-use-shared-date Use date file was shared instead of modified date. 5981 --drive-use-trash Send files to the trash instead of deleting permanently. (default true) 5982 --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) 5983 --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) 5984 --dropbox-client-id string Dropbox App Client Id 5985 --dropbox-client-secret string Dropbox App Client Secret 5986 --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) 5987 --dropbox-impersonate string Impersonate this user when using a business account. 5988 --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl 5989 --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) 5990 --fichier-shared-folder string If you want to download a shared folder, add this parameter 5991 --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited 5992 --ftp-disable-epsv Disable using EPSV even if server advertises support 5993 --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) 5994 --ftp-host string FTP host to connect to 5995 --ftp-no-check-certificate Do not verify the TLS certificate of the server 5996 --ftp-pass string FTP password (obscured) 5997 --ftp-port string FTP port, leave blank to use default (21) 5998 --ftp-tls Use FTP over TLS (Implicit) 5999 --ftp-user string FTP username, leave blank for current username, $USER 6000 --gcs-bucket-acl string Access Control List for new buckets. 6001 --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. 6002 --gcs-client-id string Google Application Client Id 6003 --gcs-client-secret string Google Application Client Secret 6004 --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) 6005 --gcs-location string Location for the newly created buckets. 6006 --gcs-object-acl string Access Control List for new objects. 6007 --gcs-project-number string Project number. 6008 --gcs-service-account-file string Service Account Credentials JSON file path 6009 --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. 6010 --gphotos-client-id string Google Application Client Id 6011 --gphotos-client-secret string Google Application Client Secret 6012 --gphotos-read-only Set to make the Google Photos backend read only. 6013 --gphotos-read-size Set to read the size of media items. 6014 --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) 6015 --http-headers CommaSepList Set HTTP headers for all transactions 6016 --http-no-head Don't use HEAD requests to find file sizes in dir listing 6017 --http-no-slash Set this if the site doesn't end directories with / 6018 --http-url string URL of http host to connect to 6019 --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) 6020 --hubic-client-id string Hubic Client Id 6021 --hubic-client-secret string Hubic Client Secret 6022 --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) 6023 --hubic-no-chunk Don't chunk files during streaming upload. 6024 --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) 6025 --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. 6026 --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) 6027 --jottacloud-trashed-only Only show files that are in the trash. 6028 --jottacloud-unlink Remove existing public link to file/folder with link command rather than creating. 6029 --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) 6030 --koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 6031 --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") 6032 --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. 6033 --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) 6034 --koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) 6035 --koofr-user string Your Koofr user name 6036 -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension 6037 --local-case-insensitive Force the filesystem to report itself as case insensitive 6038 --local-case-sensitive Force the filesystem to report itself as case sensitive. 6039 --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) 6040 --local-no-check-updated Don't check to see if the files change during upload 6041 --local-no-sparse Disable sparse files for multi-thread downloads 6042 --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) 6043 --local-nounc string Disable UNC (long path names) conversion on Windows 6044 --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) 6045 --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) 6046 --mailru-pass string Password (obscured) 6047 --mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) 6048 --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf") 6049 --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) 6050 --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) 6051 --mailru-user string User name (usually email) 6052 --mega-debug Output more debug from Mega. 6053 --mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) 6054 --mega-hard-delete Delete files permanently rather than putting them into the trash. 6055 --mega-pass string Password. (obscured) 6056 --mega-user string User name 6057 -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). 6058 --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) 6059 --onedrive-client-id string Microsoft App Client Id 6060 --onedrive-client-secret string Microsoft App Client Secret 6061 --onedrive-drive-id string The ID of the drive to use 6062 --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) 6063 --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) 6064 --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. 6065 --onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs. 6066 --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) 6067 --opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) 6068 --opendrive-password string Password. (obscured) 6069 --opendrive-username string Username 6070 --pcloud-client-id string Pcloud App Client Id 6071 --pcloud-client-secret string Pcloud App Client Secret 6072 --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 6073 --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") 6074 --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) 6075 --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 6076 --qingstor-access-key-id string QingStor Access Key ID 6077 --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) 6078 --qingstor-connection-retries int Number of connection retries. (default 3) 6079 --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) 6080 --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. 6081 --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. 6082 --qingstor-secret-access-key string QingStor Secret Access Key (password) 6083 --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) 6084 --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) 6085 --qingstor-zone string Zone to connect to. 6086 --s3-access-key-id string AWS Access Key ID. 6087 --s3-acl string Canned ACL used when creating buckets and storing or copying objects. 6088 --s3-bucket-acl string Canned ACL used when creating buckets. 6089 --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) 6090 --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G) 6091 --s3-disable-checksum Don't store MD5 checksum with object metadata 6092 --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) 6093 --s3-endpoint string Endpoint for S3 API. 6094 --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 6095 --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) 6096 --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. 6097 --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) 6098 --s3-location-constraint string Location constraint - must be set to match the Region. 6099 --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) 6100 --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. 6101 --s3-provider string Choose your S3 provider. 6102 --s3-region string Region to connect to. 6103 --s3-secret-access-key string AWS Secret Access Key (password) 6104 --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. 6105 --s3-session-token string An AWS session token 6106 --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. 6107 --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. 6108 --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. 6109 --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. 6110 --s3-storage-class string The storage class to use when storing new objects in S3. 6111 --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) 6112 --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) 6113 --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. 6114 --s3-v2-auth If true use v2 authentication. 6115 --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) 6116 --seafile-create-library Should rclone create a library if it doesn't exist 6117 --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) 6118 --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. 6119 --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) 6120 --seafile-pass string Password (obscured) 6121 --seafile-url string URL of seafile host to connect to 6122 --seafile-user string User name (usually email address) 6123 --sftp-ask-password Allow asking for SFTP password when needed. 6124 --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. 6125 --sftp-host string SSH host to connect to 6126 --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. 6127 --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) 6128 --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. 6129 --sftp-key-use-agent When set forces the usage of the ssh-agent. 6130 --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. 6131 --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) 6132 --sftp-path-override string Override path used by SSH connection. 6133 --sftp-port string SSH port, leave blank to use default (22) 6134 --sftp-set-modtime Set the modified time on the remote if set. (default true) 6135 --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. 6136 --sftp-skip-links Set to skip any symlinks and any other non regular files. 6137 --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. 6138 --sftp-user string SSH username, leave blank for current username, ncw 6139 --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) 6140 --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) 6141 --sharefile-endpoint string Endpoint for API calls. 6142 --sharefile-root-folder-id string ID of the root folder 6143 --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) 6144 --skip-links Don't warn about skipped symlinks. 6145 --sugarsync-access-key-id string Sugarsync Access Key ID. 6146 --sugarsync-app-id string Sugarsync App ID. 6147 --sugarsync-authorization string Sugarsync authorization 6148 --sugarsync-authorization-expiry string Sugarsync authorization expiry 6149 --sugarsync-deleted-id string Sugarsync deleted folder id 6150 --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) 6151 --sugarsync-hard-delete Permanently delete files if true 6152 --sugarsync-private-access-key string Sugarsync Private Access Key 6153 --sugarsync-refresh-token string Sugarsync refresh token 6154 --sugarsync-root-id string Sugarsync root id 6155 --sugarsync-user string Sugarsync user 6156 --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) 6157 --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) 6158 --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) 6159 --swift-auth string Authentication URL for server (OS_AUTH_URL). 6160 --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) 6161 --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) 6162 --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) 6163 --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) 6164 --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) 6165 --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") 6166 --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. 6167 --swift-key string API key or password (OS_PASSWORD). 6168 --swift-no-chunk Don't chunk files during streaming upload. 6169 --swift-region string Region name - optional (OS_REGION_NAME) 6170 --swift-storage-policy string The storage policy to use when creating a new container 6171 --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) 6172 --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) 6173 --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) 6174 --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) 6175 --swift-user string User name to log in (OS_USERNAME). 6176 --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). 6177 --tardigrade-access-grant string Access Grant. 6178 --tardigrade-api-key string API Key. 6179 --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. 6180 --tardigrade-provider string Choose an authentication method. (default "existing") 6181 --tardigrade-satellite-address <nodeid>@<address>:<port> Satellite Address. Custom satellite address should match the format: <nodeid>@<address>:<port>. (default "us-central-1.tardigrade.io") 6182 --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") 6183 --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) 6184 --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") 6185 --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") 6186 --union-upstreams string List of space separated upstreams. 6187 --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) 6188 --webdav-bearer-token-command string Command to run to get a bearer token 6189 --webdav-pass string Password. (obscured) 6190 --webdav-url string URL of http host to connect to 6191 --webdav-user string User name 6192 --webdav-vendor string Name of the Webdav site/service/software you are using 6193 --yandex-client-id string Yandex Client Id 6194 --yandex-client-secret string Yandex Client Secret 6195 --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) 6196 --yandex-unlink Remove existing public link to file/folder with link command rather than creating.</code></pre> 6197 <h2 id="fichier">1Fichier</h2> 6198 <p>This is a backend for the <a href="https://1fichier.com">1fichier</a> cloud storage service. Note that a Premium subscription is required to use the API.</p> 6199 <p>Paths are specified as <code>remote:path</code></p> 6200 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 6201 <p>The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser.</p> 6202 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 6203 <pre><code> rclone config</code></pre> 6204 <p>This will guide you through an interactive setup process:</p> 6205 <pre><code>No remotes found - make a new one 6206 n) New remote 6207 s) Set configuration password 6208 q) Quit config 6209 n/s/q> n 6210 name> remote 6211 Type of storage to configure. 6212 Enter a string value. Press Enter for the default (""). 6213 Choose a number from below, or type in your own value 6214 [snip] 6215 XX / 1Fichier 6216 \ "fichier" 6217 [snip] 6218 Storage> fichier 6219 ** See help for fichier backend at: https://rclone.org/fichier/ ** 6220 6221 Your API Key, get it from https://1fichier.com/console/params.pl 6222 Enter a string value. Press Enter for the default (""). 6223 api_key> example_key 6224 6225 Edit advanced config? (y/n) 6226 y) Yes 6227 n) No 6228 y/n> 6229 Remote config 6230 -------------------- 6231 [remote] 6232 type = fichier 6233 api_key = example_key 6234 -------------------- 6235 y) Yes this is OK 6236 e) Edit this remote 6237 d) Delete this remote 6238 y/e/d> y</code></pre> 6239 <p>Once configured you can then use <code>rclone</code> like this,</p> 6240 <p>List directories in top level of your 1Fichier account</p> 6241 <pre><code>rclone lsd remote:</code></pre> 6242 <p>List all the files in your 1Fichier account</p> 6243 <pre><code>rclone ls remote:</code></pre> 6244 <p>To copy a local directory to a 1Fichier directory called backup</p> 6245 <pre><code>rclone copy /home/source remote:backup</code></pre> 6246 <h3 id="modified-time-and-hashes">Modified time and hashes</h3> 6247 <p>1Fichier does not support modification times. It supports the Whirlpool hash algorithm.</p> 6248 <h3 id="duplicated-files">Duplicated files</h3> 6249 <p>1Fichier can have two files with exactly the same name and path (unlike a normal file system).</p> 6250 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 6251 <h4 id="restricted-filename-characters">Restricted filename characters</h4> 6252 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 6253 <table> 6254 <thead> 6255 <tr class="header"> 6256 <th>Character</th> 6257 <th style="text-align: center;">Value</th> 6258 <th style="text-align: center;">Replacement</th> 6259 </tr> 6260 </thead> 6261 <tbody> 6262 <tr class="odd"> 6263 <td>\</td> 6264 <td style="text-align: center;">0x5C</td> 6265 <td style="text-align: center;">＼</td> 6266 </tr> 6267 <tr class="even"> 6268 <td><</td> 6269 <td style="text-align: center;">0x3C</td> 6270 <td style="text-align: center;">＜</td> 6271 </tr> 6272 <tr class="odd"> 6273 <td>></td> 6274 <td style="text-align: center;">0x3E</td> 6275 <td style="text-align: center;">＞</td> 6276 </tr> 6277 <tr class="even"> 6278 <td>"</td> 6279 <td style="text-align: center;">0x22</td> 6280 <td style="text-align: center;">＂</td> 6281 </tr> 6282 <tr class="odd"> 6283 <td>$</td> 6284 <td style="text-align: center;">0x24</td> 6285 <td style="text-align: center;">＄</td> 6286 </tr> 6287 <tr class="even"> 6288 <td>`</td> 6289 <td style="text-align: center;">0x60</td> 6290 <td style="text-align: center;">｀</td> 6291 </tr> 6292 <tr class="odd"> 6293 <td>’</td> 6294 <td style="text-align: center;">0x27</td> 6295 <td style="text-align: center;">＇</td> 6296 </tr> 6297 </tbody> 6298 </table> 6299 <p>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:</p> 6300 <table> 6301 <thead> 6302 <tr class="header"> 6303 <th>Character</th> 6304 <th style="text-align: center;">Value</th> 6305 <th style="text-align: center;">Replacement</th> 6306 </tr> 6307 </thead> 6308 <tbody> 6309 <tr class="odd"> 6310 <td>SP</td> 6311 <td style="text-align: center;">0x20</td> 6312 <td style="text-align: center;">␠</td> 6313 </tr> 6314 </tbody> 6315 </table> 6316 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 6317 <h3 id="standard-options">Standard Options</h3> 6318 <p>Here are the standard options specific to fichier (1Fichier).</p> 6319 <h4 id="fichier-api-key">–fichier-api-key</h4> 6320 <p>Your API Key, get it from https://1fichier.com/console/params.pl</p> 6321 <ul> 6322 <li>Config: api_key</li> 6323 <li>Env Var: RCLONE_FICHIER_API_KEY</li> 6324 <li>Type: string</li> 6325 <li>Default: ""</li> 6326 </ul> 6327 <h3 id="advanced-options">Advanced Options</h3> 6328 <p>Here are the advanced options specific to fichier (1Fichier).</p> 6329 <h4 id="fichier-shared-folder">–fichier-shared-folder</h4> 6330 <p>If you want to download a shared folder, add this parameter</p> 6331 <ul> 6332 <li>Config: shared_folder</li> 6333 <li>Env Var: RCLONE_FICHIER_SHARED_FOLDER</li> 6334 <li>Type: string</li> 6335 <li>Default: ""</li> 6336 </ul> 6337 <h4 id="fichier-encoding">–fichier-encoding</h4> 6338 <p>This sets the encoding for the backend.</p> 6339 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 6340 <ul> 6341 <li>Config: encoding</li> 6342 <li>Env Var: RCLONE_FICHIER_ENCODING</li> 6343 <li>Type: MultiEncoder</li> 6344 <li>Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot</li> 6345 </ul> 6346 <h2 id="alias">Alias</h2> 6347 <p>The <code>alias</code> remote provides a new name for another remote.</p> 6348 <p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p> 6349 <p>During the initial setup with <code>rclone config</code> you will specify the target remote. The target remote can either be a local path or another remote.</p> 6350 <p>Subfolders can be used in target remote. Assume an alias remote named <code>backup</code> with the target <code>mydrive:private/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/desktop</code>.</p> 6351 <p>There will be no special handling of paths containing <code>..</code> segments. Invoking <code>rclone mkdir backup:../desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/../desktop</code>. The empty path is not allowed as a remote. To alias the current directory use <code>.</code> instead.</p> 6352 <p>Here is an example of how to make an alias called <code>remote</code> for local folder. First run:</p> 6353 <pre><code> rclone config</code></pre> 6354 <p>This will guide you through an interactive setup process:</p> 6355 <pre><code>No remotes found - make a new one 6356 n) New remote 6357 s) Set configuration password 6358 q) Quit config 6359 n/s/q> n 6360 name> remote 6361 Type of storage to configure. 6362 Choose a number from below, or type in your own value 6363 [snip] 6364 XX / Alias for an existing remote 6365 \ "alias" 6366 [snip] 6367 Storage> alias 6368 Remote or path to alias. 6369 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". 6370 remote> /mnt/storage/backup 6371 Remote config 6372 -------------------- 6373 [remote] 6374 remote = /mnt/storage/backup 6375 -------------------- 6376 y) Yes this is OK 6377 e) Edit this remote 6378 d) Delete this remote 6379 y/e/d> y 6380 Current remotes: 6381 6382 Name Type 6383 ==== ==== 6384 remote alias 6385 6386 e) Edit existing remote 6387 n) New remote 6388 d) Delete remote 6389 r) Rename remote 6390 c) Copy remote 6391 s) Set configuration password 6392 q) Quit config 6393 e/n/d/r/c/s/q> q</code></pre> 6394 <p>Once configured you can then use <code>rclone</code> like this,</p> 6395 <p>List directories in top level in <code>/mnt/storage/backup</code></p> 6396 <pre><code>rclone lsd remote:</code></pre> 6397 <p>List all the files in <code>/mnt/storage/backup</code></p> 6398 <pre><code>rclone ls remote:</code></pre> 6399 <p>Copy another local directory to the alias directory called source</p> 6400 <pre><code>rclone copy /home/source remote:source</code></pre> 6401 <h3 id="standard-options-1">Standard Options</h3> 6402 <p>Here are the standard options specific to alias (Alias for an existing remote).</p> 6403 <h4 id="alias-remote">–alias-remote</h4> 6404 <p>Remote or path to alias. Can be “myremote:path/to/dir”, “myremote:bucket”, “myremote:” or “/local/path”.</p> 6405 <ul> 6406 <li>Config: remote</li> 6407 <li>Env Var: RCLONE_ALIAS_REMOTE</li> 6408 <li>Type: string</li> 6409 <li>Default: ""</li> 6410 </ul> 6411 <h2 id="amazon-drive">Amazon Drive</h2> 6412 <p>Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers.</p> 6413 <h2 id="status">Status</h2> 6414 <p><strong>Important:</strong> rclone supports Amazon Drive only if you have your own set of API keys. Unfortunately the <a href="https://developer.amazon.com/amazon-drive">Amazon Drive developer program</a> is now closed to new entries so if you don’t already have your own set of keys you will not be able to use rclone with Amazon Drive.</p> 6415 <p>For the history on why rclone no longer has a set of Amazon Drive API keys see <a href="https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314">the forum</a>.</p> 6416 <p>If you happen to know anyone who works at Amazon then please ask them to re-instate rclone into the Amazon Drive developer program - thanks!</p> 6417 <h2 id="setup">Setup</h2> 6418 <p>The initial setup for Amazon Drive involves getting a token from Amazon which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 6419 <p>The configuration process for Amazon Drive may involve using an <a href="https://github.com/ncw/oauthproxy">oauth proxy</a>. This is used to keep the Amazon credentials out of the source code. The proxy runs in Google’s very secure App Engine environment and doesn’t store any credentials which pass through it.</p> 6420 <p>Since rclone doesn’t currently have its own Amazon Drive credentials so you will either need to have your own <code>client_id</code> and <code>client_secret</code> with Amazon Drive, or use a third party oauth proxy in which case you will need to enter <code>client_id</code>, <code>client_secret</code>, <code>auth_url</code> and <code>token_url</code>.</p> 6421 <p>Note also if you are not using Amazon’s <code>auth_url</code> and <code>token_url</code>, (ie you filled in something for those) then if setting up on a remote machine you can only use the <a href="https://rclone.org/remote_setup/#configuring-by-copying-the-config-file">copying the config method of configuration</a> - <code>rclone authorize</code> will not work.</p> 6422 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 6423 <pre><code> rclone config</code></pre> 6424 <p>This will guide you through an interactive setup process:</p> 6425 <pre><code>No remotes found - make a new one 6426 n) New remote 6427 r) Rename remote 6428 c) Copy remote 6429 s) Set configuration password 6430 q) Quit config 6431 n/r/c/s/q> n 6432 name> remote 6433 Type of storage to configure. 6434 Choose a number from below, or type in your own value 6435 [snip] 6436 XX / Amazon Drive 6437 \ "amazon cloud drive" 6438 [snip] 6439 Storage> amazon cloud drive 6440 Amazon Application Client Id - required. 6441 client_id> your client ID goes here 6442 Amazon Application Client Secret - required. 6443 client_secret> your client secret goes here 6444 Auth server URL - leave blank to use Amazon's. 6445 auth_url> Optional auth URL 6446 Token server url - leave blank to use Amazon's. 6447 token_url> Optional token URL 6448 Remote config 6449 Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. 6450 Use auto config? 6451 * Say Y if not sure 6452 * Say N if you are working on a remote or headless machine 6453 y) Yes 6454 n) No 6455 y/n> y 6456 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 6457 Log in and authorize rclone for access 6458 Waiting for code... 6459 Got code 6460 -------------------- 6461 [remote] 6462 client_id = your client ID goes here 6463 client_secret = your client secret goes here 6464 auth_url = Optional auth URL 6465 token_url = Optional token URL 6466 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} 6467 -------------------- 6468 y) Yes this is OK 6469 e) Edit this remote 6470 d) Delete this remote 6471 y/e/d> y</code></pre> 6472 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 6473 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Amazon. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 6474 <p>Once configured you can then use <code>rclone</code> like this,</p> 6475 <p>List directories in top level of your Amazon Drive</p> 6476 <pre><code>rclone lsd remote:</code></pre> 6477 <p>List all the files in your Amazon Drive</p> 6478 <pre><code>rclone ls remote:</code></pre> 6479 <p>To copy a local directory to an Amazon Drive directory called backup</p> 6480 <pre><code>rclone copy /home/source remote:backup</code></pre> 6481 <h3 id="modified-time-and-md5sums">Modified time and MD5SUMs</h3> 6482 <p>Amazon Drive doesn’t allow modification times to be changed via the API so these won’t be accurate or used for syncing.</p> 6483 <p>It does store MD5SUMs so for a more accurate sync, you can use the <code>--checksum</code> flag.</p> 6484 <h4 id="restricted-filename-characters-1">Restricted filename characters</h4> 6485 <table> 6486 <thead> 6487 <tr class="header"> 6488 <th>Character</th> 6489 <th style="text-align: center;">Value</th> 6490 <th style="text-align: center;">Replacement</th> 6491 </tr> 6492 </thead> 6493 <tbody> 6494 <tr class="odd"> 6495 <td>NUL</td> 6496 <td style="text-align: center;">0x00</td> 6497 <td style="text-align: center;">␀</td> 6498 </tr> 6499 <tr class="even"> 6500 <td>/</td> 6501 <td style="text-align: center;">0x2F</td> 6502 <td style="text-align: center;">／</td> 6503 </tr> 6504 </tbody> 6505 </table> 6506 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 6507 <h3 id="deleting-files">Deleting files</h3> 6508 <p>Any files you delete with rclone will end up in the trash. Amazon don’t provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Amazon’s apps or via the Amazon Drive website. As of November 17, 2016, files are automatically deleted by Amazon from the trash after 30 days.</p> 6509 <h3 id="using-with-non-.com-amazon-accounts">Using with non <code>.com</code> Amazon accounts</h3> 6510 <p>Let’s say you usually use <code>amazon.co.uk</code>. When you authenticate with rclone it will take you to an <code>amazon.com</code> page to log in. Your <code>amazon.co.uk</code> email and password should work here just fine.</p> 6511 <h3 id="standard-options-2">Standard Options</h3> 6512 <p>Here are the standard options specific to amazon cloud drive (Amazon Drive).</p> 6513 <h4 id="acd-client-id">–acd-client-id</h4> 6514 <p>Amazon Application Client ID.</p> 6515 <ul> 6516 <li>Config: client_id</li> 6517 <li>Env Var: RCLONE_ACD_CLIENT_ID</li> 6518 <li>Type: string</li> 6519 <li>Default: ""</li> 6520 </ul> 6521 <h4 id="acd-client-secret">–acd-client-secret</h4> 6522 <p>Amazon Application Client Secret.</p> 6523 <ul> 6524 <li>Config: client_secret</li> 6525 <li>Env Var: RCLONE_ACD_CLIENT_SECRET</li> 6526 <li>Type: string</li> 6527 <li>Default: ""</li> 6528 </ul> 6529 <h3 id="advanced-options-1">Advanced Options</h3> 6530 <p>Here are the advanced options specific to amazon cloud drive (Amazon Drive).</p> 6531 <h4 id="acd-auth-url">–acd-auth-url</h4> 6532 <p>Auth server URL. Leave blank to use Amazon’s.</p> 6533 <ul> 6534 <li>Config: auth_url</li> 6535 <li>Env Var: RCLONE_ACD_AUTH_URL</li> 6536 <li>Type: string</li> 6537 <li>Default: ""</li> 6538 </ul> 6539 <h4 id="acd-token-url">–acd-token-url</h4> 6540 <p>Token server url. leave blank to use Amazon’s.</p> 6541 <ul> 6542 <li>Config: token_url</li> 6543 <li>Env Var: RCLONE_ACD_TOKEN_URL</li> 6544 <li>Type: string</li> 6545 <li>Default: ""</li> 6546 </ul> 6547 <h4 id="acd-checkpoint">–acd-checkpoint</h4> 6548 <p>Checkpoint for internal polling (debug).</p> 6549 <ul> 6550 <li>Config: checkpoint</li> 6551 <li>Env Var: RCLONE_ACD_CHECKPOINT</li> 6552 <li>Type: string</li> 6553 <li>Default: ""</li> 6554 </ul> 6555 <h4 id="acd-upload-wait-per-gb">–acd-upload-wait-per-gb</h4> 6556 <p>Additional time per GB to wait after a failed complete upload to see if it appears.</p> 6557 <p>Sometimes Amazon Drive gives an error when a file has been fully uploaded but the file appears anyway after a little while. This happens sometimes for files over 1GB in size and nearly every time for files bigger than 10GB. This parameter controls the time rclone waits for the file to appear.</p> 6558 <p>The default value for this parameter is 3 minutes per GB, so by default it will wait 3 minutes for every GB uploaded to see if the file appears.</p> 6559 <p>You can disable this feature by setting it to 0. This may cause conflict errors as rclone retries the failed upload but the file will most likely appear correctly eventually.</p> 6560 <p>These values were determined empirically by observing lots of uploads of big files for a range of file sizes.</p> 6561 <p>Upload with the “-v” flag to see more info about what rclone is doing in this situation.</p> 6562 <ul> 6563 <li>Config: upload_wait_per_gb</li> 6564 <li>Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB</li> 6565 <li>Type: Duration</li> 6566 <li>Default: 3m0s</li> 6567 </ul> 6568 <h4 id="acd-templink-threshold">–acd-templink-threshold</h4> 6569 <p>Files >= this size will be downloaded via their tempLink.</p> 6570 <p>Files this size or more will be downloaded via their “tempLink”. This is to work around a problem with Amazon Drive which blocks downloads of files bigger than about 10GB. The default for this is 9GB which shouldn’t need to be changed.</p> 6571 <p>To download files above this threshold, rclone requests a “tempLink” which downloads the file through a temporary URL directly from the underlying S3 storage.</p> 6572 <ul> 6573 <li>Config: templink_threshold</li> 6574 <li>Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD</li> 6575 <li>Type: SizeSuffix</li> 6576 <li>Default: 9G</li> 6577 </ul> 6578 <h4 id="acd-encoding">–acd-encoding</h4> 6579 <p>This sets the encoding for the backend.</p> 6580 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 6581 <ul> 6582 <li>Config: encoding</li> 6583 <li>Env Var: RCLONE_ACD_ENCODING</li> 6584 <li>Type: MultiEncoder</li> 6585 <li>Default: Slash,InvalidUtf8,Dot</li> 6586 </ul> 6587 <h3 id="limitations-2">Limitations</h3> 6588 <p>Note that Amazon Drive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 6589 <p>Amazon Drive has rate limiting so you may notice errors in the sync (429 errors). rclone will automatically retry the sync up to 3 times by default (see <code>--retries</code> flag) which should hopefully work around this problem.</p> 6590 <p>Amazon Drive has an internal limit of file sizes that can be uploaded to the service. This limit is not officially published, but all files larger than this will fail.</p> 6591 <p>At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail.</p> 6592 <p>Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other failure. To avoid this problem, use <code>--max-size 50000M</code> option to limit the maximum size of uploaded files. Note that <code>--max-size</code> does not split files into segments, it only ignores files over this size.</p> 6593 <h2 id="amazon-s3-storage-providers">Amazon S3 Storage Providers</h2> 6594 <p>The S3 backend can be used with a number of different providers:</p> 6595 <ul> 6596 <li>AWS S3</li> 6597 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 6598 <li>Ceph</li> 6599 <li>DigitalOcean Spaces</li> 6600 <li>Dreamhost</li> 6601 <li>IBM COS S3</li> 6602 <li>Minio</li> 6603 <li>Scaleway</li> 6604 <li>StackPath</li> 6605 <li>Wasabi</li> 6606 </ul> 6607 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p> 6608 <p>Once you have made a remote (see the provider specific section above) you can use it like this:</p> 6609 <p>See all buckets</p> 6610 <pre><code>rclone lsd remote:</code></pre> 6611 <p>Make a new bucket</p> 6612 <pre><code>rclone mkdir remote:bucket</code></pre> 6613 <p>List the contents of a bucket</p> 6614 <pre><code>rclone ls remote:bucket</code></pre> 6615 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 6616 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 6617 <h2 id="amazon-s3">AWS S3</h2> 6618 <p>Here is an example of making an s3 configuration. First run</p> 6619 <pre><code>rclone config</code></pre> 6620 <p>This will guide you through an interactive setup process.</p> 6621 <pre><code>No remotes found - make a new one 6622 n) New remote 6623 s) Set configuration password 6624 q) Quit config 6625 n/s/q> n 6626 name> remote 6627 Type of storage to configure. 6628 Choose a number from below, or type in your own value 6629 [snip] 6630 XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) 6631 \ "s3" 6632 [snip] 6633 Storage> s3 6634 Choose your S3 provider. 6635 Choose a number from below, or type in your own value 6636 1 / Amazon Web Services (AWS) S3 6637 \ "AWS" 6638 2 / Ceph Object Storage 6639 \ "Ceph" 6640 3 / Digital Ocean Spaces 6641 \ "DigitalOcean" 6642 4 / Dreamhost DreamObjects 6643 \ "Dreamhost" 6644 5 / IBM COS S3 6645 \ "IBMCOS" 6646 6 / Minio Object Storage 6647 \ "Minio" 6648 7 / Wasabi Object Storage 6649 \ "Wasabi" 6650 8 / Any other S3 compatible provider 6651 \ "Other" 6652 provider> 1 6653 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. 6654 Choose a number from below, or type in your own value 6655 1 / Enter AWS credentials in the next step 6656 \ "false" 6657 2 / Get AWS credentials from the environment (env vars or IAM) 6658 \ "true" 6659 env_auth> 1 6660 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 6661 access_key_id> XXX 6662 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 6663 secret_access_key> YYY 6664 Region to connect to. 6665 Choose a number from below, or type in your own value 6666 / The default endpoint - a good choice if you are unsure. 6667 1 | US Region, Northern Virginia or Pacific Northwest. 6668 | Leave location constraint empty. 6669 \ "us-east-1" 6670 / US East (Ohio) Region 6671 2 | Needs location constraint us-east-2. 6672 \ "us-east-2" 6673 / US West (Oregon) Region 6674 3 | Needs location constraint us-west-2. 6675 \ "us-west-2" 6676 / US West (Northern California) Region 6677 4 | Needs location constraint us-west-1. 6678 \ "us-west-1" 6679 / Canada (Central) Region 6680 5 | Needs location constraint ca-central-1. 6681 \ "ca-central-1" 6682 / EU (Ireland) Region 6683 6 | Needs location constraint EU or eu-west-1. 6684 \ "eu-west-1" 6685 / EU (London) Region 6686 7 | Needs location constraint eu-west-2. 6687 \ "eu-west-2" 6688 / EU (Frankfurt) Region 6689 8 | Needs location constraint eu-central-1. 6690 \ "eu-central-1" 6691 / Asia Pacific (Singapore) Region 6692 9 | Needs location constraint ap-southeast-1. 6693 \ "ap-southeast-1" 6694 / Asia Pacific (Sydney) Region 6695 10 | Needs location constraint ap-southeast-2. 6696 \ "ap-southeast-2" 6697 / Asia Pacific (Tokyo) Region 6698 11 | Needs location constraint ap-northeast-1. 6699 \ "ap-northeast-1" 6700 / Asia Pacific (Seoul) 6701 12 | Needs location constraint ap-northeast-2. 6702 \ "ap-northeast-2" 6703 / Asia Pacific (Mumbai) 6704 13 | Needs location constraint ap-south-1. 6705 \ "ap-south-1" 6706 / Asia Patific (Hong Kong) Region 6707 14 | Needs location constraint ap-east-1. 6708 \ "ap-east-1" 6709 / South America (Sao Paulo) Region 6710 15 | Needs location constraint sa-east-1. 6711 \ "sa-east-1" 6712 region> 1 6713 Endpoint for S3 API. 6714 Leave blank if using AWS to use the default endpoint for the region. 6715 endpoint> 6716 Location constraint - must be set to match the Region. Used when creating buckets only. 6717 Choose a number from below, or type in your own value 6718 1 / Empty for US Region, Northern Virginia or Pacific Northwest. 6719 \ "" 6720 2 / US East (Ohio) Region. 6721 \ "us-east-2" 6722 3 / US West (Oregon) Region. 6723 \ "us-west-2" 6724 4 / US West (Northern California) Region. 6725 \ "us-west-1" 6726 5 / Canada (Central) Region. 6727 \ "ca-central-1" 6728 6 / EU (Ireland) Region. 6729 \ "eu-west-1" 6730 7 / EU (London) Region. 6731 \ "eu-west-2" 6732 8 / EU Region. 6733 \ "EU" 6734 9 / Asia Pacific (Singapore) Region. 6735 \ "ap-southeast-1" 6736 10 / Asia Pacific (Sydney) Region. 6737 \ "ap-southeast-2" 6738 11 / Asia Pacific (Tokyo) Region. 6739 \ "ap-northeast-1" 6740 12 / Asia Pacific (Seoul) 6741 \ "ap-northeast-2" 6742 13 / Asia Pacific (Mumbai) 6743 \ "ap-south-1" 6744 14 / Asia Pacific (Hong Kong) 6745 \ "ap-east-1" 6746 15 / South America (Sao Paulo) Region. 6747 \ "sa-east-1" 6748 location_constraint> 1 6749 Canned ACL used when creating buckets and/or storing objects in S3. 6750 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 6751 Choose a number from below, or type in your own value 6752 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 6753 \ "private" 6754 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 6755 \ "public-read" 6756 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 6757 3 | Granting this on a bucket is generally not recommended. 6758 \ "public-read-write" 6759 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. 6760 \ "authenticated-read" 6761 / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 6762 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 6763 \ "bucket-owner-read" 6764 / Both the object owner and the bucket owner get FULL_CONTROL over the object. 6765 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 6766 \ "bucket-owner-full-control" 6767 acl> 1 6768 The server-side encryption algorithm used when storing this object in S3. 6769 Choose a number from below, or type in your own value 6770 1 / None 6771 \ "" 6772 2 / AES256 6773 \ "AES256" 6774 server_side_encryption> 1 6775 The storage class to use when storing objects in S3. 6776 Choose a number from below, or type in your own value 6777 1 / Default 6778 \ "" 6779 2 / Standard storage class 6780 \ "STANDARD" 6781 3 / Reduced redundancy storage class 6782 \ "REDUCED_REDUNDANCY" 6783 4 / Standard Infrequent Access storage class 6784 \ "STANDARD_IA" 6785 5 / One Zone Infrequent Access storage class 6786 \ "ONEZONE_IA" 6787 6 / Glacier storage class 6788 \ "GLACIER" 6789 7 / Glacier Deep Archive storage class 6790 \ "DEEP_ARCHIVE" 6791 8 / Intelligent-Tiering storage class 6792 \ "INTELLIGENT_TIERING" 6793 storage_class> 1 6794 Remote config 6795 -------------------- 6796 [remote] 6797 type = s3 6798 provider = AWS 6799 env_auth = false 6800 access_key_id = XXX 6801 secret_access_key = YYY 6802 region = us-east-1 6803 endpoint = 6804 location_constraint = 6805 acl = private 6806 server_side_encryption = 6807 storage_class = 6808 -------------------- 6809 y) Yes this is OK 6810 e) Edit this remote 6811 d) Delete this remote 6812 y/e/d> </code></pre> 6813 <h3 id="fast-list-1">–fast-list</h3> 6814 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 6815 <h3 id="update-and-use-server-modtime">–update and –use-server-modtime</h3> 6816 <p>As noted below, the modified time is stored on metadata on the object. It 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 because it requires an extra API call to retrieve the metadata.</p> 6817 <p>For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is “dirty”. By using <code>--update</code> along with <code>--use-server-modtime</code>, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.</p> 6818 <h3 id="modified-time">Modified time</h3> 6819 <p>The modified time is stored as metadata on the object as <code>X-Amz-Meta-Mtime</code> as floating point since the epoch accurate to 1 ns.</p> 6820 <p>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.</p> 6821 <h4 id="restricted-filename-characters-2">Restricted filename characters</h4> 6822 <p>S3 allows any valid UTF-8 string as a key.</p> 6823 <p>Invalid UTF-8 bytes will be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in XML.</p> 6824 <p>The following characters are replaced since these are problematic when dealing with the REST API:</p> 6825 <table> 6826 <thead> 6827 <tr class="header"> 6828 <th>Character</th> 6829 <th style="text-align: center;">Value</th> 6830 <th style="text-align: center;">Replacement</th> 6831 </tr> 6832 </thead> 6833 <tbody> 6834 <tr class="odd"> 6835 <td>NUL</td> 6836 <td style="text-align: center;">0x00</td> 6837 <td style="text-align: center;">␀</td> 6838 </tr> 6839 <tr class="even"> 6840 <td>/</td> 6841 <td style="text-align: center;">0x2F</td> 6842 <td style="text-align: center;">／</td> 6843 </tr> 6844 </tbody> 6845 </table> 6846 <p>The encoding will also encode these file names as they don’t seem to work with the SDK properly:</p> 6847 <table> 6848 <thead> 6849 <tr class="header"> 6850 <th>File name</th> 6851 <th style="text-align: center;">Replacement</th> 6852 </tr> 6853 </thead> 6854 <tbody> 6855 <tr class="odd"> 6856 <td>.</td> 6857 <td style="text-align: center;">．</td> 6858 </tr> 6859 <tr class="even"> 6860 <td>..</td> 6861 <td style="text-align: center;">．．</td> 6862 </tr> 6863 </tbody> 6864 </table> 6865 <h3 id="multipart-uploads">Multipart uploads</h3> 6866 <p>rclone supports multipart uploads with S3 which means that it can upload files bigger than 5GB.</p> 6867 <p>Note that files uploaded <em>both</em> with multipart upload <em>and</em> through crypt remotes do not have MD5 sums.</p> 6868 <p>rclone switches from single part uploads to multipart uploads at the point specified by <code>--s3-upload-cutoff</code>. This can be a maximum of 5GB and a minimum of 0 (ie always upload multipart files).</p> 6869 <p>The chunk sizes used in the multipart upload are specified by <code>--s3-chunk-size</code> and the number of chunks uploaded concurrently is specified by <code>--s3-upload-concurrency</code>.</p> 6870 <p>Multipart uploads will use <code>--transfers</code> * <code>--s3-upload-concurrency</code> * <code>--s3-chunk-size</code> extra memory. Single part uploads to not use extra memory.</p> 6871 <p>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.</p> 6872 <p>Increasing <code>--s3-upload-concurrency</code> will increase throughput (8 would be a sensible value) and increasing <code>--s3-chunk-size</code> 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.</p> 6873 <h3 id="buckets-and-regions">Buckets and Regions</h3> 6874 <p>With Amazon S3 you can list buckets (<code>rclone lsd</code>) 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, <code>incorrect region, the bucket is not in 'XXX' region</code>.</p> 6875 <h3 id="authentication-4">Authentication</h3> 6876 <p>There are a number of ways to supply <code>rclone</code> with a set of AWS credentials, with and without using the environment.</p> 6877 <p>The different authentication methods are tried in this order:</p> 6878 <ul> 6879 <li>Directly in the rclone configuration file (<code>env_auth = false</code> in the config file): 6880 <ul> 6881 <li><code>access_key_id</code> and <code>secret_access_key</code> are required.</li> 6882 <li><code>session_token</code> can be optionally set when using AWS STS.</li> 6883 </ul></li> 6884 <li>Runtime configuration (<code>env_auth = true</code> in the config file): 6885 <ul> 6886 <li>Export the following environment variables before running <code>rclone</code>: 6887 <ul> 6888 <li>Access Key ID: <code>AWS_ACCESS_KEY_ID</code> or <code>AWS_ACCESS_KEY</code></li> 6889 <li>Secret Access Key: <code>AWS_SECRET_ACCESS_KEY</code> or <code>AWS_SECRET_KEY</code></li> 6890 <li>Session Token: <code>AWS_SESSION_TOKEN</code> (optional)</li> 6891 </ul></li> 6892 <li>Or, use a <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html">named profile</a>: 6893 <ul> 6894 <li>Profile files are standard files used by AWS CLI tools</li> 6895 <li>By default it will use the profile in your home directory (eg <code>~/.aws/credentials</code> on unix based systems) file and the “default” profile, to change set these environment variables: 6896 <ul> 6897 <li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file.</li> 6898 <li><code>AWS_PROFILE</code> to control which profile to use.</li> 6899 </ul></li> 6900 </ul></li> 6901 <li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS only).</li> 6902 <li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS only).</li> 6903 <li>Or, run <code>rclone</code> in an EKS pod with an IAM role that is associated with a service account (AWS only).</li> 6904 </ul></li> 6905 </ul> 6906 <p>If none of these option actually end up providing <code>rclone</code> with AWS credentials then S3 interaction will be non-authenticated (see below).</p> 6907 <h3 id="s3-permissions">S3 Permissions</h3> 6908 <p>When using the <code>sync</code> subcommand of <code>rclone</code> the following minimum permissions are required to be available on the bucket being written to:</p> 6909 <ul> 6910 <li><code>ListBucket</code></li> 6911 <li><code>DeleteObject</code></li> 6912 <li><code>GetObject</code></li> 6913 <li><code>PutObject</code></li> 6914 <li><code>PutObjectACL</code></li> 6915 </ul> 6916 <p>When using the <code>lsd</code> subcommand, the <code>ListAllMyBuckets</code> permission is required.</p> 6917 <p>Example policy:</p> 6918 <pre><code>{ 6919 "Version": "2012-10-17", 6920 "Statement": [ 6921 { 6922 "Effect": "Allow", 6923 "Principal": { 6924 "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" 6925 }, 6926 "Action": [ 6927 "s3:ListBucket", 6928 "s3:DeleteObject", 6929 "s3:GetObject", 6930 "s3:PutObject", 6931 "s3:PutObjectAcl" 6932 ], 6933 "Resource": [ 6934 "arn:aws:s3:::BUCKET_NAME/*", 6935 "arn:aws:s3:::BUCKET_NAME" 6936 ] 6937 }, 6938 { 6939 "Effect": "Allow", 6940 "Action": "s3:ListAllMyBuckets", 6941 "Resource": "arn:aws:s3:::*" 6942 } 6943 ] 6944 }</code></pre> 6945 <p>Notes on above:</p> 6946 <ol type="1"> 6947 <li>This is a policy that can be used when creating bucket. It assumes that <code>USER_NAME</code> has been created.</li> 6948 <li>The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket’s objects.</li> 6949 </ol> 6950 <p>For reference, <a href="https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b">here’s an Ansible script</a> that will generate one or more buckets that will work with <code>rclone sync</code>.</p> 6951 <h3 id="key-management-system-kms">Key Management System (KMS)</h3> 6952 <p>If you are using server side encryption with KMS then you will find you can’t transfer small objects. As a work-around you can use the <code>--ignore-checksum</code> flag.</p> 6953 <p>A proper fix is being worked on in <a href="https://github.com/rclone/rclone/issues/1824">issue #1824</a>.</p> 6954 <h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep Archive</h3> 6955 <p>You can upload objects using the glacier storage class or transition them to glacier using a <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html">lifecycle policy</a>. 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.</p> 6956 <pre><code>2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file</code></pre> 6957 <p>In this case you need to <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html">restore</a> the object(s) in question before using rclone.</p> 6958 <p>Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults.</p> 6959 <h3 id="standard-options-3">Standard Options</h3> 6960 <p>Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).</p> 6961 <h4 id="s3-provider">–s3-provider</h4> 6962 <p>Choose your S3 provider.</p> 6963 <ul> 6964 <li>Config: provider</li> 6965 <li>Env Var: RCLONE_S3_PROVIDER</li> 6966 <li>Type: string</li> 6967 <li>Default: ""</li> 6968 <li>Examples: 6969 <ul> 6970 <li>“AWS” 6971 <ul> 6972 <li>Amazon Web Services (AWS) S3</li> 6973 </ul></li> 6974 <li>“Alibaba” 6975 <ul> 6976 <li>Alibaba Cloud Object Storage System (OSS) formerly Aliyun</li> 6977 </ul></li> 6978 <li>“Ceph” 6979 <ul> 6980 <li>Ceph Object Storage</li> 6981 </ul></li> 6982 <li>“DigitalOcean” 6983 <ul> 6984 <li>Digital Ocean Spaces</li> 6985 </ul></li> 6986 <li>“Dreamhost” 6987 <ul> 6988 <li>Dreamhost DreamObjects</li> 6989 </ul></li> 6990 <li>“IBMCOS” 6991 <ul> 6992 <li>IBM COS S3</li> 6993 </ul></li> 6994 <li>“Minio” 6995 <ul> 6996 <li>Minio Object Storage</li> 6997 </ul></li> 6998 <li>“Netease” 6999 <ul> 7000 <li>Netease Object Storage (NOS)</li> 7001 </ul></li> 7002 <li>“StackPath” 7003 <ul> 7004 <li>StackPath Object Storage</li> 7005 </ul></li> 7006 <li>“Wasabi” 7007 <ul> 7008 <li>Wasabi Object Storage</li> 7009 </ul></li> 7010 <li>“Other” 7011 <ul> 7012 <li>Any other S3 compatible provider</li> 7013 </ul></li> 7014 </ul></li> 7015 </ul> 7016 <h4 id="s3-env-auth">–s3-env-auth</h4> 7017 <p>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.</p> 7018 <ul> 7019 <li>Config: env_auth</li> 7020 <li>Env Var: RCLONE_S3_ENV_AUTH</li> 7021 <li>Type: bool</li> 7022 <li>Default: false</li> 7023 <li>Examples: 7024 <ul> 7025 <li>“false” 7026 <ul> 7027 <li>Enter AWS credentials in the next step</li> 7028 </ul></li> 7029 <li>“true” 7030 <ul> 7031 <li>Get AWS credentials from the environment (env vars or IAM)</li> 7032 </ul></li> 7033 </ul></li> 7034 </ul> 7035 <h4 id="s3-access-key-id">–s3-access-key-id</h4> 7036 <p>AWS Access Key ID. Leave blank for anonymous access or runtime credentials.</p> 7037 <ul> 7038 <li>Config: access_key_id</li> 7039 <li>Env Var: RCLONE_S3_ACCESS_KEY_ID</li> 7040 <li>Type: string</li> 7041 <li>Default: ""</li> 7042 </ul> 7043 <h4 id="s3-secret-access-key">–s3-secret-access-key</h4> 7044 <p>AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials.</p> 7045 <ul> 7046 <li>Config: secret_access_key</li> 7047 <li>Env Var: RCLONE_S3_SECRET_ACCESS_KEY</li> 7048 <li>Type: string</li> 7049 <li>Default: ""</li> 7050 </ul> 7051 <h4 id="s3-region">–s3-region</h4> 7052 <p>Region to connect to.</p> 7053 <ul> 7054 <li>Config: region</li> 7055 <li>Env Var: RCLONE_S3_REGION</li> 7056 <li>Type: string</li> 7057 <li>Default: ""</li> 7058 <li>Examples: 7059 <ul> 7060 <li>“us-east-1” 7061 <ul> 7062 <li>The default endpoint - a good choice if you are unsure.</li> 7063 <li>US Region, Northern Virginia or Pacific Northwest.</li> 7064 <li>Leave location constraint empty.</li> 7065 </ul></li> 7066 <li>“us-east-2” 7067 <ul> 7068 <li>US East (Ohio) Region</li> 7069 <li>Needs location constraint us-east-2.</li> 7070 </ul></li> 7071 <li>“us-west-2” 7072 <ul> 7073 <li>US West (Oregon) Region</li> 7074 <li>Needs location constraint us-west-2.</li> 7075 </ul></li> 7076 <li>“us-west-1” 7077 <ul> 7078 <li>US West (Northern California) Region</li> 7079 <li>Needs location constraint us-west-1.</li> 7080 </ul></li> 7081 <li>“ca-central-1” 7082 <ul> 7083 <li>Canada (Central) Region</li> 7084 <li>Needs location constraint ca-central-1.</li> 7085 </ul></li> 7086 <li>“eu-west-1” 7087 <ul> 7088 <li>EU (Ireland) Region</li> 7089 <li>Needs location constraint EU or eu-west-1.</li> 7090 </ul></li> 7091 <li>“eu-west-2” 7092 <ul> 7093 <li>EU (London) Region</li> 7094 <li>Needs location constraint eu-west-2.</li> 7095 </ul></li> 7096 <li>“eu-north-1” 7097 <ul> 7098 <li>EU (Stockholm) Region</li> 7099 <li>Needs location constraint eu-north-1.</li> 7100 </ul></li> 7101 <li>“eu-central-1” 7102 <ul> 7103 <li>EU (Frankfurt) Region</li> 7104 <li>Needs location constraint eu-central-1.</li> 7105 </ul></li> 7106 <li>“ap-southeast-1” 7107 <ul> 7108 <li>Asia Pacific (Singapore) Region</li> 7109 <li>Needs location constraint ap-southeast-1.</li> 7110 </ul></li> 7111 <li>“ap-southeast-2” 7112 <ul> 7113 <li>Asia Pacific (Sydney) Region</li> 7114 <li>Needs location constraint ap-southeast-2.</li> 7115 </ul></li> 7116 <li>“ap-northeast-1” 7117 <ul> 7118 <li>Asia Pacific (Tokyo) Region</li> 7119 <li>Needs location constraint ap-northeast-1.</li> 7120 </ul></li> 7121 <li>“ap-northeast-2” 7122 <ul> 7123 <li>Asia Pacific (Seoul)</li> 7124 <li>Needs location constraint ap-northeast-2.</li> 7125 </ul></li> 7126 <li>“ap-south-1” 7127 <ul> 7128 <li>Asia Pacific (Mumbai)</li> 7129 <li>Needs location constraint ap-south-1.</li> 7130 </ul></li> 7131 <li>“ap-east-1” 7132 <ul> 7133 <li>Asia Patific (Hong Kong) Region</li> 7134 <li>Needs location constraint ap-east-1.</li> 7135 </ul></li> 7136 <li>“sa-east-1” 7137 <ul> 7138 <li>South America (Sao Paulo) Region</li> 7139 <li>Needs location constraint sa-east-1.</li> 7140 </ul></li> 7141 </ul></li> 7142 </ul> 7143 <h4 id="s3-region-1">–s3-region</h4> 7144 <p>Region to connect to. Leave blank if you are using an S3 clone and you don’t have a region.</p> 7145 <ul> 7146 <li>Config: region</li> 7147 <li>Env Var: RCLONE_S3_REGION</li> 7148 <li>Type: string</li> 7149 <li>Default: ""</li> 7150 <li>Examples: 7151 <ul> 7152 <li>"" 7153 <ul> 7154 <li>Use this if unsure. Will use v4 signatures and an empty region.</li> 7155 </ul></li> 7156 <li>“other-v2-signature” 7157 <ul> 7158 <li>Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH.</li> 7159 </ul></li> 7160 </ul></li> 7161 </ul> 7162 <h4 id="s3-endpoint">–s3-endpoint</h4> 7163 <p>Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region.</p> 7164 <ul> 7165 <li>Config: endpoint</li> 7166 <li>Env Var: RCLONE_S3_ENDPOINT</li> 7167 <li>Type: string</li> 7168 <li>Default: ""</li> 7169 </ul> 7170 <h4 id="s3-endpoint-1">–s3-endpoint</h4> 7171 <p>Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise.</p> 7172 <ul> 7173 <li>Config: endpoint</li> 7174 <li>Env Var: RCLONE_S3_ENDPOINT</li> 7175 <li>Type: string</li> 7176 <li>Default: ""</li> 7177 <li>Examples: 7178 <ul> 7179 <li>“s3-api.us-geo.objectstorage.softlayer.net” 7180 <ul> 7181 <li>US Cross Region Endpoint</li> 7182 </ul></li> 7183 <li>“s3-api.dal.us-geo.objectstorage.softlayer.net” 7184 <ul> 7185 <li>US Cross Region Dallas Endpoint</li> 7186 </ul></li> 7187 <li>“s3-api.wdc-us-geo.objectstorage.softlayer.net” 7188 <ul> 7189 <li>US Cross Region Washington DC Endpoint</li> 7190 </ul></li> 7191 <li>“s3-api.sjc-us-geo.objectstorage.softlayer.net” 7192 <ul> 7193 <li>US Cross Region San Jose Endpoint</li> 7194 </ul></li> 7195 <li>“s3-api.us-geo.objectstorage.service.networklayer.com” 7196 <ul> 7197 <li>US Cross Region Private Endpoint</li> 7198 </ul></li> 7199 <li>“s3-api.dal-us-geo.objectstorage.service.networklayer.com” 7200 <ul> 7201 <li>US Cross Region Dallas Private Endpoint</li> 7202 </ul></li> 7203 <li>“s3-api.wdc-us-geo.objectstorage.service.networklayer.com” 7204 <ul> 7205 <li>US Cross Region Washington DC Private Endpoint</li> 7206 </ul></li> 7207 <li>“s3-api.sjc-us-geo.objectstorage.service.networklayer.com” 7208 <ul> 7209 <li>US Cross Region San Jose Private Endpoint</li> 7210 </ul></li> 7211 <li>“s3.us-east.objectstorage.softlayer.net” 7212 <ul> 7213 <li>US Region East Endpoint</li> 7214 </ul></li> 7215 <li>“s3.us-east.objectstorage.service.networklayer.com” 7216 <ul> 7217 <li>US Region East Private Endpoint</li> 7218 </ul></li> 7219 <li>“s3.us-south.objectstorage.softlayer.net” 7220 <ul> 7221 <li>US Region South Endpoint</li> 7222 </ul></li> 7223 <li>“s3.us-south.objectstorage.service.networklayer.com” 7224 <ul> 7225 <li>US Region South Private Endpoint</li> 7226 </ul></li> 7227 <li>“s3.eu-geo.objectstorage.softlayer.net” 7228 <ul> 7229 <li>EU Cross Region Endpoint</li> 7230 </ul></li> 7231 <li>“s3.fra-eu-geo.objectstorage.softlayer.net” 7232 <ul> 7233 <li>EU Cross Region Frankfurt Endpoint</li> 7234 </ul></li> 7235 <li>“s3.mil-eu-geo.objectstorage.softlayer.net” 7236 <ul> 7237 <li>EU Cross Region Milan Endpoint</li> 7238 </ul></li> 7239 <li>“s3.ams-eu-geo.objectstorage.softlayer.net” 7240 <ul> 7241 <li>EU Cross Region Amsterdam Endpoint</li> 7242 </ul></li> 7243 <li>“s3.eu-geo.objectstorage.service.networklayer.com” 7244 <ul> 7245 <li>EU Cross Region Private Endpoint</li> 7246 </ul></li> 7247 <li>“s3.fra-eu-geo.objectstorage.service.networklayer.com” 7248 <ul> 7249 <li>EU Cross Region Frankfurt Private Endpoint</li> 7250 </ul></li> 7251 <li>“s3.mil-eu-geo.objectstorage.service.networklayer.com” 7252 <ul> 7253 <li>EU Cross Region Milan Private Endpoint</li> 7254 </ul></li> 7255 <li>“s3.ams-eu-geo.objectstorage.service.networklayer.com” 7256 <ul> 7257 <li>EU Cross Region Amsterdam Private Endpoint</li> 7258 </ul></li> 7259 <li>“s3.eu-gb.objectstorage.softlayer.net” 7260 <ul> 7261 <li>Great Britain Endpoint</li> 7262 </ul></li> 7263 <li>“s3.eu-gb.objectstorage.service.networklayer.com” 7264 <ul> 7265 <li>Great Britain Private Endpoint</li> 7266 </ul></li> 7267 <li>“s3.ap-geo.objectstorage.softlayer.net” 7268 <ul> 7269 <li>APAC Cross Regional Endpoint</li> 7270 </ul></li> 7271 <li>“s3.tok-ap-geo.objectstorage.softlayer.net” 7272 <ul> 7273 <li>APAC Cross Regional Tokyo Endpoint</li> 7274 </ul></li> 7275 <li>“s3.hkg-ap-geo.objectstorage.softlayer.net” 7276 <ul> 7277 <li>APAC Cross Regional HongKong Endpoint</li> 7278 </ul></li> 7279 <li>“s3.seo-ap-geo.objectstorage.softlayer.net” 7280 <ul> 7281 <li>APAC Cross Regional Seoul Endpoint</li> 7282 </ul></li> 7283 <li>“s3.ap-geo.objectstorage.service.networklayer.com” 7284 <ul> 7285 <li>APAC Cross Regional Private Endpoint</li> 7286 </ul></li> 7287 <li>“s3.tok-ap-geo.objectstorage.service.networklayer.com” 7288 <ul> 7289 <li>APAC Cross Regional Tokyo Private Endpoint</li> 7290 </ul></li> 7291 <li>“s3.hkg-ap-geo.objectstorage.service.networklayer.com” 7292 <ul> 7293 <li>APAC Cross Regional HongKong Private Endpoint</li> 7294 </ul></li> 7295 <li>“s3.seo-ap-geo.objectstorage.service.networklayer.com” 7296 <ul> 7297 <li>APAC Cross Regional Seoul Private Endpoint</li> 7298 </ul></li> 7299 <li>“s3.mel01.objectstorage.softlayer.net” 7300 <ul> 7301 <li>Melbourne Single Site Endpoint</li> 7302 </ul></li> 7303 <li>“s3.mel01.objectstorage.service.networklayer.com” 7304 <ul> 7305 <li>Melbourne Single Site Private Endpoint</li> 7306 </ul></li> 7307 <li>“s3.tor01.objectstorage.softlayer.net” 7308 <ul> 7309 <li>Toronto Single Site Endpoint</li> 7310 </ul></li> 7311 <li>“s3.tor01.objectstorage.service.networklayer.com” 7312 <ul> 7313 <li>Toronto Single Site Private Endpoint</li> 7314 </ul></li> 7315 </ul></li> 7316 </ul> 7317 <h4 id="s3-endpoint-2">–s3-endpoint</h4> 7318 <p>Endpoint for OSS API.</p> 7319 <ul> 7320 <li>Config: endpoint</li> 7321 <li>Env Var: RCLONE_S3_ENDPOINT</li> 7322 <li>Type: string</li> 7323 <li>Default: ""</li> 7324 <li>Examples: 7325 <ul> 7326 <li>“oss-cn-hangzhou.aliyuncs.com” 7327 <ul> 7328 <li>East China 1 (Hangzhou)</li> 7329 </ul></li> 7330 <li>“oss-cn-shanghai.aliyuncs.com” 7331 <ul> 7332 <li>East China 2 (Shanghai)</li> 7333 </ul></li> 7334 <li>“oss-cn-qingdao.aliyuncs.com” 7335 <ul> 7336 <li>North China 1 (Qingdao)</li> 7337 </ul></li> 7338 <li>“oss-cn-beijing.aliyuncs.com” 7339 <ul> 7340 <li>North China 2 (Beijing)</li> 7341 </ul></li> 7342 <li>“oss-cn-zhangjiakou.aliyuncs.com” 7343 <ul> 7344 <li>North China 3 (Zhangjiakou)</li> 7345 </ul></li> 7346 <li>“oss-cn-huhehaote.aliyuncs.com” 7347 <ul> 7348 <li>North China 5 (Huhehaote)</li> 7349 </ul></li> 7350 <li>“oss-cn-shenzhen.aliyuncs.com” 7351 <ul> 7352 <li>South China 1 (Shenzhen)</li> 7353 </ul></li> 7354 <li>“oss-cn-hongkong.aliyuncs.com” 7355 <ul> 7356 <li>Hong Kong (Hong Kong)</li> 7357 </ul></li> 7358 <li>“oss-us-west-1.aliyuncs.com” 7359 <ul> 7360 <li>US West 1 (Silicon Valley)</li> 7361 </ul></li> 7362 <li>“oss-us-east-1.aliyuncs.com” 7363 <ul> 7364 <li>US East 1 (Virginia)</li> 7365 </ul></li> 7366 <li>“oss-ap-southeast-1.aliyuncs.com” 7367 <ul> 7368 <li>Southeast Asia Southeast 1 (Singapore)</li> 7369 </ul></li> 7370 <li>“oss-ap-southeast-2.aliyuncs.com” 7371 <ul> 7372 <li>Asia Pacific Southeast 2 (Sydney)</li> 7373 </ul></li> 7374 <li>“oss-ap-southeast-3.aliyuncs.com” 7375 <ul> 7376 <li>Southeast Asia Southeast 3 (Kuala Lumpur)</li> 7377 </ul></li> 7378 <li>“oss-ap-southeast-5.aliyuncs.com” 7379 <ul> 7380 <li>Asia Pacific Southeast 5 (Jakarta)</li> 7381 </ul></li> 7382 <li>“oss-ap-northeast-1.aliyuncs.com” 7383 <ul> 7384 <li>Asia Pacific Northeast 1 (Japan)</li> 7385 </ul></li> 7386 <li>“oss-ap-south-1.aliyuncs.com” 7387 <ul> 7388 <li>Asia Pacific South 1 (Mumbai)</li> 7389 </ul></li> 7390 <li>“oss-eu-central-1.aliyuncs.com” 7391 <ul> 7392 <li>Central Europe 1 (Frankfurt)</li> 7393 </ul></li> 7394 <li>“oss-eu-west-1.aliyuncs.com” 7395 <ul> 7396 <li>West Europe (London)</li> 7397 </ul></li> 7398 <li>“oss-me-east-1.aliyuncs.com” 7399 <ul> 7400 <li>Middle East 1 (Dubai)</li> 7401 </ul></li> 7402 </ul></li> 7403 </ul> 7404 <h4 id="s3-endpoint-3">–s3-endpoint</h4> 7405 <p>Endpoint for StackPath Object Storage.</p> 7406 <ul> 7407 <li>Config: endpoint</li> 7408 <li>Env Var: RCLONE_S3_ENDPOINT</li> 7409 <li>Type: string</li> 7410 <li>Default: ""</li> 7411 <li>Examples: 7412 <ul> 7413 <li>“s3.us-east-2.stackpathstorage.com” 7414 <ul> 7415 <li>US East Endpoint</li> 7416 </ul></li> 7417 <li>“s3.us-west-1.stackpathstorage.com” 7418 <ul> 7419 <li>US West Endpoint</li> 7420 </ul></li> 7421 <li>“s3.eu-central-1.stackpathstorage.com” 7422 <ul> 7423 <li>EU Endpoint</li> 7424 </ul></li> 7425 </ul></li> 7426 </ul> 7427 <h4 id="s3-endpoint-4">–s3-endpoint</h4> 7428 <p>Endpoint for S3 API. Required when using an S3 clone.</p> 7429 <ul> 7430 <li>Config: endpoint</li> 7431 <li>Env Var: RCLONE_S3_ENDPOINT</li> 7432 <li>Type: string</li> 7433 <li>Default: ""</li> 7434 <li>Examples: 7435 <ul> 7436 <li>“objects-us-east-1.dream.io” 7437 <ul> 7438 <li>Dream Objects endpoint</li> 7439 </ul></li> 7440 <li>“nyc3.digitaloceanspaces.com” 7441 <ul> 7442 <li>Digital Ocean Spaces New York 3</li> 7443 </ul></li> 7444 <li>“ams3.digitaloceanspaces.com” 7445 <ul> 7446 <li>Digital Ocean Spaces Amsterdam 3</li> 7447 </ul></li> 7448 <li>“sgp1.digitaloceanspaces.com” 7449 <ul> 7450 <li>Digital Ocean Spaces Singapore 1</li> 7451 </ul></li> 7452 <li>“s3.wasabisys.com” 7453 <ul> 7454 <li>Wasabi US East endpoint</li> 7455 </ul></li> 7456 <li>“s3.us-west-1.wasabisys.com” 7457 <ul> 7458 <li>Wasabi US West endpoint</li> 7459 </ul></li> 7460 <li>“s3.eu-central-1.wasabisys.com” 7461 <ul> 7462 <li>Wasabi EU Central endpoint</li> 7463 </ul></li> 7464 </ul></li> 7465 </ul> 7466 <h4 id="s3-location-constraint">–s3-location-constraint</h4> 7467 <p>Location constraint - must be set to match the Region. Used when creating buckets only.</p> 7468 <ul> 7469 <li>Config: location_constraint</li> 7470 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 7471 <li>Type: string</li> 7472 <li>Default: ""</li> 7473 <li>Examples: 7474 <ul> 7475 <li>"" 7476 <ul> 7477 <li>Empty for US Region, Northern Virginia or Pacific Northwest.</li> 7478 </ul></li> 7479 <li>“us-east-2” 7480 <ul> 7481 <li>US East (Ohio) Region.</li> 7482 </ul></li> 7483 <li>“us-west-2” 7484 <ul> 7485 <li>US West (Oregon) Region.</li> 7486 </ul></li> 7487 <li>“us-west-1” 7488 <ul> 7489 <li>US West (Northern California) Region.</li> 7490 </ul></li> 7491 <li>“ca-central-1” 7492 <ul> 7493 <li>Canada (Central) Region.</li> 7494 </ul></li> 7495 <li>“eu-west-1” 7496 <ul> 7497 <li>EU (Ireland) Region.</li> 7498 </ul></li> 7499 <li>“eu-west-2” 7500 <ul> 7501 <li>EU (London) Region.</li> 7502 </ul></li> 7503 <li>“eu-north-1” 7504 <ul> 7505 <li>EU (Stockholm) Region.</li> 7506 </ul></li> 7507 <li>“EU” 7508 <ul> 7509 <li>EU Region.</li> 7510 </ul></li> 7511 <li>“ap-southeast-1” 7512 <ul> 7513 <li>Asia Pacific (Singapore) Region.</li> 7514 </ul></li> 7515 <li>“ap-southeast-2” 7516 <ul> 7517 <li>Asia Pacific (Sydney) Region.</li> 7518 </ul></li> 7519 <li>“ap-northeast-1” 7520 <ul> 7521 <li>Asia Pacific (Tokyo) Region.</li> 7522 </ul></li> 7523 <li>“ap-northeast-2” 7524 <ul> 7525 <li>Asia Pacific (Seoul)</li> 7526 </ul></li> 7527 <li>“ap-south-1” 7528 <ul> 7529 <li>Asia Pacific (Mumbai)</li> 7530 </ul></li> 7531 <li>“ap-east-1” 7532 <ul> 7533 <li>Asia Pacific (Hong Kong)</li> 7534 </ul></li> 7535 <li>“sa-east-1” 7536 <ul> 7537 <li>South America (Sao Paulo) Region.</li> 7538 </ul></li> 7539 </ul></li> 7540 </ul> 7541 <h4 id="s3-location-constraint-1">–s3-location-constraint</h4> 7542 <p>Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter</p> 7543 <ul> 7544 <li>Config: location_constraint</li> 7545 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 7546 <li>Type: string</li> 7547 <li>Default: ""</li> 7548 <li>Examples: 7549 <ul> 7550 <li>“us-standard” 7551 <ul> 7552 <li>US Cross Region Standard</li> 7553 </ul></li> 7554 <li>“us-vault” 7555 <ul> 7556 <li>US Cross Region Vault</li> 7557 </ul></li> 7558 <li>“us-cold” 7559 <ul> 7560 <li>US Cross Region Cold</li> 7561 </ul></li> 7562 <li>“us-flex” 7563 <ul> 7564 <li>US Cross Region Flex</li> 7565 </ul></li> 7566 <li>“us-east-standard” 7567 <ul> 7568 <li>US East Region Standard</li> 7569 </ul></li> 7570 <li>“us-east-vault” 7571 <ul> 7572 <li>US East Region Vault</li> 7573 </ul></li> 7574 <li>“us-east-cold” 7575 <ul> 7576 <li>US East Region Cold</li> 7577 </ul></li> 7578 <li>“us-east-flex” 7579 <ul> 7580 <li>US East Region Flex</li> 7581 </ul></li> 7582 <li>“us-south-standard” 7583 <ul> 7584 <li>US South Region Standard</li> 7585 </ul></li> 7586 <li>“us-south-vault” 7587 <ul> 7588 <li>US South Region Vault</li> 7589 </ul></li> 7590 <li>“us-south-cold” 7591 <ul> 7592 <li>US South Region Cold</li> 7593 </ul></li> 7594 <li>“us-south-flex” 7595 <ul> 7596 <li>US South Region Flex</li> 7597 </ul></li> 7598 <li>“eu-standard” 7599 <ul> 7600 <li>EU Cross Region Standard</li> 7601 </ul></li> 7602 <li>“eu-vault” 7603 <ul> 7604 <li>EU Cross Region Vault</li> 7605 </ul></li> 7606 <li>“eu-cold” 7607 <ul> 7608 <li>EU Cross Region Cold</li> 7609 </ul></li> 7610 <li>“eu-flex” 7611 <ul> 7612 <li>EU Cross Region Flex</li> 7613 </ul></li> 7614 <li>“eu-gb-standard” 7615 <ul> 7616 <li>Great Britain Standard</li> 7617 </ul></li> 7618 <li>“eu-gb-vault” 7619 <ul> 7620 <li>Great Britain Vault</li> 7621 </ul></li> 7622 <li>“eu-gb-cold” 7623 <ul> 7624 <li>Great Britain Cold</li> 7625 </ul></li> 7626 <li>“eu-gb-flex” 7627 <ul> 7628 <li>Great Britain Flex</li> 7629 </ul></li> 7630 <li>“ap-standard” 7631 <ul> 7632 <li>APAC Standard</li> 7633 </ul></li> 7634 <li>“ap-vault” 7635 <ul> 7636 <li>APAC Vault</li> 7637 </ul></li> 7638 <li>“ap-cold” 7639 <ul> 7640 <li>APAC Cold</li> 7641 </ul></li> 7642 <li>“ap-flex” 7643 <ul> 7644 <li>APAC Flex</li> 7645 </ul></li> 7646 <li>“mel01-standard” 7647 <ul> 7648 <li>Melbourne Standard</li> 7649 </ul></li> 7650 <li>“mel01-vault” 7651 <ul> 7652 <li>Melbourne Vault</li> 7653 </ul></li> 7654 <li>“mel01-cold” 7655 <ul> 7656 <li>Melbourne Cold</li> 7657 </ul></li> 7658 <li>“mel01-flex” 7659 <ul> 7660 <li>Melbourne Flex</li> 7661 </ul></li> 7662 <li>“tor01-standard” 7663 <ul> 7664 <li>Toronto Standard</li> 7665 </ul></li> 7666 <li>“tor01-vault” 7667 <ul> 7668 <li>Toronto Vault</li> 7669 </ul></li> 7670 <li>“tor01-cold” 7671 <ul> 7672 <li>Toronto Cold</li> 7673 </ul></li> 7674 <li>“tor01-flex” 7675 <ul> 7676 <li>Toronto Flex</li> 7677 </ul></li> 7678 </ul></li> 7679 </ul> 7680 <h4 id="s3-location-constraint-2">–s3-location-constraint</h4> 7681 <p>Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only.</p> 7682 <ul> 7683 <li>Config: location_constraint</li> 7684 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 7685 <li>Type: string</li> 7686 <li>Default: ""</li> 7687 </ul> 7688 <h4 id="s3-acl">–s3-acl</h4> 7689 <p>Canned ACL used when creating buckets and storing or copying objects.</p> 7690 <p>This ACL is used for creating objects and if bucket_acl isn’t set, for creating buckets too.</p> 7691 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 7692 <p>Note that this ACL is applied when server side copying objects as S3 doesn’t copy the ACL from the source but rather writes a fresh one.</p> 7693 <ul> 7694 <li>Config: acl</li> 7695 <li>Env Var: RCLONE_S3_ACL</li> 7696 <li>Type: string</li> 7697 <li>Default: ""</li> 7698 <li>Examples: 7699 <ul> 7700 <li>“private” 7701 <ul> 7702 <li>Owner gets FULL_CONTROL. No one else has access rights (default).</li> 7703 </ul></li> 7704 <li>“public-read” 7705 <ul> 7706 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ access.</li> 7707 </ul></li> 7708 <li>“public-read-write” 7709 <ul> 7710 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.</li> 7711 <li>Granting this on a bucket is generally not recommended.</li> 7712 </ul></li> 7713 <li>“authenticated-read” 7714 <ul> 7715 <li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.</li> 7716 </ul></li> 7717 <li>“bucket-owner-read” 7718 <ul> 7719 <li>Object owner gets FULL_CONTROL. Bucket owner gets READ access.</li> 7720 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 7721 </ul></li> 7722 <li>“bucket-owner-full-control” 7723 <ul> 7724 <li>Both the object owner and the bucket owner get FULL_CONTROL over the object.</li> 7725 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 7726 </ul></li> 7727 <li>“private” 7728 <ul> 7729 <li>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</li> 7730 </ul></li> 7731 <li>“public-read” 7732 <ul> 7733 <li>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</li> 7734 </ul></li> 7735 <li>“public-read-write” 7736 <ul> 7737 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS</li> 7738 </ul></li> 7739 <li>“authenticated-read” 7740 <ul> 7741 <li>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</li> 7742 </ul></li> 7743 </ul></li> 7744 </ul> 7745 <h4 id="s3-server-side-encryption">–s3-server-side-encryption</h4> 7746 <p>The server-side encryption algorithm used when storing this object in S3.</p> 7747 <ul> 7748 <li>Config: server_side_encryption</li> 7749 <li>Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION</li> 7750 <li>Type: string</li> 7751 <li>Default: ""</li> 7752 <li>Examples: 7753 <ul> 7754 <li>"" 7755 <ul> 7756 <li>None</li> 7757 </ul></li> 7758 <li>“AES256” 7759 <ul> 7760 <li>AES256</li> 7761 </ul></li> 7762 <li>“aws:kms” 7763 <ul> 7764 <li>aws:kms</li> 7765 </ul></li> 7766 </ul></li> 7767 </ul> 7768 <h4 id="s3-sse-kms-key-id">–s3-sse-kms-key-id</h4> 7769 <p>If using KMS ID you must provide the ARN of Key.</p> 7770 <ul> 7771 <li>Config: sse_kms_key_id</li> 7772 <li>Env Var: RCLONE_S3_SSE_KMS_KEY_ID</li> 7773 <li>Type: string</li> 7774 <li>Default: ""</li> 7775 <li>Examples: 7776 <ul> 7777 <li>"" 7778 <ul> 7779 <li>None</li> 7780 </ul></li> 7781 <li>"arn:aws:kms:us-east-1:*" 7782 <ul> 7783 <li>arn:aws:kms:*</li> 7784 </ul></li> 7785 </ul></li> 7786 </ul> 7787 <h4 id="s3-storage-class">–s3-storage-class</h4> 7788 <p>The storage class to use when storing new objects in S3.</p> 7789 <ul> 7790 <li>Config: storage_class</li> 7791 <li>Env Var: RCLONE_S3_STORAGE_CLASS</li> 7792 <li>Type: string</li> 7793 <li>Default: ""</li> 7794 <li>Examples: 7795 <ul> 7796 <li>"" 7797 <ul> 7798 <li>Default</li> 7799 </ul></li> 7800 <li>“STANDARD” 7801 <ul> 7802 <li>Standard storage class</li> 7803 </ul></li> 7804 <li>“REDUCED_REDUNDANCY” 7805 <ul> 7806 <li>Reduced redundancy storage class</li> 7807 </ul></li> 7808 <li>“STANDARD_IA” 7809 <ul> 7810 <li>Standard Infrequent Access storage class</li> 7811 </ul></li> 7812 <li>“ONEZONE_IA” 7813 <ul> 7814 <li>One Zone Infrequent Access storage class</li> 7815 </ul></li> 7816 <li>“GLACIER” 7817 <ul> 7818 <li>Glacier storage class</li> 7819 </ul></li> 7820 <li>“DEEP_ARCHIVE” 7821 <ul> 7822 <li>Glacier Deep Archive storage class</li> 7823 </ul></li> 7824 <li>“INTELLIGENT_TIERING” 7825 <ul> 7826 <li>Intelligent-Tiering storage class</li> 7827 </ul></li> 7828 </ul></li> 7829 </ul> 7830 <h4 id="s3-storage-class-1">–s3-storage-class</h4> 7831 <p>The storage class to use when storing new objects in OSS.</p> 7832 <ul> 7833 <li>Config: storage_class</li> 7834 <li>Env Var: RCLONE_S3_STORAGE_CLASS</li> 7835 <li>Type: string</li> 7836 <li>Default: ""</li> 7837 <li>Examples: 7838 <ul> 7839 <li>"" 7840 <ul> 7841 <li>Default</li> 7842 </ul></li> 7843 <li>“STANDARD” 7844 <ul> 7845 <li>Standard storage class</li> 7846 </ul></li> 7847 <li>“GLACIER” 7848 <ul> 7849 <li>Archive storage mode.</li> 7850 </ul></li> 7851 <li>“STANDARD_IA” 7852 <ul> 7853 <li>Infrequent access storage mode.</li> 7854 </ul></li> 7855 </ul></li> 7856 </ul> 7857 <h3 id="advanced-options-2">Advanced Options</h3> 7858 <p>Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).</p> 7859 <h4 id="s3-bucket-acl">–s3-bucket-acl</h4> 7860 <p>Canned ACL used when creating buckets.</p> 7861 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 7862 <p>Note that this ACL is applied when only when creating buckets. If it isn’t set then “acl” is used instead.</p> 7863 <ul> 7864 <li>Config: bucket_acl</li> 7865 <li>Env Var: RCLONE_S3_BUCKET_ACL</li> 7866 <li>Type: string</li> 7867 <li>Default: ""</li> 7868 <li>Examples: 7869 <ul> 7870 <li>“private” 7871 <ul> 7872 <li>Owner gets FULL_CONTROL. No one else has access rights (default).</li> 7873 </ul></li> 7874 <li>“public-read” 7875 <ul> 7876 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ access.</li> 7877 </ul></li> 7878 <li>“public-read-write” 7879 <ul> 7880 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.</li> 7881 <li>Granting this on a bucket is generally not recommended.</li> 7882 </ul></li> 7883 <li>“authenticated-read” 7884 <ul> 7885 <li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.</li> 7886 </ul></li> 7887 </ul></li> 7888 </ul> 7889 <h4 id="s3-sse-customer-algorithm">–s3-sse-customer-algorithm</h4> 7890 <p>If using SSE-C, the server-side encryption algorithm used when storing this object in S3.</p> 7891 <ul> 7892 <li>Config: sse_customer_algorithm</li> 7893 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM</li> 7894 <li>Type: string</li> 7895 <li>Default: ""</li> 7896 <li>Examples: 7897 <ul> 7898 <li>"" 7899 <ul> 7900 <li>None</li> 7901 </ul></li> 7902 <li>“AES256” 7903 <ul> 7904 <li>AES256</li> 7905 </ul></li> 7906 </ul></li> 7907 </ul> 7908 <h4 id="s3-sse-customer-key">–s3-sse-customer-key</h4> 7909 <p>If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.</p> 7910 <ul> 7911 <li>Config: sse_customer_key</li> 7912 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY</li> 7913 <li>Type: string</li> 7914 <li>Default: ""</li> 7915 <li>Examples: 7916 <ul> 7917 <li>"" 7918 <ul> 7919 <li>None</li> 7920 </ul></li> 7921 </ul></li> 7922 </ul> 7923 <h4 id="s3-sse-customer-key-md5">–s3-sse-customer-key-md5</h4> 7924 <p>If using SSE-C you must provide the secret encryption key MD5 checksum.</p> 7925 <ul> 7926 <li>Config: sse_customer_key_md5</li> 7927 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5</li> 7928 <li>Type: string</li> 7929 <li>Default: ""</li> 7930 <li>Examples: 7931 <ul> 7932 <li>"" 7933 <ul> 7934 <li>None</li> 7935 </ul></li> 7936 </ul></li> 7937 </ul> 7938 <h4 id="s3-upload-cutoff">–s3-upload-cutoff</h4> 7939 <p>Cutoff for switching to chunked upload</p> 7940 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.</p> 7941 <ul> 7942 <li>Config: upload_cutoff</li> 7943 <li>Env Var: RCLONE_S3_UPLOAD_CUTOFF</li> 7944 <li>Type: SizeSuffix</li> 7945 <li>Default: 200M</li> 7946 </ul> 7947 <h4 id="s3-chunk-size">–s3-chunk-size</h4> 7948 <p>Chunk size to use for uploading.</p> 7949 <p>When uploading files larger than upload_cutoff or files with unknown size (eg from “rclone rcat” or uploaded with “rclone mount” or google photos or google docs) they will be uploaded as multipart uploads using this chunk size.</p> 7950 <p>Note that “–s3-upload-concurrency” chunks of this size are buffered in memory per transfer.</p> 7951 <p>If you are transferring large files over high speed links and you have enough memory, then increasing this will speed up the transfers.</p> 7952 <p>Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.</p> 7953 <p>Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5MB and there can be at most 10,000 chunks, this means that by default the maximum size of file you can stream upload is 48GB. If you wish to stream upload larger files then you will need to increase chunk_size.</p> 7954 <ul> 7955 <li>Config: chunk_size</li> 7956 <li>Env Var: RCLONE_S3_CHUNK_SIZE</li> 7957 <li>Type: SizeSuffix</li> 7958 <li>Default: 5M</li> 7959 </ul> 7960 <h4 id="s3-copy-cutoff">–s3-copy-cutoff</h4> 7961 <p>Cutoff for switching to multipart copy</p> 7962 <p>Any files larger than this that need to be server side copied will be copied in chunks of this size.</p> 7963 <p>The minimum is 0 and the maximum is 5GB.</p> 7964 <ul> 7965 <li>Config: copy_cutoff</li> 7966 <li>Env Var: RCLONE_S3_COPY_CUTOFF</li> 7967 <li>Type: SizeSuffix</li> 7968 <li>Default: 5G</li> 7969 </ul> 7970 <h4 id="s3-disable-checksum">–s3-disable-checksum</h4> 7971 <p>Don’t store MD5 checksum with object metadata</p> 7972 <p>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.</p> 7973 <ul> 7974 <li>Config: disable_checksum</li> 7975 <li>Env Var: RCLONE_S3_DISABLE_CHECKSUM</li> 7976 <li>Type: bool</li> 7977 <li>Default: false</li> 7978 </ul> 7979 <h4 id="s3-session-token">–s3-session-token</h4> 7980 <p>An AWS session token</p> 7981 <ul> 7982 <li>Config: session_token</li> 7983 <li>Env Var: RCLONE_S3_SESSION_TOKEN</li> 7984 <li>Type: string</li> 7985 <li>Default: ""</li> 7986 </ul> 7987 <h4 id="s3-upload-concurrency">–s3-upload-concurrency</h4> 7988 <p>Concurrency for multipart uploads.</p> 7989 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 7990 <p>If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p> 7991 <ul> 7992 <li>Config: upload_concurrency</li> 7993 <li>Env Var: RCLONE_S3_UPLOAD_CONCURRENCY</li> 7994 <li>Type: int</li> 7995 <li>Default: 4</li> 7996 </ul> 7997 <h4 id="s3-force-path-style">–s3-force-path-style</h4> 7998 <p>If true use path style access if false use virtual hosted style.</p> 7999 <p>If this is true (the default) then rclone will use path style access, if false then rclone will use virtual path style. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">the AWS S3 docs</a> for more info.</p> 8000 <p>Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to false - rclone will do this automatically based on the provider setting.</p> 8001 <ul> 8002 <li>Config: force_path_style</li> 8003 <li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li> 8004 <li>Type: bool</li> 8005 <li>Default: true</li> 8006 </ul> 8007 <h4 id="s3-v2-auth">–s3-v2-auth</h4> 8008 <p>If true use v2 authentication.</p> 8009 <p>If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.</p> 8010 <p>Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH.</p> 8011 <ul> 8012 <li>Config: v2_auth</li> 8013 <li>Env Var: RCLONE_S3_V2_AUTH</li> 8014 <li>Type: bool</li> 8015 <li>Default: false</li> 8016 </ul> 8017 <h4 id="s3-use-accelerate-endpoint">–s3-use-accelerate-endpoint</h4> 8018 <p>If true use the AWS S3 accelerated endpoint.</p> 8019 <p>See: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html">AWS S3 Transfer acceleration</a></p> 8020 <ul> 8021 <li>Config: use_accelerate_endpoint</li> 8022 <li>Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT</li> 8023 <li>Type: bool</li> 8024 <li>Default: false</li> 8025 </ul> 8026 <h4 id="s3-leave-parts-on-error">–s3-leave-parts-on-error</h4> 8027 <p>If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.</p> 8028 <p>It should be set to true for resuming uploads across different sessions.</p> 8029 <p>WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.</p> 8030 <ul> 8031 <li>Config: leave_parts_on_error</li> 8032 <li>Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR</li> 8033 <li>Type: bool</li> 8034 <li>Default: false</li> 8035 </ul> 8036 <h4 id="s3-list-chunk">–s3-list-chunk</h4> 8037 <p>Size of listing chunk (response list for each ListObject S3 request).</p> 8038 <p>This option is also known as “MaxKeys”, “max-items”, or “page-size” from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html">AWS S3</a>. In Ceph, this can be increased with the “rgw list buckets max chunk” option.</p> 8039 <ul> 8040 <li>Config: list_chunk</li> 8041 <li>Env Var: RCLONE_S3_LIST_CHUNK</li> 8042 <li>Type: int</li> 8043 <li>Default: 1000</li> 8044 </ul> 8045 <h4 id="s3-encoding">–s3-encoding</h4> 8046 <p>This sets the encoding for the backend.</p> 8047 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 8048 <ul> 8049 <li>Config: encoding</li> 8050 <li>Env Var: RCLONE_S3_ENCODING</li> 8051 <li>Type: MultiEncoder</li> 8052 <li>Default: Slash,InvalidUtf8,Dot</li> 8053 </ul> 8054 <h4 id="s3-memory-pool-flush-time">–s3-memory-pool-flush-time</h4> 8055 <p>How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.</p> 8056 <ul> 8057 <li>Config: memory_pool_flush_time</li> 8058 <li>Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME</li> 8059 <li>Type: Duration</li> 8060 <li>Default: 1m0s</li> 8061 </ul> 8062 <h4 id="s3-memory-pool-use-mmap">–s3-memory-pool-use-mmap</h4> 8063 <p>Whether to use mmap buffers in internal memory pool.</p> 8064 <ul> 8065 <li>Config: memory_pool_use_mmap</li> 8066 <li>Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP</li> 8067 <li>Type: bool</li> 8068 <li>Default: false</li> 8069 </ul> 8070 <h3 id="anonymous-access-to-public-buckets">Anonymous access to public buckets</h3> 8071 <p>If you want to use rclone to access a public bucket, configure with a blank <code>access_key_id</code> and <code>secret_access_key</code>. Your config should end up looking like this:</p> 8072 <pre><code>[anons3] 8073 type = s3 8074 provider = AWS 8075 env_auth = false 8076 access_key_id = 8077 secret_access_key = 8078 region = us-east-1 8079 endpoint = 8080 location_constraint = 8081 acl = private 8082 server_side_encryption = 8083 storage_class = </code></pre> 8084 <p>Then use it as normal with the name of the public bucket, eg</p> 8085 <pre><code>rclone lsd anons3:1000genomes</code></pre> 8086 <p>You will be able to list and copy data but not upload it.</p> 8087 <h3 id="ceph">Ceph</h3> 8088 <p><a href="https://ceph.com/">Ceph</a> is an open source unified, distributed storage system designed for excellent performance, reliability and scalability. It has an S3 compatible object storage interface.</p> 8089 <p>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:</p> 8090 <pre><code>[ceph] 8091 type = s3 8092 provider = Ceph 8093 env_auth = false 8094 access_key_id = XXX 8095 secret_access_key = YYY 8096 region = 8097 endpoint = https://ceph.endpoint.example.com 8098 location_constraint = 8099 acl = 8100 server_side_encryption = 8101 storage_class =</code></pre> 8102 <p>If you are using an older version of CEPH, eg 10.2.x Jewel, then you may need to supply the parameter <code>--s3-upload-cutoff 0</code> or put this in the config file as <code>upload_cutoff 0</code> to work around a bug which causes uploading of small files to fail.</p> 8103 <p>Note also that Ceph sometimes puts <code>/</code> 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 <code>/</code> escaped as <code>\/</code>. Make sure you only write <code>/</code> in the secret access key.</p> 8104 <p>Eg the dump from Ceph looks something like this (irrelevant keys removed).</p> 8105 <pre><code>{ 8106 "user_id": "xxx", 8107 "display_name": "xxxx", 8108 "keys": [ 8109 { 8110 "user": "xxx", 8111 "access_key": "xxxxxx", 8112 "secret_key": "xxxxxx\/xxxx" 8113 } 8114 ], 8115 }</code></pre> 8116 <p>Because this is a json dump, it is encoding the <code>/</code> as <code>\/</code>, so if you use the secret key as <code>xxxxxx/xxxx</code> it will work fine.</p> 8117 <h3 id="dreamhost">Dreamhost</h3> 8118 <p>Dreamhost <a href="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an object storage system based on CEPH.</p> 8119 <p>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:</p> 8120 <pre><code>[dreamobjects] 8121 type = s3 8122 provider = DreamHost 8123 env_auth = false 8124 access_key_id = your_access_key 8125 secret_access_key = your_secret_key 8126 region = 8127 endpoint = objects-us-west-1.dream.io 8128 location_constraint = 8129 acl = private 8130 server_side_encryption = 8131 storage_class =</code></pre> 8132 <h3 id="digitalocean-spaces">DigitalOcean Spaces</h3> 8133 <p><a href="https://www.digitalocean.com/products/object-storage/">Spaces</a> is an <a href="https://developers.digitalocean.com/documentation/spaces/">S3-interoperable</a> object storage service from cloud provider DigitalOcean.</p> 8134 <p>To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the “<a href="https://cloud.digitalocean.com/settings/api/tokens">Applications & API</a>” page of the DigitalOcean control panel. They will be needed when prompted by <code>rclone config</code> for your <code>access_key_id</code> and <code>secret_access_key</code>.</p> 8135 <p>When prompted for a <code>region</code> or <code>location_constraint</code>, press enter to use the default value. The region must be included in the <code>endpoint</code> setting (e.g. <code>nyc3.digitaloceanspaces.com</code>). The default values can be used for other settings.</p> 8136 <p>Going through the whole process of creating a new remote by running <code>rclone config</code>, each prompt should be answered as shown below:</p> 8137 <pre><code>Storage> s3 8138 env_auth> 1 8139 access_key_id> YOUR_ACCESS_KEY 8140 secret_access_key> YOUR_SECRET_KEY 8141 region> 8142 endpoint> nyc3.digitaloceanspaces.com 8143 location_constraint> 8144 acl> 8145 storage_class></code></pre> 8146 <p>The resulting configuration file should look like:</p> 8147 <pre><code>[spaces] 8148 type = s3 8149 provider = DigitalOcean 8150 env_auth = false 8151 access_key_id = YOUR_ACCESS_KEY 8152 secret_access_key = YOUR_SECRET_KEY 8153 region = 8154 endpoint = nyc3.digitaloceanspaces.com 8155 location_constraint = 8156 acl = 8157 server_side_encryption = 8158 storage_class =</code></pre> 8159 <p>Once configured, you can create a new Space and begin copying files. For example:</p> 8160 <pre><code>rclone mkdir spaces:my-new-space 8161 rclone copy /path/to/files spaces:my-new-space</code></pre> 8162 <h3 id="ibm-cos-s3">IBM COS (S3)</h3> 8163 <p>Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)</p> 8164 <p>To configure access to IBM COS S3, follow the steps below:</p> 8165 <ol type="1"> 8166 <li>Run rclone config and select n for a new remote.</li> 8167 </ol> 8168 <pre><code> 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults 8169 No remotes found - make a new one 8170 n) New remote 8171 s) Set configuration password 8172 q) Quit config 8173 n/s/q> n</code></pre> 8174 <ol start="2" type="1"> 8175 <li>Enter the name for the configuration</li> 8176 </ol> 8177 <pre><code> name> <YOUR NAME></code></pre> 8178 <ol start="3" type="1"> 8179 <li>Select “s3” storage.</li> 8180 </ol> 8181 <pre><code>Choose a number from below, or type in your own value 8182 1 / Alias for an existing remote 8183 \ "alias" 8184 2 / Amazon Drive 8185 \ "amazon cloud drive" 8186 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) 8187 \ "s3" 8188 4 / Backblaze B2 8189 \ "b2" 8190 [snip] 8191 23 / http Connection 8192 \ "http" 8193 Storage> 3</code></pre> 8194 <ol start="4" type="1"> 8195 <li>Select IBM COS as the S3 Storage Provider.</li> 8196 </ol> 8197 <pre><code>Choose the S3 provider. 8198 Choose a number from below, or type in your own value 8199 1 / Choose this option to configure Storage to AWS S3 8200 \ "AWS" 8201 2 / Choose this option to configure Storage to Ceph Systems 8202 \ "Ceph" 8203 3 / Choose this option to configure Storage to Dreamhost 8204 \ "Dreamhost" 8205 4 / Choose this option to the configure Storage to IBM COS S3 8206 \ "IBMCOS" 8207 5 / Choose this option to the configure Storage to Minio 8208 \ "Minio" 8209 Provider>4</code></pre> 8210 <ol start="5" type="1"> 8211 <li>Enter the Access Key and Secret.</li> 8212 </ol> 8213 <pre><code> AWS Access Key ID - leave blank for anonymous access or runtime credentials. 8214 access_key_id> <> 8215 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 8216 secret_access_key> <></code></pre> 8217 <ol start="6" type="1"> 8218 <li>Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address.</li> 8219 </ol> 8220 <pre><code> Endpoint for IBM COS S3 API. 8221 Specify if using an IBM COS On Premise. 8222 Choose a number from below, or type in your own value 8223 1 / US Cross Region Endpoint 8224 \ "s3-api.us-geo.objectstorage.softlayer.net" 8225 2 / US Cross Region Dallas Endpoint 8226 \ "s3-api.dal.us-geo.objectstorage.softlayer.net" 8227 3 / US Cross Region Washington DC Endpoint 8228 \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" 8229 4 / US Cross Region San Jose Endpoint 8230 \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" 8231 5 / US Cross Region Private Endpoint 8232 \ "s3-api.us-geo.objectstorage.service.networklayer.com" 8233 6 / US Cross Region Dallas Private Endpoint 8234 \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" 8235 7 / US Cross Region Washington DC Private Endpoint 8236 \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" 8237 8 / US Cross Region San Jose Private Endpoint 8238 \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" 8239 9 / US Region East Endpoint 8240 \ "s3.us-east.objectstorage.softlayer.net" 8241 10 / US Region East Private Endpoint 8242 \ "s3.us-east.objectstorage.service.networklayer.com" 8243 11 / US Region South Endpoint 8244 [snip] 8245 34 / Toronto Single Site Private Endpoint 8246 \ "s3.tor01.objectstorage.service.networklayer.com" 8247 endpoint>1</code></pre> 8248 <ol start="7" type="1"> 8249 <li>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</li> 8250 </ol> 8251 <pre><code> 1 / US Cross Region Standard 8252 \ "us-standard" 8253 2 / US Cross Region Vault 8254 \ "us-vault" 8255 3 / US Cross Region Cold 8256 \ "us-cold" 8257 4 / US Cross Region Flex 8258 \ "us-flex" 8259 5 / US East Region Standard 8260 \ "us-east-standard" 8261 6 / US East Region Vault 8262 \ "us-east-vault" 8263 7 / US East Region Cold 8264 \ "us-east-cold" 8265 8 / US East Region Flex 8266 \ "us-east-flex" 8267 9 / US South Region Standard 8268 \ "us-south-standard" 8269 10 / US South Region Vault 8270 \ "us-south-vault" 8271 [snip] 8272 32 / Toronto Flex 8273 \ "tor01-flex" 8274 location_constraint>1</code></pre> 8275 <ol start="9" type="1"> 8276 <li>Specify a canned ACL. IBM Cloud (Strorage) supports “public-read” and “private”. IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.</li> 8277 </ol> 8278 <pre><code>Canned ACL used when creating buckets and/or storing objects in S3. 8279 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 8280 Choose a number from below, or type in your own value 8281 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 8282 \ "private" 8283 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 8284 \ "public-read" 8285 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 8286 \ "public-read-write" 8287 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 8288 \ "authenticated-read" 8289 acl> 1</code></pre> 8290 <ol start="12" type="1"> 8291 <li>Review the displayed configuration and accept to save the “remote” then quit. The config file should look like this</li> 8292 </ol> 8293 <pre><code> [xxx] 8294 type = s3 8295 Provider = IBMCOS 8296 access_key_id = xxx 8297 secret_access_key = yyy 8298 endpoint = s3-api.us-geo.objectstorage.softlayer.net 8299 location_constraint = us-standard 8300 acl = private</code></pre> 8301 <ol start="13" type="1"> 8302 <li>Execute rclone commands</li> 8303 </ol> 8304 <pre><code> 1) Create a bucket. 8305 rclone mkdir IBM-COS-XREGION:newbucket 8306 2) List available buckets. 8307 rclone lsd IBM-COS-XREGION: 8308 -1 2017-11-08 21:16:22 -1 test 8309 -1 2018-02-14 20:16:39 -1 newbucket 8310 3) List contents of a bucket. 8311 rclone ls IBM-COS-XREGION:newbucket 8312 18685952 test.exe 8313 4) Copy a file from local to remote. 8314 rclone copy /Users/file.txt IBM-COS-XREGION:newbucket 8315 5) Copy a file from remote to local. 8316 rclone copy IBM-COS-XREGION:newbucket/file.txt . 8317 6) Delete a file on remote. 8318 rclone delete IBM-COS-XREGION:newbucket/file.txt</code></pre> 8319 <h3 id="minio">Minio</h3> 8320 <p><a href="https://minio.io/">Minio</a> is an object storage server built for cloud application developers and devops.</p> 8321 <p>It is very easy to install and provides an S3 compatible server which can be used by rclone.</p> 8322 <p>To use it, install Minio following the instructions <a href="https://docs.minio.io/docs/minio-quickstart-guide">here</a>.</p> 8323 <p>When it configures itself Minio will print something like this</p> 8324 <pre><code>Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 8325 AccessKey: USWUXHGYZQYFYFFIT3RE 8326 SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 8327 Region: us-east-1 8328 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis 8329 8330 Browser Access: 8331 http://192.168.1.106:9000 http://172.23.0.1:9000 8332 8333 Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide 8334 $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 8335 8336 Object API (Amazon S3 compatible): 8337 Go: https://docs.minio.io/docs/golang-client-quickstart-guide 8338 Java: https://docs.minio.io/docs/java-client-quickstart-guide 8339 Python: https://docs.minio.io/docs/python-client-quickstart-guide 8340 JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide 8341 .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide 8342 8343 Drive Capacity: 26 GiB Free, 165 GiB Total</code></pre> 8344 <p>These details need to go into <code>rclone config</code> like this. Note that it is important to put the region in as stated above.</p> 8345 <pre><code>env_auth> 1 8346 access_key_id> USWUXHGYZQYFYFFIT3RE 8347 secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 8348 region> us-east-1 8349 endpoint> http://192.168.1.106:9000 8350 location_constraint> 8351 server_side_encryption></code></pre> 8352 <p>Which makes the config file look like this</p> 8353 <pre><code>[minio] 8354 type = s3 8355 provider = Minio 8356 env_auth = false 8357 access_key_id = USWUXHGYZQYFYFFIT3RE 8358 secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 8359 region = us-east-1 8360 endpoint = http://192.168.1.106:9000 8361 location_constraint = 8362 server_side_encryption =</code></pre> 8363 <p>So once set up, for example to copy files into a bucket</p> 8364 <pre><code>rclone copy /path/to/files minio:bucket</code></pre> 8365 <h3 id="scaleway">Scaleway</h3> 8366 <p><a href="https://www.scaleway.com/object-storage/">Scaleway</a> 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.</p> 8367 <p>Scaleway provides an S3 interface which can be configured for use with rclone like this:</p> 8368 <pre><code>[scaleway] 8369 type = s3 8370 env_auth = false 8371 endpoint = s3.nl-ams.scw.cloud 8372 access_key_id = SCWXXXXXXXXXXXXXX 8373 secret_access_key = 1111111-2222-3333-44444-55555555555555 8374 region = nl-ams 8375 location_constraint = 8376 acl = private 8377 force_path_style = false 8378 server_side_encryption = 8379 storage_class =</code></pre> 8380 <h3 id="wasabi">Wasabi</h3> 8381 <p><a href="https://wasabi.com">Wasabi</a> 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.</p> 8382 <p>Wasabi provides an S3 interface which can be configured for use with rclone like this.</p> 8383 <pre><code>No remotes found - make a new one 8384 n) New remote 8385 s) Set configuration password 8386 n/s> n 8387 name> wasabi 8388 Type of storage to configure. 8389 Choose a number from below, or type in your own value 8390 [snip] 8391 XX / Amazon S3 (also Dreamhost, Ceph, Minio) 8392 \ "s3" 8393 [snip] 8394 Storage> s3 8395 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. 8396 Choose a number from below, or type in your own value 8397 1 / Enter AWS credentials in the next step 8398 \ "false" 8399 2 / Get AWS credentials from the environment (env vars or IAM) 8400 \ "true" 8401 env_auth> 1 8402 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 8403 access_key_id> YOURACCESSKEY 8404 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 8405 secret_access_key> YOURSECRETACCESSKEY 8406 Region to connect to. 8407 Choose a number from below, or type in your own value 8408 / The default endpoint - a good choice if you are unsure. 8409 1 | US Region, Northern Virginia or Pacific Northwest. 8410 | Leave location constraint empty. 8411 \ "us-east-1" 8412 [snip] 8413 region> us-east-1 8414 Endpoint for S3 API. 8415 Leave blank if using AWS to use the default endpoint for the region. 8416 Specify if using an S3 clone such as Ceph. 8417 endpoint> s3.wasabisys.com 8418 Location constraint - must be set to match the Region. Used when creating buckets only. 8419 Choose a number from below, or type in your own value 8420 1 / Empty for US Region, Northern Virginia or Pacific Northwest. 8421 \ "" 8422 [snip] 8423 location_constraint> 8424 Canned ACL used when creating buckets and/or storing objects in S3. 8425 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 8426 Choose a number from below, or type in your own value 8427 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 8428 \ "private" 8429 [snip] 8430 acl> 8431 The server-side encryption algorithm used when storing this object in S3. 8432 Choose a number from below, or type in your own value 8433 1 / None 8434 \ "" 8435 2 / AES256 8436 \ "AES256" 8437 server_side_encryption> 8438 The storage class to use when storing objects in S3. 8439 Choose a number from below, or type in your own value 8440 1 / Default 8441 \ "" 8442 2 / Standard storage class 8443 \ "STANDARD" 8444 3 / Reduced redundancy storage class 8445 \ "REDUCED_REDUNDANCY" 8446 4 / Standard Infrequent Access storage class 8447 \ "STANDARD_IA" 8448 storage_class> 8449 Remote config 8450 -------------------- 8451 [wasabi] 8452 env_auth = false 8453 access_key_id = YOURACCESSKEY 8454 secret_access_key = YOURSECRETACCESSKEY 8455 region = us-east-1 8456 endpoint = s3.wasabisys.com 8457 location_constraint = 8458 acl = 8459 server_side_encryption = 8460 storage_class = 8461 -------------------- 8462 y) Yes this is OK 8463 e) Edit this remote 8464 d) Delete this remote 8465 y/e/d> y</code></pre> 8466 <p>This will leave the config file looking like this.</p> 8467 <pre><code>[wasabi] 8468 type = s3 8469 provider = Wasabi 8470 env_auth = false 8471 access_key_id = YOURACCESSKEY 8472 secret_access_key = YOURSECRETACCESSKEY 8473 region = 8474 endpoint = s3.wasabisys.com 8475 location_constraint = 8476 acl = 8477 server_side_encryption = 8478 storage_class =</code></pre> 8479 <h3 id="alibaba-oss">Alibaba OSS</h3> 8480 <p>Here is an example of making an <a href="https://www.alibabacloud.com/product/oss/">Alibaba Cloud (Aliyun) OSS</a> configuration. First run:</p> 8481 <pre><code>rclone config</code></pre> 8482 <p>This will guide you through an interactive setup process.</p> 8483 <pre><code>No remotes found - make a new one 8484 n) New remote 8485 s) Set configuration password 8486 q) Quit config 8487 n/s/q> n 8488 name> oss 8489 Type of storage to configure. 8490 Enter a string value. Press Enter for the default (""). 8491 Choose a number from below, or type in your own value 8492 [snip] 8493 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) 8494 \ "s3" 8495 [snip] 8496 Storage> s3 8497 Choose your S3 provider. 8498 Enter a string value. Press Enter for the default (""). 8499 Choose a number from below, or type in your own value 8500 1 / Amazon Web Services (AWS) S3 8501 \ "AWS" 8502 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun 8503 \ "Alibaba" 8504 3 / Ceph Object Storage 8505 \ "Ceph" 8506 [snip] 8507 provider> Alibaba 8508 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 8509 Only applies if access_key_id and secret_access_key is blank. 8510 Enter a boolean value (true or false). Press Enter for the default ("false"). 8511 Choose a number from below, or type in your own value 8512 1 / Enter AWS credentials in the next step 8513 \ "false" 8514 2 / Get AWS credentials from the environment (env vars or IAM) 8515 \ "true" 8516 env_auth> 1 8517 AWS Access Key ID. 8518 Leave blank for anonymous access or runtime credentials. 8519 Enter a string value. Press Enter for the default (""). 8520 access_key_id> accesskeyid 8521 AWS Secret Access Key (password) 8522 Leave blank for anonymous access or runtime credentials. 8523 Enter a string value. Press Enter for the default (""). 8524 secret_access_key> secretaccesskey 8525 Endpoint for OSS API. 8526 Enter a string value. Press Enter for the default (""). 8527 Choose a number from below, or type in your own value 8528 1 / East China 1 (Hangzhou) 8529 \ "oss-cn-hangzhou.aliyuncs.com" 8530 2 / East China 2 (Shanghai) 8531 \ "oss-cn-shanghai.aliyuncs.com" 8532 3 / North China 1 (Qingdao) 8533 \ "oss-cn-qingdao.aliyuncs.com" 8534 [snip] 8535 endpoint> 1 8536 Canned ACL used when creating buckets and storing or copying objects. 8537 8538 Note that this ACL is applied when server side copying objects as S3 8539 doesn't copy the ACL from the source but rather writes a fresh one. 8540 Enter a string value. Press Enter for the default (""). 8541 Choose a number from below, or type in your own value 8542 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 8543 \ "private" 8544 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 8545 \ "public-read" 8546 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 8547 [snip] 8548 acl> 1 8549 The storage class to use when storing new objects in OSS. 8550 Enter a string value. Press Enter for the default (""). 8551 Choose a number from below, or type in your own value 8552 1 / Default 8553 \ "" 8554 2 / Standard storage class 8555 \ "STANDARD" 8556 3 / Archive storage mode. 8557 \ "GLACIER" 8558 4 / Infrequent access storage mode. 8559 \ "STANDARD_IA" 8560 storage_class> 1 8561 Edit advanced config? (y/n) 8562 y) Yes 8563 n) No 8564 y/n> n 8565 Remote config 8566 -------------------- 8567 [oss] 8568 type = s3 8569 provider = Alibaba 8570 env_auth = false 8571 access_key_id = accesskeyid 8572 secret_access_key = secretaccesskey 8573 endpoint = oss-cn-hangzhou.aliyuncs.com 8574 acl = private 8575 storage_class = Standard 8576 -------------------- 8577 y) Yes this is OK 8578 e) Edit this remote 8579 d) Delete this remote 8580 y/e/d> y</code></pre> 8581 <h3 id="netease-nos">Netease NOS</h3> 8582 <p>For Netease NOS configure as per the configurator <code>rclone config</code> setting the provider <code>Netease</code>. This will automatically set <code>force_path_style = false</code> which is necessary for it to run properly.</p> 8583 <h2 id="backblaze-b2">Backblaze B2</h2> 8584 <p>B2 is <a href="https://www.backblaze.com/b2/">Backblaze’s cloud storage system</a>.</p> 8585 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p> 8586 <p>Here is an example of making a b2 configuration. First run</p> 8587 <pre><code>rclone config</code></pre> 8588 <p>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.</p> 8589 <pre><code>No remotes found - make a new one 8590 n) New remote 8591 q) Quit config 8592 n/q> n 8593 name> remote 8594 Type of storage to configure. 8595 Choose a number from below, or type in your own value 8596 [snip] 8597 XX / Backblaze B2 8598 \ "b2" 8599 [snip] 8600 Storage> b2 8601 Account ID or Application Key ID 8602 account> 123456789abc 8603 Application Key 8604 key> 0123456789abcdef0123456789abcdef0123456789 8605 Endpoint for the service - leave blank normally. 8606 endpoint> 8607 Remote config 8608 -------------------- 8609 [remote] 8610 account = 123456789abc 8611 key = 0123456789abcdef0123456789abcdef0123456789 8612 endpoint = 8613 -------------------- 8614 y) Yes this is OK 8615 e) Edit this remote 8616 d) Delete this remote 8617 y/e/d> y</code></pre> 8618 <p>This remote is called <code>remote</code> and can now be used like this</p> 8619 <p>See all buckets</p> 8620 <pre><code>rclone lsd remote:</code></pre> 8621 <p>Create a new bucket</p> 8622 <pre><code>rclone mkdir remote:bucket</code></pre> 8623 <p>List the contents of a bucket</p> 8624 <pre><code>rclone ls remote:bucket</code></pre> 8625 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 8626 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 8627 <h3 id="application-keys">Application Keys</h3> 8628 <p>B2 supports multiple <a href="https://www.backblaze.com/b2/docs/application_keys.html">Application Keys for different access permission to B2 Buckets</a>.</p> 8629 <p>You can use these with rclone too; you will need to use rclone version 1.43 or later.</p> 8630 <p>Follow Backblaze’s docs to create an Application Key with the required permission and add the <code>applicationKeyId</code> as the <code>account</code> and the <code>Application Key</code> itself as the <code>key</code>.</p> 8631 <p>Note that you must put the <em>applicationKeyId</em> as the <code>account</code> – you can’t use the master Account ID. If you try then B2 will return 401 errors.</p> 8632 <h3 id="fast-list-2">–fast-list</h3> 8633 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 8634 <h3 id="modified-time-1">Modified time</h3> 8635 <p>The modified time is stored as metadata on the object as <code>X-Bz-Info-src_last_modified_millis</code> as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.</p> 8636 <p>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.</p> 8637 <h4 id="restricted-filename-characters-3">Restricted filename characters</h4> 8638 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 8639 <table> 8640 <thead> 8641 <tr class="header"> 8642 <th>Character</th> 8643 <th style="text-align: center;">Value</th> 8644 <th style="text-align: center;">Replacement</th> 8645 </tr> 8646 </thead> 8647 <tbody> 8648 <tr class="odd"> 8649 <td>\</td> 8650 <td style="text-align: center;">0x5C</td> 8651 <td style="text-align: center;">＼</td> 8652 </tr> 8653 </tbody> 8654 </table> 8655 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 8656 <h3 id="sha1-checksums">SHA1 checksums</h3> 8657 <p>The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.</p> 8658 <p>Large files (bigger than the limit in <code>--b2-upload-cutoff</code>) which are uploaded in chunks will store their SHA1 on the object as <code>X-Bz-Info-large_file_sha1</code> as recommended by Backblaze.</p> 8659 <p>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 <a href="https://rclone.org/overview/#features">the overview</a> for exactly which remotes support SHA1.</p> 8660 <p>Sources which don’t support SHA1, in particular <code>crypt</code> will upload large files without SHA1 checksums. This may be fixed in the future (see <a href="https://github.com/rclone/rclone/issues/1767">#1767</a>).</p> 8661 <p>Files sizes below <code>--b2-upload-cutoff</code> will always have an SHA1 regardless of the source.</p> 8662 <h3 id="transfers">Transfers</h3> 8663 <p>Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about <code>--transfers 32</code> 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 <code>--transfers 4</code> is definitely too low for Backblaze B2 though.</p> 8664 <p>Note that uploading big files (bigger than 200 MB by default) will use a 96 MB RAM buffer by default. There can be at most <code>--transfers</code> of these in use at any moment, so this sets the upper limit on the memory used.</p> 8665 <h3 id="versions">Versions</h3> 8666 <p>When rclone uploads a new version of a file it creates a <a href="https://www.backblaze.com/b2/docs/file_versions.html">new version of it</a>. Likewise when you delete a file, the old version will be marked hidden and still be available. Conversely, you may opt in to a “hard delete” of files with the <code>--b2-hard-delete</code> flag which would permanently remove the file instead of hiding it.</p> 8667 <p>Old versions of files, where available, are visible using the <code>--b2-versions</code> flag.</p> 8668 <p><strong>NB</strong> Note that <code>--b2-versions</code> does not work with crypt at the moment <a href="https://github.com/rclone/rclone/issues/1627">#1627</a>. Using <a href="https://rclone.org/docs/#backup-dir-dir">–backup-dir</a> with rclone is the recommended way of working around this.</p> 8669 <p>If you wish to remove all the old versions then you can use the <code>rclone cleanup remote:bucket</code> 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, eg <code>rclone cleanup remote:bucket/path/to/stuff</code>.</p> 8670 <p>Note that <code>cleanup</code> will remove partially uploaded files from the bucket if they are more than a day old.</p> 8671 <p>When you <code>purge</code> a bucket, the current and the old versions will be deleted then the bucket will be deleted.</p> 8672 <p>However <code>delete</code> will cause the current versions of the files to become hidden old versions.</p> 8673 <p>Here is a session showing the listing and retrieval of an old version followed by a <code>cleanup</code> of the old versions.</p> 8674 <p>Show current version and all the versions with <code>--b2-versions</code> flag.</p> 8675 <pre><code>$ rclone -q ls b2:cleanup-test 8676 9 one.txt 8677 8678 $ rclone -q --b2-versions ls b2:cleanup-test 8679 9 one.txt 8680 8 one-v2016-07-04-141032-000.txt 8681 16 one-v2016-07-04-141003-000.txt 8682 15 one-v2016-07-02-155621-000.txt</code></pre> 8683 <p>Retrieve an old version</p> 8684 <pre><code>$ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp 8685 8686 $ ls -l /tmp/one-v2016-07-04-141003-000.txt 8687 -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt</code></pre> 8688 <p>Clean up all the old versions and show that they’ve gone.</p> 8689 <pre><code>$ rclone -q cleanup b2:cleanup-test 8690 8691 $ rclone -q ls b2:cleanup-test 8692 9 one.txt 8693 8694 $ rclone -q --b2-versions ls b2:cleanup-test 8695 9 one.txt</code></pre> 8696 <h3 id="data-usage">Data usage</h3> 8697 <p>It is useful to know how many requests are sent to the server in different scenarios.</p> 8698 <p>All copy commands send the following 4 requests:</p> 8699 <pre><code>/b2api/v1/b2_authorize_account 8700 /b2api/v1/b2_create_bucket 8701 /b2api/v1/b2_list_buckets 8702 /b2api/v1/b2_list_file_names</code></pre> 8703 <p>The <code>b2_list_file_names</code> 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 <a href="https://github.com/rclone/rclone/issues/818">#818</a> 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.</p> 8704 <p>Uploading files that do not require chunking, will send 2 requests per file upload:</p> 8705 <pre><code>/b2api/v1/b2_get_upload_url 8706 /b2api/v1/b2_upload_file/</code></pre> 8707 <p>Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk:</p> 8708 <pre><code>/b2api/v1/b2_start_large_file 8709 /b2api/v1/b2_get_upload_part_url 8710 /b2api/v1/b2_upload_part/ 8711 /b2api/v1/b2_finish_large_file</code></pre> 8712 <h4 id="versions-1">Versions</h4> 8713 <p>Versions can be viewed with the <code>--b2-versions</code> flag. When it is set rclone will show and act on older versions of files. For example</p> 8714 <p>Listing without <code>--b2-versions</code></p> 8715 <pre><code>$ rclone -q ls b2:cleanup-test 8716 9 one.txt</code></pre> 8717 <p>And with</p> 8718 <pre><code>$ rclone -q --b2-versions ls b2:cleanup-test 8719 9 one.txt 8720 8 one-v2016-07-04-141032-000.txt 8721 16 one-v2016-07-04-141003-000.txt 8722 15 one-v2016-07-02-155621-000.txt</code></pre> 8723 <p>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.</p> 8724 <p>Note that when using <code>--b2-versions</code> no file write operations are permitted, so you can’t upload files or delete them.</p> 8725 <h3 id="b2-and-rclone-link">B2 and rclone link</h3> 8726 <p>Rclone supports generating file share links for private B2 buckets. They can either be for a file for example:</p> 8727 <pre><code>./rclone link B2:bucket/path/to/file.txt 8728 https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx 8729 </code></pre> 8730 <p>or if run on a directory you will get:</p> 8731 <pre><code>./rclone link B2:bucket/path 8732 https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx</code></pre> 8733 <p>you can then use the authorization token (the part of the url from the <code>?Authorization=</code> on) on any file path under that directory. For example:</p> 8734 <pre><code>https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx 8735 https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx 8736 https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx 8737 </code></pre> 8738 <h3 id="standard-options-4">Standard Options</h3> 8739 <p>Here are the standard options specific to b2 (Backblaze B2).</p> 8740 <h4 id="b2-account">–b2-account</h4> 8741 <p>Account ID or Application Key ID</p> 8742 <ul> 8743 <li>Config: account</li> 8744 <li>Env Var: RCLONE_B2_ACCOUNT</li> 8745 <li>Type: string</li> 8746 <li>Default: ""</li> 8747 </ul> 8748 <h4 id="b2-key">–b2-key</h4> 8749 <p>Application Key</p> 8750 <ul> 8751 <li>Config: key</li> 8752 <li>Env Var: RCLONE_B2_KEY</li> 8753 <li>Type: string</li> 8754 <li>Default: ""</li> 8755 </ul> 8756 <h4 id="b2-hard-delete">–b2-hard-delete</h4> 8757 <p>Permanently delete files on remote removal, otherwise hide files.</p> 8758 <ul> 8759 <li>Config: hard_delete</li> 8760 <li>Env Var: RCLONE_B2_HARD_DELETE</li> 8761 <li>Type: bool</li> 8762 <li>Default: false</li> 8763 </ul> 8764 <h3 id="advanced-options-3">Advanced Options</h3> 8765 <p>Here are the advanced options specific to b2 (Backblaze B2).</p> 8766 <h4 id="b2-endpoint">–b2-endpoint</h4> 8767 <p>Endpoint for the service. Leave blank normally.</p> 8768 <ul> 8769 <li>Config: endpoint</li> 8770 <li>Env Var: RCLONE_B2_ENDPOINT</li> 8771 <li>Type: string</li> 8772 <li>Default: ""</li> 8773 </ul> 8774 <h4 id="b2-test-mode">–b2-test-mode</h4> 8775 <p>A flag string for X-Bz-Test-Mode header for debugging.</p> 8776 <p>This is for debugging purposes only. Setting it to one of the strings below will cause b2 to return specific errors:</p> 8777 <ul> 8778 <li>“fail_some_uploads”</li> 8779 <li>“expire_some_account_authorization_tokens”</li> 8780 <li>“force_cap_exceeded”</li> 8781 </ul> 8782 <p>These will be set in the “X-Bz-Test-Mode” header which is documented in the <a href="https://www.backblaze.com/b2/docs/integration_checklist.html">b2 integrations checklist</a>.</p> 8783 <ul> 8784 <li>Config: test_mode</li> 8785 <li>Env Var: RCLONE_B2_TEST_MODE</li> 8786 <li>Type: string</li> 8787 <li>Default: ""</li> 8788 </ul> 8789 <h4 id="b2-versions">–b2-versions</h4> 8790 <p>Include old versions in directory listings. Note that when using this no file write operations are permitted, so you can’t upload files or delete them.</p> 8791 <ul> 8792 <li>Config: versions</li> 8793 <li>Env Var: RCLONE_B2_VERSIONS</li> 8794 <li>Type: bool</li> 8795 <li>Default: false</li> 8796 </ul> 8797 <h4 id="b2-upload-cutoff">–b2-upload-cutoff</h4> 8798 <p>Cutoff for switching to chunked upload.</p> 8799 <p>Files above this size will be uploaded in chunks of “–b2-chunk-size”.</p> 8800 <p>This value should be set no larger than 4.657GiB (== 5GB).</p> 8801 <ul> 8802 <li>Config: upload_cutoff</li> 8803 <li>Env Var: RCLONE_B2_UPLOAD_CUTOFF</li> 8804 <li>Type: SizeSuffix</li> 8805 <li>Default: 200M</li> 8806 </ul> 8807 <h4 id="b2-chunk-size">–b2-chunk-size</h4> 8808 <p>Upload chunk size. Must fit in memory.</p> 8809 <p>When uploading large files, chunk the file into this size. Note that these chunks are buffered in memory and there might a maximum of “–transfers” chunks in progress at once. 5,000,000 Bytes is the minimum size.</p> 8810 <ul> 8811 <li>Config: chunk_size</li> 8812 <li>Env Var: RCLONE_B2_CHUNK_SIZE</li> 8813 <li>Type: SizeSuffix</li> 8814 <li>Default: 96M</li> 8815 </ul> 8816 <h4 id="b2-disable-checksum">–b2-disable-checksum</h4> 8817 <p>Disable checksums for large (> upload cutoff) files</p> 8818 <p>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.</p> 8819 <ul> 8820 <li>Config: disable_checksum</li> 8821 <li>Env Var: RCLONE_B2_DISABLE_CHECKSUM</li> 8822 <li>Type: bool</li> 8823 <li>Default: false</li> 8824 </ul> 8825 <h4 id="b2-download-url">–b2-download-url</h4> 8826 <p>Custom endpoint for downloads.</p> 8827 <p>This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. This is probably only useful for a public bucket. Leave blank if you want to use the endpoint provided by Backblaze.</p> 8828 <ul> 8829 <li>Config: download_url</li> 8830 <li>Env Var: RCLONE_B2_DOWNLOAD_URL</li> 8831 <li>Type: string</li> 8832 <li>Default: ""</li> 8833 </ul> 8834 <h4 id="b2-download-auth-duration">–b2-download-auth-duration</h4> 8835 <p>Time before the authorization token will expire in s or suffix ms|s|m|h|d.</p> 8836 <p>The duration before the download authorization token will expire. The minimum value is 1 second. The maximum value is one week.</p> 8837 <ul> 8838 <li>Config: download_auth_duration</li> 8839 <li>Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION</li> 8840 <li>Type: Duration</li> 8841 <li>Default: 1w</li> 8842 </ul> 8843 <h4 id="b2-encoding">–b2-encoding</h4> 8844 <p>This sets the encoding for the backend.</p> 8845 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 8846 <ul> 8847 <li>Config: encoding</li> 8848 <li>Env Var: RCLONE_B2_ENCODING</li> 8849 <li>Type: MultiEncoder</li> 8850 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 8851 </ul> 8852 <h2 id="box">Box</h2> 8853 <p>Paths are specified as <code>remote:path</code></p> 8854 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 8855 <p>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. <code>rclone config</code> walks you through it.</p> 8856 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 8857 <pre><code> rclone config</code></pre> 8858 <p>This will guide you through an interactive setup process:</p> 8859 <pre><code>No remotes found - make a new one 8860 n) New remote 8861 s) Set configuration password 8862 q) Quit config 8863 n/s/q> n 8864 name> remote 8865 Type of storage to configure. 8866 Choose a number from below, or type in your own value 8867 [snip] 8868 XX / Box 8869 \ "box" 8870 [snip] 8871 Storage> box 8872 Box App Client Id - leave blank normally. 8873 client_id> 8874 Box App Client Secret - leave blank normally. 8875 client_secret> 8876 Box App config.json location 8877 Leave blank normally. 8878 Enter a string value. Press Enter for the default (""). 8879 config_json> 8880 'enterprise' or 'user' depending on the type of token being requested. 8881 Enter a string value. Press Enter for the default ("user"). 8882 box_sub_type> 8883 Remote config 8884 Use auto config? 8885 * Say Y if not sure 8886 * Say N if you are working on a remote or headless machine 8887 y) Yes 8888 n) No 8889 y/n> y 8890 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 8891 Log in and authorize rclone for access 8892 Waiting for code... 8893 Got code 8894 -------------------- 8895 [remote] 8896 client_id = 8897 client_secret = 8898 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} 8899 -------------------- 8900 y) Yes this is OK 8901 e) Edit this remote 8902 d) Delete this remote 8903 y/e/d> y</code></pre> 8904 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 8905 <p>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 <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 8906 <p>Once configured you can then use <code>rclone</code> like this,</p> 8907 <p>List directories in top level of your Box</p> 8908 <pre><code>rclone lsd remote:</code></pre> 8909 <p>List all the files in your Box</p> 8910 <pre><code>rclone ls remote:</code></pre> 8911 <p>To copy a local directory to an Box directory called backup</p> 8912 <pre><code>rclone copy /home/source remote:backup</code></pre> 8913 <h3 id="using-rclone-with-an-enterprise-account-with-sso">Using rclone with an Enterprise account with SSO</h3> 8914 <p>If you have an “Enterprise” 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, “Account” Tab, and then set the password in the “Authentication” field.</p> 8915 <p>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.</p> 8916 <h3 id="invalid-refresh-token">Invalid refresh token</h3> 8917 <p>According to the <a href="https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens">box docs</a>:</p> 8918 <blockquote> 8919 <p>Each refresh_token is valid for one use in 60 days.</p> 8920 </blockquote> 8921 <p>This means that if you</p> 8922 <ul> 8923 <li>Don’t use the box remote for 60 days</li> 8924 <li>Copy the config file with a box refresh token in and use it in two places</li> 8925 <li>Get an error on a token refresh</li> 8926 </ul> 8927 <p>then rclone will return an error which includes the text <code>Invalid refresh token</code>.</p> 8928 <p>To fix this you will need to use oauth2 again to update the refresh token. You can use the methods in <a href="https://rclone.org/remote_setup/">the remote setup docs</a>, 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.</p> 8929 <p>Here is how to do it.</p> 8930 <pre><code>$ rclone config 8931 Current remotes: 8932 8933 Name Type 8934 ==== ==== 8935 remote box 8936 8937 e) Edit existing remote 8938 n) New remote 8939 d) Delete remote 8940 r) Rename remote 8941 c) Copy remote 8942 s) Set configuration password 8943 q) Quit config 8944 e/n/d/r/c/s/q> e 8945 Choose a number from below, or type in an existing value 8946 1 > remote 8947 remote> remote 8948 -------------------- 8949 [remote] 8950 type = box 8951 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} 8952 -------------------- 8953 Edit remote 8954 Value "client_id" = "" 8955 Edit? (y/n)> 8956 y) Yes 8957 n) No 8958 y/n> n 8959 Value "client_secret" = "" 8960 Edit? (y/n)> 8961 y) Yes 8962 n) No 8963 y/n> n 8964 Remote config 8965 Already have a token - refresh? 8966 y) Yes 8967 n) No 8968 y/n> y 8969 Use auto config? 8970 * Say Y if not sure 8971 * Say N if you are working on a remote or headless machine 8972 y) Yes 8973 n) No 8974 y/n> y 8975 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 8976 Log in and authorize rclone for access 8977 Waiting for code... 8978 Got code 8979 -------------------- 8980 [remote] 8981 type = box 8982 token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} 8983 -------------------- 8984 y) Yes this is OK 8985 e) Edit this remote 8986 d) Delete this remote 8987 y/e/d> y</code></pre> 8988 <h3 id="modified-time-and-hashes-1">Modified time and hashes</h3> 8989 <p>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.</p> 8990 <p>Box supports SHA1 type hashes, so you can use the <code>--checksum</code> flag.</p> 8991 <h4 id="restricted-filename-characters-4">Restricted filename characters</h4> 8992 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 8993 <table> 8994 <thead> 8995 <tr class="header"> 8996 <th>Character</th> 8997 <th style="text-align: center;">Value</th> 8998 <th style="text-align: center;">Replacement</th> 8999 </tr> 9000 </thead> 9001 <tbody> 9002 <tr class="odd"> 9003 <td>\</td> 9004 <td style="text-align: center;">0x5C</td> 9005 <td style="text-align: center;">＼</td> 9006 </tr> 9007 </tbody> 9008 </table> 9009 <p>File names can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 9010 <table> 9011 <thead> 9012 <tr class="header"> 9013 <th>Character</th> 9014 <th style="text-align: center;">Value</th> 9015 <th style="text-align: center;">Replacement</th> 9016 </tr> 9017 </thead> 9018 <tbody> 9019 <tr class="odd"> 9020 <td>SP</td> 9021 <td style="text-align: center;">0x20</td> 9022 <td style="text-align: center;">␠</td> 9023 </tr> 9024 </tbody> 9025 </table> 9026 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 9027 <h3 id="transfers-1">Transfers</h3> 9028 <p>For files above 50MB rclone will use a chunked transfer. Rclone will upload up to <code>--transfers</code> chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 8MB so increasing <code>--transfers</code> will increase memory use.</p> 9029 <h3 id="deleting-files-1">Deleting files</h3> 9030 <p>Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.</p> 9031 <h3 id="root-folder-id">Root folder ID</h3> 9032 <p>You can set the <code>root_folder_id</code> for rclone. This is the directory (identified by its <code>Folder ID</code>) that rclone considers to be the root of your Box drive.</p> 9033 <p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p> 9034 <p>However you can set this to restrict rclone to a specific folder hierarchy.</p> 9035 <p>In order to do this you will have to find the <code>Folder ID</code> 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.</p> 9036 <p>So if the folder you want rclone to use has a URL which looks like <code>https://app.box.com/folder/11xxxxxxxxx8</code> in the browser, then you use <code>11xxxxxxxxx8</code> as the <code>root_folder_id</code> in the config.</p> 9037 <h3 id="standard-options-5">Standard Options</h3> 9038 <p>Here are the standard options specific to box (Box).</p> 9039 <h4 id="box-client-id">–box-client-id</h4> 9040 <p>Box App Client Id. Leave blank normally.</p> 9041 <ul> 9042 <li>Config: client_id</li> 9043 <li>Env Var: RCLONE_BOX_CLIENT_ID</li> 9044 <li>Type: string</li> 9045 <li>Default: ""</li> 9046 </ul> 9047 <h4 id="box-client-secret">–box-client-secret</h4> 9048 <p>Box App Client Secret Leave blank normally.</p> 9049 <ul> 9050 <li>Config: client_secret</li> 9051 <li>Env Var: RCLONE_BOX_CLIENT_SECRET</li> 9052 <li>Type: string</li> 9053 <li>Default: ""</li> 9054 </ul> 9055 <h4 id="box-box-config-file">–box-box-config-file</h4> 9056 <p>Box App config.json location Leave blank normally.</p> 9057 <ul> 9058 <li>Config: box_config_file</li> 9059 <li>Env Var: RCLONE_BOX_BOX_CONFIG_FILE</li> 9060 <li>Type: string</li> 9061 <li>Default: ""</li> 9062 </ul> 9063 <h4 id="box-box-sub-type">–box-box-sub-type</h4> 9064 <ul> 9065 <li>Config: box_sub_type</li> 9066 <li>Env Var: RCLONE_BOX_BOX_SUB_TYPE</li> 9067 <li>Type: string</li> 9068 <li>Default: “user”</li> 9069 <li>Examples: 9070 <ul> 9071 <li>“user” 9072 <ul> 9073 <li>Rclone should act on behalf of a user</li> 9074 </ul></li> 9075 <li>“enterprise” 9076 <ul> 9077 <li>Rclone should act on behalf of a service account</li> 9078 </ul></li> 9079 </ul></li> 9080 </ul> 9081 <h3 id="advanced-options-4">Advanced Options</h3> 9082 <p>Here are the advanced options specific to box (Box).</p> 9083 <h4 id="box-root-folder-id">–box-root-folder-id</h4> 9084 <p>Fill in for rclone to use a non root folder as its starting point.</p> 9085 <ul> 9086 <li>Config: root_folder_id</li> 9087 <li>Env Var: RCLONE_BOX_ROOT_FOLDER_ID</li> 9088 <li>Type: string</li> 9089 <li>Default: “0”</li> 9090 </ul> 9091 <h4 id="box-upload-cutoff">–box-upload-cutoff</h4> 9092 <p>Cutoff for switching to multipart upload (>= 50MB).</p> 9093 <ul> 9094 <li>Config: upload_cutoff</li> 9095 <li>Env Var: RCLONE_BOX_UPLOAD_CUTOFF</li> 9096 <li>Type: SizeSuffix</li> 9097 <li>Default: 50M</li> 9098 </ul> 9099 <h4 id="box-commit-retries">–box-commit-retries</h4> 9100 <p>Max number of times to try committing a multipart file.</p> 9101 <ul> 9102 <li>Config: commit_retries</li> 9103 <li>Env Var: RCLONE_BOX_COMMIT_RETRIES</li> 9104 <li>Type: int</li> 9105 <li>Default: 100</li> 9106 </ul> 9107 <h4 id="box-encoding">–box-encoding</h4> 9108 <p>This sets the encoding for the backend.</p> 9109 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 9110 <ul> 9111 <li>Config: encoding</li> 9112 <li>Env Var: RCLONE_BOX_ENCODING</li> 9113 <li>Type: MultiEncoder</li> 9114 <li>Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot</li> 9115 </ul> 9116 <h3 id="limitations-3">Limitations</h3> 9117 <p>Note that Box is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9118 <p>Box file names can’t have the <code>\</code> character in. rclone maps this to and from an identical looking unicode equivalent <code>＼</code>.</p> 9119 <p>Box only supports filenames up to 255 characters in length.</p> 9120 <h2 id="cache-beta">Cache (BETA)</h2> 9121 <p>The <code>cache</code> remote wraps another existing remote and stores file structure and its data for long running tasks like <code>rclone mount</code>.</p> 9122 <h2 id="status-1">Status</h2> 9123 <p>The cache backend code is working but it currently doesn’t have a maintainer so there are <a href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22">outstanding bugs</a> which aren’t getting fixed.</p> 9124 <p>The cache backend is due to be phased out in favour of the VFS caching layer eventually which is more tightly integrated into rclone.</p> 9125 <p>Until this happens we recommend only using the cache backend if you find you can’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’t needed in those scenarios any more.</p> 9126 <h2 id="setup-1">Setup</h2> 9127 <p>To get started you just need to have an existing remote which can be configured with <code>cache</code>.</p> 9128 <p>Here is an example of how to make a remote called <code>test-cache</code>. First run:</p> 9129 <pre><code> rclone config</code></pre> 9130 <p>This will guide you through an interactive setup process:</p> 9131 <pre><code>No remotes found - make a new one 9132 n) New remote 9133 r) Rename remote 9134 c) Copy remote 9135 s) Set configuration password 9136 q) Quit config 9137 n/r/c/s/q> n 9138 name> test-cache 9139 Type of storage to configure. 9140 Choose a number from below, or type in your own value 9141 [snip] 9142 XX / Cache a remote 9143 \ "cache" 9144 [snip] 9145 Storage> cache 9146 Remote to cache. 9147 Normally should contain a ':' and a path, eg "myremote:path/to/dir", 9148 "myremote:bucket" or maybe "myremote:" (not recommended). 9149 remote> local:/test 9150 Optional: The URL of the Plex server 9151 plex_url> http://127.0.0.1:32400 9152 Optional: The username of the Plex user 9153 plex_username> dummyusername 9154 Optional: The password of the Plex user 9155 y) Yes type in my own password 9156 g) Generate random password 9157 n) No leave this optional password blank 9158 y/g/n> y 9159 Enter the password: 9160 password: 9161 Confirm the password: 9162 password: 9163 The size of a chunk. Lower value good for slow connections but can affect seamless reading. 9164 Default: 5M 9165 Choose a number from below, or type in your own value 9166 1 / 1MB 9167 \ "1m" 9168 2 / 5 MB 9169 \ "5M" 9170 3 / 10 MB 9171 \ "10M" 9172 chunk_size> 2 9173 How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. 9174 Accepted units are: "s", "m", "h". 9175 Default: 5m 9176 Choose a number from below, or type in your own value 9177 1 / 1 hour 9178 \ "1h" 9179 2 / 24 hours 9180 \ "24h" 9181 3 / 24 hours 9182 \ "48h" 9183 info_age> 2 9184 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. 9185 Default: 10G 9186 Choose a number from below, or type in your own value 9187 1 / 500 MB 9188 \ "500M" 9189 2 / 1 GB 9190 \ "1G" 9191 3 / 10 GB 9192 \ "10G" 9193 chunk_total_size> 3 9194 Remote config 9195 -------------------- 9196 [test-cache] 9197 remote = local:/test 9198 plex_url = http://127.0.0.1:32400 9199 plex_username = dummyusername 9200 plex_password = *** ENCRYPTED *** 9201 chunk_size = 5M 9202 info_age = 48h 9203 chunk_total_size = 10G</code></pre> 9204 <p>You can then use it like this,</p> 9205 <p>List directories in top level of your drive</p> 9206 <pre><code>rclone lsd test-cache:</code></pre> 9207 <p>List all the files in your drive</p> 9208 <pre><code>rclone ls test-cache:</code></pre> 9209 <p>To start a cached mount</p> 9210 <pre><code>rclone mount --allow-other test-cache: /var/tmp/test-cache</code></pre> 9211 <h3 id="write-features">Write Features</h3> 9212 <h3 id="offline-uploading">Offline uploading</h3> 9213 <p>In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a <code>cache-tmp-upload-path</code>.</p> 9214 <p>A files goes through these states when using this feature:</p> 9215 <ol type="1"> 9216 <li>An upload is started (usually by copying a file on the cache remote)</li> 9217 <li>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)</li> 9218 <li>After <code>cache-tmp-wait-time</code> passes and the file is next in line, <code>rclone move</code> is used to move the file to the cloud provider</li> 9219 <li>Reading the file still works during the upload but most modifications on it will be prohibited</li> 9220 <li>Once the move is complete the file is unlocked for modifications as it becomes as any other regular file</li> 9221 <li>If the file is being read through <code>cache</code> when it’s actually deleted from the temporary path then <code>cache</code> will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though)</li> 9222 </ol> 9223 <p>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 <code>--cache-db-purge</code> flag.</p> 9224 <h3 id="write-support">Write Support</h3> 9225 <p>Writes are supported through <code>cache</code>. 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 <code>Offline uploading</code> for reliable writes.</p> 9226 <p>One special case is covered with <code>cache-writes</code> 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.</p> 9227 <h3 id="read-features">Read Features</h3> 9228 <h4 id="multiple-connections">Multiple connections</h4> 9229 <p>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.</p> 9230 <p>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.</p> 9231 <h4 id="plex-integration">Plex Integration</h4> 9232 <p>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.</p> 9233 <p>Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.</p> 9234 <p>This integration opens the doorway to additional performance improvements which will be explored in the near future.</p> 9235 <p><strong>Note:</strong> If Plex options are not configured, <code>cache</code> will function with its configured options without adapting any of its settings.</p> 9236 <p>How to enable? Run <code>rclone config</code> and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled.</p> 9237 <p>Affected settings: - <code>cache-workers</code>: <em>Configured value</em> during confirmed playback or <em>1</em> all the other times</p> 9238 <h5 id="certificate-validation">Certificate Validation</h5> 9239 <p>When the Plex server is configured to only accept secure connections, it is possible to use <code>.plex.direct</code> URLs to ensure certificate validation succeeds. These URLs are used by Plex internally to connect to the Plex server securely.</p> 9240 <p>The format for these URLs is the following:</p> 9241 <p>https://ip-with-dots-replaced.server-hash.plex.direct:32400/</p> 9242 <p>The <code>ip-with-dots-replaced</code> part can be any IPv4 address, where the dots have been replaced with dashes, e.g. <code>127.0.0.1</code> becomes <code>127-0-0-1</code>.</p> 9243 <p>To get the <code>server-hash</code> part, the easiest way is to visit</p> 9244 <p>https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token</p> 9245 <p>This page will list all the available Plex servers for your account with at least one <code>.plex.direct</code> link for each. Copy one URL and replace the IP address with the desired address. This can be used as the <code>plex_url</code> value.</p> 9246 <h3 id="known-issues">Known issues</h3> 9247 <h4 id="mount-and-dir-cache-time">Mount and –dir-cache-time</h4> 9248 <p>–dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the <code>cache</code> backend, it will manage its own entries based on the configured time.</p> 9249 <p>To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set <code>--dir-cache-time</code> to a lower time than <code>--cache-info-age</code>. Default values are already configured in this way.</p> 9250 <h4 id="windows-support---experimental">Windows support - Experimental</h4> 9251 <p>There are a couple of issues with Windows <code>mount</code> functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS.</p> 9252 <p>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.</p> 9253 <p>Any reports or feedback on how cache behaves on this OS is greatly appreciated.</p> 9254 <ul> 9255 <li>https://github.com/rclone/rclone/issues/1935</li> 9256 <li>https://github.com/rclone/rclone/issues/1907</li> 9257 <li>https://github.com/rclone/rclone/issues/1834</li> 9258 </ul> 9259 <h4 id="risk-of-throttling">Risk of throttling</h4> 9260 <p>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.</p> 9261 <p>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.</p> 9262 <p>Some recommendations: - don’t use a very small interval for entry information (<code>--cache-info-age</code>) - while writes aren’t yet optimised, you can still write through <code>cache</code> which gives you the advantage of adding the file in the cache at the same time if configured to do so.</p> 9263 <p>Future enhancements:</p> 9264 <ul> 9265 <li>https://github.com/rclone/rclone/issues/1937</li> 9266 <li>https://github.com/rclone/rclone/issues/1936</li> 9267 </ul> 9268 <h4 id="cache-and-crypt">cache and crypt</h4> 9269 <p>One common scenario is to keep your data encrypted in the cloud provider using the <code>crypt</code> remote. <code>crypt</code> uses a similar technique to wrap around an existing remote and handles this translation in a seamless way.</p> 9270 <p>There is an issue with wrapping the remotes in this order: <strong>cloud remote</strong> -> <strong>crypt</strong> -> <strong>cache</strong></p> 9271 <p>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’re downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: <strong>cloud remote</strong> -> <strong>cache</strong> -> <strong>crypt</strong></p> 9272 <h4 id="absolute-remote-paths">absolute remote paths</h4> 9273 <p><code>cache</code> can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the <code>remote</code> 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 <code>/</code> character.</p> 9274 <p>This behavior is irrelevant for most backend types, but there are backends where a leading <code>/</code> changes the effective directory, e.g. in the <code>sftp</code> backend paths starting with a <code>/</code> are relative to the root of the SSH server and paths without are relative to the user home directory. As a result <code>sftp:bin</code> and <code>sftp:/bin</code> will share the same cache folder, even if they represent a different directory on the SSH server.</p> 9275 <h3 id="cache-and-remote-control-rc">Cache and Remote Control (–rc)</h3> 9276 <p>Cache supports the new <code>--rc</code> 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.</p> 9277 <h3 id="rc-cacheexpire">rc cache/expire</h3> 9278 <p>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.</p> 9279 <p>Params: - <strong>remote</strong> = path to remote <strong>(required)</strong> - <strong>withData</strong> = true/false to delete cached data (chunks) as well <em>(optional, false by default)</em></p> 9280 <h3 id="standard-options-6">Standard Options</h3> 9281 <p>Here are the standard options specific to cache (Cache a remote).</p> 9282 <h4 id="cache-remote">–cache-remote</h4> 9283 <p>Remote to cache. Normally should contain a ‘:’ and a path, eg “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not recommended).</p> 9284 <ul> 9285 <li>Config: remote</li> 9286 <li>Env Var: RCLONE_CACHE_REMOTE</li> 9287 <li>Type: string</li> 9288 <li>Default: ""</li> 9289 </ul> 9290 <h4 id="cache-plex-url">–cache-plex-url</h4> 9291 <p>The URL of the Plex server</p> 9292 <ul> 9293 <li>Config: plex_url</li> 9294 <li>Env Var: RCLONE_CACHE_PLEX_URL</li> 9295 <li>Type: string</li> 9296 <li>Default: ""</li> 9297 </ul> 9298 <h4 id="cache-plex-username">–cache-plex-username</h4> 9299 <p>The username of the Plex user</p> 9300 <ul> 9301 <li>Config: plex_username</li> 9302 <li>Env Var: RCLONE_CACHE_PLEX_USERNAME</li> 9303 <li>Type: string</li> 9304 <li>Default: ""</li> 9305 </ul> 9306 <h4 id="cache-plex-password">–cache-plex-password</h4> 9307 <p>The password of the Plex user</p> 9308 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 9309 <ul> 9310 <li>Config: plex_password</li> 9311 <li>Env Var: RCLONE_CACHE_PLEX_PASSWORD</li> 9312 <li>Type: string</li> 9313 <li>Default: ""</li> 9314 </ul> 9315 <h4 id="cache-chunk-size">–cache-chunk-size</h4> 9316 <p>The size of a chunk (partial file data).</p> 9317 <p>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.</p> 9318 <ul> 9319 <li>Config: chunk_size</li> 9320 <li>Env Var: RCLONE_CACHE_CHUNK_SIZE</li> 9321 <li>Type: SizeSuffix</li> 9322 <li>Default: 5M</li> 9323 <li>Examples: 9324 <ul> 9325 <li>“1m” 9326 <ul> 9327 <li>1MB</li> 9328 </ul></li> 9329 <li>“5M” 9330 <ul> 9331 <li>5 MB</li> 9332 </ul></li> 9333 <li>“10M” 9334 <ul> 9335 <li>10 MB</li> 9336 </ul></li> 9337 </ul></li> 9338 </ul> 9339 <h4 id="cache-info-age">–cache-info-age</h4> 9340 <p>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.</p> 9341 <ul> 9342 <li>Config: info_age</li> 9343 <li>Env Var: RCLONE_CACHE_INFO_AGE</li> 9344 <li>Type: Duration</li> 9345 <li>Default: 6h0m0s</li> 9346 <li>Examples: 9347 <ul> 9348 <li>“1h” 9349 <ul> 9350 <li>1 hour</li> 9351 </ul></li> 9352 <li>“24h” 9353 <ul> 9354 <li>24 hours</li> 9355 </ul></li> 9356 <li>“48h” 9357 <ul> 9358 <li>48 hours</li> 9359 </ul></li> 9360 </ul></li> 9361 </ul> 9362 <h4 id="cache-chunk-total-size">–cache-chunk-total-size</h4> 9363 <p>The total size that the chunks can take up on the local disk.</p> 9364 <p>If the cache exceeds this value then it will start to delete the oldest chunks until it goes under this value.</p> 9365 <ul> 9366 <li>Config: chunk_total_size</li> 9367 <li>Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE</li> 9368 <li>Type: SizeSuffix</li> 9369 <li>Default: 10G</li> 9370 <li>Examples: 9371 <ul> 9372 <li>“500M” 9373 <ul> 9374 <li>500 MB</li> 9375 </ul></li> 9376 <li>“1G” 9377 <ul> 9378 <li>1 GB</li> 9379 </ul></li> 9380 <li>“10G” 9381 <ul> 9382 <li>10 GB</li> 9383 </ul></li> 9384 </ul></li> 9385 </ul> 9386 <h3 id="advanced-options-5">Advanced Options</h3> 9387 <p>Here are the advanced options specific to cache (Cache a remote).</p> 9388 <h4 id="cache-plex-token">–cache-plex-token</h4> 9389 <p>The plex token for authentication - auto set normally</p> 9390 <ul> 9391 <li>Config: plex_token</li> 9392 <li>Env Var: RCLONE_CACHE_PLEX_TOKEN</li> 9393 <li>Type: string</li> 9394 <li>Default: ""</li> 9395 </ul> 9396 <h4 id="cache-plex-insecure">–cache-plex-insecure</h4> 9397 <p>Skip all certificate verification when connecting to the Plex server</p> 9398 <ul> 9399 <li>Config: plex_insecure</li> 9400 <li>Env Var: RCLONE_CACHE_PLEX_INSECURE</li> 9401 <li>Type: string</li> 9402 <li>Default: ""</li> 9403 </ul> 9404 <h4 id="cache-db-path">–cache-db-path</h4> 9405 <p>Directory to store file structure metadata DB. The remote name is used as the DB file name.</p> 9406 <ul> 9407 <li>Config: db_path</li> 9408 <li>Env Var: RCLONE_CACHE_DB_PATH</li> 9409 <li>Type: string</li> 9410 <li>Default: “$HOME/.cache/rclone/cache-backend”</li> 9411 </ul> 9412 <h4 id="cache-chunk-path">–cache-chunk-path</h4> 9413 <p>Directory to cache chunk files.</p> 9414 <p>Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.</p> 9415 <p>This config follows the “–cache-db-path”. If you specify a custom location for “–cache-db-path” and don’t specify one for “–cache-chunk-path” then “–cache-chunk-path” will use the same path as “–cache-db-path”.</p> 9416 <ul> 9417 <li>Config: chunk_path</li> 9418 <li>Env Var: RCLONE_CACHE_CHUNK_PATH</li> 9419 <li>Type: string</li> 9420 <li>Default: “$HOME/.cache/rclone/cache-backend”</li> 9421 </ul> 9422 <h4 id="cache-db-purge">–cache-db-purge</h4> 9423 <p>Clear all the cached data for this remote on start.</p> 9424 <ul> 9425 <li>Config: db_purge</li> 9426 <li>Env Var: RCLONE_CACHE_DB_PURGE</li> 9427 <li>Type: bool</li> 9428 <li>Default: false</li> 9429 </ul> 9430 <h4 id="cache-chunk-clean-interval">–cache-chunk-clean-interval</h4> 9431 <p>How often should the cache perform cleanups of the chunk storage. The default value should be ok for most people. If you find that the cache goes over “cache-chunk-total-size” too often then try to lower this value to force it to perform cleanups more often.</p> 9432 <ul> 9433 <li>Config: chunk_clean_interval</li> 9434 <li>Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL</li> 9435 <li>Type: Duration</li> 9436 <li>Default: 1m0s</li> 9437 </ul> 9438 <h4 id="cache-read-retries">–cache-read-retries</h4> 9439 <p>How many times to retry a read from a cache storage.</p> 9440 <p>Since reading from a cache stream is independent from downloading file data, readers can get to a point where there’s no more data in the cache. Most of the times this can indicate a connectivity issue if cache isn’t able to provide file data anymore.</p> 9441 <p>For really slow connections, increase this to a point where the stream is able to provide data but your experience will be very stuttering.</p> 9442 <ul> 9443 <li>Config: read_retries</li> 9444 <li>Env Var: RCLONE_CACHE_READ_RETRIES</li> 9445 <li>Type: int</li> 9446 <li>Default: 10</li> 9447 </ul> 9448 <h4 id="cache-workers">–cache-workers</h4> 9449 <p>How many workers should run in parallel to download chunks.</p> 9450 <p>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.</p> 9451 <p><strong>Note</strong>: 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.</p> 9452 <ul> 9453 <li>Config: workers</li> 9454 <li>Env Var: RCLONE_CACHE_WORKERS</li> 9455 <li>Type: int</li> 9456 <li>Default: 4</li> 9457 </ul> 9458 <h4 id="cache-chunk-no-memory">–cache-chunk-no-memory</h4> 9459 <p>Disable the in-memory cache for storing chunks during streaming.</p> 9460 <p>By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible.</p> 9461 <p>This transient data is evicted as soon as it is read and the number of chunks stored doesn’t exceed the number of workers. However, depending on other settings like “cache-chunk-size” and “cache-workers” this footprint can increase if there are parallel streams too (multiple files being read at the same time).</p> 9462 <p>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.</p> 9463 <ul> 9464 <li>Config: chunk_no_memory</li> 9465 <li>Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY</li> 9466 <li>Type: bool</li> 9467 <li>Default: false</li> 9468 </ul> 9469 <h4 id="cache-rps">–cache-rps</h4> 9470 <p>Limits the number of requests per second to the source FS (-1 to disable)</p> 9471 <p>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.</p> 9472 <p>If you find that you’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.</p> 9473 <p>A good balance of all the other settings should make this setting useless but it is available to set for more special cases.</p> 9474 <p><strong>NOTE</strong>: This will limit the number of requests during streams but other API calls to the cloud provider like directory listings will still pass.</p> 9475 <ul> 9476 <li>Config: rps</li> 9477 <li>Env Var: RCLONE_CACHE_RPS</li> 9478 <li>Type: int</li> 9479 <li>Default: -1</li> 9480 </ul> 9481 <h4 id="cache-writes">–cache-writes</h4> 9482 <p>Cache file data on writes through the FS</p> 9483 <p>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.</p> 9484 <ul> 9485 <li>Config: writes</li> 9486 <li>Env Var: RCLONE_CACHE_WRITES</li> 9487 <li>Type: bool</li> 9488 <li>Default: false</li> 9489 </ul> 9490 <h4 id="cache-tmp-upload-path">–cache-tmp-upload-path</h4> 9491 <p>Directory to keep temporary files until they are uploaded.</p> 9492 <p>This is the path where cache will use as a temporary storage for new files that need to be uploaded to the cloud provider.</p> 9493 <p>Specifying a value will enable this feature. Without it, it is completely disabled and files will be uploaded directly to the cloud provider</p> 9494 <ul> 9495 <li>Config: tmp_upload_path</li> 9496 <li>Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH</li> 9497 <li>Type: string</li> 9498 <li>Default: ""</li> 9499 </ul> 9500 <h4 id="cache-tmp-wait-time">–cache-tmp-wait-time</h4> 9501 <p>How long should files be stored in local cache before being uploaded</p> 9502 <p>This is the duration that a file must wait in the temporary location <em>cache-tmp-upload-path</em> before it is selected for upload.</p> 9503 <p>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.</p> 9504 <ul> 9505 <li>Config: tmp_wait_time</li> 9506 <li>Env Var: RCLONE_CACHE_TMP_WAIT_TIME</li> 9507 <li>Type: Duration</li> 9508 <li>Default: 15s</li> 9509 </ul> 9510 <h4 id="cache-db-wait-time">–cache-db-wait-time</h4> 9511 <p>How long to wait for the DB to be available - 0 is unlimited</p> 9512 <p>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.</p> 9513 <p>If you set it to 0 then it will wait forever.</p> 9514 <ul> 9515 <li>Config: db_wait_time</li> 9516 <li>Env Var: RCLONE_CACHE_DB_WAIT_TIME</li> 9517 <li>Type: Duration</li> 9518 <li>Default: 1s</li> 9519 </ul> 9520 <h3 id="backend-commands">Backend commands</h3> 9521 <p>Here are the commands specific to the cache backend.</p> 9522 <p>Run them with</p> 9523 <pre><code>rclone backend COMMAND remote:</code></pre> 9524 <p>The help below will explain what arguments each command takes.</p> 9525 <p>See <a href="https://rclone.org/commands/rclone_backend/">the “rclone backend” command</a> for more info on how to pass options and arguments.</p> 9526 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend/command">backend/command</a>.</p> 9527 <h4 id="stats">stats</h4> 9528 <p>Print stats on the cache backend in JSON format.</p> 9529 <pre><code>rclone backend stats remote: [options] [<arguments>+]</code></pre> 9530 <h2 id="chunker-beta">Chunker (BETA)</h2> 9531 <p>The <code>chunker</code> 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.</p> 9532 <p>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.</p> 9533 <p>First check your chosen remote is working - we’ll call it <code>remote:path</code> here. Note that anything inside <code>remote:path</code> will be chunked and anything outside won’t. This means that if you are using a bucket based remote (eg S3, B2, swift) then you should probably put the bucket in the remote <code>s3:bucket</code>.</p> 9534 <p>Now configure <code>chunker</code> using <code>rclone config</code>. We will call this one <code>overlay</code> to separate it from the <code>remote</code> itself.</p> 9535 <pre><code>No remotes found - make a new one 9536 n) New remote 9537 s) Set configuration password 9538 q) Quit config 9539 n/s/q> n 9540 name> overlay 9541 Type of storage to configure. 9542 Choose a number from below, or type in your own value 9543 [snip] 9544 XX / Transparently chunk/split large files 9545 \ "chunker" 9546 [snip] 9547 Storage> chunker 9548 Remote to chunk/unchunk. 9549 Normally should contain a ':' and a path, eg "myremote:path/to/dir", 9550 "myremote:bucket" or maybe "myremote:" (not recommended). 9551 Enter a string value. Press Enter for the default (""). 9552 remote> remote:path 9553 Files larger than chunk size will be split in chunks. 9554 Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). 9555 chunk_size> 100M 9556 Choose how chunker handles hash sums. All modes but "none" require metadata. 9557 Enter a string value. Press Enter for the default ("md5"). 9558 Choose a number from below, or type in your own value 9559 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise 9560 \ "none" 9561 2 / MD5 for composite files 9562 \ "md5" 9563 3 / SHA1 for composite files 9564 \ "sha1" 9565 4 / MD5 for all files 9566 \ "md5all" 9567 5 / SHA1 for all files 9568 \ "sha1all" 9569 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported 9570 \ "md5quick" 9571 7 / Similar to "md5quick" but prefers SHA1 over MD5 9572 \ "sha1quick" 9573 hash_type> md5 9574 Edit advanced config? (y/n) 9575 y) Yes 9576 n) No 9577 y/n> n 9578 Remote config 9579 -------------------- 9580 [overlay] 9581 type = chunker 9582 remote = remote:bucket 9583 chunk_size = 100M 9584 hash_type = md5 9585 -------------------- 9586 y) Yes this is OK 9587 e) Edit this remote 9588 d) Delete this remote 9589 y/e/d> y</code></pre> 9590 <h3 id="specifying-the-remote">Specifying the remote</h3> 9591 <p>In normal use, make sure the remote has a <code>:</code> in. If you specify the remote without a <code>:</code> then rclone will use a local directory of that name. So if you use a remote of <code>/path/to/secret/files</code> then rclone will chunk stuff in that directory. If you use a remote of <code>name</code> then rclone will put files in a directory called <code>name</code> in the current directory.</p> 9592 <h3 id="chunking">Chunking</h3> 9593 <p>When rclone starts a file upload, chunker checks the file size. If it doesn’t exceed the configured chunk size, chunker will just pass the file to the wrapped remote. 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.</p> 9594 <p>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.</p> 9595 <p>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.</p> 9596 <p>When the <code>list</code> 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.</p> 9597 <p>List and other commands can sometimes come across composite files with missing or invalid chunks, eg. 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 <code>--chunker-fail-hard</code> flag to have commands abort with error message in such cases.</p> 9598 <h4 id="chunk-names">Chunk names</h4> 9599 <p>The default chunk name format is <code>*.rclone_chunk.###</code>, hence by default chunk names are <code>BIG_FILE_NAME.rclone_chunk.001</code>, <code>BIG_FILE_NAME.rclone_chunk.002</code> etc. You can configure another name format using the <code>name_format</code> configuration file option. The format uses asterisk <code>*</code> as a placeholder for the base file name and one or more consecutive hash characters <code>#</code> 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, eg. for compatibility with legacy software.</p> 9600 <p>For example, if name format is <code>big_*-##.part</code> and original file name is <code>data.txt</code> and numbering starts from 0, then the first chunk will be named <code>big_data.txt-00.part</code>, the 99th chunk will be <code>big_data.txt-98.part</code> and the 302nd chunk will become <code>big_data.txt-301.part</code>.</p> 9601 <p>Note that <code>list</code> assembles composite directory entries only when chunk names match the configured format and treats non-conforming file names as normal non-chunked files.</p> 9602 <h3 id="metadata">Metadata</h3> 9603 <p>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 <code>none</code> format). Note that metadata is normally not created for files smaller than the configured chunk size. This may change in future rclone releases.</p> 9604 <h4 id="simple-json-metadata-format">Simple JSON metadata format</h4> 9605 <p>This is the default format. It supports hash sums and chunk validation for composite files. Meta objects carry the following fields:</p> 9606 <ul> 9607 <li><code>ver</code> - version of format, currently <code>1</code></li> 9608 <li><code>size</code> - total size of composite file</li> 9609 <li><code>nchunks</code> - number of data chunks in file</li> 9610 <li><code>md5</code> - MD5 hashsum of composite file (if present)</li> 9611 <li><code>sha1</code> - SHA1 hashsum (if present)</li> 9612 </ul> 9613 <p>There is no field for composite file name as it’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.</p> 9614 <h4 id="no-metadata">No metadata</h4> 9615 <p>You can disable meta objects by setting the meta format option to <code>none</code>. 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.</p> 9616 <h3 id="hashsums">Hashsums</h3> 9617 <p>Chunker supports hashsums only when a compatible metadata is present. Hence, if you choose metadata format of <code>none</code>, chunker will report hashsum as <code>UNSUPPORTED</code>.</p> 9618 <p>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’t support it.</p> 9619 <p>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.</p> 9620 <p>If your storage backend does not support MD5 or SHA1 but you need consistent file hashing, configure chunker with <code>md5all</code> or <code>sha1all</code>. These two modes guarantee given hash for all files. If wrapped remote doesn’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 eg. <code>chunk_type=sha1all</code> to force hashsums and <code>chunk_size=1P</code> to effectively disable chunking.</p> 9621 <p>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: <code>sha1quick</code> and <code>md5quick</code>. 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 <code>sync</code> command will revert (sometimes silently) to time/size comparison if compatible hashsums between source and target are not found.</p> 9622 <h3 id="modified-time-2">Modified time</h3> 9623 <p>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 <code>none</code> then chunker will use modification time of the first data chunk.</p> 9624 <h3 id="migrations">Migrations</h3> 9625 <p>The idiomatic way to migrate to a different chunk size, hash type or chunk naming scheme is to:</p> 9626 <ul> 9627 <li>Collect all your chunked files under a directory and have your chunker remote point to it.</li> 9628 <li>Create another directory (most probably on the same cloud storage) and configure a new remote with desired metadata format, hash type, chunk naming etc.</li> 9629 <li>Now run <code>rclone sync oldchunks: newchunks:</code> and all your data will be transparently converted in transfer. This may take some time, yet chunker will try server-side copy if possible.</li> 9630 <li>After checking data integrity you may remove configuration section of the old remote.</li> 9631 </ul> 9632 <p>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 <code>list</code> command but will eat up your account quota. Please note that the <code>deletefile</code> 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 <code>copy</code> command will copy only active chunks while the <code>purge</code> will remove everything including garbage.</p> 9633 <h3 id="caveats-and-limitations">Caveats and Limitations</h3> 9634 <p>Chunker requires wrapped remote to support server side <code>move</code> (or <code>copy</code> + <code>delete</code>) 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.</p> 9635 <p>Chunker encodes chunk number in file name, so with default <code>name_format</code> 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’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 eg. <code>*.rcc##</code> and save 10 characters (provided at most 99 chunks per file).</p> 9636 <p>Note that a move implemented using the copy-and-delete method may incur double charging with some cloud storage providers.</p> 9637 <p>Chunker will not automatically rename existing chunks when you run <code>rclone config</code> 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.</p> 9638 <p>If wrapped remote is case insensitive, the chunker overlay will inherit that property (so you can’t have a file called “Hello.doc” and “hello.doc” in the same directory).</p> 9639 <h3 id="standard-options-7">Standard Options</h3> 9640 <p>Here are the standard options specific to chunker (Transparently chunk/split large files).</p> 9641 <h4 id="chunker-remote">–chunker-remote</h4> 9642 <p>Remote to chunk/unchunk. Normally should contain a ‘:’ and a path, eg “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not recommended).</p> 9643 <ul> 9644 <li>Config: remote</li> 9645 <li>Env Var: RCLONE_CHUNKER_REMOTE</li> 9646 <li>Type: string</li> 9647 <li>Default: ""</li> 9648 </ul> 9649 <h4 id="chunker-chunk-size">–chunker-chunk-size</h4> 9650 <p>Files larger than chunk size will be split in chunks.</p> 9651 <ul> 9652 <li>Config: chunk_size</li> 9653 <li>Env Var: RCLONE_CHUNKER_CHUNK_SIZE</li> 9654 <li>Type: SizeSuffix</li> 9655 <li>Default: 2G</li> 9656 </ul> 9657 <h4 id="chunker-hash-type">–chunker-hash-type</h4> 9658 <p>Choose how chunker handles hash sums. All modes but “none” require metadata.</p> 9659 <ul> 9660 <li>Config: hash_type</li> 9661 <li>Env Var: RCLONE_CHUNKER_HASH_TYPE</li> 9662 <li>Type: string</li> 9663 <li>Default: “md5”</li> 9664 <li>Examples: 9665 <ul> 9666 <li>“none” 9667 <ul> 9668 <li>Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise</li> 9669 </ul></li> 9670 <li>“md5” 9671 <ul> 9672 <li>MD5 for composite files</li> 9673 </ul></li> 9674 <li>“sha1” 9675 <ul> 9676 <li>SHA1 for composite files</li> 9677 </ul></li> 9678 <li>“md5all” 9679 <ul> 9680 <li>MD5 for all files</li> 9681 </ul></li> 9682 <li>“sha1all” 9683 <ul> 9684 <li>SHA1 for all files</li> 9685 </ul></li> 9686 <li>“md5quick” 9687 <ul> 9688 <li>Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported</li> 9689 </ul></li> 9690 <li>“sha1quick” 9691 <ul> 9692 <li>Similar to “md5quick” but prefers SHA1 over MD5</li> 9693 </ul></li> 9694 </ul></li> 9695 </ul> 9696 <h3 id="advanced-options-6">Advanced Options</h3> 9697 <p>Here are the advanced options specific to chunker (Transparently chunk/split large files).</p> 9698 <h4 id="chunker-name-format">–chunker-name-format</h4> 9699 <p>String format of chunk file names. 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.</p> 9700 <ul> 9701 <li>Config: name_format</li> 9702 <li>Env Var: RCLONE_CHUNKER_NAME_FORMAT</li> 9703 <li>Type: string</li> 9704 <li>Default: "*.rclone_chunk.###"</li> 9705 </ul> 9706 <h4 id="chunker-start-from">–chunker-start-from</h4> 9707 <p>Minimum valid chunk number. Usually 0 or 1. By default chunk numbers start from 1.</p> 9708 <ul> 9709 <li>Config: start_from</li> 9710 <li>Env Var: RCLONE_CHUNKER_START_FROM</li> 9711 <li>Type: int</li> 9712 <li>Default: 1</li> 9713 </ul> 9714 <h4 id="chunker-meta-format">–chunker-meta-format</h4> 9715 <p>Format of the metadata object or “none”. By default “simplejson”. Metadata is a small JSON file named after the composite file.</p> 9716 <ul> 9717 <li>Config: meta_format</li> 9718 <li>Env Var: RCLONE_CHUNKER_META_FORMAT</li> 9719 <li>Type: string</li> 9720 <li>Default: “simplejson”</li> 9721 <li>Examples: 9722 <ul> 9723 <li>“none” 9724 <ul> 9725 <li>Do not use metadata files at all. Requires hash type “none”.</li> 9726 </ul></li> 9727 <li>“simplejson” 9728 <ul> 9729 <li>Simple JSON supports hash sums and chunk validation.</li> 9730 <li>It has the following fields: ver, size, nchunks, md5, sha1.</li> 9731 </ul></li> 9732 </ul></li> 9733 </ul> 9734 <h4 id="chunker-fail-hard">–chunker-fail-hard</h4> 9735 <p>Choose how chunker should handle files with missing or invalid chunks.</p> 9736 <ul> 9737 <li>Config: fail_hard</li> 9738 <li>Env Var: RCLONE_CHUNKER_FAIL_HARD</li> 9739 <li>Type: bool</li> 9740 <li>Default: false</li> 9741 <li>Examples: 9742 <ul> 9743 <li>“true” 9744 <ul> 9745 <li>Report errors and abort current command.</li> 9746 </ul></li> 9747 <li>“false” 9748 <ul> 9749 <li>Warn user, skip incomplete file and proceed.</li> 9750 </ul></li> 9751 </ul></li> 9752 </ul> 9753 <h2 id="citrix-sharefile">Citrix ShareFile</h2> 9754 <p><a href="https://sharefile.com">Citrix ShareFile</a> is a secure file sharing and transfer service aimed as business.</p> 9755 <p>The initial setup for Citrix ShareFile involves getting a token from Citrix ShareFile which you can in your browser. <code>rclone config</code> walks you through it.</p> 9756 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 9757 <pre><code> rclone config</code></pre> 9758 <p>This will guide you through an interactive setup process:</p> 9759 <pre><code>No remotes found - make a new one 9760 n) New remote 9761 s) Set configuration password 9762 q) Quit config 9763 n/s/q> n 9764 name> remote 9765 Type of storage to configure. 9766 Enter a string value. Press Enter for the default (""). 9767 Choose a number from below, or type in your own value 9768 XX / Citrix Sharefile 9769 \ "sharefile" 9770 Storage> sharefile 9771 ** See help for sharefile backend at: https://rclone.org/sharefile/ ** 9772 9773 ID of the root folder 9774 9775 Leave blank to access "Personal Folders". You can use one of the 9776 standard values here or any folder ID (long hex number ID). 9777 Enter a string value. Press Enter for the default (""). 9778 Choose a number from below, or type in your own value 9779 1 / Access the Personal Folders. (Default) 9780 \ "" 9781 2 / Access the Favorites folder. 9782 \ "favorites" 9783 3 / Access all the shared folders. 9784 \ "allshared" 9785 4 / Access all the individual connectors. 9786 \ "connectors" 9787 5 / Access the home, favorites, and shared folders as well as the connectors. 9788 \ "top" 9789 root_folder_id> 9790 Edit advanced config? (y/n) 9791 y) Yes 9792 n) No 9793 y/n> n 9794 Remote config 9795 Use auto config? 9796 * Say Y if not sure 9797 * Say N if you are working on a remote or headless machine 9798 y) Yes 9799 n) No 9800 y/n> y 9801 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX 9802 Log in and authorize rclone for access 9803 Waiting for code... 9804 Got code 9805 -------------------- 9806 [remote] 9807 type = sharefile 9808 endpoint = https://XXX.sharefile.com 9809 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} 9810 -------------------- 9811 y) Yes this is OK 9812 e) Edit this remote 9813 d) Delete this remote 9814 y/e/d> y</code></pre> 9815 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 9816 <p>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 <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 9817 <p>Once configured you can then use <code>rclone</code> like this,</p> 9818 <p>List directories in top level of your ShareFile</p> 9819 <pre><code>rclone lsd remote:</code></pre> 9820 <p>List all the files in your ShareFile</p> 9821 <pre><code>rclone ls remote:</code></pre> 9822 <p>To copy a local directory to an ShareFile directory called backup</p> 9823 <pre><code>rclone copy /home/source remote:backup</code></pre> 9824 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9825 <h3 id="modified-time-and-hashes-2">Modified time and hashes</h3> 9826 <p>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.</p> 9827 <p>ShareFile supports MD5 type hashes, so you can use the <code>--checksum</code> flag.</p> 9828 <h3 id="transfers-2">Transfers</h3> 9829 <p>For files above 128MB rclone will use a chunked transfer. Rclone will upload up to <code>--transfers</code> chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 64MB so increasing <code>--transfers</code> will increase memory use.</p> 9830 <h3 id="limitations-4">Limitations</h3> 9831 <p>Note that ShareFile is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9832 <p>ShareFile only supports filenames up to 256 characters in length.</p> 9833 <h4 id="restricted-filename-characters-5">Restricted filename characters</h4> 9834 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 9835 <table> 9836 <thead> 9837 <tr class="header"> 9838 <th>Character</th> 9839 <th style="text-align: center;">Value</th> 9840 <th style="text-align: center;">Replacement</th> 9841 </tr> 9842 </thead> 9843 <tbody> 9844 <tr class="odd"> 9845 <td>\</td> 9846 <td style="text-align: center;">0x5C</td> 9847 <td style="text-align: center;">＼</td> 9848 </tr> 9849 <tr class="even"> 9850 <td>*</td> 9851 <td style="text-align: center;">0x2A</td> 9852 <td style="text-align: center;">＊</td> 9853 </tr> 9854 <tr class="odd"> 9855 <td><</td> 9856 <td style="text-align: center;">0x3C</td> 9857 <td style="text-align: center;">＜</td> 9858 </tr> 9859 <tr class="even"> 9860 <td>></td> 9861 <td style="text-align: center;">0x3E</td> 9862 <td style="text-align: center;">＞</td> 9863 </tr> 9864 <tr class="odd"> 9865 <td>?</td> 9866 <td style="text-align: center;">0x3F</td> 9867 <td style="text-align: center;">？</td> 9868 </tr> 9869 <tr class="even"> 9870 <td>:</td> 9871 <td style="text-align: center;">0x3A</td> 9872 <td style="text-align: center;">：</td> 9873 </tr> 9874 <tr class="odd"> 9875 <td>|</td> 9876 <td style="text-align: center;">0x7C</td> 9877 <td style="text-align: center;">｜</td> 9878 </tr> 9879 <tr class="even"> 9880 <td>"</td> 9881 <td style="text-align: center;">0x22</td> 9882 <td style="text-align: center;">＂</td> 9883 </tr> 9884 </tbody> 9885 </table> 9886 <p>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:</p> 9887 <table> 9888 <thead> 9889 <tr class="header"> 9890 <th>Character</th> 9891 <th style="text-align: center;">Value</th> 9892 <th style="text-align: center;">Replacement</th> 9893 </tr> 9894 </thead> 9895 <tbody> 9896 <tr class="odd"> 9897 <td>SP</td> 9898 <td style="text-align: center;">0x20</td> 9899 <td style="text-align: center;">␠</td> 9900 </tr> 9901 <tr class="even"> 9902 <td>.</td> 9903 <td style="text-align: center;">0x2E</td> 9904 <td style="text-align: center;">．</td> 9905 </tr> 9906 </tbody> 9907 </table> 9908 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 9909 <h3 id="standard-options-8">Standard Options</h3> 9910 <p>Here are the standard options specific to sharefile (Citrix Sharefile).</p> 9911 <h4 id="sharefile-root-folder-id">–sharefile-root-folder-id</h4> 9912 <p>ID of the root folder</p> 9913 <p>Leave blank to access “Personal Folders”. You can use one of the standard values here or any folder ID (long hex number ID).</p> 9914 <ul> 9915 <li>Config: root_folder_id</li> 9916 <li>Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID</li> 9917 <li>Type: string</li> 9918 <li>Default: ""</li> 9919 <li>Examples: 9920 <ul> 9921 <li>"" 9922 <ul> 9923 <li>Access the Personal Folders. (Default)</li> 9924 </ul></li> 9925 <li>“favorites” 9926 <ul> 9927 <li>Access the Favorites folder.</li> 9928 </ul></li> 9929 <li>“allshared” 9930 <ul> 9931 <li>Access all the shared folders.</li> 9932 </ul></li> 9933 <li>“connectors” 9934 <ul> 9935 <li>Access all the individual connectors.</li> 9936 </ul></li> 9937 <li>“top” 9938 <ul> 9939 <li>Access the home, favorites, and shared folders as well as the connectors.</li> 9940 </ul></li> 9941 </ul></li> 9942 </ul> 9943 <h3 id="advanced-options-7">Advanced Options</h3> 9944 <p>Here are the advanced options specific to sharefile (Citrix Sharefile).</p> 9945 <h4 id="sharefile-upload-cutoff">–sharefile-upload-cutoff</h4> 9946 <p>Cutoff for switching to multipart upload.</p> 9947 <ul> 9948 <li>Config: upload_cutoff</li> 9949 <li>Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF</li> 9950 <li>Type: SizeSuffix</li> 9951 <li>Default: 128M</li> 9952 </ul> 9953 <h4 id="sharefile-chunk-size">–sharefile-chunk-size</h4> 9954 <p>Upload chunk size. Must a power of 2 >= 256k.</p> 9955 <p>Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.</p> 9956 <p>Reducing this will reduce memory usage but decrease performance.</p> 9957 <ul> 9958 <li>Config: chunk_size</li> 9959 <li>Env Var: RCLONE_SHAREFILE_CHUNK_SIZE</li> 9960 <li>Type: SizeSuffix</li> 9961 <li>Default: 64M</li> 9962 </ul> 9963 <h4 id="sharefile-endpoint">–sharefile-endpoint</h4> 9964 <p>Endpoint for API calls.</p> 9965 <p>This is usually auto discovered as part of the oauth process, but can be set manually to something like: https://XXX.sharefile.com</p> 9966 <ul> 9967 <li>Config: endpoint</li> 9968 <li>Env Var: RCLONE_SHAREFILE_ENDPOINT</li> 9969 <li>Type: string</li> 9970 <li>Default: ""</li> 9971 </ul> 9972 <h4 id="sharefile-encoding">–sharefile-encoding</h4> 9973 <p>This sets the encoding for the backend.</p> 9974 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 9975 <ul> 9976 <li>Config: encoding</li> 9977 <li>Env Var: RCLONE_SHAREFILE_ENCODING</li> 9978 <li>Type: MultiEncoder</li> 9979 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot</li> 9980 </ul> 9981 <h2 id="crypt">Crypt</h2> 9982 <p>The <code>crypt</code> remote encrypts and decrypts another remote.</p> 9983 <p>To use it first set up the underlying remote following the config instructions for that remote. You can also use a local pathname instead of a remote which will encrypt and decrypt from that directory which might be useful for encrypting onto a USB stick for example.</p> 9984 <p>First check your chosen remote is working - we’ll call it <code>remote:path</code> in these docs. Note that anything inside <code>remote:path</code> will be encrypted and anything outside won’t. This means that if you are using a bucket based remote (eg S3, B2, swift) then you should probably put the bucket in the remote <code>s3:bucket</code>. If you just use <code>s3:</code> then rclone will make encrypted bucket names too (if using file name encryption) which may or may not be what you want.</p> 9985 <p>Now configure <code>crypt</code> using <code>rclone config</code>. We will call this one <code>secret</code> to differentiate it from the <code>remote</code>.</p> 9986 <pre><code>No remotes found - make a new one 9987 n) New remote 9988 s) Set configuration password 9989 q) Quit config 9990 n/s/q> n 9991 name> secret 9992 Type of storage to configure. 9993 Choose a number from below, or type in your own value 9994 [snip] 9995 XX / Encrypt/Decrypt a remote 9996 \ "crypt" 9997 [snip] 9998 Storage> crypt 9999 Remote to encrypt/decrypt. 10000 Normally should contain a ':' and a path, eg "myremote:path/to/dir", 10001 "myremote:bucket" or maybe "myremote:" (not recommended). 10002 remote> remote:path 10003 How to encrypt the filenames. 10004 Choose a number from below, or type in your own value 10005 1 / Don't encrypt the file names. Adds a ".bin" extension only. 10006 \ "off" 10007 2 / Encrypt the filenames see the docs for the details. 10008 \ "standard" 10009 3 / Very simple filename obfuscation. 10010 \ "obfuscate" 10011 filename_encryption> 2 10012 Option to either encrypt directory names or leave them intact. 10013 Choose a number from below, or type in your own value 10014 1 / Encrypt directory names. 10015 \ "true" 10016 2 / Don't encrypt directory names, leave them intact. 10017 \ "false" 10018 filename_encryption> 1 10019 Password or pass phrase for encryption. 10020 y) Yes type in my own password 10021 g) Generate random password 10022 y/g> y 10023 Enter the password: 10024 password: 10025 Confirm the password: 10026 password: 10027 Password or pass phrase for salt. Optional but recommended. 10028 Should be different to the previous password. 10029 y) Yes type in my own password 10030 g) Generate random password 10031 n) No leave this optional password blank 10032 y/g/n> g 10033 Password strength in bits. 10034 64 is just about memorable 10035 128 is secure 10036 1024 is the maximum 10037 Bits> 128 10038 Your password is: JAsJvRcgR-_veXNfy_sGmQ 10039 Use this password? 10040 y) Yes 10041 n) No 10042 y/n> y 10043 Remote config 10044 -------------------- 10045 [secret] 10046 remote = remote:path 10047 filename_encryption = standard 10048 password = *** ENCRYPTED *** 10049 password2 = *** ENCRYPTED *** 10050 -------------------- 10051 y) Yes this is OK 10052 e) Edit this remote 10053 d) Delete this remote 10054 y/e/d> y</code></pre> 10055 <p><strong>Important</strong> The password is stored in the config file is lightly obscured so it isn’t immediately obvious what it is. It is in no way secure unless you use config file encryption.</p> 10056 <p>A long passphrase is recommended, or you can use a random one.</p> 10057 <p>The obscured password is created by using AES-CTR with a static key, with the salt stored verbatim at the beginning of the obscured password. This static key is shared by between all versions of rclone.</p> 10058 <p>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.</p> 10059 <p>Note that rclone does not encrypt</p> 10060 <ul> 10061 <li>file length - this can be calculated within 16 bytes</li> 10062 <li>modification time - used for syncing</li> 10063 </ul> 10064 <h2 id="specifying-the-remote-1">Specifying the remote</h2> 10065 <p>In normal use, make sure the remote has a <code>:</code> in. If you specify the remote without a <code>:</code> then rclone will use a local directory of that name. So if you use a remote of <code>/path/to/secret/files</code> then rclone will encrypt stuff to that directory. If you use a remote of <code>name</code> then rclone will put files in a directory called <code>name</code> in the current directory.</p> 10066 <p>If you specify the remote as <code>remote:path/to/dir</code> then rclone will store encrypted files in <code>path/to/dir</code> on the remote. If you are using file name encryption, then when you save files to <code>secret:subdir/subfile</code> this will store them in the unencrypted path <code>path/to/dir</code> but the <code>subdir/subpath</code> bit will be encrypted.</p> 10067 <p>Note that unless you want encrypted bucket names (which are difficult to manage because you won’t know what directory they represent in web interfaces etc), you should probably specify a bucket, eg <code>remote:secretbucket</code> when using bucket based remotes such as S3, Swift, Hubic, B2, GCS.</p> 10068 <h2 id="example">Example</h2> 10069 <p>To test I made a little directory of files using “standard” file name encryption.</p> 10070 <pre><code>plaintext/ 10071 ├── file0.txt 10072 ├── file1.txt 10073 └── subdir 10074 ├── file2.txt 10075 ├── file3.txt 10076 └── subsubdir 10077 └── file4.txt</code></pre> 10078 <p>Copy these to the remote and list them back</p> 10079 <pre><code>$ rclone -q copy plaintext secret: 10080 $ rclone -q ls secret: 10081 7 file1.txt 10082 6 file0.txt 10083 8 subdir/file2.txt 10084 10 subdir/subsubdir/file4.txt 10085 9 subdir/file3.txt</code></pre> 10086 <p>Now see what that looked like when encrypted</p> 10087 <pre><code>$ rclone -q ls remote:path 10088 55 hagjclgavj2mbiqm6u6cnjjqcg 10089 54 v05749mltvv1tf4onltun46gls 10090 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 10091 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 10092 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps</code></pre> 10093 <p>Note that this retains the directory structure which means you can do this</p> 10094 <pre><code>$ rclone -q ls secret:subdir 10095 8 file2.txt 10096 9 file3.txt 10097 10 subsubdir/file4.txt</code></pre> 10098 <p>If don’t use file name encryption then the remote will look like this - note the <code>.bin</code> extensions added to prevent the cloud provider attempting to interpret the data.</p> 10099 <pre><code>$ rclone -q ls remote:path 10100 54 file0.txt.bin 10101 57 subdir/file3.txt.bin 10102 56 subdir/file2.txt.bin 10103 58 subdir/subsubdir/file4.txt.bin 10104 55 file1.txt.bin</code></pre> 10105 <h3 id="file-name-encryption-modes">File name encryption modes</h3> 10106 <p>Here are some of the features of the file name encryption modes</p> 10107 <p>Off</p> 10108 <ul> 10109 <li>doesn’t hide file names or directory structure</li> 10110 <li>allows for longer file names (~246 characters)</li> 10111 <li>can use sub paths and copy single files</li> 10112 </ul> 10113 <p>Standard</p> 10114 <ul> 10115 <li>file names encrypted</li> 10116 <li>file names can’t be as long (~143 characters)</li> 10117 <li>can use sub paths and copy single files</li> 10118 <li>directory structure visible</li> 10119 <li>identical files names will have identical uploaded names</li> 10120 <li>can use shortcuts to shorten the directory recursion</li> 10121 </ul> 10122 <p>Obfuscation</p> 10123 <p>This is a simple “rotate” of the filename, with each file having a rot distance based on the filename. We store the distance at the beginning of the filename. So a file called “hello” may become “53.jgnnq”.</p> 10124 <p>This is not a strong encryption of filenames, but it may stop automated scanning tools from picking up on filename patterns. As such it’s an intermediate between “off” and “standard”. The advantage is that it allows for longer path segment names.</p> 10125 <p>There is a possibility with some unicode based filenames that the obfuscation is weak and may map lower case characters to upper case equivalents. You can not rely on this for strong protection.</p> 10126 <ul> 10127 <li>file names very lightly obfuscated</li> 10128 <li>file names can be longer than standard encryption</li> 10129 <li>can use sub paths and copy single files</li> 10130 <li>directory structure visible</li> 10131 <li>identical files names will have identical uploaded names</li> 10132 </ul> 10133 <p>Cloud storage systems have various limits on file name length and total path length which you are more likely to hit using “Standard” file name encryption. If you keep your file names to below 156 characters in length then you should be OK on all providers.</p> 10134 <p>There may be an even more secure file name encryption mode in the future which will address the long file name problem.</p> 10135 <h3 id="directory-name-encryption">Directory name encryption</h3> 10136 <p>Crypt offers the option of encrypting dir names or leaving them intact. There are two options:</p> 10137 <p>True</p> 10138 <p>Encrypts the whole file path including directory names Example: <code>1/12/123.txt</code> is encrypted to <code>p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0</code></p> 10139 <p>False</p> 10140 <p>Only encrypts file names, skips directory names Example: <code>1/12/123.txt</code> is encrypted to <code>1/12/qgm4avr35m5loi1th53ato71v0</code></p> 10141 <h3 id="modified-time-and-hashes-3">Modified time and hashes</h3> 10142 <p>Crypt stores modification times using the underlying remote so support depends on that.</p> 10143 <p>Hashes are not stored for crypt. However the data integrity is protected by an extremely strong crypto authenticator.</p> 10144 <p>Note that you should use the <code>rclone cryptcheck</code> command to check the integrity of a crypted remote instead of <code>rclone check</code> which can’t check the checksums properly.</p> 10145 <h3 id="standard-options-9">Standard Options</h3> 10146 <p>Here are the standard options specific to crypt (Encrypt/Decrypt a remote).</p> 10147 <h4 id="crypt-remote">–crypt-remote</h4> 10148 <p>Remote to encrypt/decrypt. Normally should contain a ‘:’ and a path, eg “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not recommended).</p> 10149 <ul> 10150 <li>Config: remote</li> 10151 <li>Env Var: RCLONE_CRYPT_REMOTE</li> 10152 <li>Type: string</li> 10153 <li>Default: ""</li> 10154 </ul> 10155 <h4 id="crypt-filename-encryption">–crypt-filename-encryption</h4> 10156 <p>How to encrypt the filenames.</p> 10157 <ul> 10158 <li>Config: filename_encryption</li> 10159 <li>Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION</li> 10160 <li>Type: string</li> 10161 <li>Default: “standard”</li> 10162 <li>Examples: 10163 <ul> 10164 <li>“standard” 10165 <ul> 10166 <li>Encrypt the filenames see the docs for the details.</li> 10167 </ul></li> 10168 <li>“obfuscate” 10169 <ul> 10170 <li>Very simple filename obfuscation.</li> 10171 </ul></li> 10172 <li>“off” 10173 <ul> 10174 <li>Don’t encrypt the file names. Adds a “.bin” extension only.</li> 10175 </ul></li> 10176 </ul></li> 10177 </ul> 10178 <h4 id="crypt-directory-name-encryption">–crypt-directory-name-encryption</h4> 10179 <p>Option to either encrypt directory names or leave them intact.</p> 10180 <p>NB If filename_encryption is “off” then this option will do nothing.</p> 10181 <ul> 10182 <li>Config: directory_name_encryption</li> 10183 <li>Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION</li> 10184 <li>Type: bool</li> 10185 <li>Default: true</li> 10186 <li>Examples: 10187 <ul> 10188 <li>“true” 10189 <ul> 10190 <li>Encrypt directory names.</li> 10191 </ul></li> 10192 <li>“false” 10193 <ul> 10194 <li>Don’t encrypt directory names, leave them intact.</li> 10195 </ul></li> 10196 </ul></li> 10197 </ul> 10198 <h4 id="crypt-password">–crypt-password</h4> 10199 <p>Password or pass phrase for encryption.</p> 10200 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 10201 <ul> 10202 <li>Config: password</li> 10203 <li>Env Var: RCLONE_CRYPT_PASSWORD</li> 10204 <li>Type: string</li> 10205 <li>Default: ""</li> 10206 </ul> 10207 <h4 id="crypt-password2">–crypt-password2</h4> 10208 <p>Password or pass phrase for salt. Optional but recommended. Should be different to the previous password.</p> 10209 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 10210 <ul> 10211 <li>Config: password2</li> 10212 <li>Env Var: RCLONE_CRYPT_PASSWORD2</li> 10213 <li>Type: string</li> 10214 <li>Default: ""</li> 10215 </ul> 10216 <h3 id="advanced-options-8">Advanced Options</h3> 10217 <p>Here are the advanced options specific to crypt (Encrypt/Decrypt a remote).</p> 10218 <h4 id="crypt-show-mapping">–crypt-show-mapping</h4> 10219 <p>For all files listed show how the names encrypt.</p> 10220 <p>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.</p> 10221 <p>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.</p> 10222 <ul> 10223 <li>Config: show_mapping</li> 10224 <li>Env Var: RCLONE_CRYPT_SHOW_MAPPING</li> 10225 <li>Type: bool</li> 10226 <li>Default: false</li> 10227 </ul> 10228 <h3 id="backend-commands-1">Backend commands</h3> 10229 <p>Here are the commands specific to the crypt backend.</p> 10230 <p>Run them with</p> 10231 <pre><code>rclone backend COMMAND remote:</code></pre> 10232 <p>The help below will explain what arguments each command takes.</p> 10233 <p>See <a href="https://rclone.org/commands/rclone_backend/">the “rclone backend” command</a> for more info on how to pass options and arguments.</p> 10234 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend/command">backend/command</a>.</p> 10235 <h4 id="encode">encode</h4> 10236 <p>Encode the given filename(s)</p> 10237 <pre><code>rclone backend encode remote: [options] [<arguments>+]</code></pre> 10238 <p>This encodes the filenames given as arguments returning a list of strings of the encoded results.</p> 10239 <p>Usage Example:</p> 10240 <pre><code>rclone backend encode crypt: file1 [file2...] 10241 rclone rc backend/command command=encode fs=crypt: file1 [file2...]</code></pre> 10242 <h4 id="decode">decode</h4> 10243 <p>Decode the given filename(s)</p> 10244 <pre><code>rclone backend decode remote: [options] [<arguments>+]</code></pre> 10245 <p>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.</p> 10246 <p>Usage Example:</p> 10247 <pre><code>rclone backend decode crypt: encryptedfile1 [encryptedfile2...] 10248 rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]</code></pre> 10249 <h2 id="backing-up-a-crypted-remote">Backing up a crypted remote</h2> 10250 <p>If you wish to backup a crypted remote, it is recommended that you use <code>rclone sync</code> on the encrypted files, and make sure the passwords are the same in the new encrypted remote.</p> 10251 <p>This will have the following advantages</p> 10252 <ul> 10253 <li><code>rclone sync</code> will check the checksums while copying</li> 10254 <li>you can use <code>rclone check</code> between the encrypted remotes</li> 10255 <li>you don’t decrypt and encrypt unnecessarily</li> 10256 </ul> 10257 <p>For example, let’s say you have your original remote at <code>remote:</code> with the encrypted version at <code>eremote:</code> with path <code>remote:crypt</code>. You would then set up the new remote <code>remote2:</code> and then the encrypted version <code>eremote2:</code> with path <code>remote2:crypt</code> using the same passwords as <code>eremote:</code>.</p> 10258 <p>To sync the two remotes you would do</p> 10259 <pre><code>rclone sync remote:crypt remote2:crypt</code></pre> 10260 <p>And to check the integrity you would do</p> 10261 <pre><code>rclone check remote:crypt remote2:crypt</code></pre> 10262 <h2 id="file-formats">File formats</h2> 10263 <h3 id="file-encryption">File encryption</h3> 10264 <p>Files are encrypted 1:1 source file to destination object. The file has a header and is divided into chunks.</p> 10265 <h4 id="header-1">Header</h4> 10266 <ul> 10267 <li>8 bytes magic string <code>RCLONE\x00\x00</code></li> 10268 <li>24 bytes Nonce (IV)</li> 10269 </ul> 10270 <p>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 re-used is minuscule. If you wrote an exabyte of data (10¹⁸ bytes) you would have a probability of approximately 2×10⁻³² of re-using a nonce.</p> 10271 <h4 id="chunk">Chunk</h4> 10272 <p>Each chunk will contain 64kB 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.</p> 10273 <p>Each chunk contains:</p> 10274 <ul> 10275 <li>16 Bytes of Poly1305 authenticator</li> 10276 <li>1 - 65536 bytes XSalsa20 encrypted data</li> 10277 </ul> 10278 <p>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’t be too big.</p> 10279 <p>This uses a 32 byte (256 bit key) key derived from the user password.</p> 10280 <h4 id="examples">Examples</h4> 10281 <p>1 byte file will encrypt to</p> 10282 <ul> 10283 <li>32 bytes header</li> 10284 <li>17 bytes data chunk</li> 10285 </ul> 10286 <p>49 bytes total</p> 10287 <p>1MB (1048576 bytes) file will encrypt to</p> 10288 <ul> 10289 <li>32 bytes header</li> 10290 <li>16 chunks of 65568 bytes</li> 10291 </ul> 10292 <p>1049120 bytes total (a 0.05% overhead). This is the overhead for big files.</p> 10293 <h3 id="name-encryption">Name encryption</h3> 10294 <p>File names are encrypted segment by segment - the path is broken up into <code>/</code> separated strings and these are encrypted individually.</p> 10295 <p>File segments are padded using PKCS#7 to a multiple of 16 bytes before encryption.</p> 10296 <p>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 “A Parallelizable Enciphering Mode” by Halevi and Rogaway.</p> 10297 <p>This makes for deterministic encryption which is what we want - the same filename must encrypt to the same thing otherwise we can’t find it on the cloud storage system.</p> 10298 <p>This means that</p> 10299 <ul> 10300 <li>filenames with the same name will encrypt the same</li> 10301 <li>filenames which start the same won’t have a common prefix</li> 10302 </ul> 10303 <p>This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password.</p> 10304 <p>After encryption they are written out using a modified version of standard <code>base32</code> encoding as described in RFC4648. The standard encoding is modified in two ways:</p> 10305 <ul> 10306 <li>it becomes lower case (no-one likes upper case filenames!)</li> 10307 <li>we strip the padding character <code>=</code></li> 10308 </ul> 10309 <p><code>base32</code> is used rather than the more efficient <code>base64</code> so rclone can be used on case insensitive remotes (eg Windows, Amazon Drive).</p> 10310 <h3 id="key-derivation">Key derivation</h3> 10311 <p>Rclone uses <code>scrypt</code> with parameters <code>N=16384, r=8, p=1</code> with an optional user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key material required. If the user doesn’t supply a salt then rclone uses an internal one.</p> 10312 <p><code>scrypt</code> makes it impractical to mount a dictionary attack on rclone encrypted data. For full protection against this you should always use a salt.</p> 10313 <h2 id="dropbox">Dropbox</h2> 10314 <p>Paths are specified as <code>remote:path</code></p> 10315 <p>Dropbox paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 10316 <p>The initial setup for dropbox involves getting a token from Dropbox which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 10317 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 10318 <pre><code> rclone config</code></pre> 10319 <p>This will guide you through an interactive setup process:</p> 10320 <pre><code>n) New remote 10321 d) Delete remote 10322 q) Quit config 10323 e/n/d/q> n 10324 name> remote 10325 Type of storage to configure. 10326 Choose a number from below, or type in your own value 10327 [snip] 10328 XX / Dropbox 10329 \ "dropbox" 10330 [snip] 10331 Storage> dropbox 10332 Dropbox App Key - leave blank normally. 10333 app_key> 10334 Dropbox App Secret - leave blank normally. 10335 app_secret> 10336 Remote config 10337 Please visit: 10338 https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code 10339 Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX 10340 -------------------- 10341 [remote] 10342 app_key = 10343 app_secret = 10344 token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX 10345 -------------------- 10346 y) Yes this is OK 10347 e) Edit this remote 10348 d) Delete this remote 10349 y/e/d> y</code></pre> 10350 <p>You can then use it like this,</p> 10351 <p>List directories in top level of your dropbox</p> 10352 <pre><code>rclone lsd remote:</code></pre> 10353 <p>List all the files in your dropbox</p> 10354 <pre><code>rclone ls remote:</code></pre> 10355 <p>To copy a local directory to a dropbox directory called backup</p> 10356 <pre><code>rclone copy /home/source remote:backup</code></pre> 10357 <h3 id="dropbox-for-business">Dropbox for business</h3> 10358 <p>Rclone supports Dropbox for business and Team Folders.</p> 10359 <p>When using Dropbox for business <code>remote:</code> and <code>remote:path/to/file</code> will refer to your personal folder.</p> 10360 <p>If you wish to see Team Folders you must use a leading <code>/</code> in the path, so <code>rclone lsd remote:/</code> will refer to the root and show you all Team Folders and your User Folder.</p> 10361 <p>You can then use team folders like this <code>remote:/TeamFolder</code> and <code>remote:/TeamFolder/path/to/file</code>.</p> 10362 <p>A leading <code>/</code> for a Dropbox personal account will do nothing, but it will take an extra HTTP transaction so it should be avoided.</p> 10363 <h3 id="modified-time-and-hashes-4">Modified time and Hashes</h3> 10364 <p>Dropbox supports modified times, but the only way to set a modification time is to re-upload the file.</p> 10365 <p>This means that if you uploaded your data with an older version of rclone which didn’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’t want this to happen use <code>--size-only</code> or <code>--checksum</code> flag to stop it.</p> 10366 <p>Dropbox supports <a href="https://www.dropbox.com/developers/reference/content-hash">its own hash type</a> which is checked for all transfers.</p> 10367 <h4 id="restricted-filename-characters-6">Restricted filename characters</h4> 10368 <table> 10369 <thead> 10370 <tr class="header"> 10371 <th>Character</th> 10372 <th style="text-align: center;">Value</th> 10373 <th style="text-align: center;">Replacement</th> 10374 </tr> 10375 </thead> 10376 <tbody> 10377 <tr class="odd"> 10378 <td>NUL</td> 10379 <td style="text-align: center;">0x00</td> 10380 <td style="text-align: center;">␀</td> 10381 </tr> 10382 <tr class="even"> 10383 <td>/</td> 10384 <td style="text-align: center;">0x2F</td> 10385 <td style="text-align: center;">／</td> 10386 </tr> 10387 <tr class="odd"> 10388 <td>DEL</td> 10389 <td style="text-align: center;">0x7F</td> 10390 <td style="text-align: center;">␡</td> 10391 </tr> 10392 <tr class="even"> 10393 <td>\</td> 10394 <td style="text-align: center;">0x5C</td> 10395 <td style="text-align: center;">＼</td> 10396 </tr> 10397 </tbody> 10398 </table> 10399 <p>File names can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 10400 <table> 10401 <thead> 10402 <tr class="header"> 10403 <th>Character</th> 10404 <th style="text-align: center;">Value</th> 10405 <th style="text-align: center;">Replacement</th> 10406 </tr> 10407 </thead> 10408 <tbody> 10409 <tr class="odd"> 10410 <td>SP</td> 10411 <td style="text-align: center;">0x20</td> 10412 <td style="text-align: center;">␠</td> 10413 </tr> 10414 </tbody> 10415 </table> 10416 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 10417 <h3 id="standard-options-10">Standard Options</h3> 10418 <p>Here are the standard options specific to dropbox (Dropbox).</p> 10419 <h4 id="dropbox-client-id">–dropbox-client-id</h4> 10420 <p>Dropbox App Client Id Leave blank normally.</p> 10421 <ul> 10422 <li>Config: client_id</li> 10423 <li>Env Var: RCLONE_DROPBOX_CLIENT_ID</li> 10424 <li>Type: string</li> 10425 <li>Default: ""</li> 10426 </ul> 10427 <h4 id="dropbox-client-secret">–dropbox-client-secret</h4> 10428 <p>Dropbox App Client Secret Leave blank normally.</p> 10429 <ul> 10430 <li>Config: client_secret</li> 10431 <li>Env Var: RCLONE_DROPBOX_CLIENT_SECRET</li> 10432 <li>Type: string</li> 10433 <li>Default: ""</li> 10434 </ul> 10435 <h3 id="advanced-options-9">Advanced Options</h3> 10436 <p>Here are the advanced options specific to dropbox (Dropbox).</p> 10437 <h4 id="dropbox-chunk-size">–dropbox-chunk-size</h4> 10438 <p>Upload chunk size. (< 150M).</p> 10439 <p>Any files larger than this will be uploaded in chunks of this size.</p> 10440 <p>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 128MB in tests) at the cost of using more memory. It can be set smaller if you are tight on memory.</p> 10441 <ul> 10442 <li>Config: chunk_size</li> 10443 <li>Env Var: RCLONE_DROPBOX_CHUNK_SIZE</li> 10444 <li>Type: SizeSuffix</li> 10445 <li>Default: 48M</li> 10446 </ul> 10447 <h4 id="dropbox-impersonate">–dropbox-impersonate</h4> 10448 <p>Impersonate this user when using a business account.</p> 10449 <ul> 10450 <li>Config: impersonate</li> 10451 <li>Env Var: RCLONE_DROPBOX_IMPERSONATE</li> 10452 <li>Type: string</li> 10453 <li>Default: ""</li> 10454 </ul> 10455 <h4 id="dropbox-encoding">–dropbox-encoding</h4> 10456 <p>This sets the encoding for the backend.</p> 10457 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 10458 <ul> 10459 <li>Config: encoding</li> 10460 <li>Env Var: RCLONE_DROPBOX_ENCODING</li> 10461 <li>Type: MultiEncoder</li> 10462 <li>Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot</li> 10463 </ul> 10464 <h3 id="limitations-5">Limitations</h3> 10465 <p>Note that Dropbox is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 10466 <p>There are some file names such as <code>thumbs.db</code> which Dropbox can’t store. There is a full list of them in the <a href="https://www.dropbox.com/en/help/145">“Ignored Files” section of this document</a>. Rclone will issue an error message <code>File name disallowed - not uploading</code> if it attempts to upload one of those file names, but the sync won’t fail.</p> 10467 <p>If you have more than 10,000 files in a directory then <code>rclone purge dropbox:dir</code> will return the error <code>Failed to purge: There are too many files involved in this operation</code>. As a work-around do an <code>rclone delete dropbox:dir</code> followed by an <code>rclone rmdir dropbox:dir</code>.</p> 10468 <h3 id="get-your-own-dropbox-app-id">Get your own Dropbox App ID</h3> 10469 <p>When you use rclone with Dropbox in its default configuration you are using rclone’s App ID. This is shared between all the rclone users.</p> 10470 <p>Here is how to create your own Dropbox App ID for rclone:</p> 10471 <ol type="1"> 10472 <li><p>Log into the <a href="https://www.dropbox.com/developers/apps/create">Dropbox App console</a> with your Dropbox Account (It need not to be the same account as the Dropbox you want to access)</p></li> 10473 <li><p>Choose an API => Usually this should be <code>Dropbox API</code></p></li> 10474 <li><p>Choose the type of access you want to use => <code>Full Dropbox</code> or <code>App Folder</code></p></li> 10475 <li><p>Name your App. The app name is global, so you can’t use <code>rclone</code> for example</p></li> 10476 <li><p>Click the button <code>Create App</code></p></li> 10477 <li><p>Fill <code>Redirect URIs</code> as <code>http://localhost:53682/</code></p></li> 10478 <li><p>Find the <code>App key</code> and <code>App secret</code> Use these values in rclone config to add a new remote or edit an existing remote.</p></li> 10479 </ol> 10480 <h2 id="ftp">FTP</h2> 10481 <p>FTP is the File Transfer Protocol. FTP support is provided using the <a href="https://godoc.org/github.com/jlaffaye/ftp">github.com/jlaffaye/ftp</a> package.</p> 10482 <p>Here is an example of making an FTP configuration. First run</p> 10483 <pre><code>rclone config</code></pre> 10484 <p>This will guide you through an interactive setup process. An FTP remote only needs a host together with and a username and a password. With anonymous FTP server, you will need to use <code>anonymous</code> as username and your email address as the password.</p> 10485 <pre><code>No remotes found - make a new one 10486 n) New remote 10487 r) Rename remote 10488 c) Copy remote 10489 s) Set configuration password 10490 q) Quit config 10491 n/r/c/s/q> n 10492 name> remote 10493 Type of storage to configure. 10494 Enter a string value. Press Enter for the default (""). 10495 Choose a number from below, or type in your own value 10496 [snip] 10497 XX / FTP Connection 10498 \ "ftp" 10499 [snip] 10500 Storage> ftp 10501 ** See help for ftp backend at: https://rclone.org/ftp/ ** 10502 10503 FTP host to connect to 10504 Enter a string value. Press Enter for the default (""). 10505 Choose a number from below, or type in your own value 10506 1 / Connect to ftp.example.com 10507 \ "ftp.example.com" 10508 host> ftp.example.com 10509 FTP username, leave blank for current username, ncw 10510 Enter a string value. Press Enter for the default (""). 10511 user> 10512 FTP port, leave blank to use default (21) 10513 Enter a string value. Press Enter for the default (""). 10514 port> 10515 FTP password 10516 y) Yes type in my own password 10517 g) Generate random password 10518 y/g> y 10519 Enter the password: 10520 password: 10521 Confirm the password: 10522 password: 10523 Use FTP over TLS (Implicit) 10524 Enter a boolean value (true or false). Press Enter for the default ("false"). 10525 tls> 10526 Remote config 10527 -------------------- 10528 [remote] 10529 type = ftp 10530 host = ftp.example.com 10531 pass = *** ENCRYPTED *** 10532 -------------------- 10533 y) Yes this is OK 10534 e) Edit this remote 10535 d) Delete this remote 10536 y/e/d> y</code></pre> 10537 <p>This remote is called <code>remote</code> and can now be used like this</p> 10538 <p>See all directories in the home directory</p> 10539 <pre><code>rclone lsd remote:</code></pre> 10540 <p>Make a new directory</p> 10541 <pre><code>rclone mkdir remote:path/to/directory</code></pre> 10542 <p>List the contents of a directory</p> 10543 <pre><code>rclone ls remote:path/to/directory</code></pre> 10544 <p>Sync <code>/home/local/directory</code> to the remote directory, deleting any excess files in the directory.</p> 10545 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 10546 <h3 id="modified-time-3">Modified time</h3> 10547 <p>FTP does not support modified times. Any times you see on the server will be time of upload.</p> 10548 <h3 id="checksums">Checksums</h3> 10549 <p>FTP does not support any checksums.</p> 10550 <h3 id="usage-without-a-config-file">Usage without a config file</h3> 10551 <p>An example how to use the ftp remote without a config file:</p> 10552 <pre><code>rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy`</code></pre> 10553 <h4 id="restricted-filename-characters-7">Restricted filename characters</h4> 10554 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 10555 <p>File names can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 10556 <table> 10557 <thead> 10558 <tr class="header"> 10559 <th>Character</th> 10560 <th style="text-align: center;">Value</th> 10561 <th style="text-align: center;">Replacement</th> 10562 </tr> 10563 </thead> 10564 <tbody> 10565 <tr class="odd"> 10566 <td>SP</td> 10567 <td style="text-align: center;">0x20</td> 10568 <td style="text-align: center;">␠</td> 10569 </tr> 10570 </tbody> 10571 </table> 10572 <p>Note that not all FTP servers can have all characters in file names, for example:</p> 10573 <table> 10574 <thead> 10575 <tr class="header"> 10576 <th>FTP Server</th> 10577 <th style="text-align: center;">Forbidden characters</th> 10578 </tr> 10579 </thead> 10580 <tbody> 10581 <tr class="odd"> 10582 <td>proftpd</td> 10583 <td style="text-align: center;"><code>*</code></td> 10584 </tr> 10585 <tr class="even"> 10586 <td>pureftpd</td> 10587 <td style="text-align: center;"><code>\ [ ]</code></td> 10588 </tr> 10589 </tbody> 10590 </table> 10591 <h3 id="implicit-tls">Implicit TLS</h3> 10592 <p>FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled in the config for the remote. The default FTPS port is <code>990</code> so the port will likely have to be explicitly set in the config for the remote.</p> 10593 <h3 id="standard-options-11">Standard Options</h3> 10594 <p>Here are the standard options specific to ftp (FTP Connection).</p> 10595 <h4 id="ftp-host">–ftp-host</h4> 10596 <p>FTP host to connect to</p> 10597 <ul> 10598 <li>Config: host</li> 10599 <li>Env Var: RCLONE_FTP_HOST</li> 10600 <li>Type: string</li> 10601 <li>Default: ""</li> 10602 <li>Examples: 10603 <ul> 10604 <li>“ftp.example.com” 10605 <ul> 10606 <li>Connect to ftp.example.com</li> 10607 </ul></li> 10608 </ul></li> 10609 </ul> 10610 <h4 id="ftp-user">–ftp-user</h4> 10611 <p>FTP username, leave blank for current username, $USER</p> 10612 <ul> 10613 <li>Config: user</li> 10614 <li>Env Var: RCLONE_FTP_USER</li> 10615 <li>Type: string</li> 10616 <li>Default: ""</li> 10617 </ul> 10618 <h4 id="ftp-port">–ftp-port</h4> 10619 <p>FTP port, leave blank to use default (21)</p> 10620 <ul> 10621 <li>Config: port</li> 10622 <li>Env Var: RCLONE_FTP_PORT</li> 10623 <li>Type: string</li> 10624 <li>Default: ""</li> 10625 </ul> 10626 <h4 id="ftp-pass">–ftp-pass</h4> 10627 <p>FTP password</p> 10628 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 10629 <ul> 10630 <li>Config: pass</li> 10631 <li>Env Var: RCLONE_FTP_PASS</li> 10632 <li>Type: string</li> 10633 <li>Default: ""</li> 10634 </ul> 10635 <h4 id="ftp-tls">–ftp-tls</h4> 10636 <p>Use FTP over TLS (Implicit)</p> 10637 <ul> 10638 <li>Config: tls</li> 10639 <li>Env Var: RCLONE_FTP_TLS</li> 10640 <li>Type: bool</li> 10641 <li>Default: false</li> 10642 </ul> 10643 <h3 id="advanced-options-10">Advanced Options</h3> 10644 <p>Here are the advanced options specific to ftp (FTP Connection).</p> 10645 <h4 id="ftp-concurrency">–ftp-concurrency</h4> 10646 <p>Maximum number of FTP simultaneous connections, 0 for unlimited</p> 10647 <ul> 10648 <li>Config: concurrency</li> 10649 <li>Env Var: RCLONE_FTP_CONCURRENCY</li> 10650 <li>Type: int</li> 10651 <li>Default: 0</li> 10652 </ul> 10653 <h4 id="ftp-no-check-certificate">–ftp-no-check-certificate</h4> 10654 <p>Do not verify the TLS certificate of the server</p> 10655 <ul> 10656 <li>Config: no_check_certificate</li> 10657 <li>Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE</li> 10658 <li>Type: bool</li> 10659 <li>Default: false</li> 10660 </ul> 10661 <h4 id="ftp-disable-epsv">–ftp-disable-epsv</h4> 10662 <p>Disable using EPSV even if server advertises support</p> 10663 <ul> 10664 <li>Config: disable_epsv</li> 10665 <li>Env Var: RCLONE_FTP_DISABLE_EPSV</li> 10666 <li>Type: bool</li> 10667 <li>Default: false</li> 10668 </ul> 10669 <h4 id="ftp-encoding">–ftp-encoding</h4> 10670 <p>This sets the encoding for the backend.</p> 10671 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 10672 <ul> 10673 <li>Config: encoding</li> 10674 <li>Env Var: RCLONE_FTP_ENCODING</li> 10675 <li>Type: MultiEncoder</li> 10676 <li>Default: Slash,Del,Ctl,RightSpace,Dot</li> 10677 </ul> 10678 <h3 id="limitations-6">Limitations</h3> 10679 <p>Note that since FTP isn’t HTTP based the following flags don’t work with it: <code>--dump-headers</code>, <code>--dump-bodies</code>, <code>--dump-auth</code></p> 10680 <p>Note that <code>--timeout</code> isn’t supported (but <code>--contimeout</code> is).</p> 10681 <p>Note that <code>--bind</code> isn’t supported.</p> 10682 <p>FTP could support server side move but doesn’t yet.</p> 10683 <p>Note that the ftp backend does not support the <code>ftp_proxy</code> environment variable yet.</p> 10684 <p>Note that while implicit FTP over TLS is supported, explicit FTP over TLS is not.</p> 10685 <h2 id="google-cloud-storage">Google Cloud Storage</h2> 10686 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p> 10687 <p>The initial setup for google cloud storage involves getting a token from Google Cloud Storage which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 10688 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 10689 <pre><code> rclone config</code></pre> 10690 <p>This will guide you through an interactive setup process:</p> 10691 <pre><code>n) New remote 10692 d) Delete remote 10693 q) Quit config 10694 e/n/d/q> n 10695 name> remote 10696 Type of storage to configure. 10697 Choose a number from below, or type in your own value 10698 [snip] 10699 XX / Google Cloud Storage (this is not Google Drive) 10700 \ "google cloud storage" 10701 [snip] 10702 Storage> google cloud storage 10703 Google Application Client Id - leave blank normally. 10704 client_id> 10705 Google Application Client Secret - leave blank normally. 10706 client_secret> 10707 Project number optional - needed only for list/create/delete buckets - see your developer console. 10708 project_number> 12345678 10709 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. 10710 service_account_file> 10711 Access Control List for new objects. 10712 Choose a number from below, or type in your own value 10713 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. 10714 \ "authenticatedRead" 10715 2 / Object owner gets OWNER access, and project team owners get OWNER access. 10716 \ "bucketOwnerFullControl" 10717 3 / Object owner gets OWNER access, and project team owners get READER access. 10718 \ "bucketOwnerRead" 10719 4 / Object owner gets OWNER access [default if left blank]. 10720 \ "private" 10721 5 / Object owner gets OWNER access, and project team members get access according to their roles. 10722 \ "projectPrivate" 10723 6 / Object owner gets OWNER access, and all Users get READER access. 10724 \ "publicRead" 10725 object_acl> 4 10726 Access Control List for new buckets. 10727 Choose a number from below, or type in your own value 10728 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. 10729 \ "authenticatedRead" 10730 2 / Project team owners get OWNER access [default if left blank]. 10731 \ "private" 10732 3 / Project team members get access according to their roles. 10733 \ "projectPrivate" 10734 4 / Project team owners get OWNER access, and all Users get READER access. 10735 \ "publicRead" 10736 5 / Project team owners get OWNER access, and all Users get WRITER access. 10737 \ "publicReadWrite" 10738 bucket_acl> 2 10739 Location for the newly created buckets. 10740 Choose a number from below, or type in your own value 10741 1 / Empty for default location (US). 10742 \ "" 10743 2 / Multi-regional location for Asia. 10744 \ "asia" 10745 3 / Multi-regional location for Europe. 10746 \ "eu" 10747 4 / Multi-regional location for United States. 10748 \ "us" 10749 5 / Taiwan. 10750 \ "asia-east1" 10751 6 / Tokyo. 10752 \ "asia-northeast1" 10753 7 / Singapore. 10754 \ "asia-southeast1" 10755 8 / Sydney. 10756 \ "australia-southeast1" 10757 9 / Belgium. 10758 \ "europe-west1" 10759 10 / London. 10760 \ "europe-west2" 10761 11 / Iowa. 10762 \ "us-central1" 10763 12 / South Carolina. 10764 \ "us-east1" 10765 13 / Northern Virginia. 10766 \ "us-east4" 10767 14 / Oregon. 10768 \ "us-west1" 10769 location> 12 10770 The storage class to use when storing objects in Google Cloud Storage. 10771 Choose a number from below, or type in your own value 10772 1 / Default 10773 \ "" 10774 2 / Multi-regional storage class 10775 \ "MULTI_REGIONAL" 10776 3 / Regional storage class 10777 \ "REGIONAL" 10778 4 / Nearline storage class 10779 \ "NEARLINE" 10780 5 / Coldline storage class 10781 \ "COLDLINE" 10782 6 / Durable reduced availability storage class 10783 \ "DURABLE_REDUCED_AVAILABILITY" 10784 storage_class> 5 10785 Remote config 10786 Use auto config? 10787 * Say Y if not sure 10788 * Say N if you are working on a remote or headless machine or Y didn't work 10789 y) Yes 10790 n) No 10791 y/n> y 10792 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 10793 Log in and authorize rclone for access 10794 Waiting for code... 10795 Got code 10796 -------------------- 10797 [remote] 10798 type = google cloud storage 10799 client_id = 10800 client_secret = 10801 token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} 10802 project_number = 12345678 10803 object_acl = private 10804 bucket_acl = private 10805 -------------------- 10806 y) Yes this is OK 10807 e) Edit this remote 10808 d) Delete this remote 10809 y/e/d> y</code></pre> 10810 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p> 10811 <p>This remote is called <code>remote</code> and can now be used like this</p> 10812 <p>See all the buckets in your project</p> 10813 <pre><code>rclone lsd remote:</code></pre> 10814 <p>Make a new bucket</p> 10815 <pre><code>rclone mkdir remote:bucket</code></pre> 10816 <p>List the contents of a bucket</p> 10817 <pre><code>rclone ls remote:bucket</code></pre> 10818 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 10819 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 10820 <h3 id="service-account-support">Service Account support</h3> 10821 <p>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’t have actively logged-in users, for example build machines.</p> 10822 <p>To get credentials for Google Cloud Platform <a href="https://cloud.google.com/iam/docs/service-accounts">IAM Service Accounts</a>, please head to the <a href="https://console.cloud.google.com/permissions/serviceaccounts">Service Account</a> section of the Google Developer Console. Service Accounts behave just like normal <code>User</code> permissions in <a href="https://cloud.google.com/storage/docs/access-control">Google Cloud Storage ACLs</a>, so you can limit their access (e.g. make them read only). After creating an account, a JSON file containing the Service Account’s credentials will be downloaded onto your machines. These credentials are what rclone will use for authentication.</p> 10823 <p>To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the <code>service_account_file</code> prompt and rclone won’t use the browser based authentication flow. If you’d rather stuff the contents of the credentials file into the rclone config file, you can set <code>service_account_credentials</code> with the actual contents of the file instead, or set the equivalent environment variable.</p> 10824 <h3 id="application-default-credentials">Application Default Credentials</h3> 10825 <p>If no other source of credentials is provided, rclone will fall back to <a href="https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials">Application Default Credentials</a> 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 - <a href="https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper">see this page</a>.</p> 10826 <p>Note that in the case application default credentials are used, there is no need to explicitly configure a project number.</p> 10827 <h3 id="fast-list-3">–fast-list</h3> 10828 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 10829 <h3 id="custom-upload-headers">Custom upload headers</h3> 10830 <p>You can set custom upload headers with the <code>--header-upload</code> flag. Google Cloud Storage supports the headers as described in the <a href="https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata">working with metadata documentation</a></p> 10831 <ul> 10832 <li>Cache-Control</li> 10833 <li>Content-Disposition</li> 10834 <li>Content-Encoding</li> 10835 <li>Content-Language</li> 10836 <li>Content-Type</li> 10837 <li>X-Goog-Meta-</li> 10838 </ul> 10839 <p>Eg <code>--header-upload "Content-Type text/potato"</code></p> 10840 <p>Note that the last of these is for setting custom metadata in the form <code>--header-upload "x-goog-meta-key: value"</code></p> 10841 <h3 id="modified-time-4">Modified time</h3> 10842 <p>Google google cloud storage stores md5sums natively and rclone stores modification times as metadata on the object, under the “mtime” key in RFC3339 format accurate to 1ns.</p> 10843 <h4 id="restricted-filename-characters-8">Restricted filename characters</h4> 10844 <table> 10845 <thead> 10846 <tr class="header"> 10847 <th>Character</th> 10848 <th style="text-align: center;">Value</th> 10849 <th style="text-align: center;">Replacement</th> 10850 </tr> 10851 </thead> 10852 <tbody> 10853 <tr class="odd"> 10854 <td>NUL</td> 10855 <td style="text-align: center;">0x00</td> 10856 <td style="text-align: center;">␀</td> 10857 </tr> 10858 <tr class="even"> 10859 <td>LF</td> 10860 <td style="text-align: center;">0x0A</td> 10861 <td style="text-align: center;">␊</td> 10862 </tr> 10863 <tr class="odd"> 10864 <td>CR</td> 10865 <td style="text-align: center;">0x0D</td> 10866 <td style="text-align: center;">␍</td> 10867 </tr> 10868 <tr class="even"> 10869 <td>/</td> 10870 <td style="text-align: center;">0x2F</td> 10871 <td style="text-align: center;">／</td> 10872 </tr> 10873 </tbody> 10874 </table> 10875 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 10876 <h3 id="standard-options-12">Standard Options</h3> 10877 <p>Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).</p> 10878 <h4 id="gcs-client-id">–gcs-client-id</h4> 10879 <p>Google Application Client Id Leave blank normally.</p> 10880 <ul> 10881 <li>Config: client_id</li> 10882 <li>Env Var: RCLONE_GCS_CLIENT_ID</li> 10883 <li>Type: string</li> 10884 <li>Default: ""</li> 10885 </ul> 10886 <h4 id="gcs-client-secret">–gcs-client-secret</h4> 10887 <p>Google Application Client Secret Leave blank normally.</p> 10888 <ul> 10889 <li>Config: client_secret</li> 10890 <li>Env Var: RCLONE_GCS_CLIENT_SECRET</li> 10891 <li>Type: string</li> 10892 <li>Default: ""</li> 10893 </ul> 10894 <h4 id="gcs-project-number">–gcs-project-number</h4> 10895 <p>Project number. Optional - needed only for list/create/delete buckets - see your developer console.</p> 10896 <ul> 10897 <li>Config: project_number</li> 10898 <li>Env Var: RCLONE_GCS_PROJECT_NUMBER</li> 10899 <li>Type: string</li> 10900 <li>Default: ""</li> 10901 </ul> 10902 <h4 id="gcs-service-account-file">–gcs-service-account-file</h4> 10903 <p>Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 10904 <ul> 10905 <li>Config: service_account_file</li> 10906 <li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE</li> 10907 <li>Type: string</li> 10908 <li>Default: ""</li> 10909 </ul> 10910 <h4 id="gcs-service-account-credentials">–gcs-service-account-credentials</h4> 10911 <p>Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 10912 <ul> 10913 <li>Config: service_account_credentials</li> 10914 <li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS</li> 10915 <li>Type: string</li> 10916 <li>Default: ""</li> 10917 </ul> 10918 <h4 id="gcs-object-acl">–gcs-object-acl</h4> 10919 <p>Access Control List for new objects.</p> 10920 <ul> 10921 <li>Config: object_acl</li> 10922 <li>Env Var: RCLONE_GCS_OBJECT_ACL</li> 10923 <li>Type: string</li> 10924 <li>Default: ""</li> 10925 <li>Examples: 10926 <ul> 10927 <li>“authenticatedRead” 10928 <ul> 10929 <li>Object owner gets OWNER access, and all Authenticated Users get READER access.</li> 10930 </ul></li> 10931 <li>“bucketOwnerFullControl” 10932 <ul> 10933 <li>Object owner gets OWNER access, and project team owners get OWNER access.</li> 10934 </ul></li> 10935 <li>“bucketOwnerRead” 10936 <ul> 10937 <li>Object owner gets OWNER access, and project team owners get READER access.</li> 10938 </ul></li> 10939 <li>“private” 10940 <ul> 10941 <li>Object owner gets OWNER access [default if left blank].</li> 10942 </ul></li> 10943 <li>“projectPrivate” 10944 <ul> 10945 <li>Object owner gets OWNER access, and project team members get access according to their roles.</li> 10946 </ul></li> 10947 <li>“publicRead” 10948 <ul> 10949 <li>Object owner gets OWNER access, and all Users get READER access.</li> 10950 </ul></li> 10951 </ul></li> 10952 </ul> 10953 <h4 id="gcs-bucket-acl">–gcs-bucket-acl</h4> 10954 <p>Access Control List for new buckets.</p> 10955 <ul> 10956 <li>Config: bucket_acl</li> 10957 <li>Env Var: RCLONE_GCS_BUCKET_ACL</li> 10958 <li>Type: string</li> 10959 <li>Default: ""</li> 10960 <li>Examples: 10961 <ul> 10962 <li>“authenticatedRead” 10963 <ul> 10964 <li>Project team owners get OWNER access, and all Authenticated Users get READER access.</li> 10965 </ul></li> 10966 <li>“private” 10967 <ul> 10968 <li>Project team owners get OWNER access [default if left blank].</li> 10969 </ul></li> 10970 <li>“projectPrivate” 10971 <ul> 10972 <li>Project team members get access according to their roles.</li> 10973 </ul></li> 10974 <li>“publicRead” 10975 <ul> 10976 <li>Project team owners get OWNER access, and all Users get READER access.</li> 10977 </ul></li> 10978 <li>“publicReadWrite” 10979 <ul> 10980 <li>Project team owners get OWNER access, and all Users get WRITER access.</li> 10981 </ul></li> 10982 </ul></li> 10983 </ul> 10984 <h4 id="gcs-bucket-policy-only">–gcs-bucket-policy-only</h4> 10985 <p>Access checks should use bucket-level IAM policies.</p> 10986 <p>If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this.</p> 10987 <p>When it is set, rclone:</p> 10988 <ul> 10989 <li>ignores ACLs set on buckets</li> 10990 <li>ignores ACLs set on objects</li> 10991 <li>creates buckets with Bucket Policy Only set</li> 10992 </ul> 10993 <p>Docs: https://cloud.google.com/storage/docs/bucket-policy-only</p> 10994 <ul> 10995 <li>Config: bucket_policy_only</li> 10996 <li>Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY</li> 10997 <li>Type: bool</li> 10998 <li>Default: false</li> 10999 </ul> 11000 <h4 id="gcs-location">–gcs-location</h4> 11001 <p>Location for the newly created buckets.</p> 11002 <ul> 11003 <li>Config: location</li> 11004 <li>Env Var: RCLONE_GCS_LOCATION</li> 11005 <li>Type: string</li> 11006 <li>Default: ""</li> 11007 <li>Examples: 11008 <ul> 11009 <li>"" 11010 <ul> 11011 <li>Empty for default location (US).</li> 11012 </ul></li> 11013 <li>“asia” 11014 <ul> 11015 <li>Multi-regional location for Asia.</li> 11016 </ul></li> 11017 <li>“eu” 11018 <ul> 11019 <li>Multi-regional location for Europe.</li> 11020 </ul></li> 11021 <li>“us” 11022 <ul> 11023 <li>Multi-regional location for United States.</li> 11024 </ul></li> 11025 <li>“asia-east1” 11026 <ul> 11027 <li>Taiwan.</li> 11028 </ul></li> 11029 <li>“asia-east2” 11030 <ul> 11031 <li>Hong Kong.</li> 11032 </ul></li> 11033 <li>“asia-northeast1” 11034 <ul> 11035 <li>Tokyo.</li> 11036 </ul></li> 11037 <li>“asia-south1” 11038 <ul> 11039 <li>Mumbai.</li> 11040 </ul></li> 11041 <li>“asia-southeast1” 11042 <ul> 11043 <li>Singapore.</li> 11044 </ul></li> 11045 <li>“australia-southeast1” 11046 <ul> 11047 <li>Sydney.</li> 11048 </ul></li> 11049 <li>“europe-north1” 11050 <ul> 11051 <li>Finland.</li> 11052 </ul></li> 11053 <li>“europe-west1” 11054 <ul> 11055 <li>Belgium.</li> 11056 </ul></li> 11057 <li>“europe-west2” 11058 <ul> 11059 <li>London.</li> 11060 </ul></li> 11061 <li>“europe-west3” 11062 <ul> 11063 <li>Frankfurt.</li> 11064 </ul></li> 11065 <li>“europe-west4” 11066 <ul> 11067 <li>Netherlands.</li> 11068 </ul></li> 11069 <li>“us-central1” 11070 <ul> 11071 <li>Iowa.</li> 11072 </ul></li> 11073 <li>“us-east1” 11074 <ul> 11075 <li>South Carolina.</li> 11076 </ul></li> 11077 <li>“us-east4” 11078 <ul> 11079 <li>Northern Virginia.</li> 11080 </ul></li> 11081 <li>“us-west1” 11082 <ul> 11083 <li>Oregon.</li> 11084 </ul></li> 11085 <li>“us-west2” 11086 <ul> 11087 <li>California.</li> 11088 </ul></li> 11089 </ul></li> 11090 </ul> 11091 <h4 id="gcs-storage-class">–gcs-storage-class</h4> 11092 <p>The storage class to use when storing objects in Google Cloud Storage.</p> 11093 <ul> 11094 <li>Config: storage_class</li> 11095 <li>Env Var: RCLONE_GCS_STORAGE_CLASS</li> 11096 <li>Type: string</li> 11097 <li>Default: ""</li> 11098 <li>Examples: 11099 <ul> 11100 <li>"" 11101 <ul> 11102 <li>Default</li> 11103 </ul></li> 11104 <li>“MULTI_REGIONAL” 11105 <ul> 11106 <li>Multi-regional storage class</li> 11107 </ul></li> 11108 <li>“REGIONAL” 11109 <ul> 11110 <li>Regional storage class</li> 11111 </ul></li> 11112 <li>“NEARLINE” 11113 <ul> 11114 <li>Nearline storage class</li> 11115 </ul></li> 11116 <li>“COLDLINE” 11117 <ul> 11118 <li>Coldline storage class</li> 11119 </ul></li> 11120 <li>“ARCHIVE” 11121 <ul> 11122 <li>Archive storage class</li> 11123 </ul></li> 11124 <li>“DURABLE_REDUCED_AVAILABILITY” 11125 <ul> 11126 <li>Durable reduced availability storage class</li> 11127 </ul></li> 11128 </ul></li> 11129 </ul> 11130 <h3 id="advanced-options-11">Advanced Options</h3> 11131 <p>Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).</p> 11132 <h4 id="gcs-encoding">–gcs-encoding</h4> 11133 <p>This sets the encoding for the backend.</p> 11134 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 11135 <ul> 11136 <li>Config: encoding</li> 11137 <li>Env Var: RCLONE_GCS_ENCODING</li> 11138 <li>Type: MultiEncoder</li> 11139 <li>Default: Slash,CrLf,InvalidUtf8,Dot</li> 11140 </ul> 11141 <h2 id="google-drive">Google Drive</h2> 11142 <p>Paths are specified as <code>drive:path</code></p> 11143 <p>Drive paths may be as deep as required, eg <code>drive:directory/subdirectory</code>.</p> 11144 <p>The initial setup for drive involves getting a token from Google drive which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 11145 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 11146 <pre><code> rclone config</code></pre> 11147 <p>This will guide you through an interactive setup process:</p> 11148 <pre><code>No remotes found - make a new one 11149 n) New remote 11150 r) Rename remote 11151 c) Copy remote 11152 s) Set configuration password 11153 q) Quit config 11154 n/r/c/s/q> n 11155 name> remote 11156 Type of storage to configure. 11157 Choose a number from below, or type in your own value 11158 [snip] 11159 XX / Google Drive 11160 \ "drive" 11161 [snip] 11162 Storage> drive 11163 Google Application Client Id - leave blank normally. 11164 client_id> 11165 Google Application Client Secret - leave blank normally. 11166 client_secret> 11167 Scope that rclone should use when requesting access from drive. 11168 Choose a number from below, or type in your own value 11169 1 / Full access all files, excluding Application Data Folder. 11170 \ "drive" 11171 2 / Read-only access to file metadata and file contents. 11172 \ "drive.readonly" 11173 / Access to files created by rclone only. 11174 3 | These are visible in the drive website. 11175 | File authorization is revoked when the user deauthorizes the app. 11176 \ "drive.file" 11177 / Allows read and write access to the Application Data folder. 11178 4 | This is not visible in the drive website. 11179 \ "drive.appfolder" 11180 / Allows read-only access to file metadata but 11181 5 | does not allow any access to read or download file content. 11182 \ "drive.metadata.readonly" 11183 scope> 1 11184 ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). 11185 root_folder_id> 11186 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. 11187 service_account_file> 11188 Remote config 11189 Use auto config? 11190 * Say Y if not sure 11191 * Say N if you are working on a remote or headless machine or Y didn't work 11192 y) Yes 11193 n) No 11194 y/n> y 11195 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 11196 Log in and authorize rclone for access 11197 Waiting for code... 11198 Got code 11199 Configure this as a team drive? 11200 y) Yes 11201 n) No 11202 y/n> n 11203 -------------------- 11204 [remote] 11205 client_id = 11206 client_secret = 11207 scope = drive 11208 root_folder_id = 11209 service_account_file = 11210 token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} 11211 -------------------- 11212 y) Yes this is OK 11213 e) Edit this remote 11214 d) Delete this remote 11215 y/e/d> y</code></pre> 11216 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p> 11217 <p>You can then use it like this,</p> 11218 <p>List directories in top level of your drive</p> 11219 <pre><code>rclone lsd remote:</code></pre> 11220 <p>List all the files in your drive</p> 11221 <pre><code>rclone ls remote:</code></pre> 11222 <p>To copy a local directory to a drive directory called backup</p> 11223 <pre><code>rclone copy /home/source remote:backup</code></pre> 11224 <h3 id="scopes">Scopes</h3> 11225 <p>Rclone allows you to select which scope you would like for rclone to use. This changes what type of token is granted to rclone. <a href="https://developers.google.com/drive/v3/web/about-auth">The scopes are defined here</a>.</p> 11226 <p>The scope are</p> 11227 <h4 id="drive">drive</h4> 11228 <p>This is the default scope and allows full access to all files, except for the Application Data Folder (see below).</p> 11229 <p>Choose this one if you aren’t sure.</p> 11230 <h4 id="drive.readonly">drive.readonly</h4> 11231 <p>This allows read only access to all files. Files may be listed and downloaded but not uploaded, renamed or deleted.</p> 11232 <h4 id="drive.file">drive.file</h4> 11233 <p>With this scope rclone can read/view/modify only those files and folders it creates.</p> 11234 <p>So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone.</p> 11235 <p>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.</p> 11236 <p>Files created with this scope are visible in the web interface.</p> 11237 <h4 id="drive.appfolder">drive.appfolder</h4> 11238 <p>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’t be able to see rclone’s files from the web interface either.</p> 11239 <h4 id="drive.metadata.readonly">drive.metadata.readonly</h4> 11240 <p>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.</p> 11241 <h3 id="root-folder-id-1">Root folder ID</h3> 11242 <p>You can set the <code>root_folder_id</code> for rclone. This is the directory (identified by its <code>Folder ID</code>) that rclone considers to be the root of your drive.</p> 11243 <p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p> 11244 <p>However you can set this to restrict rclone to a specific folder hierarchy or to access data within the “Computers” tab on the drive web interface (where files from Google’s Backup and Sync desktop program go).</p> 11245 <p>In order to do this you will have to find the <code>Folder ID</code> 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.</p> 11246 <p>So if the folder you want rclone to use has a URL which looks like <code>https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code> in the browser, then you use <code>1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code> as the <code>root_folder_id</code> in the config.</p> 11247 <p><strong>NB</strong> folders under the “Computers” tab seem to be read only (drive gives a 500 error) when using rclone.</p> 11248 <p>There doesn’t appear to be an API to discover the folder IDs of the “Computers” tab - please contact us if you know otherwise!</p> 11249 <p>Note also that rclone can’t access any data under the “Backups” tab on the google drive web interface yet.</p> 11250 <h3 id="service-account-support-1">Service Account support</h3> 11251 <p>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’t have actively logged-in users, for example build machines.</p> 11252 <p>To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the <code>service_account_file</code> prompt during <code>rclone config</code> and rclone won’t use the browser based authentication flow. If you’d rather stuff the contents of the credentials file into the rclone config file, you can set <code>service_account_credentials</code> with the actual contents of the file instead, or set the equivalent environment variable.</p> 11253 <h4 id="use-case---google-appsg-suite-account-and-individual-drive">Use case - Google Apps/G-suite account and individual Drive</h4> 11254 <p>Let’s say that you are the administrator of a Google Apps (old) or G-suite account. The goal is to store data on an individual’s Drive account, who IS a member of the domain. We’ll call the domain <strong>example.com</strong>, and the user <strong>foo@example.com</strong>.</p> 11255 <p>There’s a few steps we need to go through to accomplish this:</p> 11256 <h5 id="create-a-service-account-for-example.com">1. Create a service account for example.com</h5> 11257 <ul> 11258 <li>To create a service account and obtain its credentials, go to the <a href="https://console.developers.google.com">Google Developer Console</a>.</li> 11259 <li>You must have a project - create one if you don’t.</li> 11260 <li>Then go to “IAM & admin” -> “Service Accounts”.</li> 11261 <li>Use the “Create Credentials” button. Fill in “Service account name” with something that identifies your client. “Role” can be empty.</li> 11262 <li>Tick “Furnish a new private key” - select “Key type JSON”.</li> 11263 <li>Tick “Enable G Suite Domain-wide Delegation”. This option makes “impersonation” possible, as documented here: <a href="https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority">Delegating domain-wide authority to the service account</a></li> 11264 <li>These credentials are what rclone will use for authentication. If you ever need to remove access, press the “Delete service account key” button.</li> 11265 </ul> 11266 <h5 id="allowing-api-access-to-example.com-google-drive">2. Allowing API access to example.com Google Drive</h5> 11267 <ul> 11268 <li>Go to example.com’s admin console</li> 11269 <li>Go into “Security” (or use the search bar)</li> 11270 <li>Select “Show more” and then “Advanced settings”</li> 11271 <li>Select “Manage API client access” in the “Authentication” section</li> 11272 <li>In the “Client Name” field enter the service account’s “Client ID” - this can be found in the Developer Console under “IAM & Admin” -> “Service Accounts”, then “View Client ID” for the newly created service account. It is a ~21 character numerical string.</li> 11273 <li>In the next field, “One or More API Scopes”, enter <code>https://www.googleapis.com/auth/drive</code> to grant access to Google Drive specifically.</li> 11274 </ul> 11275 <h5 id="configure-rclone-assuming-a-new-install">3. Configure rclone, assuming a new install</h5> 11276 <pre><code>rclone config 11277 11278 n/s/q> n # New 11279 name>gdrive # Gdrive is an example name 11280 Storage> # Select the number shown for Google Drive 11281 client_id> # Can be left blank 11282 client_secret> # Can be left blank 11283 scope> # Select your scope, 1 for example 11284 root_folder_id> # Can be left blank 11285 service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! 11286 y/n> # Auto config, y 11287 </code></pre> 11288 <h5 id="verify-that-its-working">4. Verify that it’s working</h5> 11289 <ul> 11290 <li><code>rclone -v --drive-impersonate foo@example.com lsf gdrive:backup</code></li> 11291 <li>The arguments do: 11292 <ul> 11293 <li><code>-v</code> - verbose logging</li> 11294 <li><code>--drive-impersonate foo@example.com</code> - this is what does the magic, pretending to be user foo.</li> 11295 <li><code>lsf</code> - list files in a parsing friendly way</li> 11296 <li><code>gdrive:backup</code> - use the remote called gdrive, work in the folder named backup.</li> 11297 </ul></li> 11298 </ul> 11299 <h3 id="team-drives">Team drives</h3> 11300 <p>If you want to configure the remote to point to a Google Team Drive then answer <code>y</code> to the question <code>Configure this as a team drive?</code>.</p> 11301 <p>This will fetch the list of Team Drives from google and allow you to configure which one you want to use. You can also type in a team drive ID if you prefer.</p> 11302 <p>For example:</p> 11303 <pre><code>Configure this as a team drive? 11304 y) Yes 11305 n) No 11306 y/n> y 11307 Fetching team drive list... 11308 Choose a number from below, or type in your own value 11309 1 / Rclone Test 11310 \ "xxxxxxxxxxxxxxxxxxxx" 11311 2 / Rclone Test 2 11312 \ "yyyyyyyyyyyyyyyyyyyy" 11313 3 / Rclone Test 3 11314 \ "zzzzzzzzzzzzzzzzzzzz" 11315 Enter a Team Drive ID> 1 11316 -------------------- 11317 [remote] 11318 client_id = 11319 client_secret = 11320 token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} 11321 team_drive = xxxxxxxxxxxxxxxxxxxx 11322 -------------------- 11323 y) Yes this is OK 11324 e) Edit this remote 11325 d) Delete this remote 11326 y/e/d> y</code></pre> 11327 <h3 id="fast-list-4">–fast-list</h3> 11328 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 11329 <p>It does this by combining multiple <code>list</code> calls into a single API request.</p> 11330 <p>This works by combining many <code>'%s' in parents</code> filters into one expression. To list the contents of directories a, b and c, the following requests will be send by the regular <code>List</code> function:</p> 11331 <pre><code>trashed=false and 'a' in parents 11332 trashed=false and 'b' in parents 11333 trashed=false and 'c' in parents</code></pre> 11334 <p>These can now be combined into a single request:</p> 11335 <pre><code>trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)</code></pre> 11336 <p>The implementation of <code>ListR</code> will put up to 50 <code>parents</code> filters into one request. It will use the <code>--checkers</code> value to specify the number of requests to run in parallel.</p> 11337 <p>In tests, these batch requests were up to 20x faster than the regular method. Running the following command against different sized folders gives:</p> 11338 <pre><code>rclone lsjson -vv -R --checkers=6 gdrive:folder</code></pre> 11339 <p>small folder (220 directories, 700 files):</p> 11340 <ul> 11341 <li>without <code>--fast-list</code>: 38s</li> 11342 <li>with <code>--fast-list</code>: 10s</li> 11343 </ul> 11344 <p>large folder (10600 directories, 39000 files):</p> 11345 <ul> 11346 <li>without <code>--fast-list</code>: 22:05 min</li> 11347 <li>with <code>--fast-list</code>: 58s</li> 11348 </ul> 11349 <h3 id="modified-time-5">Modified time</h3> 11350 <p>Google drive stores modification times accurate to 1 ms.</p> 11351 <h4 id="restricted-filename-characters-9">Restricted filename characters</h4> 11352 <p>Only Invalid UTF-8 bytes will be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 11353 <p>In contrast to other backends, <code>/</code> can also be used in names and <code>.</code> or <code>..</code> are valid names.</p> 11354 <h3 id="revisions">Revisions</h3> 11355 <p>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.</p> 11356 <p>Revisions follow the standard google policy which at time of writing was</p> 11357 <ul> 11358 <li>They are deleted after 30 days or 100 revisions (whatever comes first).</li> 11359 <li>They do not count towards a user storage quota.</li> 11360 </ul> 11361 <h3 id="deleting-files-2">Deleting files</h3> 11362 <p>By default rclone will send all files to the trash when deleting files. If deleting them permanently is required then use the <code>--drive-use-trash=false</code> flag, or set the equivalent environment variable.</p> 11363 <h3 id="shortcuts">Shortcuts</h3> 11364 <p>In March 2020 Google introduced a new feature in Google Drive called <a href="https://support.google.com/drive/answer/9700156">drive shortcuts</a> (<a href="https://developers.google.com/drive/api/v3/shortcuts">API</a>). These will (by September 2020) <a href="https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models">replace the ability for files or folders to be in multiple folders at once</a>.</p> 11365 <p>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 (eg the inode in unix terms) so they don’t break if the source is renamed or moved about.</p> 11366 <p>Be default rclone treats these as follows.</p> 11367 <p>For shortcuts pointing to files:</p> 11368 <ul> 11369 <li>When listing a file shortcut appears as the destination file.</li> 11370 <li>When downloading the contents of the destination file is downloaded.</li> 11371 <li>When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut.</li> 11372 <li>When server side moving (renaming) the shortcut is renamed, not the destination file.</li> 11373 <li>When server side copying the shortcut is copied, not the contents of the shortcut.</li> 11374 <li>When deleting the shortcut is deleted not the linked file.</li> 11375 <li>When setting the modification time, the modification time of the linked file will be set.</li> 11376 </ul> 11377 <p>For shortcuts pointing to folders:</p> 11378 <ul> 11379 <li>When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders)</li> 11380 <li>When downloading the contents of the linked folder and sub contents are downloaded</li> 11381 <li>When uploading to a shortcut folder the file will be placed in the linked folder</li> 11382 <li>When server side moving (renaming) the shortcut is renamed, not the destination folder</li> 11383 <li>When server side copying the contents of the linked folder is copied, not the shortcut.</li> 11384 <li>When deleting with <code>rclone rmdir</code> or <code>rclone purge</code> the shortcut is deleted not the linked folder.</li> 11385 <li><strong>NB</strong> When deleting with <code>rclone remove</code> or <code>rclone mount</code> the contents of the linked folder will be deleted.</li> 11386 </ul> 11387 <p>The <a href="https://rclone.org/commands/rclone_backend/">rclone backend</a> command can be used to create shortcuts.</p> 11388 <p>Shortcuts can be completely ignored with the <code>--drive-skip-shortcuts</code> flag or the corresponding <code>skip_shortcuts</code> configuration setting.</p> 11389 <h3 id="emptying-trash">Emptying trash</h3> 11390 <p>If you wish to empty your trash you can use the <code>rclone cleanup remote:</code> command which will permanently delete all your trashed files. This command does not take any path arguments.</p> 11391 <p>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.</p> 11392 <h3 id="quota-information">Quota information</h3> 11393 <p>To view your current quota you can use the <code>rclone about remote:</code> 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.</p> 11394 <h4 id="importexport-of-google-documents">Import/Export of google documents</h4> 11395 <p>Google documents can be exported from and uploaded to Google Drive.</p> 11396 <p>When rclone downloads a Google doc it chooses a format to download depending upon the <code>--drive-export-formats</code> setting. By default the export formats are <code>docx,xlsx,pptx,svg</code> which are a sensible default for an editable document.</p> 11397 <p>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’t be exported to a format on the formats list, then rclone will choose a format from the default list.</p> 11398 <p>If you prefer an archive copy then you might use <code>--drive-export-formats pdf</code>, or if you prefer openoffice/libreoffice formats you might use <code>--drive-export-formats ods,odt,odp</code>.</p> 11399 <p>Note that rclone adds the extension to the google doc, so if it is called <code>My Spreadsheet</code> on google docs, it will be exported as <code>My Spreadsheet.xlsx</code> or <code>My Spreadsheet.pdf</code> etc.</p> 11400 <p>When importing files into Google Drive, rclone will convert all files with an extension in <code>--drive-import-formats</code> to their associated document type. rclone will not convert any files by default, since the conversion is lossy process.</p> 11401 <p>The conversion must result in a file with the same extension when the <code>--drive-export-formats</code> rules are applied to the uploaded document.</p> 11402 <p>Here are some examples for allowed and prohibited conversions.</p> 11403 <table> 11404 <thead> 11405 <tr class="header"> 11406 <th>export-formats</th> 11407 <th>import-formats</th> 11408 <th>Upload Ext</th> 11409 <th>Document Ext</th> 11410 <th>Allowed</th> 11411 </tr> 11412 </thead> 11413 <tbody> 11414 <tr class="odd"> 11415 <td>odt</td> 11416 <td>odt</td> 11417 <td>odt</td> 11418 <td>odt</td> 11419 <td>Yes</td> 11420 </tr> 11421 <tr class="even"> 11422 <td>odt</td> 11423 <td>docx,odt</td> 11424 <td>odt</td> 11425 <td>odt</td> 11426 <td>Yes</td> 11427 </tr> 11428 <tr class="odd"> 11429 <td></td> 11430 <td>docx</td> 11431 <td>docx</td> 11432 <td>docx</td> 11433 <td>Yes</td> 11434 </tr> 11435 <tr class="even"> 11436 <td></td> 11437 <td>odt</td> 11438 <td>odt</td> 11439 <td>docx</td> 11440 <td>No</td> 11441 </tr> 11442 <tr class="odd"> 11443 <td>odt,docx</td> 11444 <td>docx,odt</td> 11445 <td>docx</td> 11446 <td>odt</td> 11447 <td>No</td> 11448 </tr> 11449 <tr class="even"> 11450 <td>docx,odt</td> 11451 <td>docx,odt</td> 11452 <td>docx</td> 11453 <td>docx</td> 11454 <td>Yes</td> 11455 </tr> 11456 <tr class="odd"> 11457 <td>docx,odt</td> 11458 <td>docx,odt</td> 11459 <td>odt</td> 11460 <td>docx</td> 11461 <td>No</td> 11462 </tr> 11463 </tbody> 11464 </table> 11465 <p>This limitation can be disabled by specifying <code>--drive-allow-import-name-change</code>. When using this flag, rclone can convert multiple files types resulting in the same document type at once, eg with <code>--drive-import-formats docx,odt,txt</code>, 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.</p> 11466 <p>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.</p> 11467 <p>This list can be changed by Google Drive at any time and might not represent the currently available conversions.</p> 11468 <table> 11469 <colgroup> 11470 <col style="width: 28%" /> 11471 <col style="width: 34%" /> 11472 <col style="width: 37%" /> 11473 </colgroup> 11474 <thead> 11475 <tr class="header"> 11476 <th>Extension</th> 11477 <th>Mime Type</th> 11478 <th>Description</th> 11479 </tr> 11480 </thead> 11481 <tbody> 11482 <tr class="odd"> 11483 <td>csv</td> 11484 <td>text/csv</td> 11485 <td>Standard CSV format for Spreadsheets</td> 11486 </tr> 11487 <tr class="even"> 11488 <td>docx</td> 11489 <td>application/vnd.openxmlformats-officedocument.wordprocessingml.document</td> 11490 <td>Microsoft Office Document</td> 11491 </tr> 11492 <tr class="odd"> 11493 <td>epub</td> 11494 <td>application/epub+zip</td> 11495 <td>E-book format</td> 11496 </tr> 11497 <tr class="even"> 11498 <td>html</td> 11499 <td>text/html</td> 11500 <td>An HTML Document</td> 11501 </tr> 11502 <tr class="odd"> 11503 <td>jpg</td> 11504 <td>image/jpeg</td> 11505 <td>A JPEG Image File</td> 11506 </tr> 11507 <tr class="even"> 11508 <td>json</td> 11509 <td>application/vnd.google-apps.script+json</td> 11510 <td>JSON Text Format</td> 11511 </tr> 11512 <tr class="odd"> 11513 <td>odp</td> 11514 <td>application/vnd.oasis.opendocument.presentation</td> 11515 <td>Openoffice Presentation</td> 11516 </tr> 11517 <tr class="even"> 11518 <td>ods</td> 11519 <td>application/vnd.oasis.opendocument.spreadsheet</td> 11520 <td>Openoffice Spreadsheet</td> 11521 </tr> 11522 <tr class="odd"> 11523 <td>ods</td> 11524 <td>application/x-vnd.oasis.opendocument.spreadsheet</td> 11525 <td>Openoffice Spreadsheet</td> 11526 </tr> 11527 <tr class="even"> 11528 <td>odt</td> 11529 <td>application/vnd.oasis.opendocument.text</td> 11530 <td>Openoffice Document</td> 11531 </tr> 11532 <tr class="odd"> 11533 <td>pdf</td> 11534 <td>application/pdf</td> 11535 <td>Adobe PDF Format</td> 11536 </tr> 11537 <tr class="even"> 11538 <td>png</td> 11539 <td>image/png</td> 11540 <td>PNG Image Format</td> 11541 </tr> 11542 <tr class="odd"> 11543 <td>pptx</td> 11544 <td>application/vnd.openxmlformats-officedocument.presentationml.presentation</td> 11545 <td>Microsoft Office Powerpoint</td> 11546 </tr> 11547 <tr class="even"> 11548 <td>rtf</td> 11549 <td>application/rtf</td> 11550 <td>Rich Text Format</td> 11551 </tr> 11552 <tr class="odd"> 11553 <td>svg</td> 11554 <td>image/svg+xml</td> 11555 <td>Scalable Vector Graphics Format</td> 11556 </tr> 11557 <tr class="even"> 11558 <td>tsv</td> 11559 <td>text/tab-separated-values</td> 11560 <td>Standard TSV format for spreadsheets</td> 11561 </tr> 11562 <tr class="odd"> 11563 <td>txt</td> 11564 <td>text/plain</td> 11565 <td>Plain Text</td> 11566 </tr> 11567 <tr class="even"> 11568 <td>xlsx</td> 11569 <td>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td> 11570 <td>Microsoft Office Spreadsheet</td> 11571 </tr> 11572 <tr class="odd"> 11573 <td>zip</td> 11574 <td>application/zip</td> 11575 <td>A ZIP file of HTML, Images CSS</td> 11576 </tr> 11577 </tbody> 11578 </table> 11579 <p>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 <code>--drive-export-formats</code> parameter. They will match all available Google Documents.</p> 11580 <table> 11581 <thead> 11582 <tr class="header"> 11583 <th>Extension</th> 11584 <th>Description</th> 11585 <th>OS Support</th> 11586 </tr> 11587 </thead> 11588 <tbody> 11589 <tr class="odd"> 11590 <td>desktop</td> 11591 <td>freedesktop.org specified desktop entry</td> 11592 <td>Linux</td> 11593 </tr> 11594 <tr class="even"> 11595 <td>link.html</td> 11596 <td>An HTML Document with a redirect</td> 11597 <td>All</td> 11598 </tr> 11599 <tr class="odd"> 11600 <td>url</td> 11601 <td>INI style link file</td> 11602 <td>macOS, Windows</td> 11603 </tr> 11604 <tr class="even"> 11605 <td>webloc</td> 11606 <td>macOS specific XML format</td> 11607 <td>macOS</td> 11608 </tr> 11609 </tbody> 11610 </table> 11611 <h3 id="standard-options-13">Standard Options</h3> 11612 <p>Here are the standard options specific to drive (Google Drive).</p> 11613 <h4 id="drive-client-id">–drive-client-id</h4> 11614 <p>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.</p> 11615 <ul> 11616 <li>Config: client_id</li> 11617 <li>Env Var: RCLONE_DRIVE_CLIENT_ID</li> 11618 <li>Type: string</li> 11619 <li>Default: ""</li> 11620 </ul> 11621 <h4 id="drive-client-secret">–drive-client-secret</h4> 11622 <p>Google Application Client Secret Setting your own is recommended.</p> 11623 <ul> 11624 <li>Config: client_secret</li> 11625 <li>Env Var: RCLONE_DRIVE_CLIENT_SECRET</li> 11626 <li>Type: string</li> 11627 <li>Default: ""</li> 11628 </ul> 11629 <h4 id="drive-scope">–drive-scope</h4> 11630 <p>Scope that rclone should use when requesting access from drive.</p> 11631 <ul> 11632 <li>Config: scope</li> 11633 <li>Env Var: RCLONE_DRIVE_SCOPE</li> 11634 <li>Type: string</li> 11635 <li>Default: ""</li> 11636 <li>Examples: 11637 <ul> 11638 <li>“drive” 11639 <ul> 11640 <li>Full access all files, excluding Application Data Folder.</li> 11641 </ul></li> 11642 <li>“drive.readonly” 11643 <ul> 11644 <li>Read-only access to file metadata and file contents.</li> 11645 </ul></li> 11646 <li>“drive.file” 11647 <ul> 11648 <li>Access to files created by rclone only.</li> 11649 <li>These are visible in the drive website.</li> 11650 <li>File authorization is revoked when the user deauthorizes the app.</li> 11651 </ul></li> 11652 <li>“drive.appfolder” 11653 <ul> 11654 <li>Allows read and write access to the Application Data folder.</li> 11655 <li>This is not visible in the drive website.</li> 11656 </ul></li> 11657 <li>“drive.metadata.readonly” 11658 <ul> 11659 <li>Allows read-only access to file metadata but</li> 11660 <li>does not allow any access to read or download file content.</li> 11661 </ul></li> 11662 </ul></li> 11663 </ul> 11664 <h4 id="drive-root-folder-id">–drive-root-folder-id</h4> 11665 <p>ID of the root folder Leave blank normally.</p> 11666 <p>Fill in to access “Computers” folders (see docs), or for rclone to use a non root folder as its starting point.</p> 11667 <p>Note that if this is blank, the first time rclone runs it will fill it in with the ID of the root folder.</p> 11668 <ul> 11669 <li>Config: root_folder_id</li> 11670 <li>Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID</li> 11671 <li>Type: string</li> 11672 <li>Default: ""</li> 11673 </ul> 11674 <h4 id="drive-service-account-file">–drive-service-account-file</h4> 11675 <p>Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 11676 <ul> 11677 <li>Config: service_account_file</li> 11678 <li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE</li> 11679 <li>Type: string</li> 11680 <li>Default: ""</li> 11681 </ul> 11682 <h3 id="advanced-options-12">Advanced Options</h3> 11683 <p>Here are the advanced options specific to drive (Google Drive).</p> 11684 <h4 id="drive-service-account-credentials">–drive-service-account-credentials</h4> 11685 <p>Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 11686 <ul> 11687 <li>Config: service_account_credentials</li> 11688 <li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS</li> 11689 <li>Type: string</li> 11690 <li>Default: ""</li> 11691 </ul> 11692 <h4 id="drive-team-drive">–drive-team-drive</h4> 11693 <p>ID of the Team Drive</p> 11694 <ul> 11695 <li>Config: team_drive</li> 11696 <li>Env Var: RCLONE_DRIVE_TEAM_DRIVE</li> 11697 <li>Type: string</li> 11698 <li>Default: ""</li> 11699 </ul> 11700 <h4 id="drive-auth-owner-only">–drive-auth-owner-only</h4> 11701 <p>Only consider files owned by the authenticated user.</p> 11702 <ul> 11703 <li>Config: auth_owner_only</li> 11704 <li>Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY</li> 11705 <li>Type: bool</li> 11706 <li>Default: false</li> 11707 </ul> 11708 <h4 id="drive-use-trash">–drive-use-trash</h4> 11709 <p>Send files to the trash instead of deleting permanently. Defaults to true, namely sending files to the trash. Use <code>--drive-use-trash=false</code> to delete files permanently instead.</p> 11710 <ul> 11711 <li>Config: use_trash</li> 11712 <li>Env Var: RCLONE_DRIVE_USE_TRASH</li> 11713 <li>Type: bool</li> 11714 <li>Default: true</li> 11715 </ul> 11716 <h4 id="drive-skip-gdocs">–drive-skip-gdocs</h4> 11717 <p>Skip google documents in all listings. If given, gdocs practically become invisible to rclone.</p> 11718 <ul> 11719 <li>Config: skip_gdocs</li> 11720 <li>Env Var: RCLONE_DRIVE_SKIP_GDOCS</li> 11721 <li>Type: bool</li> 11722 <li>Default: false</li> 11723 </ul> 11724 <h4 id="drive-skip-checksum-gphotos">–drive-skip-checksum-gphotos</h4> 11725 <p>Skip MD5 checksum on Google photos and videos only.</p> 11726 <p>Use this if you get checksum errors when transferring Google photos or videos.</p> 11727 <p>Setting this flag will cause Google photos and videos to return a blank MD5 checksum.</p> 11728 <p>Google photos are identified by being in the “photos” space.</p> 11729 <p>Corrupted checksums are caused by Google modifying the image/video but not updating the checksum.</p> 11730 <ul> 11731 <li>Config: skip_checksum_gphotos</li> 11732 <li>Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS</li> 11733 <li>Type: bool</li> 11734 <li>Default: false</li> 11735 </ul> 11736 <h4 id="drive-shared-with-me">–drive-shared-with-me</h4> 11737 <p>Only show files that are shared with me.</p> 11738 <p>Instructs rclone to operate on your “Shared with me” folder (where Google Drive lets you access the files and folders others have shared with you).</p> 11739 <p>This works both with the “list” (lsd, lsl, etc) and the “copy” commands (copy, sync, etc), and with all other commands too.</p> 11740 <ul> 11741 <li>Config: shared_with_me</li> 11742 <li>Env Var: RCLONE_DRIVE_SHARED_WITH_ME</li> 11743 <li>Type: bool</li> 11744 <li>Default: false</li> 11745 </ul> 11746 <h4 id="drive-trashed-only">–drive-trashed-only</h4> 11747 <p>Only show files that are in the trash. This will show trashed files in their original directory structure.</p> 11748 <ul> 11749 <li>Config: trashed_only</li> 11750 <li>Env Var: RCLONE_DRIVE_TRASHED_ONLY</li> 11751 <li>Type: bool</li> 11752 <li>Default: false</li> 11753 </ul> 11754 <h4 id="drive-formats">–drive-formats</h4> 11755 <p>Deprecated: see export_formats</p> 11756 <ul> 11757 <li>Config: formats</li> 11758 <li>Env Var: RCLONE_DRIVE_FORMATS</li> 11759 <li>Type: string</li> 11760 <li>Default: ""</li> 11761 </ul> 11762 <h4 id="drive-export-formats">–drive-export-formats</h4> 11763 <p>Comma separated list of preferred formats for downloading Google docs.</p> 11764 <ul> 11765 <li>Config: export_formats</li> 11766 <li>Env Var: RCLONE_DRIVE_EXPORT_FORMATS</li> 11767 <li>Type: string</li> 11768 <li>Default: “docx,xlsx,pptx,svg”</li> 11769 </ul> 11770 <h4 id="drive-import-formats">–drive-import-formats</h4> 11771 <p>Comma separated list of preferred formats for uploading Google docs.</p> 11772 <ul> 11773 <li>Config: import_formats</li> 11774 <li>Env Var: RCLONE_DRIVE_IMPORT_FORMATS</li> 11775 <li>Type: string</li> 11776 <li>Default: ""</li> 11777 </ul> 11778 <h4 id="drive-allow-import-name-change">–drive-allow-import-name-change</h4> 11779 <p>Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.</p> 11780 <ul> 11781 <li>Config: allow_import_name_change</li> 11782 <li>Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE</li> 11783 <li>Type: bool</li> 11784 <li>Default: false</li> 11785 </ul> 11786 <h4 id="drive-use-created-date">–drive-use-created-date</h4> 11787 <p>Use file created date instead of modified date.,</p> 11788 <p>Useful when downloading data and you want the creation date used in place of the last modified date.</p> 11789 <p><strong>WARNING</strong>: This flag may have some unexpected consequences.</p> 11790 <p>When uploading to your drive all files will be overwritten unless they haven’t been modified since their creation. And the inverse will occur while downloading. This side effect can be avoided by using the “–checksum” flag.</p> 11791 <p>This feature was implemented to retain photos capture date as recorded by google photos. You will first need to check the “Create a Google Photos folder” 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.</p> 11792 <ul> 11793 <li>Config: use_created_date</li> 11794 <li>Env Var: RCLONE_DRIVE_USE_CREATED_DATE</li> 11795 <li>Type: bool</li> 11796 <li>Default: false</li> 11797 </ul> 11798 <h4 id="drive-use-shared-date">–drive-use-shared-date</h4> 11799 <p>Use date file was shared instead of modified date.</p> 11800 <p>Note that, as with “–drive-use-created-date”, this flag may have unexpected consequences when uploading/downloading files.</p> 11801 <p>If both this flag and “–drive-use-created-date” are set, the created date is used.</p> 11802 <ul> 11803 <li>Config: use_shared_date</li> 11804 <li>Env Var: RCLONE_DRIVE_USE_SHARED_DATE</li> 11805 <li>Type: bool</li> 11806 <li>Default: false</li> 11807 </ul> 11808 <h4 id="drive-list-chunk">–drive-list-chunk</h4> 11809 <p>Size of listing chunk 100-1000. 0 to disable.</p> 11810 <ul> 11811 <li>Config: list_chunk</li> 11812 <li>Env Var: RCLONE_DRIVE_LIST_CHUNK</li> 11813 <li>Type: int</li> 11814 <li>Default: 1000</li> 11815 </ul> 11816 <h4 id="drive-impersonate">–drive-impersonate</h4> 11817 <p>Impersonate this user when using a service account.</p> 11818 <p>Note that if this is used then “root_folder_id” will be ignored.</p> 11819 <ul> 11820 <li>Config: impersonate</li> 11821 <li>Env Var: RCLONE_DRIVE_IMPERSONATE</li> 11822 <li>Type: string</li> 11823 <li>Default: ""</li> 11824 </ul> 11825 <h4 id="drive-alternate-export">–drive-alternate-export</h4> 11826 <p>Use alternate export URLs for google documents export.,</p> 11827 <p>If this option is set this instructs rclone to use an alternate set of export URLs for drive documents. Users have reported that the official export URLs can’t export large documents, whereas these unofficial ones can.</p> 11828 <p>See rclone issue <a href="https://github.com/rclone/rclone/issues/2243">#2243</a> for background, <a href="https://issuetracker.google.com/issues/36761333">this google drive issue</a> and <a href="https://www.labnol.org/internet/direct-links-for-google-drive/28356/">this helpful post</a>.</p> 11829 <ul> 11830 <li>Config: alternate_export</li> 11831 <li>Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT</li> 11832 <li>Type: bool</li> 11833 <li>Default: false</li> 11834 </ul> 11835 <h4 id="drive-upload-cutoff">–drive-upload-cutoff</h4> 11836 <p>Cutoff for switching to chunked upload</p> 11837 <ul> 11838 <li>Config: upload_cutoff</li> 11839 <li>Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF</li> 11840 <li>Type: SizeSuffix</li> 11841 <li>Default: 8M</li> 11842 </ul> 11843 <h4 id="drive-chunk-size">–drive-chunk-size</h4> 11844 <p>Upload chunk size. Must a power of 2 >= 256k.</p> 11845 <p>Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.</p> 11846 <p>Reducing this will reduce memory usage but decrease performance.</p> 11847 <ul> 11848 <li>Config: chunk_size</li> 11849 <li>Env Var: RCLONE_DRIVE_CHUNK_SIZE</li> 11850 <li>Type: SizeSuffix</li> 11851 <li>Default: 8M</li> 11852 </ul> 11853 <h4 id="drive-acknowledge-abuse">–drive-acknowledge-abuse</h4> 11854 <p>Set to allow files which return cannotDownloadAbusiveFile to be downloaded.</p> 11855 <p>If downloading a file returns the error “This file has been identified as malware or spam and cannot be downloaded” with the error code “cannotDownloadAbusiveFile” then supply this flag to rclone to indicate you acknowledge the risks of downloading the file and rclone will download it anyway.</p> 11856 <ul> 11857 <li>Config: acknowledge_abuse</li> 11858 <li>Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE</li> 11859 <li>Type: bool</li> 11860 <li>Default: false</li> 11861 </ul> 11862 <h4 id="drive-keep-revision-forever">–drive-keep-revision-forever</h4> 11863 <p>Keep new head revision of each file forever.</p> 11864 <ul> 11865 <li>Config: keep_revision_forever</li> 11866 <li>Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER</li> 11867 <li>Type: bool</li> 11868 <li>Default: false</li> 11869 </ul> 11870 <h4 id="drive-size-as-quota">–drive-size-as-quota</h4> 11871 <p>Show sizes as storage quota usage, not actual size.</p> 11872 <p>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.</p> 11873 <p><strong>WARNING</strong>: This flag may have some unexpected consequences.</p> 11874 <p>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.</p> 11875 <p>If you do use this flag for syncing (not recommended) then you will need to use –ignore size also.</p> 11876 <ul> 11877 <li>Config: size_as_quota</li> 11878 <li>Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA</li> 11879 <li>Type: bool</li> 11880 <li>Default: false</li> 11881 </ul> 11882 <h4 id="drive-v2-download-min-size">–drive-v2-download-min-size</h4> 11883 <p>If Object’s are greater, use drive v2 API to download.</p> 11884 <ul> 11885 <li>Config: v2_download_min_size</li> 11886 <li>Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE</li> 11887 <li>Type: SizeSuffix</li> 11888 <li>Default: off</li> 11889 </ul> 11890 <h4 id="drive-pacer-min-sleep">–drive-pacer-min-sleep</h4> 11891 <p>Minimum time to sleep between API calls.</p> 11892 <ul> 11893 <li>Config: pacer_min_sleep</li> 11894 <li>Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP</li> 11895 <li>Type: Duration</li> 11896 <li>Default: 100ms</li> 11897 </ul> 11898 <h4 id="drive-pacer-burst">–drive-pacer-burst</h4> 11899 <p>Number of API calls to allow without sleeping.</p> 11900 <ul> 11901 <li>Config: pacer_burst</li> 11902 <li>Env Var: RCLONE_DRIVE_PACER_BURST</li> 11903 <li>Type: int</li> 11904 <li>Default: 100</li> 11905 </ul> 11906 <h4 id="drive-server-side-across-configs">–drive-server-side-across-configs</h4> 11907 <p>Allow server side operations (eg copy) to work across different drive configs.</p> 11908 <p>This can be useful if you wish to do a server side copy between two different Google drives. Note that this isn’t enabled by default because it isn’t easy to tell if it will work between any two configurations.</p> 11909 <ul> 11910 <li>Config: server_side_across_configs</li> 11911 <li>Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS</li> 11912 <li>Type: bool</li> 11913 <li>Default: false</li> 11914 </ul> 11915 <h4 id="drive-disable-http2">–drive-disable-http2</h4> 11916 <p>Disable drive using http2</p> 11917 <p>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.</p> 11918 <p>See: https://github.com/rclone/rclone/issues/3631</p> 11919 <ul> 11920 <li>Config: disable_http2</li> 11921 <li>Env Var: RCLONE_DRIVE_DISABLE_HTTP2</li> 11922 <li>Type: bool</li> 11923 <li>Default: true</li> 11924 </ul> 11925 <h4 id="drive-stop-on-upload-limit">–drive-stop-on-upload-limit</h4> 11926 <p>Make upload limit errors be fatal</p> 11927 <p>At the time of writing it is only possible to upload 750GB 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.</p> 11928 <p>Note that this detection is relying on error message strings which Google don’t document so it may break in the future.</p> 11929 <p>See: https://github.com/rclone/rclone/issues/3857</p> 11930 <ul> 11931 <li>Config: stop_on_upload_limit</li> 11932 <li>Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT</li> 11933 <li>Type: bool</li> 11934 <li>Default: false</li> 11935 </ul> 11936 <h4 id="drive-skip-shortcuts">–drive-skip-shortcuts</h4> 11937 <p>If set skip shortcut files</p> 11938 <p>Normally rclone dereferences shortcut files making them appear as if they are the original file (see <a href="#shortcuts">the shortcuts section</a>). If this flag is set then rclone will ignore shortcut files completely.</p> 11939 <ul> 11940 <li>Config: skip_shortcuts</li> 11941 <li>Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS</li> 11942 <li>Type: bool</li> 11943 <li>Default: false</li> 11944 </ul> 11945 <h4 id="drive-encoding">–drive-encoding</h4> 11946 <p>This sets the encoding for the backend.</p> 11947 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 11948 <ul> 11949 <li>Config: encoding</li> 11950 <li>Env Var: RCLONE_DRIVE_ENCODING</li> 11951 <li>Type: MultiEncoder</li> 11952 <li>Default: InvalidUtf8</li> 11953 </ul> 11954 <h3 id="backend-commands-2">Backend commands</h3> 11955 <p>Here are the commands specific to the drive backend.</p> 11956 <p>Run them with</p> 11957 <pre><code>rclone backend COMMAND remote:</code></pre> 11958 <p>The help below will explain what arguments each command takes.</p> 11959 <p>See <a href="https://rclone.org/commands/rclone_backend/">the “rclone backend” command</a> for more info on how to pass options and arguments.</p> 11960 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend/command">backend/command</a>.</p> 11961 <h4 id="get">get</h4> 11962 <p>Get command for fetching the drive config parameters</p> 11963 <pre><code>rclone backend get remote: [options] [<arguments>+]</code></pre> 11964 <p>This is a get command which will be used to fetch the various drive config parameters</p> 11965 <p>Usage Examples:</p> 11966 <pre><code>rclone backend get drive: [-o service_account_file] [-o chunk_size] 11967 rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]</code></pre> 11968 <p>Options:</p> 11969 <ul> 11970 <li>“chunk_size”: show the current upload chunk size</li> 11971 <li>“service_account_file”: show the current service account file</li> 11972 </ul> 11973 <h4 id="set">set</h4> 11974 <p>Set command for updating the drive config parameters</p> 11975 <pre><code>rclone backend set remote: [options] [<arguments>+]</code></pre> 11976 <p>This is a set command which will be used to update the various drive config parameters</p> 11977 <p>Usage Examples:</p> 11978 <pre><code>rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] 11979 rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]</code></pre> 11980 <p>Options:</p> 11981 <ul> 11982 <li>“chunk_size”: update the current upload chunk size</li> 11983 <li>“service_account_file”: update the current service account file</li> 11984 </ul> 11985 <h4 id="shortcut">shortcut</h4> 11986 <p>Create shortcuts from files or directories</p> 11987 <pre><code>rclone backend shortcut remote: [options] [<arguments>+]</code></pre> 11988 <p>This command creates shortcuts from files or directories.</p> 11989 <p>Usage:</p> 11990 <pre><code>rclone backend shortcut drive: source_item destination_shortcut 11991 rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut</code></pre> 11992 <p>In the first example this creates a shortcut from the “source_item” which can be a file or a directory to the “destination_shortcut”. The “source_item” and the “destination_shortcut” should be relative paths from “drive:”</p> 11993 <p>In the second example this creates a shortcut from the “source_item” relative to “drive:” to the “destination_shortcut” relative to “drive2:”. This may fail with a permission error if the user authenticated with “drive2:” can’t read files from “drive:”.</p> 11994 <p>Options:</p> 11995 <ul> 11996 <li>“target”: optional target remote for the shortcut destination</li> 11997 </ul> 11998 <h3 id="limitations-7">Limitations</h3> 11999 <p>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 MBytes/s but lots of small files can take a long time.</p> 12000 <p>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 <code>--disable copy</code> to download and upload the files if you prefer.</p> 12001 <h4 id="limitations-of-google-docs">Limitations of Google Docs</h4> 12002 <p>Google docs will appear as size -1 in <code>rclone ls</code> and as size 0 in anything which uses the VFS layer, eg <code>rclone mount</code>, <code>rclone serve</code>.</p> 12003 <p>This is because rclone can’t find out the size of the Google docs without downloading them.</p> 12004 <p>Google docs will transfer correctly with <code>rclone sync</code>, <code>rclone copy</code> etc as rclone knows to ignore the size when doing the transfer.</p> 12005 <p>However an unfortunate consequence of this is that you may not be able to download Google docs using <code>rclone mount</code>. If it doesn’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!</p> 12006 <h3 id="duplicated-files-1">Duplicated files</h3> 12007 <p>Sometimes, for no reason I’ve been able to track down, drive will duplicate a file that rclone uploads. Drive unlike all the other remotes can have duplicated files.</p> 12008 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 12009 <p>Use <code>rclone dedupe</code> to fix duplicated files.</p> 12010 <p>Note that this isn’t just a problem with rclone, even Google Photos on Android duplicates files on drive sometimes.</p> 12011 <h3 id="rclone-appears-to-be-re-copying-files-it-shouldnt">Rclone appears to be re-copying files it shouldn’t</h3> 12012 <p>The most likely cause of this is the duplicated file issue above - run <code>rclone dedupe</code> and check your logs for duplicate object or directory messages.</p> 12013 <p>This can also be caused by a delay/caching on google drive’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.</p> 12014 <p>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.</p> 12015 <h3 id="making-your-own-client_id">Making your own client_id</h3> 12016 <p>When you use rclone with Google drive in its default configuration you are using rclone’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.</p> 12017 <p>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.</p> 12018 <p>Here is how to create your own Google Drive client ID for rclone:</p> 12019 <ol type="1"> 12020 <li><p>Log into the <a href="https://console.developers.google.com/">Google API Console</a> with your Google account. It doesn’t matter what Google account you use. (It need not be the same account as the Google Drive you want to access)</p></li> 12021 <li><p>Select a project or create a new project.</p></li> 12022 <li><p>Under “ENABLE APIS AND SERVICES” search for “Drive”, and enable the “Google Drive API”.</p></li> 12023 <li><p>Click “Credentials” in the left-side panel (not “Create credentials”, which opens the wizard), then “Create credentials”</p></li> 12024 <li><p>If you already configured an “Oauth Consent Screen”, then skip to the next step; if not, click on “CONFIGURE CONSENT SCREEN” button (near the top right corner of the right panel), then select “External” and click on “CREATE”; on the next screen, enter an “Application name” (“rclone” is OK) then click on “Save” (all other data is optional). Click again on “Credentials” on the left panel to go back to the “Credentials” screen.</p></li> 12025 </ol> 12026 <p>(PS: if you are a GSuite user, you could also select “Internal” instead of “External” above, but this has not been tested/documented so far).</p> 12027 <ol start="6" type="1"> 12028 <li><p>Click on the “+ CREATE CREDENTIALS” button at the top of the screen, then select “OAuth client ID”.</p></li> 12029 <li><p>Choose an application type of “Desktop app” if you using a Google account or “Other” if you using a GSuite account and click “Create”. (the default name is fine)</p></li> 12030 <li><p>It will show you a client ID and client secret. Use these values in rclone config to add a new remote or edit an existing remote.</p></li> 12031 </ol> 12032 <p>Be aware that, due to the “enhanced security” recently introduced by Google, you are theoretically expected to “submit your app for verification” 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’s not such a big deal).</p> 12033 <p>(Thanks to <span class="citation" data-cites="balazer">@balazer</span> on github for these instructions.)</p> 12034 <h2 id="google-photos">Google Photos</h2> 12035 <p>The rclone backend for <a href="https://www.google.com/photos/about/">Google Photos</a> is a specialized backend for transferring photos and videos to and from Google Photos.</p> 12036 <p><strong>NB</strong> The Google Photos API which rclone uses has quite a few limitations, so please read the <a href="#limitations">limitations section</a> carefully to make sure it is suitable for your use.</p> 12037 <h2 id="configuring-google-photos">Configuring Google Photos</h2> 12038 <p>The initial setup for google cloud storage involves getting a token from Google Photos which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 12039 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 12040 <pre><code> rclone config</code></pre> 12041 <p>This will guide you through an interactive setup process:</p> 12042 <pre><code>No remotes found - make a new one 12043 n) New remote 12044 s) Set configuration password 12045 q) Quit config 12046 n/s/q> n 12047 name> remote 12048 Type of storage to configure. 12049 Enter a string value. Press Enter for the default (""). 12050 Choose a number from below, or type in your own value 12051 [snip] 12052 XX / Google Photos 12053 \ "google photos" 12054 [snip] 12055 Storage> google photos 12056 ** See help for google photos backend at: https://rclone.org/googlephotos/ ** 12057 12058 Google Application Client Id 12059 Leave blank normally. 12060 Enter a string value. Press Enter for the default (""). 12061 client_id> 12062 Google Application Client Secret 12063 Leave blank normally. 12064 Enter a string value. Press Enter for the default (""). 12065 client_secret> 12066 Set to make the Google Photos backend read only. 12067 12068 If you choose read only then rclone will only request read only access 12069 to your photos, otherwise rclone will request full access. 12070 Enter a boolean value (true or false). Press Enter for the default ("false"). 12071 read_only> 12072 Edit advanced config? (y/n) 12073 y) Yes 12074 n) No 12075 y/n> n 12076 Remote config 12077 Use auto config? 12078 * Say Y if not sure 12079 * Say N if you are working on a remote or headless machine 12080 y) Yes 12081 n) No 12082 y/n> y 12083 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 12084 Log in and authorize rclone for access 12085 Waiting for code... 12086 Got code 12087 12088 *** IMPORTANT: All media items uploaded to Google Photos with rclone 12089 *** are stored in full resolution at original quality. These uploads 12090 *** will count towards storage in your Google Account. 12091 12092 -------------------- 12093 [remote] 12094 type = google photos 12095 token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"} 12096 -------------------- 12097 y) Yes this is OK 12098 e) Edit this remote 12099 d) Delete this remote 12100 y/e/d> y</code></pre> 12101 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p> 12102 <p>This remote is called <code>remote</code> and can now be used like this</p> 12103 <p>See all the albums in your photos</p> 12104 <pre><code>rclone lsd remote:album</code></pre> 12105 <p>Make a new album</p> 12106 <pre><code>rclone mkdir remote:album/newAlbum</code></pre> 12107 <p>List the contents of an album</p> 12108 <pre><code>rclone ls remote:album/newAlbum</code></pre> 12109 <p>Sync <code>/home/local/images</code> to the Google Photos, removing any excess files in the album.</p> 12110 <pre><code>rclone sync /home/local/image remote:album/newAlbum</code></pre> 12111 <h2 id="layout">Layout</h2> 12112 <p>As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it.</p> 12113 <p>The directories under <code>media</code> 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 <code>remote:media/by-month</code>. (<strong>NB</strong> <code>remote:media/by-day</code> is rather slow at the moment so avoid for syncing.)</p> 12114 <p>Note that all your photos and videos will appear somewhere under <code>media</code>, but they may not appear under <code>album</code> unless you’ve put them into albums.</p> 12115 <pre><code>/ 12116 - upload 12117 - file1.jpg 12118 - file2.jpg 12119 - ... 12120 - media 12121 - all 12122 - file1.jpg 12123 - file2.jpg 12124 - ... 12125 - by-year 12126 - 2000 12127 - file1.jpg 12128 - ... 12129 - 2001 12130 - file2.jpg 12131 - ... 12132 - ... 12133 - by-month 12134 - 2000 12135 - 2000-01 12136 - file1.jpg 12137 - ... 12138 - 2000-02 12139 - file2.jpg 12140 - ... 12141 - ... 12142 - by-day 12143 - 2000 12144 - 2000-01-01 12145 - file1.jpg 12146 - ... 12147 - 2000-01-02 12148 - file2.jpg 12149 - ... 12150 - ... 12151 - album 12152 - album name 12153 - album name/sub 12154 - shared-album 12155 - album name 12156 - album name/sub 12157 - feature 12158 - favorites 12159 - file1.jpg 12160 - file2.jpg</code></pre> 12161 <p>There are two writable parts of the tree, the <code>upload</code> directory and sub directories of the <code>album</code> directory.</p> 12162 <p>The <code>upload</code> directory is for uploading files you don’t want to put into albums. This will be empty to start with and will contain the files you’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 <code>album</code> will work better.</p> 12163 <p>Directories within the <code>album</code> directory are also writeable and you may create new directories (albums) under <code>album</code>. If you copy files with a directory hierarchy in there then rclone will create albums with the <code>/</code> character in them. For example if you do</p> 12164 <pre><code>rclone copy /path/to/images remote:album/images</code></pre> 12165 <p>and the images directory contains</p> 12166 <pre><code>images 12167 - file1.jpg 12168 dir 12169 file2.jpg 12170 dir2 12171 dir3 12172 file3.jpg</code></pre> 12173 <p>Then rclone will create the following albums with the following files in</p> 12174 <ul> 12175 <li>images 12176 <ul> 12177 <li>file1.jpg</li> 12178 </ul></li> 12179 <li>images/dir 12180 <ul> 12181 <li>file2.jpg</li> 12182 </ul></li> 12183 <li>images/dir2/dir3 12184 <ul> 12185 <li>file3.jpg</li> 12186 </ul></li> 12187 </ul> 12188 <p>This means that you can use the <code>album</code> path pretty much like a normal filesystem and it is a good target for repeated syncing.</p> 12189 <p>The <code>shared-album</code> directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface.</p> 12190 <h2 id="limitations-8">Limitations</h2> 12191 <p>Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn’t understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item.</p> 12192 <p>Note that all media items uploaded to Google Photos through the API are stored in full resolution at “original quality” and <strong>will</strong> count towards your storage quota in your Google Account. The API does <strong>not</strong> offer a way to upload in “high quality” mode..</p> 12193 <h3 id="downloading-images">Downloading Images</h3> 12194 <p>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 <a href="https://issuetracker.google.com/issues/112096115">bug #112096115</a>.</p> 12195 <p><strong>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 “Google Photos” as a backup of your photos. You will not be able to use rclone to redownload original images. You could use ‘google takeout’ to recover the original photos as a last resort</strong></p> 12196 <h3 id="downloading-videos">Downloading Videos</h3> 12197 <p>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 <a href="https://issuetracker.google.com/issues/113672044">bug #113672044</a>.</p> 12198 <h3 id="duplicates">Duplicates</h3> 12199 <p>If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called <code>file.jpg</code> would then appear as <code>file {123456}.jpg</code> and <code>file {ABCDEF}.jpg</code> (the actual IDs are a lot longer alas!).</p> 12200 <p>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 <code>upload</code> then uploaded the same image to <code>album/my_album</code> the filename of the image in <code>album/my_album</code> will be what it was uploaded with initially, not what you uploaded it with to <code>album</code>. In practise this shouldn’t cause too many problems.</p> 12201 <h3 id="modified-time-6">Modified time</h3> 12202 <p>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.</p> 12203 <p>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.</p> 12204 <h3 id="size">Size</h3> 12205 <p>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.</p> 12206 <p>It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is <strong>very slow</strong> and uses up a lot of transactions. This can be enabled with the <code>--gphotos-read-size</code> option or the <code>read_size = true</code> config parameter.</p> 12207 <p>If you want to use the backend with <code>rclone mount</code> 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’ll need to experiment to see if it works for you without the flag.</p> 12208 <h3 id="albums">Albums</h3> 12209 <p>Rclone can only upload files to albums it created. This is a <a href="https://developers.google.com/photos/library/guides/manage-albums">limitation of the Google Photos API</a>.</p> 12210 <p>Rclone can remove files it uploaded from albums it created only.</p> 12211 <h3 id="deleting-files-3">Deleting files</h3> 12212 <p>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 <a href="https://issuetracker.google.com/issues/109759781">bug #109759781</a>.</p> 12213 <p>Rclone cannot delete files anywhere except under <code>album</code>.</p> 12214 <h3 id="deleting-albums">Deleting albums</h3> 12215 <p>The Google Photos API does not support deleting albums - see <a href="https://issuetracker.google.com/issues/135714733">bug #135714733</a>.</p> 12216 <h3 id="standard-options-14">Standard Options</h3> 12217 <p>Here are the standard options specific to google photos (Google Photos).</p> 12218 <h4 id="gphotos-client-id">–gphotos-client-id</h4> 12219 <p>Google Application Client Id Leave blank normally.</p> 12220 <ul> 12221 <li>Config: client_id</li> 12222 <li>Env Var: RCLONE_GPHOTOS_CLIENT_ID</li> 12223 <li>Type: string</li> 12224 <li>Default: ""</li> 12225 </ul> 12226 <h4 id="gphotos-client-secret">–gphotos-client-secret</h4> 12227 <p>Google Application Client Secret Leave blank normally.</p> 12228 <ul> 12229 <li>Config: client_secret</li> 12230 <li>Env Var: RCLONE_GPHOTOS_CLIENT_SECRET</li> 12231 <li>Type: string</li> 12232 <li>Default: ""</li> 12233 </ul> 12234 <h4 id="gphotos-read-only">–gphotos-read-only</h4> 12235 <p>Set to make the Google Photos backend read only.</p> 12236 <p>If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access.</p> 12237 <ul> 12238 <li>Config: read_only</li> 12239 <li>Env Var: RCLONE_GPHOTOS_READ_ONLY</li> 12240 <li>Type: bool</li> 12241 <li>Default: false</li> 12242 </ul> 12243 <h3 id="advanced-options-13">Advanced Options</h3> 12244 <p>Here are the advanced options specific to google photos (Google Photos).</p> 12245 <h4 id="gphotos-read-size">–gphotos-read-size</h4> 12246 <p>Set to read the size of media items.</p> 12247 <p>Normally rclone does not read the size of media items since this takes another transaction. This isn’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.</p> 12248 <ul> 12249 <li>Config: read_size</li> 12250 <li>Env Var: RCLONE_GPHOTOS_READ_SIZE</li> 12251 <li>Type: bool</li> 12252 <li>Default: false</li> 12253 </ul> 12254 <h4 id="gphotos-start-year">–gphotos-start-year</h4> 12255 <p>Year limits the photos to be downloaded to those which are uploaded after the given year</p> 12256 <ul> 12257 <li>Config: start_year</li> 12258 <li>Env Var: RCLONE_GPHOTOS_START_YEAR</li> 12259 <li>Type: int</li> 12260 <li>Default: 2000</li> 12261 </ul> 12262 <h2 id="http">HTTP</h2> 12263 <p>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’t then please file an issue, or send a pull request!)</p> 12264 <p>Paths are specified as <code>remote:</code> or <code>remote:path/to/dir</code>.</p> 12265 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 12266 <pre><code> rclone config</code></pre> 12267 <p>This will guide you through an interactive setup process:</p> 12268 <pre><code>No remotes found - make a new one 12269 n) New remote 12270 s) Set configuration password 12271 q) Quit config 12272 n/s/q> n 12273 name> remote 12274 Type of storage to configure. 12275 Choose a number from below, or type in your own value 12276 [snip] 12277 XX / http Connection 12278 \ "http" 12279 [snip] 12280 Storage> http 12281 URL of http host to connect to 12282 Choose a number from below, or type in your own value 12283 1 / Connect to example.com 12284 \ "https://example.com" 12285 url> https://beta.rclone.org 12286 Remote config 12287 -------------------- 12288 [remote] 12289 url = https://beta.rclone.org 12290 -------------------- 12291 y) Yes this is OK 12292 e) Edit this remote 12293 d) Delete this remote 12294 y/e/d> y 12295 Current remotes: 12296 12297 Name Type 12298 ==== ==== 12299 remote http 12300 12301 e) Edit existing remote 12302 n) New remote 12303 d) Delete remote 12304 r) Rename remote 12305 c) Copy remote 12306 s) Set configuration password 12307 q) Quit config 12308 e/n/d/r/c/s/q> q</code></pre> 12309 <p>This remote is called <code>remote</code> and can now be used like this</p> 12310 <p>See all the top level directories</p> 12311 <pre><code>rclone lsd remote:</code></pre> 12312 <p>List the contents of a directory</p> 12313 <pre><code>rclone ls remote:directory</code></pre> 12314 <p>Sync the remote <code>directory</code> to <code>/home/local/directory</code>, deleting any excess files.</p> 12315 <pre><code>rclone sync remote:directory /home/local/directory</code></pre> 12316 <h3 id="read-only">Read only</h3> 12317 <p>This remote is read only - you can’t upload files to an HTTP server.</p> 12318 <h3 id="modified-time-7">Modified time</h3> 12319 <p>Most HTTP servers store time accurate to 1 second.</p> 12320 <h3 id="checksum">Checksum</h3> 12321 <p>No checksums are stored.</p> 12322 <h3 id="usage-without-a-config-file-1">Usage without a config file</h3> 12323 <p>Since the http remote only has one config parameter it is easy to use without a config file:</p> 12324 <pre><code>rclone lsd --http-url https://beta.rclone.org :http:</code></pre> 12325 <h3 id="standard-options-15">Standard Options</h3> 12326 <p>Here are the standard options specific to http (http Connection).</p> 12327 <h4 id="http-url">–http-url</h4> 12328 <p>URL of http host to connect to</p> 12329 <ul> 12330 <li>Config: url</li> 12331 <li>Env Var: RCLONE_HTTP_URL</li> 12332 <li>Type: string</li> 12333 <li>Default: ""</li> 12334 <li>Examples: 12335 <ul> 12336 <li>“https://example.com” 12337 <ul> 12338 <li>Connect to example.com</li> 12339 </ul></li> 12340 <li>“https://user:pass@example.com” 12341 <ul> 12342 <li>Connect to example.com using a username and password</li> 12343 </ul></li> 12344 </ul></li> 12345 </ul> 12346 <h3 id="advanced-options-14">Advanced Options</h3> 12347 <p>Here are the advanced options specific to http (http Connection).</p> 12348 <h4 id="http-headers">–http-headers</h4> 12349 <p>Set HTTP headers for all transactions</p> 12350 <p>Use this to set additional HTTP headers for all transactions</p> 12351 <p>The input format is comma separated list of key,value pairs. Standard <a href="https://godoc.org/encoding/csv">CSV encoding</a> may be used.</p> 12352 <p>For example to set a Cookie use ‘Cookie,name=value’, or ‘“Cookie”,“name=value”’.</p> 12353 <p>You can set multiple headers, eg ‘“Cookie”,“name=value”,“Authorization”,“xxx”’.</p> 12354 <ul> 12355 <li>Config: headers</li> 12356 <li>Env Var: RCLONE_HTTP_HEADERS</li> 12357 <li>Type: CommaSepList</li> 12358 <li>Default:</li> 12359 </ul> 12360 <h4 id="http-no-slash">–http-no-slash</h4> 12361 <p>Set this if the site doesn’t end directories with /</p> 12362 <p>Use this if your target website does not use / on the end of directories.</p> 12363 <p>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.</p> 12364 <p>Note that this may cause rclone to confuse genuine HTML files with directories.</p> 12365 <ul> 12366 <li>Config: no_slash</li> 12367 <li>Env Var: RCLONE_HTTP_NO_SLASH</li> 12368 <li>Type: bool</li> 12369 <li>Default: false</li> 12370 </ul> 12371 <h4 id="http-no-head">–http-no-head</h4> 12372 <p>Don’t use HEAD requests to find file sizes in dir listing</p> 12373 <p>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:</p> 12374 <ul> 12375 <li>find its size</li> 12376 <li>check it really exists</li> 12377 <li>check to see if it is a directory</li> 12378 </ul> 12379 <p>If you set this option, rclone will not do the HEAD request. This will mean</p> 12380 <ul> 12381 <li>directory listings are much quicker</li> 12382 <li>rclone won’t have the times or sizes of any files</li> 12383 <li><p>some files that don’t exist may be in the listing</p></li> 12384 <li>Config: no_head</li> 12385 <li>Env Var: RCLONE_HTTP_NO_HEAD</li> 12386 <li>Type: bool</li> 12387 <li><p>Default: false</p></li> 12388 </ul> 12389 <h2 id="hubic">Hubic</h2> 12390 <p>Paths are specified as <code>remote:path</code></p> 12391 <p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p> 12392 <p>The initial setup for Hubic involves getting a token from Hubic which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 12393 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 12394 <pre><code> rclone config</code></pre> 12395 <p>This will guide you through an interactive setup process:</p> 12396 <pre><code>n) New remote 12397 s) Set configuration password 12398 n/s> n 12399 name> remote 12400 Type of storage to configure. 12401 Choose a number from below, or type in your own value 12402 [snip] 12403 XX / Hubic 12404 \ "hubic" 12405 [snip] 12406 Storage> hubic 12407 Hubic Client Id - leave blank normally. 12408 client_id> 12409 Hubic Client Secret - leave blank normally. 12410 client_secret> 12411 Remote config 12412 Use auto config? 12413 * Say Y if not sure 12414 * Say N if you are working on a remote or headless machine 12415 y) Yes 12416 n) No 12417 y/n> y 12418 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 12419 Log in and authorize rclone for access 12420 Waiting for code... 12421 Got code 12422 -------------------- 12423 [remote] 12424 client_id = 12425 client_secret = 12426 token = {"access_token":"XXXXXX"} 12427 -------------------- 12428 y) Yes this is OK 12429 e) Edit this remote 12430 d) Delete this remote 12431 y/e/d> y</code></pre> 12432 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 12433 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Hubic. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 12434 <p>Once configured you can then use <code>rclone</code> like this,</p> 12435 <p>List containers in the top level of your Hubic</p> 12436 <pre><code>rclone lsd remote:</code></pre> 12437 <p>List all the files in your Hubic</p> 12438 <pre><code>rclone ls remote:</code></pre> 12439 <p>To copy a local directory to an Hubic directory called backup</p> 12440 <pre><code>rclone copy /home/source remote:backup</code></pre> 12441 <p>If you want the directory to be visible in the official <em>Hubic browser</em>, you need to copy your files to the <code>default</code> directory</p> 12442 <pre><code>rclone copy /home/source remote:default/backup</code></pre> 12443 <h3 id="fast-list-5">–fast-list</h3> 12444 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 12445 <h3 id="modified-time-8">Modified time</h3> 12446 <p>The modified time is stored as metadata on the object as <code>X-Object-Meta-Mtime</code> as floating point since the epoch accurate to 1 ns.</p> 12447 <p>This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p> 12448 <p>Note that Hubic wraps the Swift backend, so most of the properties of are the same.</p> 12449 <h3 id="standard-options-16">Standard Options</h3> 12450 <p>Here are the standard options specific to hubic (Hubic).</p> 12451 <h4 id="hubic-client-id">–hubic-client-id</h4> 12452 <p>Hubic Client Id Leave blank normally.</p> 12453 <ul> 12454 <li>Config: client_id</li> 12455 <li>Env Var: RCLONE_HUBIC_CLIENT_ID</li> 12456 <li>Type: string</li> 12457 <li>Default: ""</li> 12458 </ul> 12459 <h4 id="hubic-client-secret">–hubic-client-secret</h4> 12460 <p>Hubic Client Secret Leave blank normally.</p> 12461 <ul> 12462 <li>Config: client_secret</li> 12463 <li>Env Var: RCLONE_HUBIC_CLIENT_SECRET</li> 12464 <li>Type: string</li> 12465 <li>Default: ""</li> 12466 </ul> 12467 <h3 id="advanced-options-15">Advanced Options</h3> 12468 <p>Here are the advanced options specific to hubic (Hubic).</p> 12469 <h4 id="hubic-chunk-size">–hubic-chunk-size</h4> 12470 <p>Above this size files will be chunked into a _segments container.</p> 12471 <p>Above this size files will be chunked into a _segments container. The default for this is 5GB which is its maximum value.</p> 12472 <ul> 12473 <li>Config: chunk_size</li> 12474 <li>Env Var: RCLONE_HUBIC_CHUNK_SIZE</li> 12475 <li>Type: SizeSuffix</li> 12476 <li>Default: 5G</li> 12477 </ul> 12478 <h4 id="hubic-no-chunk">–hubic-no-chunk</h4> 12479 <p>Don’t chunk files during streaming upload.</p> 12480 <p>When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.</p> 12481 <p>This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.</p> 12482 <p>Rclone will still chunk files bigger than chunk_size when doing normal copy operations.</p> 12483 <ul> 12484 <li>Config: no_chunk</li> 12485 <li>Env Var: RCLONE_HUBIC_NO_CHUNK</li> 12486 <li>Type: bool</li> 12487 <li>Default: false</li> 12488 </ul> 12489 <h4 id="hubic-encoding">–hubic-encoding</h4> 12490 <p>This sets the encoding for the backend.</p> 12491 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 12492 <ul> 12493 <li>Config: encoding</li> 12494 <li>Env Var: RCLONE_HUBIC_ENCODING</li> 12495 <li>Type: MultiEncoder</li> 12496 <li>Default: Slash,InvalidUtf8</li> 12497 </ul> 12498 <h3 id="limitations-9">Limitations</h3> 12499 <p>This uses the normal OpenStack Swift mechanism to refresh the Swift API credentials and ignores the expires field returned by the Hubic API.</p> 12500 <p>The Swift API doesn’t return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won’t check or use the MD5SUM for these.</p> 12501 <h2 id="jottacloud">Jottacloud</h2> 12502 <p>Jottacloud is a cloud storage service provider from a Norwegian company, using its own datacenters in Norway.</p> 12503 <p>In addition to the official service at <a href="https://www.jottacloud.com/">jottacloud.com</a>, there are also several whitelabel versions which should work with this backend.</p> 12504 <p>Paths are specified as <code>remote:path</code></p> 12505 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 12506 <h2 id="setup-2">Setup</h2> 12507 <p>To configure Jottacloud you will need to generate a personal security token in the Jottacloud web interface. You will the option to do in your <a href="https://www.jottacloud.com/web/secure">account security settings</a> (for whitelabel version you need to find this page in its web interface). Note that the web interface may refer to this token as a JottaCli token.</p> 12508 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 12509 <pre><code>rclone config</code></pre> 12510 <p>This will guide you through an interactive setup process:</p> 12511 <pre><code>No remotes found - make a new one 12512 n) New remote 12513 s) Set configuration password 12514 q) Quit config 12515 n/s/q> n 12516 name> jotta 12517 Type of storage to configure. 12518 Enter a string value. Press Enter for the default (""). 12519 Choose a number from below, or type in your own value 12520 [snip] 12521 XX / Jottacloud 12522 \ "jottacloud" 12523 [snip] 12524 Storage> jottacloud 12525 ** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** 12526 12527 Edit advanced config? (y/n) 12528 y) Yes 12529 n) No 12530 y/n> n 12531 Remote config 12532 12533 Generate a personal login token here: https://www.jottacloud.com/web/secure 12534 Login Token> <your token here> 12535 12536 Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? 12537 12538 y) Yes 12539 n) No 12540 y/n> y 12541 Please select the device to use. Normally this will be Jotta 12542 Choose a number from below, or type in an existing value 12543 1 > DESKTOP-3H31129 12544 2 > fla1 12545 3 > Jotta 12546 Devices> 3 12547 Please select the mountpoint to user. Normally this will be Archive 12548 Choose a number from below, or type in an existing value 12549 1 > Archive 12550 2 > Links 12551 3 > Sync 12552 12553 Mountpoints> 1 12554 -------------------- 12555 [jotta] 12556 type = jottacloud 12557 user = 0xC4KE@gmail.com 12558 token = {........} 12559 device = Jotta 12560 mountpoint = Archive 12561 configVersion = 1 12562 -------------------- 12563 y) Yes this is OK 12564 e) Edit this remote 12565 d) Delete this remote 12566 y/e/d> y</code></pre> 12567 <p>Once configured you can then use <code>rclone</code> like this,</p> 12568 <p>List directories in top level of your Jottacloud</p> 12569 <pre><code>rclone lsd remote:</code></pre> 12570 <p>List all the files in your Jottacloud</p> 12571 <pre><code>rclone ls remote:</code></pre> 12572 <p>To copy a local directory to an Jottacloud directory called backup</p> 12573 <pre><code>rclone copy /home/source remote:backup</code></pre> 12574 <h3 id="devices-and-mountpoints">Devices and Mountpoints</h3> 12575 <p>The official Jottacloud client registers a device for each computer you install it on, and then creates a mountpoint for each folder you select for Backup. The web interface uses a special device called Jotta for the Archive and Sync mountpoints. In most cases you’ll want to use the Jotta/Archive device/mountpoint, however if you want to access files uploaded by any of the official clients rclone provides the option to select other devices and mountpoints during config.</p> 12576 <p>The built-in Jotta device may also contain several other mountpoints, such as: Latest, Links, Shared and Trash. These are special mountpoints with a different internal representation than the “regular” mountpoints. Rclone will only to a very limited degree support them. Generally you should avoid these, unless you know what you are doing.</p> 12577 <h3 id="fast-list-6">–fast-list</h3> 12578 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 12579 <p>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.</p> 12580 <h3 id="modified-time-and-hashes-5">Modified time and hashes</h3> 12581 <p>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.</p> 12582 <p>Jottacloud supports MD5 type hashes, so you can use the <code>--checksum</code> flag.</p> 12583 <p>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 (wherever the <code>TMPDIR</code> environment variable points to) before it is uploaded. Small files will be cached in memory - see the <a href="#jottacloud-md5-memory-limit">–jottacloud-md5-memory-limit</a> flag.</p> 12584 <h4 id="restricted-filename-characters-10">Restricted filename characters</h4> 12585 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 12586 <table> 12587 <thead> 12588 <tr class="header"> 12589 <th>Character</th> 12590 <th style="text-align: center;">Value</th> 12591 <th style="text-align: center;">Replacement</th> 12592 </tr> 12593 </thead> 12594 <tbody> 12595 <tr class="odd"> 12596 <td>"</td> 12597 <td style="text-align: center;">0x22</td> 12598 <td style="text-align: center;">＂</td> 12599 </tr> 12600 <tr class="even"> 12601 <td>*</td> 12602 <td style="text-align: center;">0x2A</td> 12603 <td style="text-align: center;">＊</td> 12604 </tr> 12605 <tr class="odd"> 12606 <td>:</td> 12607 <td style="text-align: center;">0x3A</td> 12608 <td style="text-align: center;">：</td> 12609 </tr> 12610 <tr class="even"> 12611 <td><</td> 12612 <td style="text-align: center;">0x3C</td> 12613 <td style="text-align: center;">＜</td> 12614 </tr> 12615 <tr class="odd"> 12616 <td>></td> 12617 <td style="text-align: center;">0x3E</td> 12618 <td style="text-align: center;">＞</td> 12619 </tr> 12620 <tr class="even"> 12621 <td>?</td> 12622 <td style="text-align: center;">0x3F</td> 12623 <td style="text-align: center;">？</td> 12624 </tr> 12625 <tr class="odd"> 12626 <td>|</td> 12627 <td style="text-align: center;">0x7C</td> 12628 <td style="text-align: center;">｜</td> 12629 </tr> 12630 </tbody> 12631 </table> 12632 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in XML strings.</p> 12633 <h3 id="deleting-files-4">Deleting files</h3> 12634 <p>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 <a href="#jottacloud-hard-delete">–jottacloud-hard-delete</a> flag, or set the equivalent environment variable. Emptying the trash is supported by the <a href="https://rclone.org/commands/rclone_cleanup/">cleanup</a> command.</p> 12635 <h3 id="versions-2">Versions</h3> 12636 <p>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.</p> 12637 <h3 id="quota-information-1">Quota information</h3> 12638 <p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (unless it is unlimited) and the current usage.</p> 12639 <h3 id="advanced-options-16">Advanced Options</h3> 12640 <p>Here are the advanced options specific to jottacloud (Jottacloud).</p> 12641 <h4 id="jottacloud-md5-memory-limit">–jottacloud-md5-memory-limit</h4> 12642 <p>Files bigger than this will be cached on disk to calculate the MD5 if required.</p> 12643 <ul> 12644 <li>Config: md5_memory_limit</li> 12645 <li>Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT</li> 12646 <li>Type: SizeSuffix</li> 12647 <li>Default: 10M</li> 12648 </ul> 12649 <h4 id="jottacloud-trashed-only">–jottacloud-trashed-only</h4> 12650 <p>Only show files that are in the trash. This will show trashed files in their original directory structure.</p> 12651 <ul> 12652 <li>Config: trashed_only</li> 12653 <li>Env Var: RCLONE_JOTTACLOUD_TRASHED_ONLY</li> 12654 <li>Type: bool</li> 12655 <li>Default: false</li> 12656 </ul> 12657 <h4 id="jottacloud-hard-delete">–jottacloud-hard-delete</h4> 12658 <p>Delete files permanently rather than putting them into the trash.</p> 12659 <ul> 12660 <li>Config: hard_delete</li> 12661 <li>Env Var: RCLONE_JOTTACLOUD_HARD_DELETE</li> 12662 <li>Type: bool</li> 12663 <li>Default: false</li> 12664 </ul> 12665 <h4 id="jottacloud-unlink">–jottacloud-unlink</h4> 12666 <p>Remove existing public link to file/folder with link command rather than creating. Default is false, meaning link command will create or retrieve public link.</p> 12667 <ul> 12668 <li>Config: unlink</li> 12669 <li>Env Var: RCLONE_JOTTACLOUD_UNLINK</li> 12670 <li>Type: bool</li> 12671 <li>Default: false</li> 12672 </ul> 12673 <h4 id="jottacloud-upload-resume-limit">–jottacloud-upload-resume-limit</h4> 12674 <p>Files bigger than this can be resumed if the upload fail’s.</p> 12675 <ul> 12676 <li>Config: upload_resume_limit</li> 12677 <li>Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT</li> 12678 <li>Type: SizeSuffix</li> 12679 <li>Default: 10M</li> 12680 </ul> 12681 <h4 id="jottacloud-encoding">–jottacloud-encoding</h4> 12682 <p>This sets the encoding for the backend.</p> 12683 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 12684 <ul> 12685 <li>Config: encoding</li> 12686 <li>Env Var: RCLONE_JOTTACLOUD_ENCODING</li> 12687 <li>Type: MultiEncoder</li> 12688 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot</li> 12689 </ul> 12690 <h3 id="limitations-10">Limitations</h3> 12691 <p>Note that Jottacloud is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 12692 <p>There are quite a few characters that can’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 ？ instead.</p> 12693 <p>Jottacloud only supports filenames up to 255 characters in length.</p> 12694 <h3 id="troubleshooting">Troubleshooting</h3> 12695 <p>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.</p> 12696 <h2 id="koofr">Koofr</h2> 12697 <p>Paths are specified as <code>remote:path</code></p> 12698 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 12699 <p>The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr <a href="https://app.koofr.net/app/admin/preferences/password">web application</a>, giving the password a nice name like <code>rclone</code> and clicking on generate.</p> 12700 <p>Here is an example of how to make a remote called <code>koofr</code>. First run:</p> 12701 <pre><code> rclone config</code></pre> 12702 <p>This will guide you through an interactive setup process:</p> 12703 <pre><code>No remotes found - make a new one 12704 n) New remote 12705 s) Set configuration password 12706 q) Quit config 12707 n/s/q> n 12708 name> koofr 12709 Type of storage to configure. 12710 Enter a string value. Press Enter for the default (""). 12711 Choose a number from below, or type in your own value 12712 [snip] 12713 XX / Koofr 12714 \ "koofr" 12715 [snip] 12716 Storage> koofr 12717 ** See help for koofr backend at: https://rclone.org/koofr/ ** 12718 12719 Your Koofr user name 12720 Enter a string value. Press Enter for the default (""). 12721 user> USER@NAME 12722 Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) 12723 y) Yes type in my own password 12724 g) Generate random password 12725 y/g> y 12726 Enter the password: 12727 password: 12728 Confirm the password: 12729 password: 12730 Edit advanced config? (y/n) 12731 y) Yes 12732 n) No 12733 y/n> n 12734 Remote config 12735 -------------------- 12736 [koofr] 12737 type = koofr 12738 baseurl = https://app.koofr.net 12739 user = USER@NAME 12740 password = *** ENCRYPTED *** 12741 -------------------- 12742 y) Yes this is OK 12743 e) Edit this remote 12744 d) Delete this remote 12745 y/e/d> y</code></pre> 12746 <p>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.</p> 12747 <p>Once configured you can then use <code>rclone</code> like this,</p> 12748 <p>List directories in top level of your Koofr</p> 12749 <pre><code>rclone lsd koofr:</code></pre> 12750 <p>List all the files in your Koofr</p> 12751 <pre><code>rclone ls koofr:</code></pre> 12752 <p>To copy a local directory to an Koofr directory called backup</p> 12753 <pre><code>rclone copy /home/source remote:backup</code></pre> 12754 <h4 id="restricted-filename-characters-11">Restricted filename characters</h4> 12755 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 12756 <table> 12757 <thead> 12758 <tr class="header"> 12759 <th>Character</th> 12760 <th style="text-align: center;">Value</th> 12761 <th style="text-align: center;">Replacement</th> 12762 </tr> 12763 </thead> 12764 <tbody> 12765 <tr class="odd"> 12766 <td>\</td> 12767 <td style="text-align: center;">0x5C</td> 12768 <td style="text-align: center;">＼</td> 12769 </tr> 12770 </tbody> 12771 </table> 12772 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in XML strings.</p> 12773 <h3 id="standard-options-17">Standard Options</h3> 12774 <p>Here are the standard options specific to koofr (Koofr).</p> 12775 <h4 id="koofr-user">–koofr-user</h4> 12776 <p>Your Koofr user name</p> 12777 <ul> 12778 <li>Config: user</li> 12779 <li>Env Var: RCLONE_KOOFR_USER</li> 12780 <li>Type: string</li> 12781 <li>Default: ""</li> 12782 </ul> 12783 <h4 id="koofr-password">–koofr-password</h4> 12784 <p>Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)</p> 12785 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 12786 <ul> 12787 <li>Config: password</li> 12788 <li>Env Var: RCLONE_KOOFR_PASSWORD</li> 12789 <li>Type: string</li> 12790 <li>Default: ""</li> 12791 </ul> 12792 <h3 id="advanced-options-17">Advanced Options</h3> 12793 <p>Here are the advanced options specific to koofr (Koofr).</p> 12794 <h4 id="koofr-endpoint">–koofr-endpoint</h4> 12795 <p>The Koofr API endpoint to use</p> 12796 <ul> 12797 <li>Config: endpoint</li> 12798 <li>Env Var: RCLONE_KOOFR_ENDPOINT</li> 12799 <li>Type: string</li> 12800 <li>Default: “https://app.koofr.net”</li> 12801 </ul> 12802 <h4 id="koofr-mountid">–koofr-mountid</h4> 12803 <p>Mount ID of the mount to use. If omitted, the primary mount is used.</p> 12804 <ul> 12805 <li>Config: mountid</li> 12806 <li>Env Var: RCLONE_KOOFR_MOUNTID</li> 12807 <li>Type: string</li> 12808 <li>Default: ""</li> 12809 </ul> 12810 <h4 id="koofr-setmtime">–koofr-setmtime</h4> 12811 <p>Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend.</p> 12812 <ul> 12813 <li>Config: setmtime</li> 12814 <li>Env Var: RCLONE_KOOFR_SETMTIME</li> 12815 <li>Type: bool</li> 12816 <li>Default: true</li> 12817 </ul> 12818 <h4 id="koofr-encoding">–koofr-encoding</h4> 12819 <p>This sets the encoding for the backend.</p> 12820 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 12821 <ul> 12822 <li>Config: encoding</li> 12823 <li>Env Var: RCLONE_KOOFR_ENCODING</li> 12824 <li>Type: MultiEncoder</li> 12825 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 12826 </ul> 12827 <h3 id="limitations-11">Limitations</h3> 12828 <p>Note that Koofr is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 12829 <h2 id="mail.ru-cloud">Mail.ru Cloud</h2> 12830 <p><a href="https://cloud.mail.ru/">Mail.ru Cloud</a> is a cloud storage provided by a Russian internet company <a href="https://mail.ru">Mail.Ru Group</a>. The official desktop client is <a href="https://disk-o.cloud/">Disk-O:</a>, available only on Windows. (Please note that official sites are in Russian)</p> 12831 <p>Currently it is recommended to disable 2FA on Mail.ru accounts intended for rclone until it gets eventually implemented.</p> 12832 <h3 id="features-highlights">Features highlights</h3> 12833 <ul> 12834 <li>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code></li> 12835 <li>Files have a <code>last modified time</code> property, directories don’t</li> 12836 <li>Deleted files are by default moved to the trash</li> 12837 <li>Files and directories can be shared via public links</li> 12838 <li>Partial uploads or streaming are not supported, file size must be known before upload</li> 12839 <li>Maximum file size is limited to 2G for a free account, unlimited for paid accounts</li> 12840 <li>Storage keeps hash for all files and performs transparent deduplication, the hash algorithm is a modified SHA1</li> 12841 <li>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)</li> 12842 </ul> 12843 <h3 id="configuration">Configuration</h3> 12844 <p>Here is an example of making a mailru configuration. First create a Mail.ru Cloud account and choose a tariff, then run</p> 12845 <pre><code>rclone config</code></pre> 12846 <p>This will guide you through an interactive setup process:</p> 12847 <pre><code>No remotes found - make a new one 12848 n) New remote 12849 s) Set configuration password 12850 q) Quit config 12851 n/s/q> n 12852 name> remote 12853 Type of storage to configure. 12854 Type of storage to configure. 12855 Enter a string value. Press Enter for the default (""). 12856 Choose a number from below, or type in your own value 12857 [snip] 12858 XX / Mail.ru Cloud 12859 \ "mailru" 12860 [snip] 12861 Storage> mailru 12862 User name (usually email) 12863 Enter a string value. Press Enter for the default (""). 12864 user> username@mail.ru 12865 Password 12866 y) Yes type in my own password 12867 g) Generate random password 12868 y/g> y 12869 Enter the password: 12870 password: 12871 Confirm the password: 12872 password: 12873 Skip full upload if there is another file with same data hash. 12874 This feature is called "speedup" or "put by hash". It is especially efficient 12875 in case of generally available files like popular books, video or audio clips 12876 [snip] 12877 Enter a boolean value (true or false). Press Enter for the default ("true"). 12878 Choose a number from below, or type in your own value 12879 1 / Enable 12880 \ "true" 12881 2 / Disable 12882 \ "false" 12883 speedup_enable> 1 12884 Edit advanced config? (y/n) 12885 y) Yes 12886 n) No 12887 y/n> n 12888 Remote config 12889 -------------------- 12890 [remote] 12891 type = mailru 12892 user = username@mail.ru 12893 pass = *** ENCRYPTED *** 12894 speedup_enable = true 12895 -------------------- 12896 y) Yes this is OK 12897 e) Edit this remote 12898 d) Delete this remote 12899 y/e/d> y</code></pre> 12900 <p>Configuration of this backend does not require a local web browser. You can use the configured backend as shown below:</p> 12901 <p>See top level directories</p> 12902 <pre><code>rclone lsd remote:</code></pre> 12903 <p>Make a new directory</p> 12904 <pre><code>rclone mkdir remote:directory</code></pre> 12905 <p>List the contents of a directory</p> 12906 <pre><code>rclone ls remote:directory</code></pre> 12907 <p>Sync <code>/home/local/directory</code> to the remote path, deleting any excess files in the path.</p> 12908 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 12909 <h3 id="modified-time-9">Modified time</h3> 12910 <p>Files support a modification time attribute with up to 1 second precision. Directories do not have a modification time, which is shown as “Jan 1 1970”.</p> 12911 <h3 id="hash-checksums">Hash checksums</h3> 12912 <p>Hash sums use 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. Hash sum of a larger file is computed as a SHA1 sum of the file data bytes concatenated with a decimal representation of the data length.</p> 12913 <h3 id="emptying-trash-1">Emptying Trash</h3> 12914 <p>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 <code>rclone cleanup remote:</code> command, which will permanently delete all your trashed files. This command does not take any path arguments.</p> 12915 <h3 id="quota-information-2">Quota information</h3> 12916 <p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (quota) and the current usage.</p> 12917 <h4 id="restricted-filename-characters-12">Restricted filename characters</h4> 12918 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 12919 <table> 12920 <thead> 12921 <tr class="header"> 12922 <th>Character</th> 12923 <th style="text-align: center;">Value</th> 12924 <th style="text-align: center;">Replacement</th> 12925 </tr> 12926 </thead> 12927 <tbody> 12928 <tr class="odd"> 12929 <td>"</td> 12930 <td style="text-align: center;">0x22</td> 12931 <td style="text-align: center;">＂</td> 12932 </tr> 12933 <tr class="even"> 12934 <td>*</td> 12935 <td style="text-align: center;">0x2A</td> 12936 <td style="text-align: center;">＊</td> 12937 </tr> 12938 <tr class="odd"> 12939 <td>:</td> 12940 <td style="text-align: center;">0x3A</td> 12941 <td style="text-align: center;">：</td> 12942 </tr> 12943 <tr class="even"> 12944 <td><</td> 12945 <td style="text-align: center;">0x3C</td> 12946 <td style="text-align: center;">＜</td> 12947 </tr> 12948 <tr class="odd"> 12949 <td>></td> 12950 <td style="text-align: center;">0x3E</td> 12951 <td style="text-align: center;">＞</td> 12952 </tr> 12953 <tr class="even"> 12954 <td>?</td> 12955 <td style="text-align: center;">0x3F</td> 12956 <td style="text-align: center;">？</td> 12957 </tr> 12958 <tr class="odd"> 12959 <td>\</td> 12960 <td style="text-align: center;">0x5C</td> 12961 <td style="text-align: center;">＼</td> 12962 </tr> 12963 <tr class="even"> 12964 <td>|</td> 12965 <td style="text-align: center;">0x7C</td> 12966 <td style="text-align: center;">｜</td> 12967 </tr> 12968 </tbody> 12969 </table> 12970 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 12971 <h3 id="limitations-12">Limitations</h3> 12972 <p>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.</p> 12973 <p>Note that Mailru is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 12974 <h3 id="standard-options-18">Standard Options</h3> 12975 <p>Here are the standard options specific to mailru (Mail.ru Cloud).</p> 12976 <h4 id="mailru-user">–mailru-user</h4> 12977 <p>User name (usually email)</p> 12978 <ul> 12979 <li>Config: user</li> 12980 <li>Env Var: RCLONE_MAILRU_USER</li> 12981 <li>Type: string</li> 12982 <li>Default: ""</li> 12983 </ul> 12984 <h4 id="mailru-pass">–mailru-pass</h4> 12985 <p>Password</p> 12986 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 12987 <ul> 12988 <li>Config: pass</li> 12989 <li>Env Var: RCLONE_MAILRU_PASS</li> 12990 <li>Type: string</li> 12991 <li>Default: ""</li> 12992 </ul> 12993 <h4 id="mailru-speedup-enable">–mailru-speedup-enable</h4> 12994 <p>Skip full upload if there is another file with same data hash. This feature is called “speedup” or “put by hash”. 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. 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.</p> 12995 <ul> 12996 <li>Config: speedup_enable</li> 12997 <li>Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE</li> 12998 <li>Type: bool</li> 12999 <li>Default: true</li> 13000 <li>Examples: 13001 <ul> 13002 <li>“true” 13003 <ul> 13004 <li>Enable</li> 13005 </ul></li> 13006 <li>“false” 13007 <ul> 13008 <li>Disable</li> 13009 </ul></li> 13010 </ul></li> 13011 </ul> 13012 <h3 id="advanced-options-18">Advanced Options</h3> 13013 <p>Here are the advanced options specific to mailru (Mail.ru Cloud).</p> 13014 <h4 id="mailru-speedup-file-patterns">–mailru-speedup-file-patterns</h4> 13015 <p>Comma separated list of file name patterns eligible for speedup (put by hash). Patterns are case insensitive and can contain ’*’ or ‘?’ meta characters.</p> 13016 <ul> 13017 <li>Config: speedup_file_patterns</li> 13018 <li>Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS</li> 13019 <li>Type: string</li> 13020 <li>Default: “<em>.mkv,</em>.avi,<em>.mp4,</em>.mp3,<em>.zip,</em>.gz,<em>.rar,</em>.pdf”</li> 13021 <li>Examples: 13022 <ul> 13023 <li>"" 13024 <ul> 13025 <li>Empty list completely disables speedup (put by hash).</li> 13026 </ul></li> 13027 <li>"*" 13028 <ul> 13029 <li>All files will be attempted for speedup.</li> 13030 </ul></li> 13031 <li>“<em>.mkv,</em>.avi,<em>.mp4,</em>.mp3” 13032 <ul> 13033 <li>Only common audio/video files will be tried for put by hash.</li> 13034 </ul></li> 13035 <li>“<em>.zip,</em>.gz,<em>.rar,</em>.pdf” 13036 <ul> 13037 <li>Only common archives or PDF books will be tried for speedup.</li> 13038 </ul></li> 13039 </ul></li> 13040 </ul> 13041 <h4 id="mailru-speedup-max-disk">–mailru-speedup-max-disk</h4> 13042 <p>This option allows you to disable speedup (put by hash) for large files (because preliminary hashing can exhaust you RAM or disk space)</p> 13043 <ul> 13044 <li>Config: speedup_max_disk</li> 13045 <li>Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK</li> 13046 <li>Type: SizeSuffix</li> 13047 <li>Default: 3G</li> 13048 <li>Examples: 13049 <ul> 13050 <li>“0” 13051 <ul> 13052 <li>Completely disable speedup (put by hash).</li> 13053 </ul></li> 13054 <li>“1G” 13055 <ul> 13056 <li>Files larger than 1Gb will be uploaded directly.</li> 13057 </ul></li> 13058 <li>“3G” 13059 <ul> 13060 <li>Choose this option if you have less than 3Gb free on local disk.</li> 13061 </ul></li> 13062 </ul></li> 13063 </ul> 13064 <h4 id="mailru-speedup-max-memory">–mailru-speedup-max-memory</h4> 13065 <p>Files larger than the size given below will always be hashed on disk.</p> 13066 <ul> 13067 <li>Config: speedup_max_memory</li> 13068 <li>Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY</li> 13069 <li>Type: SizeSuffix</li> 13070 <li>Default: 32M</li> 13071 <li>Examples: 13072 <ul> 13073 <li>“0” 13074 <ul> 13075 <li>Preliminary hashing will always be done in a temporary disk location.</li> 13076 </ul></li> 13077 <li>“32M” 13078 <ul> 13079 <li>Do not dedicate more than 32Mb RAM for preliminary hashing.</li> 13080 </ul></li> 13081 <li>“256M” 13082 <ul> 13083 <li>You have at most 256Mb RAM free for hash calculations.</li> 13084 </ul></li> 13085 </ul></li> 13086 </ul> 13087 <h4 id="mailru-check-hash">–mailru-check-hash</h4> 13088 <p>What should copy do if file checksum is mismatched or invalid</p> 13089 <ul> 13090 <li>Config: check_hash</li> 13091 <li>Env Var: RCLONE_MAILRU_CHECK_HASH</li> 13092 <li>Type: bool</li> 13093 <li>Default: true</li> 13094 <li>Examples: 13095 <ul> 13096 <li>“true” 13097 <ul> 13098 <li>Fail with error.</li> 13099 </ul></li> 13100 <li>“false” 13101 <ul> 13102 <li>Ignore and continue.</li> 13103 </ul></li> 13104 </ul></li> 13105 </ul> 13106 <h4 id="mailru-user-agent">–mailru-user-agent</h4> 13107 <p>HTTP user agent used internally by client. Defaults to “rclone/VERSION” or “–user-agent” provided on command line.</p> 13108 <ul> 13109 <li>Config: user_agent</li> 13110 <li>Env Var: RCLONE_MAILRU_USER_AGENT</li> 13111 <li>Type: string</li> 13112 <li>Default: ""</li> 13113 </ul> 13114 <h4 id="mailru-quirks">–mailru-quirks</h4> 13115 <p>Comma separated list of internal maintenance flags. 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 gzip insecure retry400</p> 13116 <ul> 13117 <li>Config: quirks</li> 13118 <li>Env Var: RCLONE_MAILRU_QUIRKS</li> 13119 <li>Type: string</li> 13120 <li>Default: ""</li> 13121 </ul> 13122 <h4 id="mailru-encoding">–mailru-encoding</h4> 13123 <p>This sets the encoding for the backend.</p> 13124 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 13125 <ul> 13126 <li>Config: encoding</li> 13127 <li>Env Var: RCLONE_MAILRU_ENCODING</li> 13128 <li>Type: MultiEncoder</li> 13129 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 13130 </ul> 13131 <h2 id="mega">Mega</h2> 13132 <p><a href="https://mega.nz/">Mega</a> 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.</p> 13133 <p>This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption.</p> 13134 <p>Paths are specified as <code>remote:path</code></p> 13135 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 13136 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 13137 <pre><code> rclone config</code></pre> 13138 <p>This will guide you through an interactive setup process:</p> 13139 <pre><code>No remotes found - make a new one 13140 n) New remote 13141 s) Set configuration password 13142 q) Quit config 13143 n/s/q> n 13144 name> remote 13145 Type of storage to configure. 13146 Choose a number from below, or type in your own value 13147 [snip] 13148 XX / Mega 13149 \ "mega" 13150 [snip] 13151 Storage> mega 13152 User name 13153 user> you@example.com 13154 Password. 13155 y) Yes type in my own password 13156 g) Generate random password 13157 n) No leave this optional password blank 13158 y/g/n> y 13159 Enter the password: 13160 password: 13161 Confirm the password: 13162 password: 13163 Remote config 13164 -------------------- 13165 [remote] 13166 type = mega 13167 user = you@example.com 13168 pass = *** ENCRYPTED *** 13169 -------------------- 13170 y) Yes this is OK 13171 e) Edit this remote 13172 d) Delete this remote 13173 y/e/d> y</code></pre> 13174 <p><strong>NOTE:</strong> The encryption keys need to have been already generated after a regular login via the browser, otherwise attempting to use the credentials in <code>rclone</code> will fail.</p> 13175 <p>Once configured you can then use <code>rclone</code> like this,</p> 13176 <p>List directories in top level of your Mega</p> 13177 <pre><code>rclone lsd remote:</code></pre> 13178 <p>List all the files in your Mega</p> 13179 <pre><code>rclone ls remote:</code></pre> 13180 <p>To copy a local directory to an Mega directory called backup</p> 13181 <pre><code>rclone copy /home/source remote:backup</code></pre> 13182 <h3 id="modified-time-and-hashes-6">Modified time and hashes</h3> 13183 <p>Mega does not support modification times or hashes yet.</p> 13184 <h4 id="restricted-filename-characters-13">Restricted filename characters</h4> 13185 <table> 13186 <thead> 13187 <tr class="header"> 13188 <th>Character</th> 13189 <th style="text-align: center;">Value</th> 13190 <th style="text-align: center;">Replacement</th> 13191 </tr> 13192 </thead> 13193 <tbody> 13194 <tr class="odd"> 13195 <td>NUL</td> 13196 <td style="text-align: center;">0x00</td> 13197 <td style="text-align: center;">␀</td> 13198 </tr> 13199 <tr class="even"> 13200 <td>/</td> 13201 <td style="text-align: center;">0x2F</td> 13202 <td style="text-align: center;">／</td> 13203 </tr> 13204 </tbody> 13205 </table> 13206 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 13207 <h3 id="duplicated-files-2">Duplicated files</h3> 13208 <p>Mega can have two files with exactly the same name and path (unlike a normal file system).</p> 13209 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 13210 <p>Use <code>rclone dedupe</code> to fix duplicated files.</p> 13211 <h3 id="failure-to-log-in">Failure to log-in</h3> 13212 <p>Mega remotes seem to get blocked (reject logins) under “heavy use”. We haven’t worked out the exact blocking rules but it seems to be related to fast paced, successive rclone commands.</p> 13213 <p>For example, executing this command 90 times in a row <code>rclone link remote:file</code> will cause the remote to become “blocked”. 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.</p> 13214 <p>You can mitigate this issue by mounting the remote it with <code>rclone mount</code>. This will log-in when mounting and a log-out when unmounting only. You can also run <code>rclone rcd</code> and then use <code>rclone rc</code> to run the commands over the API to avoid logging in each time.</p> 13215 <p>Rclone does not currently close mega sessions (you can see them in the web interface), however closing the sessions does not solve the issue.</p> 13216 <p>If you space rclone commands by 3 seconds it will avoid blocking the remote. We haven’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…</p> 13217 <p>Note that this has been observed by trial and error and might not be set in stone.</p> 13218 <p>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’t compatible with the current stateless rclone approach.</p> 13219 <p>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.</p> 13220 <p>Investigation is continuing in relation to workarounds based on timeouts, pacers, retrials and tpslimits - if you discover something relevant, please post on the forum.</p> 13221 <p>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.</p> 13222 <h3 id="standard-options-19">Standard Options</h3> 13223 <p>Here are the standard options specific to mega (Mega).</p> 13224 <h4 id="mega-user">–mega-user</h4> 13225 <p>User name</p> 13226 <ul> 13227 <li>Config: user</li> 13228 <li>Env Var: RCLONE_MEGA_USER</li> 13229 <li>Type: string</li> 13230 <li>Default: ""</li> 13231 </ul> 13232 <h4 id="mega-pass">–mega-pass</h4> 13233 <p>Password.</p> 13234 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 13235 <ul> 13236 <li>Config: pass</li> 13237 <li>Env Var: RCLONE_MEGA_PASS</li> 13238 <li>Type: string</li> 13239 <li>Default: ""</li> 13240 </ul> 13241 <h3 id="advanced-options-19">Advanced Options</h3> 13242 <p>Here are the advanced options specific to mega (Mega).</p> 13243 <h4 id="mega-debug">–mega-debug</h4> 13244 <p>Output more debug from Mega.</p> 13245 <p>If this flag is set (along with -vv) it will print further debugging information from the mega backend.</p> 13246 <ul> 13247 <li>Config: debug</li> 13248 <li>Env Var: RCLONE_MEGA_DEBUG</li> 13249 <li>Type: bool</li> 13250 <li>Default: false</li> 13251 </ul> 13252 <h4 id="mega-hard-delete">–mega-hard-delete</h4> 13253 <p>Delete files permanently rather than putting them into the trash.</p> 13254 <p>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.</p> 13255 <ul> 13256 <li>Config: hard_delete</li> 13257 <li>Env Var: RCLONE_MEGA_HARD_DELETE</li> 13258 <li>Type: bool</li> 13259 <li>Default: false</li> 13260 </ul> 13261 <h4 id="mega-encoding">–mega-encoding</h4> 13262 <p>This sets the encoding for the backend.</p> 13263 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 13264 <ul> 13265 <li>Config: encoding</li> 13266 <li>Env Var: RCLONE_MEGA_ENCODING</li> 13267 <li>Type: MultiEncoder</li> 13268 <li>Default: Slash,InvalidUtf8,Dot</li> 13269 </ul> 13270 <h3 id="limitations-13">Limitations</h3> 13271 <p>This backend uses the <a href="https://github.com/t3rm1n4l/go-mega">go-mega go library</a> which is an opensource go library implementing the Mega API. There doesn’t appear to be any documentation for the mega protocol beyond the <a href="https://github.com/meganz/sdk">mega C++ SDK</a> source code so there are likely quite a few errors still remaining in this library.</p> 13272 <p>Mega allows duplicate files which may confuse rclone.</p> 13273 <h2 id="memory">Memory</h2> 13274 <p>The memory backend is an in RAM backend. It does not persist its data - use the local backend for that.</p> 13275 <p>The memory backend behaves like a bucket based remote (eg like s3). Because it has no parameters you can just use it with the <code>:memory:</code> remote name.</p> 13276 <p>You can configure it as a remote like this with <code>rclone config</code> too if you want to:</p> 13277 <pre><code>No remotes found - make a new one 13278 n) New remote 13279 s) Set configuration password 13280 q) Quit config 13281 n/s/q> n 13282 name> remote 13283 Type of storage to configure. 13284 Enter a string value. Press Enter for the default (""). 13285 Choose a number from below, or type in your own value 13286 [snip] 13287 XX / Memory 13288 \ "memory" 13289 [snip] 13290 Storage> memory 13291 ** See help for memory backend at: https://rclone.org/memory/ ** 13292 13293 Remote config 13294 13295 -------------------- 13296 [remote] 13297 type = memory 13298 -------------------- 13299 y) Yes this is OK (default) 13300 e) Edit this remote 13301 d) Delete this remote 13302 y/e/d> y</code></pre> 13303 <p>Because the memory backend isn’t persistent it is most useful for testing or with an rclone server or rclone mount, eg</p> 13304 <pre><code>rclone mount :memory: /mnt/tmp 13305 rclone serve webdav :memory: 13306 rclone serve sftp :memory:</code></pre> 13307 <h3 id="modified-time-and-hashes-7">Modified time and hashes</h3> 13308 <p>The memory backend supports MD5 hashes and modification times accurate to 1 nS.</p> 13309 <h4 id="restricted-filename-characters-14">Restricted filename characters</h4> 13310 <p>The memory backend replaces the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a>.</p> 13311 <h2 id="microsoft-azure-blob-storage">Microsoft Azure Blob Storage</h2> 13312 <p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p> 13313 <p>Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called <code>remote</code>. First run:</p> 13314 <pre><code> rclone config</code></pre> 13315 <p>This will guide you through an interactive setup process:</p> 13316 <pre><code>No remotes found - make a new one 13317 n) New remote 13318 s) Set configuration password 13319 q) Quit config 13320 n/s/q> n 13321 name> remote 13322 Type of storage to configure. 13323 Choose a number from below, or type in your own value 13324 [snip] 13325 XX / Microsoft Azure Blob Storage 13326 \ "azureblob" 13327 [snip] 13328 Storage> azureblob 13329 Storage Account Name 13330 account> account_name 13331 Storage Account Key 13332 key> base64encodedkey== 13333 Endpoint for the service - leave blank normally. 13334 endpoint> 13335 Remote config 13336 -------------------- 13337 [remote] 13338 account = account_name 13339 key = base64encodedkey== 13340 endpoint = 13341 -------------------- 13342 y) Yes this is OK 13343 e) Edit this remote 13344 d) Delete this remote 13345 y/e/d> y</code></pre> 13346 <p>See all containers</p> 13347 <pre><code>rclone lsd remote:</code></pre> 13348 <p>Make a new container</p> 13349 <pre><code>rclone mkdir remote:container</code></pre> 13350 <p>List the contents of a container</p> 13351 <pre><code>rclone ls remote:container</code></pre> 13352 <p>Sync <code>/home/local/directory</code> to the remote container, deleting any excess files in the container.</p> 13353 <pre><code>rclone sync /home/local/directory remote:container</code></pre> 13354 <h3 id="fast-list-7">–fast-list</h3> 13355 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 13356 <h3 id="modified-time-10">Modified time</h3> 13357 <p>The modified time is stored as metadata on the object with the <code>mtime</code> key. It is stored using RFC3339 Format time with nanosecond precision. The metadata is supplied during directory listings so there is no overhead to using it.</p> 13358 <h3 id="restricted-filename-characters-15">Restricted filename characters</h3> 13359 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 13360 <table> 13361 <thead> 13362 <tr class="header"> 13363 <th>Character</th> 13364 <th style="text-align: center;">Value</th> 13365 <th style="text-align: center;">Replacement</th> 13366 </tr> 13367 </thead> 13368 <tbody> 13369 <tr class="odd"> 13370 <td>/</td> 13371 <td style="text-align: center;">0x2F</td> 13372 <td style="text-align: center;">／</td> 13373 </tr> 13374 <tr class="even"> 13375 <td>\</td> 13376 <td style="text-align: center;">0x5C</td> 13377 <td style="text-align: center;">＼</td> 13378 </tr> 13379 </tbody> 13380 </table> 13381 <p>File names can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 13382 <table> 13383 <thead> 13384 <tr class="header"> 13385 <th>Character</th> 13386 <th style="text-align: center;">Value</th> 13387 <th style="text-align: center;">Replacement</th> 13388 </tr> 13389 </thead> 13390 <tbody> 13391 <tr class="odd"> 13392 <td>.</td> 13393 <td style="text-align: center;">0x2E</td> 13394 <td style="text-align: center;">．</td> 13395 </tr> 13396 </tbody> 13397 </table> 13398 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 13399 <h3 id="hashes">Hashes</h3> 13400 <p>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, eg the local disk.</p> 13401 <h3 id="authenticating-with-azure-blob-storage">Authenticating with Azure Blob Storage</h3> 13402 <p>Rclone has 3 ways of authenticating with Azure Blob Storage:</p> 13403 <h4 id="account-and-key">Account and Key</h4> 13404 <p>This is the most straight forward and least flexible way. Just fill in the <code>account</code> and <code>key</code> lines and leave the rest blank.</p> 13405 <h4 id="sas-url">SAS URL</h4> 13406 <p>This can be an account level SAS URL or container level SAS URL.</p> 13407 <p>To use it leave <code>account</code>, <code>key</code> blank and fill in <code>sas_url</code>.</p> 13408 <p>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.</p> 13409 <p>If you use a container level SAS URL, rclone operations are permitted only on a particular container, eg</p> 13410 <pre><code>rclone ls azureblob:container</code></pre> 13411 <p>You can also list the single container from the root. This will only show the container specified by the SAS URL.</p> 13412 <pre><code>$ rclone lsd azureblob: 13413 container/</code></pre> 13414 <p>Note that you can’t see or access any other containers - this will fail</p> 13415 <pre><code>rclone ls azureblob:othercontainer</code></pre> 13416 <p>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.</p> 13417 <h3 id="multipart-uploads-1">Multipart uploads</h3> 13418 <p>Rclone supports multipart uploads with Azure Blob storage. Files bigger than 256MB will be uploaded using chunked upload by default.</p> 13419 <p>The files will be uploaded in parallel in 4MB chunks (by default). Note that these chunks are buffered in memory and there may be up to <code>--transfers</code> of them being uploaded at once.</p> 13420 <p>Files can’t be split into more than 50,000 chunks so by default, so the largest file that can be uploaded with 4MB chunk size is 195GB. Above this rclone will double the chunk size until it creates less than 50,000 chunks. By default this will mean a maximum file size of 3.2TB can be uploaded. This can be raised to 5TB using <code>--azureblob-chunk-size 100M</code>.</p> 13421 <p>Note that rclone doesn’t commit the block list until the end of the upload which means that there is a limit of 9.5TB of multipart uploads in progress as Azure won’t allow more than that amount of uncommitted blocks.</p> 13422 <h3 id="standard-options-20">Standard Options</h3> 13423 <p>Here are the standard options specific to azureblob (Microsoft Azure Blob Storage).</p> 13424 <h4 id="azureblob-account">–azureblob-account</h4> 13425 <p>Storage Account Name (leave blank to use SAS URL or Emulator)</p> 13426 <ul> 13427 <li>Config: account</li> 13428 <li>Env Var: RCLONE_AZUREBLOB_ACCOUNT</li> 13429 <li>Type: string</li> 13430 <li>Default: ""</li> 13431 </ul> 13432 <h4 id="azureblob-key">–azureblob-key</h4> 13433 <p>Storage Account Key (leave blank to use SAS URL or Emulator)</p> 13434 <ul> 13435 <li>Config: key</li> 13436 <li>Env Var: RCLONE_AZUREBLOB_KEY</li> 13437 <li>Type: string</li> 13438 <li>Default: ""</li> 13439 </ul> 13440 <h4 id="azureblob-sas-url">–azureblob-sas-url</h4> 13441 <p>SAS URL for container level access only (leave blank if using account/key or Emulator)</p> 13442 <ul> 13443 <li>Config: sas_url</li> 13444 <li>Env Var: RCLONE_AZUREBLOB_SAS_URL</li> 13445 <li>Type: string</li> 13446 <li>Default: ""</li> 13447 </ul> 13448 <h4 id="azureblob-use-emulator">–azureblob-use-emulator</h4> 13449 <p>Uses local storage emulator if provided as ‘true’ (leave blank if using real azure storage endpoint)</p> 13450 <ul> 13451 <li>Config: use_emulator</li> 13452 <li>Env Var: RCLONE_AZUREBLOB_USE_EMULATOR</li> 13453 <li>Type: bool</li> 13454 <li>Default: false</li> 13455 </ul> 13456 <h3 id="advanced-options-20">Advanced Options</h3> 13457 <p>Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage).</p> 13458 <h4 id="azureblob-endpoint">–azureblob-endpoint</h4> 13459 <p>Endpoint for the service Leave blank normally.</p> 13460 <ul> 13461 <li>Config: endpoint</li> 13462 <li>Env Var: RCLONE_AZUREBLOB_ENDPOINT</li> 13463 <li>Type: string</li> 13464 <li>Default: ""</li> 13465 </ul> 13466 <h4 id="azureblob-upload-cutoff">–azureblob-upload-cutoff</h4> 13467 <p>Cutoff for switching to chunked upload (<= 256MB).</p> 13468 <ul> 13469 <li>Config: upload_cutoff</li> 13470 <li>Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF</li> 13471 <li>Type: SizeSuffix</li> 13472 <li>Default: 256M</li> 13473 </ul> 13474 <h4 id="azureblob-chunk-size">–azureblob-chunk-size</h4> 13475 <p>Upload chunk size (<= 100MB).</p> 13476 <p>Note that this is stored in memory and there may be up to “–transfers” chunks stored at once in memory.</p> 13477 <ul> 13478 <li>Config: chunk_size</li> 13479 <li>Env Var: RCLONE_AZUREBLOB_CHUNK_SIZE</li> 13480 <li>Type: SizeSuffix</li> 13481 <li>Default: 4M</li> 13482 </ul> 13483 <h4 id="azureblob-list-chunk">–azureblob-list-chunk</h4> 13484 <p>Size of blob list.</p> 13485 <p>This sets the number of blobs requested in each listing chunk. Default is the maximum, 5000. “List blobs” 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 ( <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval">source</a> ). This can be used to limit the number of blobs items to return, to avoid the time out.</p> 13486 <ul> 13487 <li>Config: list_chunk</li> 13488 <li>Env Var: RCLONE_AZUREBLOB_LIST_CHUNK</li> 13489 <li>Type: int</li> 13490 <li>Default: 5000</li> 13491 </ul> 13492 <h4 id="azureblob-access-tier">–azureblob-access-tier</h4> 13493 <p>Access tier of blob: hot, cool or archive.</p> 13494 <p>Archived blobs can be restored by setting access tier to hot or cool. Leave blank if you intend to use default access tier, which is set at account level</p> 13495 <p>If there is no “access tier” specified, rclone doesn’t apply any tier. rclone performs “Set Tier” operation on blobs while uploading, if objects are not modified, specifying “access tier” to new one will have no effect. If blobs are in “archive tier” at remote, trying to perform data transfer operations from remote will not be allowed. User should first restore by tiering blob to “Hot” or “Cool”.</p> 13496 <ul> 13497 <li>Config: access_tier</li> 13498 <li>Env Var: RCLONE_AZUREBLOB_ACCESS_TIER</li> 13499 <li>Type: string</li> 13500 <li>Default: ""</li> 13501 </ul> 13502 <h4 id="azureblob-disable-checksum">–azureblob-disable-checksum</h4> 13503 <p>Don’t store MD5 checksum with object metadata.</p> 13504 <p>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.</p> 13505 <ul> 13506 <li>Config: disable_checksum</li> 13507 <li>Env Var: RCLONE_AZUREBLOB_DISABLE_CHECKSUM</li> 13508 <li>Type: bool</li> 13509 <li>Default: false</li> 13510 </ul> 13511 <h4 id="azureblob-memory-pool-flush-time">–azureblob-memory-pool-flush-time</h4> 13512 <p>How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.</p> 13513 <ul> 13514 <li>Config: memory_pool_flush_time</li> 13515 <li>Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME</li> 13516 <li>Type: Duration</li> 13517 <li>Default: 1m0s</li> 13518 </ul> 13519 <h4 id="azureblob-memory-pool-use-mmap">–azureblob-memory-pool-use-mmap</h4> 13520 <p>Whether to use mmap buffers in internal memory pool.</p> 13521 <ul> 13522 <li>Config: memory_pool_use_mmap</li> 13523 <li>Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP</li> 13524 <li>Type: bool</li> 13525 <li>Default: false</li> 13526 </ul> 13527 <h4 id="azureblob-encoding">–azureblob-encoding</h4> 13528 <p>This sets the encoding for the backend.</p> 13529 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 13530 <ul> 13531 <li>Config: encoding</li> 13532 <li>Env Var: RCLONE_AZUREBLOB_ENCODING</li> 13533 <li>Type: MultiEncoder</li> 13534 <li>Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8</li> 13535 </ul> 13536 <h3 id="limitations-14">Limitations</h3> 13537 <p>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.</p> 13538 <h3 id="azure-storage-emulator-support">Azure Storage Emulator Support</h3> 13539 <p>You can test rclone with storage emulator locally, to do this make sure azure storage emulator installed locally and set up a new remote with <code>rclone config</code> follow instructions described in introduction, set <code>use_emulator</code> config as <code>true</code>, you do not need to provide default account name or key if using emulator.</p> 13540 <h2 id="microsoft-onedrive">Microsoft OneDrive</h2> 13541 <p>Paths are specified as <code>remote:path</code></p> 13542 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 13543 <p>The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 13544 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 13545 <pre><code> rclone config</code></pre> 13546 <p>This will guide you through an interactive setup process:</p> 13547 <pre><code>e) Edit existing remote 13548 n) New remote 13549 d) Delete remote 13550 r) Rename remote 13551 c) Copy remote 13552 s) Set configuration password 13553 q) Quit config 13554 e/n/d/r/c/s/q> n 13555 name> remote 13556 Type of storage to configure. 13557 Enter a string value. Press Enter for the default (""). 13558 Choose a number from below, or type in your own value 13559 [snip] 13560 XX / Microsoft OneDrive 13561 \ "onedrive" 13562 [snip] 13563 Storage> onedrive 13564 Microsoft App Client Id 13565 Leave blank normally. 13566 Enter a string value. Press Enter for the default (""). 13567 client_id> 13568 Microsoft App Client Secret 13569 Leave blank normally. 13570 Enter a string value. Press Enter for the default (""). 13571 client_secret> 13572 Edit advanced config? (y/n) 13573 y) Yes 13574 n) No 13575 y/n> n 13576 Remote config 13577 Use auto config? 13578 * Say Y if not sure 13579 * Say N if you are working on a remote or headless machine 13580 y) Yes 13581 n) No 13582 y/n> y 13583 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 13584 Log in and authorize rclone for access 13585 Waiting for code... 13586 Got code 13587 Choose a number from below, or type in an existing value 13588 1 / OneDrive Personal or Business 13589 \ "onedrive" 13590 2 / Sharepoint site 13591 \ "sharepoint" 13592 3 / Type in driveID 13593 \ "driveid" 13594 4 / Type in SiteID 13595 \ "siteid" 13596 5 / Search a Sharepoint site 13597 \ "search" 13598 Your choice> 1 13599 Found 1 drives, please select the one you want to use: 13600 0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk 13601 Chose drive to use:> 0 13602 Found drive 'root' of type 'business', URL: https://org-my.sharepoint.com/personal/you/Documents 13603 Is that okay? 13604 y) Yes 13605 n) No 13606 y/n> y 13607 -------------------- 13608 [remote] 13609 type = onedrive 13610 token = {"access_token":"youraccesstoken","token_type":"Bearer","refresh_token":"yourrefreshtoken","expiry":"2018-08-26T22:39:52.486512262+08:00"} 13611 drive_id = b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk 13612 drive_type = business 13613 -------------------- 13614 y) Yes this is OK 13615 e) Edit this remote 13616 d) Delete this remote 13617 y/e/d> y</code></pre> 13618 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 13619 <p>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 <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 13620 <p>Once configured you can then use <code>rclone</code> like this,</p> 13621 <p>List directories in top level of your OneDrive</p> 13622 <pre><code>rclone lsd remote:</code></pre> 13623 <p>List all the files in your OneDrive</p> 13624 <pre><code>rclone ls remote:</code></pre> 13625 <p>To copy a local directory to an OneDrive directory called backup</p> 13626 <pre><code>rclone copy /home/source remote:backup</code></pre> 13627 <h3 id="getting-your-own-client-id-and-key">Getting your own Client ID and Key</h3> 13628 <p>You can use your own Client ID if the default (<code>client_id</code> left blank) one doesn’t work for you or you see lots of throttling. The default Client ID and Key is shared by all rclone users when performing requests.</p> 13629 <p>If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below:</p> 13630 <ol type="1"> 13631 <li>Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, then click <code>New registration</code>.</li> 13632 <li>Enter a name for your app, choose account type <code>Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)</code>, select <code>Web</code> in <code>Redirect URI</code> Enter <code>http://localhost:53682/</code> and click Register. Copy and keep the <code>Application (client) ID</code> under the app name for later use.</li> 13633 <li>Under <code>manage</code> select <code>Certificates & secrets</code>, click <code>New client secret</code>. Copy and keep that secret for later use.</li> 13634 <li>Under <code>manage</code> select <code>API permissions</code>, click <code>Add a permission</code> and select <code>Microsoft Graph</code> then select <code>delegated permissions</code>.</li> 13635 <li>Search and select the following permissions: <code>Files.Read</code>, <code>Files.ReadWrite</code>, <code>Files.Read.All</code>, <code>Files.ReadWrite.All</code>, <code>offline_access</code>, <code>User.Read</code>. Once selected click <code>Add permissions</code> at the bottom.</li> 13636 </ol> 13637 <p>Now the application is complete. Run <code>rclone config</code> 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.</p> 13638 <h3 id="modification-time-and-hashes">Modification time and hashes</h3> 13639 <p>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.</p> 13640 <p>OneDrive personal supports SHA1 type hashes. OneDrive for business and Sharepoint Server support <a href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p> 13641 <p>For all types of OneDrive you can use the <code>--checksum</code> flag.</p> 13642 <h3 id="restricted-filename-characters-16">Restricted filename characters</h3> 13643 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 13644 <table> 13645 <thead> 13646 <tr class="header"> 13647 <th>Character</th> 13648 <th style="text-align: center;">Value</th> 13649 <th style="text-align: center;">Replacement</th> 13650 </tr> 13651 </thead> 13652 <tbody> 13653 <tr class="odd"> 13654 <td>"</td> 13655 <td style="text-align: center;">0x22</td> 13656 <td style="text-align: center;">＂</td> 13657 </tr> 13658 <tr class="even"> 13659 <td>*</td> 13660 <td style="text-align: center;">0x2A</td> 13661 <td style="text-align: center;">＊</td> 13662 </tr> 13663 <tr class="odd"> 13664 <td>:</td> 13665 <td style="text-align: center;">0x3A</td> 13666 <td style="text-align: center;">：</td> 13667 </tr> 13668 <tr class="even"> 13669 <td><</td> 13670 <td style="text-align: center;">0x3C</td> 13671 <td style="text-align: center;">＜</td> 13672 </tr> 13673 <tr class="odd"> 13674 <td>></td> 13675 <td style="text-align: center;">0x3E</td> 13676 <td style="text-align: center;">＞</td> 13677 </tr> 13678 <tr class="even"> 13679 <td>?</td> 13680 <td style="text-align: center;">0x3F</td> 13681 <td style="text-align: center;">？</td> 13682 </tr> 13683 <tr class="odd"> 13684 <td>\</td> 13685 <td style="text-align: center;">0x5C</td> 13686 <td style="text-align: center;">＼</td> 13687 </tr> 13688 <tr class="even"> 13689 <td>|</td> 13690 <td style="text-align: center;">0x7C</td> 13691 <td style="text-align: center;">｜</td> 13692 </tr> 13693 <tr class="odd"> 13694 <td>#</td> 13695 <td style="text-align: center;">0x23</td> 13696 <td style="text-align: center;">＃</td> 13697 </tr> 13698 <tr class="even"> 13699 <td>%</td> 13700 <td style="text-align: center;">0x25</td> 13701 <td style="text-align: center;">％</td> 13702 </tr> 13703 </tbody> 13704 </table> 13705 <p>File names can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 13706 <table> 13707 <thead> 13708 <tr class="header"> 13709 <th>Character</th> 13710 <th style="text-align: center;">Value</th> 13711 <th style="text-align: center;">Replacement</th> 13712 </tr> 13713 </thead> 13714 <tbody> 13715 <tr class="odd"> 13716 <td>SP</td> 13717 <td style="text-align: center;">0x20</td> 13718 <td style="text-align: center;">␠</td> 13719 </tr> 13720 <tr class="even"> 13721 <td>.</td> 13722 <td style="text-align: center;">0x2E</td> 13723 <td style="text-align: center;">．</td> 13724 </tr> 13725 </tbody> 13726 </table> 13727 <p>File names can also not begin with the following characters. These only get replaced if they are the first character in the name:</p> 13728 <table> 13729 <thead> 13730 <tr class="header"> 13731 <th>Character</th> 13732 <th style="text-align: center;">Value</th> 13733 <th style="text-align: center;">Replacement</th> 13734 </tr> 13735 </thead> 13736 <tbody> 13737 <tr class="odd"> 13738 <td>SP</td> 13739 <td style="text-align: center;">0x20</td> 13740 <td style="text-align: center;">␠</td> 13741 </tr> 13742 <tr class="even"> 13743 <td>~</td> 13744 <td style="text-align: center;">0x7E</td> 13745 <td style="text-align: center;">～</td> 13746 </tr> 13747 </tbody> 13748 </table> 13749 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 13750 <h3 id="deleting-files-5">Deleting files</h3> 13751 <p>Any files you delete with rclone will end up in the trash. Microsoft doesn’t provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft’s apps or via the OneDrive website.</p> 13752 <h3 id="standard-options-21">Standard Options</h3> 13753 <p>Here are the standard options specific to onedrive (Microsoft OneDrive).</p> 13754 <h4 id="onedrive-client-id">–onedrive-client-id</h4> 13755 <p>Microsoft App Client Id Leave blank normally.</p> 13756 <ul> 13757 <li>Config: client_id</li> 13758 <li>Env Var: RCLONE_ONEDRIVE_CLIENT_ID</li> 13759 <li>Type: string</li> 13760 <li>Default: ""</li> 13761 </ul> 13762 <h4 id="onedrive-client-secret">–onedrive-client-secret</h4> 13763 <p>Microsoft App Client Secret Leave blank normally.</p> 13764 <ul> 13765 <li>Config: client_secret</li> 13766 <li>Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET</li> 13767 <li>Type: string</li> 13768 <li>Default: ""</li> 13769 </ul> 13770 <h3 id="advanced-options-21">Advanced Options</h3> 13771 <p>Here are the advanced options specific to onedrive (Microsoft OneDrive).</p> 13772 <h4 id="onedrive-chunk-size">–onedrive-chunk-size</h4> 13773 <p>Chunk size to upload files with - must be multiple of 320k (327,680 bytes).</p> 13774 <p>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 "Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big." Note that the chunks will be buffered into memory.</p> 13775 <ul> 13776 <li>Config: chunk_size</li> 13777 <li>Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE</li> 13778 <li>Type: SizeSuffix</li> 13779 <li>Default: 10M</li> 13780 </ul> 13781 <h4 id="onedrive-drive-id">–onedrive-drive-id</h4> 13782 <p>The ID of the drive to use</p> 13783 <ul> 13784 <li>Config: drive_id</li> 13785 <li>Env Var: RCLONE_ONEDRIVE_DRIVE_ID</li> 13786 <li>Type: string</li> 13787 <li>Default: ""</li> 13788 </ul> 13789 <h4 id="onedrive-drive-type">–onedrive-drive-type</h4> 13790 <p>The type of the drive ( personal | business | documentLibrary )</p> 13791 <ul> 13792 <li>Config: drive_type</li> 13793 <li>Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE</li> 13794 <li>Type: string</li> 13795 <li>Default: ""</li> 13796 </ul> 13797 <h4 id="onedrive-expose-onenote-files">–onedrive-expose-onenote-files</h4> 13798 <p>Set to make OneNote files show up in directory listings.</p> 13799 <p>By default rclone will hide OneNote files in directory listings because operations like “Open” and “Update” won’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.</p> 13800 <ul> 13801 <li>Config: expose_onenote_files</li> 13802 <li>Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES</li> 13803 <li>Type: bool</li> 13804 <li>Default: false</li> 13805 </ul> 13806 <h4 id="onedrive-server-side-across-configs">–onedrive-server-side-across-configs</h4> 13807 <p>Allow server side operations (eg copy) to work across different onedrive configs.</p> 13808 <p>This can be useful if you wish to do a server side copy between two different Onedrives. Note that this isn’t enabled by default because it isn’t easy to tell if it will work between any two configurations.</p> 13809 <ul> 13810 <li>Config: server_side_across_configs</li> 13811 <li>Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS</li> 13812 <li>Type: bool</li> 13813 <li>Default: false</li> 13814 </ul> 13815 <h4 id="onedrive-encoding">–onedrive-encoding</h4> 13816 <p>This sets the encoding for the backend.</p> 13817 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 13818 <ul> 13819 <li>Config: encoding</li> 13820 <li>Env Var: RCLONE_ONEDRIVE_ENCODING</li> 13821 <li>Type: MultiEncoder</li> 13822 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot</li> 13823 </ul> 13824 <h3 id="limitations-15">Limitations</h3> 13825 <h4 id="naming">Naming</h4> 13826 <p>Note that OneDrive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 13827 <p>There are quite a few characters that can’t be in OneDrive file names. These can’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 <code>?</code> in it will be mapped to <code>？</code> instead.</p> 13828 <h4 id="file-sizes">File sizes</h4> 13829 <p>The largest allowed file sizes are 15GB for OneDrive for Business and 100GB for OneDrive Personal (Updated 19 May 2020). Source: https://support.office.com/en-us/article/upload-photos-and-files-to-onedrive-b00ad3fe-6643-4b16-9212-de00ef02b586</p> 13830 <h4 id="path-length">Path length</h4> 13831 <p>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.</p> 13832 <h4 id="number-of-files">Number of files</h4> 13833 <p>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 <code>couldn’t list files: UnknownError:</code>. See <a href="https://github.com/rclone/rclone/issues/2707">#2707</a> for more info.</p> 13834 <p>An official document about the limitations for different types of OneDrive can be found <a href="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">here</a>.</p> 13835 <h3 id="versioning-issue">Versioning issue</h3> 13836 <p>Every change in OneDrive causes the service to create a new version. This counts against a users quota. For example changing the modification time of a file creates a second version, so the file is using twice the space.</p> 13837 <p>The <code>copy</code> is the only rclone command affected by this as we copy the file and then afterwards set the modification time to match the source file.</p> 13838 <p><strong>Note</strong>: Starting October 2018, users will no longer be able to disable versioning by default. This is because Microsoft has brought an <a href="https://techcommunity.microsoft.com/t5/Microsoft-OneDrive-Blog/New-Updates-to-OneDrive-and-SharePoint-Team-Site-Versioning/ba-p/204390">update</a> 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:</p> 13839 <ol type="1"> 13840 <li><code>Install-Module -Name Microsoft.Online.SharePoint.PowerShell</code> (in case you haven’t installed this already)</li> 13841 <li><code>Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking</code></li> 13842 <li><code>Connect-SPOService -Url https://YOURSITE-admin.sharepoint.com -Credential YOU@YOURSITE.COM</code> (replacing <code>YOURSITE</code>, <code>YOU</code>, <code>YOURSITE.COM</code> with the actual values; this will prompt for your credentials)</li> 13843 <li><code>Set-SPOTenant -EnableMinimumVersionRequirement $False</code></li> 13844 <li><code>Disconnect-SPOService</code> (to disconnect from the server)</li> 13845 </ol> 13846 <p><em>Below are the steps for normal users to disable versioning. If you don’t see the “No Versioning” option, make sure the above requirements are met.</em></p> 13847 <p>User <a href="https://github.com/Weropol">Weropol</a> has found a method to disable versioning on OneDrive</p> 13848 <ol type="1"> 13849 <li>Open the settings menu by clicking on the gear symbol at the top of the OneDrive Business page.</li> 13850 <li>Click Site settings.</li> 13851 <li>Once on the Site settings page, navigate to Site Administration > Site libraries and lists.</li> 13852 <li>Click Customize “Documents”.</li> 13853 <li>Click General Settings > Versioning Settings.</li> 13854 <li>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.</li> 13855 <li>Apply the changes by clicking OK.</li> 13856 <li>Use rclone to upload or modify files. (I also use the –no-update-modtime flag)</li> 13857 <li>Restore the versioning settings after using rclone. (Optional)</li> 13858 </ol> 13859 <h3 id="troubleshooting-1">Troubleshooting</h3> 13860 <h4 id="unexpected-file-sizehash-differences-on-sharepoint">Unexpected file size/hash differences on Sharepoint</h4> 13861 <p>It is a <a href="https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631">known</a> 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. To use rclone with such affected files on Sharepoint, you may disable these checks with the following command line arguments:</p> 13862 <pre><code>--ignore-checksum --ignore-size</code></pre> 13863 <h4 id="replacingdeleting-existing-files-on-sharepoint-gets-item-not-found">Replacing/deleting existing files on Sharepoint gets “item not found”</h4> 13864 <p>It is a <a href="https://github.com/OneDrive/onedrive-api-docs/issues/1068">known</a> issue that Sharepoint (not OneDrive or OneDrive for Business) may return “item not found” errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, etc.). As a workaround, you may use the <code>--backup-dir <BACKUP_DIR></code> 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 <code>rclone-backup-dir</code> on backend <code>mysharepoint</code>, you may use:</p> 13865 <pre><code>--backup-dir mysharepoint:rclone-backup-dir</code></pre> 13866 <h4 id="access_denied-aadsts65005">access_denied (AADSTS65005)</h4> 13867 <pre><code>Error: access_denied 13868 Code: AADSTS65005 13869 Description: Using application 'rclone' 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.</code></pre> 13870 <p>This means that rclone can’t use the OneDrive for Business API with your account. You can’t do much about it, maybe write an email to your admins.</p> 13871 <p>However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint</p> 13872 <h4 id="invalid_grant-aadsts50076">invalid_grant (AADSTS50076)</h4> 13873 <pre><code>Error: invalid_grant 13874 Code: AADSTS50076 13875 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 '...'.</code></pre> 13876 <p>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 <code>rclone config</code>, and choose to edit your OneDrive backend. Then, you don’t need to actually make any changes until you reach this question: <code>Already have a token - refresh?</code>. For this question, answer <code>y</code> 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.</p> 13877 <h2 id="opendrive">OpenDrive</h2> 13878 <p>Paths are specified as <code>remote:path</code></p> 13879 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 13880 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 13881 <pre><code> rclone config</code></pre> 13882 <p>This will guide you through an interactive setup process:</p> 13883 <pre><code>n) New remote 13884 d) Delete remote 13885 q) Quit config 13886 e/n/d/q> n 13887 name> remote 13888 Type of storage to configure. 13889 Choose a number from below, or type in your own value 13890 [snip] 13891 XX / OpenDrive 13892 \ "opendrive" 13893 [snip] 13894 Storage> opendrive 13895 Username 13896 username> 13897 Password 13898 y) Yes type in my own password 13899 g) Generate random password 13900 y/g> y 13901 Enter the password: 13902 password: 13903 Confirm the password: 13904 password: 13905 -------------------- 13906 [remote] 13907 username = 13908 password = *** ENCRYPTED *** 13909 -------------------- 13910 y) Yes this is OK 13911 e) Edit this remote 13912 d) Delete this remote 13913 y/e/d> y</code></pre> 13914 <p>List directories in top level of your OpenDrive</p> 13915 <pre><code>rclone lsd remote:</code></pre> 13916 <p>List all the files in your OpenDrive</p> 13917 <pre><code>rclone ls remote:</code></pre> 13918 <p>To copy a local directory to an OpenDrive directory called backup</p> 13919 <pre><code>rclone copy /home/source remote:backup</code></pre> 13920 <h3 id="modified-time-and-md5sums-1">Modified time and MD5SUMs</h3> 13921 <p>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.</p> 13922 <h4 id="restricted-filename-characters-17">Restricted filename characters</h4> 13923 <table> 13924 <thead> 13925 <tr class="header"> 13926 <th>Character</th> 13927 <th style="text-align: center;">Value</th> 13928 <th style="text-align: center;">Replacement</th> 13929 </tr> 13930 </thead> 13931 <tbody> 13932 <tr class="odd"> 13933 <td>NUL</td> 13934 <td style="text-align: center;">0x00</td> 13935 <td style="text-align: center;">␀</td> 13936 </tr> 13937 <tr class="even"> 13938 <td>/</td> 13939 <td style="text-align: center;">0x2F</td> 13940 <td style="text-align: center;">／</td> 13941 </tr> 13942 <tr class="odd"> 13943 <td>"</td> 13944 <td style="text-align: center;">0x22</td> 13945 <td style="text-align: center;">＂</td> 13946 </tr> 13947 <tr class="even"> 13948 <td>*</td> 13949 <td style="text-align: center;">0x2A</td> 13950 <td style="text-align: center;">＊</td> 13951 </tr> 13952 <tr class="odd"> 13953 <td>:</td> 13954 <td style="text-align: center;">0x3A</td> 13955 <td style="text-align: center;">：</td> 13956 </tr> 13957 <tr class="even"> 13958 <td><</td> 13959 <td style="text-align: center;">0x3C</td> 13960 <td style="text-align: center;">＜</td> 13961 </tr> 13962 <tr class="odd"> 13963 <td>></td> 13964 <td style="text-align: center;">0x3E</td> 13965 <td style="text-align: center;">＞</td> 13966 </tr> 13967 <tr class="even"> 13968 <td>?</td> 13969 <td style="text-align: center;">0x3F</td> 13970 <td style="text-align: center;">？</td> 13971 </tr> 13972 <tr class="odd"> 13973 <td>\</td> 13974 <td style="text-align: center;">0x5C</td> 13975 <td style="text-align: center;">＼</td> 13976 </tr> 13977 <tr class="even"> 13978 <td>|</td> 13979 <td style="text-align: center;">0x7C</td> 13980 <td style="text-align: center;">｜</td> 13981 </tr> 13982 </tbody> 13983 </table> 13984 <p>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:</p> 13985 <table> 13986 <thead> 13987 <tr class="header"> 13988 <th>Character</th> 13989 <th style="text-align: center;">Value</th> 13990 <th style="text-align: center;">Replacement</th> 13991 </tr> 13992 </thead> 13993 <tbody> 13994 <tr class="odd"> 13995 <td>SP</td> 13996 <td style="text-align: center;">0x20</td> 13997 <td style="text-align: center;">␠</td> 13998 </tr> 13999 <tr class="even"> 14000 <td>HT</td> 14001 <td style="text-align: center;">0x09</td> 14002 <td style="text-align: center;">␉</td> 14003 </tr> 14004 <tr class="odd"> 14005 <td>LF</td> 14006 <td style="text-align: center;">0x0A</td> 14007 <td style="text-align: center;">␊</td> 14008 </tr> 14009 <tr class="even"> 14010 <td>VT</td> 14011 <td style="text-align: center;">0x0B</td> 14012 <td style="text-align: center;">␋</td> 14013 </tr> 14014 <tr class="odd"> 14015 <td>CR</td> 14016 <td style="text-align: center;">0x0D</td> 14017 <td style="text-align: center;">␍</td> 14018 </tr> 14019 </tbody> 14020 </table> 14021 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 14022 <h3 id="standard-options-22">Standard Options</h3> 14023 <p>Here are the standard options specific to opendrive (OpenDrive).</p> 14024 <h4 id="opendrive-username">–opendrive-username</h4> 14025 <p>Username</p> 14026 <ul> 14027 <li>Config: username</li> 14028 <li>Env Var: RCLONE_OPENDRIVE_USERNAME</li> 14029 <li>Type: string</li> 14030 <li>Default: ""</li> 14031 </ul> 14032 <h4 id="opendrive-password">–opendrive-password</h4> 14033 <p>Password.</p> 14034 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 14035 <ul> 14036 <li>Config: password</li> 14037 <li>Env Var: RCLONE_OPENDRIVE_PASSWORD</li> 14038 <li>Type: string</li> 14039 <li>Default: ""</li> 14040 </ul> 14041 <h3 id="advanced-options-22">Advanced Options</h3> 14042 <p>Here are the advanced options specific to opendrive (OpenDrive).</p> 14043 <h4 id="opendrive-encoding">–opendrive-encoding</h4> 14044 <p>This sets the encoding for the backend.</p> 14045 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14046 <ul> 14047 <li>Config: encoding</li> 14048 <li>Env Var: RCLONE_OPENDRIVE_ENCODING</li> 14049 <li>Type: MultiEncoder</li> 14050 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot</li> 14051 </ul> 14052 <h4 id="opendrive-chunk-size">–opendrive-chunk-size</h4> 14053 <p>Files will be uploaded in chunks this size.</p> 14054 <p>Note that these chunks are buffered in memory so increasing them will increase memory use.</p> 14055 <ul> 14056 <li>Config: chunk_size</li> 14057 <li>Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE</li> 14058 <li>Type: SizeSuffix</li> 14059 <li>Default: 10M</li> 14060 </ul> 14061 <h3 id="limitations-16">Limitations</h3> 14062 <p>Note that OpenDrive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 14063 <p>There are quite a few characters that can’t be in OpenDrive file names. These can’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 <code>?</code> in it will be mapped to <code>？</code> instead.</p> 14064 <h2 id="qingstor">QingStor</h2> 14065 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p> 14066 <p>Here is an example of making an QingStor configuration. First run</p> 14067 <pre><code>rclone config</code></pre> 14068 <p>This will guide you through an interactive setup process.</p> 14069 <pre><code>No remotes found - make a new one 14070 n) New remote 14071 r) Rename remote 14072 c) Copy remote 14073 s) Set configuration password 14074 q) Quit config 14075 n/r/c/s/q> n 14076 name> remote 14077 Type of storage to configure. 14078 Choose a number from below, or type in your own value 14079 [snip] 14080 XX / QingStor Object Storage 14081 \ "qingstor" 14082 [snip] 14083 Storage> qingstor 14084 Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. 14085 Choose a number from below, or type in your own value 14086 1 / Enter QingStor credentials in the next step 14087 \ "false" 14088 2 / Get QingStor credentials from the environment (env vars or IAM) 14089 \ "true" 14090 env_auth> 1 14091 QingStor Access Key ID - leave blank for anonymous access or runtime credentials. 14092 access_key_id> access_key 14093 QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 14094 secret_access_key> secret_key 14095 Enter an endpoint URL to connection QingStor API. 14096 Leave blank will use the default value "https://qingstor.com:443" 14097 endpoint> 14098 Zone connect to. Default is "pek3a". 14099 Choose a number from below, or type in your own value 14100 / The Beijing (China) Three Zone 14101 1 | Needs location constraint pek3a. 14102 \ "pek3a" 14103 / The Shanghai (China) First Zone 14104 2 | Needs location constraint sh1a. 14105 \ "sh1a" 14106 zone> 1 14107 Number of connection retry. 14108 Leave blank will use the default value "3". 14109 connection_retries> 14110 Remote config 14111 -------------------- 14112 [remote] 14113 env_auth = false 14114 access_key_id = access_key 14115 secret_access_key = secret_key 14116 endpoint = 14117 zone = pek3a 14118 connection_retries = 14119 -------------------- 14120 y) Yes this is OK 14121 e) Edit this remote 14122 d) Delete this remote 14123 y/e/d> y</code></pre> 14124 <p>This remote is called <code>remote</code> and can now be used like this</p> 14125 <p>See all buckets</p> 14126 <pre><code>rclone lsd remote:</code></pre> 14127 <p>Make a new bucket</p> 14128 <pre><code>rclone mkdir remote:bucket</code></pre> 14129 <p>List the contents of a bucket</p> 14130 <pre><code>rclone ls remote:bucket</code></pre> 14131 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 14132 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 14133 <h3 id="fast-list-8">–fast-list</h3> 14134 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 14135 <h3 id="multipart-uploads-2">Multipart uploads</h3> 14136 <p>rclone supports multipart uploads with QingStor which means that it can upload files bigger than 5GB. Note that files uploaded with multipart upload don’t have an MD5SUM.</p> 14137 <p>Note that incomplete multipart uploads older than 24 hours can be removed with <code>rclone cleanup remote:bucket</code> just for one bucket <code>rclone cleanup remote:</code> for all buckets. QingStor does not ever remove incomplete multipart uploads so it may be necessary to run this from time to time.</p> 14138 <h3 id="buckets-and-zone">Buckets and Zone</h3> 14139 <p>With QingStor you can list buckets (<code>rclone lsd</code>) 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, <code>incorrect zone, the bucket is not in 'XXX' zone</code>.</p> 14140 <h3 id="authentication-5">Authentication</h3> 14141 <p>There are two ways to supply <code>rclone</code> with a set of QingStor credentials. In order of precedence:</p> 14142 <ul> 14143 <li>Directly in the rclone configuration file (as configured by <code>rclone config</code>) 14144 <ul> 14145 <li>set <code>access_key_id</code> and <code>secret_access_key</code></li> 14146 </ul></li> 14147 <li>Runtime configuration: 14148 <ul> 14149 <li>set <code>env_auth</code> to <code>true</code> in the config file</li> 14150 <li>Exporting the following environment variables before running <code>rclone</code> 14151 <ul> 14152 <li>Access Key ID: <code>QS_ACCESS_KEY_ID</code> or <code>QS_ACCESS_KEY</code></li> 14153 <li>Secret Access Key: <code>QS_SECRET_ACCESS_KEY</code> or <code>QS_SECRET_KEY</code></li> 14154 </ul></li> 14155 </ul></li> 14156 </ul> 14157 <h3 id="restricted-filename-characters-18">Restricted filename characters</h3> 14158 <p>The control characters 0x00-0x1F and / are replaced as in the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a>. Note that 0x7F is not replaced.</p> 14159 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 14160 <h3 id="standard-options-23">Standard Options</h3> 14161 <p>Here are the standard options specific to qingstor (QingCloud Object Storage).</p> 14162 <h4 id="qingstor-env-auth">–qingstor-env-auth</h4> 14163 <p>Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.</p> 14164 <ul> 14165 <li>Config: env_auth</li> 14166 <li>Env Var: RCLONE_QINGSTOR_ENV_AUTH</li> 14167 <li>Type: bool</li> 14168 <li>Default: false</li> 14169 <li>Examples: 14170 <ul> 14171 <li>“false” 14172 <ul> 14173 <li>Enter QingStor credentials in the next step</li> 14174 </ul></li> 14175 <li>“true” 14176 <ul> 14177 <li>Get QingStor credentials from the environment (env vars or IAM)</li> 14178 </ul></li> 14179 </ul></li> 14180 </ul> 14181 <h4 id="qingstor-access-key-id">–qingstor-access-key-id</h4> 14182 <p>QingStor Access Key ID Leave blank for anonymous access or runtime credentials.</p> 14183 <ul> 14184 <li>Config: access_key_id</li> 14185 <li>Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID</li> 14186 <li>Type: string</li> 14187 <li>Default: ""</li> 14188 </ul> 14189 <h4 id="qingstor-secret-access-key">–qingstor-secret-access-key</h4> 14190 <p>QingStor Secret Access Key (password) Leave blank for anonymous access or runtime credentials.</p> 14191 <ul> 14192 <li>Config: secret_access_key</li> 14193 <li>Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY</li> 14194 <li>Type: string</li> 14195 <li>Default: ""</li> 14196 </ul> 14197 <h4 id="qingstor-endpoint">–qingstor-endpoint</h4> 14198 <p>Enter an endpoint URL to connection QingStor API. Leave blank will use the default value “https://qingstor.com:443”</p> 14199 <ul> 14200 <li>Config: endpoint</li> 14201 <li>Env Var: RCLONE_QINGSTOR_ENDPOINT</li> 14202 <li>Type: string</li> 14203 <li>Default: ""</li> 14204 </ul> 14205 <h4 id="qingstor-zone">–qingstor-zone</h4> 14206 <p>Zone to connect to. Default is “pek3a”.</p> 14207 <ul> 14208 <li>Config: zone</li> 14209 <li>Env Var: RCLONE_QINGSTOR_ZONE</li> 14210 <li>Type: string</li> 14211 <li>Default: ""</li> 14212 <li>Examples: 14213 <ul> 14214 <li>“pek3a” 14215 <ul> 14216 <li>The Beijing (China) Three Zone</li> 14217 <li>Needs location constraint pek3a.</li> 14218 </ul></li> 14219 <li>“sh1a” 14220 <ul> 14221 <li>The Shanghai (China) First Zone</li> 14222 <li>Needs location constraint sh1a.</li> 14223 </ul></li> 14224 <li>“gd2a” 14225 <ul> 14226 <li>The Guangdong (China) Second Zone</li> 14227 <li>Needs location constraint gd2a.</li> 14228 </ul></li> 14229 </ul></li> 14230 </ul> 14231 <h3 id="advanced-options-23">Advanced Options</h3> 14232 <p>Here are the advanced options specific to qingstor (QingCloud Object Storage).</p> 14233 <h4 id="qingstor-connection-retries">–qingstor-connection-retries</h4> 14234 <p>Number of connection retries.</p> 14235 <ul> 14236 <li>Config: connection_retries</li> 14237 <li>Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES</li> 14238 <li>Type: int</li> 14239 <li>Default: 3</li> 14240 </ul> 14241 <h4 id="qingstor-upload-cutoff">–qingstor-upload-cutoff</h4> 14242 <p>Cutoff for switching to chunked upload</p> 14243 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.</p> 14244 <ul> 14245 <li>Config: upload_cutoff</li> 14246 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF</li> 14247 <li>Type: SizeSuffix</li> 14248 <li>Default: 200M</li> 14249 </ul> 14250 <h4 id="qingstor-chunk-size">–qingstor-chunk-size</h4> 14251 <p>Chunk size to use for uploading.</p> 14252 <p>When uploading files larger than upload_cutoff they will be uploaded as multipart uploads using this chunk size.</p> 14253 <p>Note that “–qingstor-upload-concurrency” chunks of this size are buffered in memory per transfer.</p> 14254 <p>If you are transferring large files over high speed links and you have enough memory, then increasing this will speed up the transfers.</p> 14255 <ul> 14256 <li>Config: chunk_size</li> 14257 <li>Env Var: RCLONE_QINGSTOR_CHUNK_SIZE</li> 14258 <li>Type: SizeSuffix</li> 14259 <li>Default: 4M</li> 14260 </ul> 14261 <h4 id="qingstor-upload-concurrency">–qingstor-upload-concurrency</h4> 14262 <p>Concurrency for multipart uploads.</p> 14263 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 14264 <p>NB if you set this to > 1 then the checksums of multpart uploads become corrupted (the uploads themselves are not corrupted though).</p> 14265 <p>If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p> 14266 <ul> 14267 <li>Config: upload_concurrency</li> 14268 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY</li> 14269 <li>Type: int</li> 14270 <li>Default: 1</li> 14271 </ul> 14272 <h4 id="qingstor-encoding">–qingstor-encoding</h4> 14273 <p>This sets the encoding for the backend.</p> 14274 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14275 <ul> 14276 <li>Config: encoding</li> 14277 <li>Env Var: RCLONE_QINGSTOR_ENCODING</li> 14278 <li>Type: MultiEncoder</li> 14279 <li>Default: Slash,Ctl,InvalidUtf8</li> 14280 </ul> 14281 <h2 id="swift">Swift</h2> 14282 <p>Swift refers to <a href="https://docs.openstack.org/swift/latest/">OpenStack Object Storage</a>. Commercial implementations of that being:</p> 14283 <ul> 14284 <li><a href="https://www.rackspace.com/cloud/files/">Rackspace Cloud Files</a></li> 14285 <li><a href="https://www.memset.com/cloud/storage/">Memset Memstore</a></li> 14286 <li><a href="https://www.ovh.co.uk/public-cloud/storage/object-storage/">OVH Object Storage</a></li> 14287 <li><a href="https://cloud.oracle.com/storage-opc">Oracle Cloud Storage</a></li> 14288 <li><a href="https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html">IBM Bluemix Cloud ObjectStorage Swift</a></li> 14289 </ul> 14290 <p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p> 14291 <p>Here is an example of making a swift configuration. First run</p> 14292 <pre><code>rclone config</code></pre> 14293 <p>This will guide you through an interactive setup process.</p> 14294 <pre><code>No remotes found - make a new one 14295 n) New remote 14296 s) Set configuration password 14297 q) Quit config 14298 n/s/q> n 14299 name> remote 14300 Type of storage to configure. 14301 Choose a number from below, or type in your own value 14302 [snip] 14303 XX / OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 14304 \ "swift" 14305 [snip] 14306 Storage> swift 14307 Get swift credentials from environment variables in standard OpenStack form. 14308 Choose a number from below, or type in your own value 14309 1 / Enter swift credentials in the next step 14310 \ "false" 14311 2 / Get swift credentials from environment vars. Leave other fields blank if using this. 14312 \ "true" 14313 env_auth> true 14314 User name to log in (OS_USERNAME). 14315 user> 14316 API key or password (OS_PASSWORD). 14317 key> 14318 Authentication URL for server (OS_AUTH_URL). 14319 Choose a number from below, or type in your own value 14320 1 / Rackspace US 14321 \ "https://auth.api.rackspacecloud.com/v1.0" 14322 2 / Rackspace UK 14323 \ "https://lon.auth.api.rackspacecloud.com/v1.0" 14324 3 / Rackspace v2 14325 \ "https://identity.api.rackspacecloud.com/v2.0" 14326 4 / Memset Memstore UK 14327 \ "https://auth.storage.memset.com/v1.0" 14328 5 / Memset Memstore UK v2 14329 \ "https://auth.storage.memset.com/v2.0" 14330 6 / OVH 14331 \ "https://auth.cloud.ovh.net/v3" 14332 auth> 14333 User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). 14334 user_id> 14335 User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) 14336 domain> 14337 Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) 14338 tenant> 14339 Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) 14340 tenant_id> 14341 Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) 14342 tenant_domain> 14343 Region name - optional (OS_REGION_NAME) 14344 region> 14345 Storage URL - optional (OS_STORAGE_URL) 14346 storage_url> 14347 Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) 14348 auth_token> 14349 AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) 14350 auth_version> 14351 Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) 14352 Choose a number from below, or type in your own value 14353 1 / Public (default, choose this if not sure) 14354 \ "public" 14355 2 / Internal (use internal service net) 14356 \ "internal" 14357 3 / Admin 14358 \ "admin" 14359 endpoint_type> 14360 Remote config 14361 -------------------- 14362 [test] 14363 env_auth = true 14364 user = 14365 key = 14366 auth = 14367 user_id = 14368 domain = 14369 tenant = 14370 tenant_id = 14371 tenant_domain = 14372 region = 14373 storage_url = 14374 auth_token = 14375 auth_version = 14376 endpoint_type = 14377 -------------------- 14378 y) Yes this is OK 14379 e) Edit this remote 14380 d) Delete this remote 14381 y/e/d> y</code></pre> 14382 <p>This remote is called <code>remote</code> and can now be used like this</p> 14383 <p>See all containers</p> 14384 <pre><code>rclone lsd remote:</code></pre> 14385 <p>Make a new container</p> 14386 <pre><code>rclone mkdir remote:container</code></pre> 14387 <p>List the contents of a container</p> 14388 <pre><code>rclone ls remote:container</code></pre> 14389 <p>Sync <code>/home/local/directory</code> to the remote container, deleting any excess files in the container.</p> 14390 <pre><code>rclone sync /home/local/directory remote:container</code></pre> 14391 <h3 id="configuration-from-an-openstack-credentials-file">Configuration from an OpenStack credentials file</h3> 14392 <p>An OpenStack credentials file typically looks something something like this (without the comments)</p> 14393 <pre><code>export OS_AUTH_URL=https://a.provider.net/v2.0 14394 export OS_TENANT_ID=ffffffffffffffffffffffffffffffff 14395 export OS_TENANT_NAME="1234567890123456" 14396 export OS_USERNAME="123abc567xy" 14397 echo "Please enter your OpenStack Password: " 14398 read -sr OS_PASSWORD_INPUT 14399 export OS_PASSWORD=$OS_PASSWORD_INPUT 14400 export OS_REGION_NAME="SBG1" 14401 if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi</code></pre> 14402 <p>The config file needs to look something like this where <code>$OS_USERNAME</code> represents the value of the <code>OS_USERNAME</code> variable - <code>123abc567xy</code> in the example above.</p> 14403 <pre><code>[remote] 14404 type = swift 14405 user = $OS_USERNAME 14406 key = $OS_PASSWORD 14407 auth = $OS_AUTH_URL 14408 tenant = $OS_TENANT_NAME</code></pre> 14409 <p>Note that you may (or may not) need to set <code>region</code> too - try without first.</p> 14410 <h3 id="configuration-from-the-environment">Configuration from the environment</h3> 14411 <p>If you prefer you can configure rclone to use swift using a standard set of OpenStack environment variables.</p> 14412 <p>When you run through the config, make sure you choose <code>true</code> for <code>env_auth</code> and leave everything else blank.</p> 14413 <p>rclone will then set any empty config parameters from the environment using standard OpenStack environment variables. There is <a href="https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment">a list of the variables</a> in the docs for the swift library.</p> 14414 <h3 id="using-an-alternate-authentication-method">Using an alternate authentication method</h3> 14415 <p>If your OpenStack installation uses a non-standard authentication method that might not be yet supported by rclone or the underlying swift library, you can authenticate externally (e.g. calling manually the <code>openstack</code> commands to get a token). Then, you just need to pass the two configuration variables <code>auth_token</code> and <code>storage_url</code>. If they are both provided, the other variables are ignored. rclone will not try to authenticate but instead assume it is already authenticated and use these two variables to access the OpenStack installation.</p> 14416 <h4 id="using-rclone-without-a-config-file">Using rclone without a config file</h4> 14417 <p>You can use rclone with swift without a config file, if desired, like this:</p> 14418 <pre><code>source openstack-credentials-file 14419 export RCLONE_CONFIG_MYREMOTE_TYPE=swift 14420 export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true 14421 rclone lsd myremote:</code></pre> 14422 <h3 id="fast-list-9">–fast-list</h3> 14423 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 14424 <h3 id="update-and-use-server-modtime-1">–update and –use-server-modtime</h3> 14425 <p>As noted below, the modified time is stored on metadata on the object. It 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 because it requires an extra API call to retrieve the metadata.</p> 14426 <p>For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is “dirty”. By using <code>--update</code> along with <code>--use-server-modtime</code>, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.</p> 14427 <h3 id="standard-options-24">Standard Options</h3> 14428 <p>Here are the standard options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).</p> 14429 <h4 id="swift-env-auth">–swift-env-auth</h4> 14430 <p>Get swift credentials from environment variables in standard OpenStack form.</p> 14431 <ul> 14432 <li>Config: env_auth</li> 14433 <li>Env Var: RCLONE_SWIFT_ENV_AUTH</li> 14434 <li>Type: bool</li> 14435 <li>Default: false</li> 14436 <li>Examples: 14437 <ul> 14438 <li>“false” 14439 <ul> 14440 <li>Enter swift credentials in the next step</li> 14441 </ul></li> 14442 <li>“true” 14443 <ul> 14444 <li>Get swift credentials from environment vars. Leave other fields blank if using this.</li> 14445 </ul></li> 14446 </ul></li> 14447 </ul> 14448 <h4 id="swift-user">–swift-user</h4> 14449 <p>User name to log in (OS_USERNAME).</p> 14450 <ul> 14451 <li>Config: user</li> 14452 <li>Env Var: RCLONE_SWIFT_USER</li> 14453 <li>Type: string</li> 14454 <li>Default: ""</li> 14455 </ul> 14456 <h4 id="swift-key">–swift-key</h4> 14457 <p>API key or password (OS_PASSWORD).</p> 14458 <ul> 14459 <li>Config: key</li> 14460 <li>Env Var: RCLONE_SWIFT_KEY</li> 14461 <li>Type: string</li> 14462 <li>Default: ""</li> 14463 </ul> 14464 <h4 id="swift-auth">–swift-auth</h4> 14465 <p>Authentication URL for server (OS_AUTH_URL).</p> 14466 <ul> 14467 <li>Config: auth</li> 14468 <li>Env Var: RCLONE_SWIFT_AUTH</li> 14469 <li>Type: string</li> 14470 <li>Default: ""</li> 14471 <li>Examples: 14472 <ul> 14473 <li>“https://auth.api.rackspacecloud.com/v1.0” 14474 <ul> 14475 <li>Rackspace US</li> 14476 </ul></li> 14477 <li>“https://lon.auth.api.rackspacecloud.com/v1.0” 14478 <ul> 14479 <li>Rackspace UK</li> 14480 </ul></li> 14481 <li>“https://identity.api.rackspacecloud.com/v2.0” 14482 <ul> 14483 <li>Rackspace v2</li> 14484 </ul></li> 14485 <li>“https://auth.storage.memset.com/v1.0” 14486 <ul> 14487 <li>Memset Memstore UK</li> 14488 </ul></li> 14489 <li>“https://auth.storage.memset.com/v2.0” 14490 <ul> 14491 <li>Memset Memstore UK v2</li> 14492 </ul></li> 14493 <li>“https://auth.cloud.ovh.net/v3” 14494 <ul> 14495 <li>OVH</li> 14496 </ul></li> 14497 </ul></li> 14498 </ul> 14499 <h4 id="swift-user-id">–swift-user-id</h4> 14500 <p>User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).</p> 14501 <ul> 14502 <li>Config: user_id</li> 14503 <li>Env Var: RCLONE_SWIFT_USER_ID</li> 14504 <li>Type: string</li> 14505 <li>Default: ""</li> 14506 </ul> 14507 <h4 id="swift-domain">–swift-domain</h4> 14508 <p>User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)</p> 14509 <ul> 14510 <li>Config: domain</li> 14511 <li>Env Var: RCLONE_SWIFT_DOMAIN</li> 14512 <li>Type: string</li> 14513 <li>Default: ""</li> 14514 </ul> 14515 <h4 id="swift-tenant">–swift-tenant</h4> 14516 <p>Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)</p> 14517 <ul> 14518 <li>Config: tenant</li> 14519 <li>Env Var: RCLONE_SWIFT_TENANT</li> 14520 <li>Type: string</li> 14521 <li>Default: ""</li> 14522 </ul> 14523 <h4 id="swift-tenant-id">–swift-tenant-id</h4> 14524 <p>Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)</p> 14525 <ul> 14526 <li>Config: tenant_id</li> 14527 <li>Env Var: RCLONE_SWIFT_TENANT_ID</li> 14528 <li>Type: string</li> 14529 <li>Default: ""</li> 14530 </ul> 14531 <h4 id="swift-tenant-domain">–swift-tenant-domain</h4> 14532 <p>Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)</p> 14533 <ul> 14534 <li>Config: tenant_domain</li> 14535 <li>Env Var: RCLONE_SWIFT_TENANT_DOMAIN</li> 14536 <li>Type: string</li> 14537 <li>Default: ""</li> 14538 </ul> 14539 <h4 id="swift-region">–swift-region</h4> 14540 <p>Region name - optional (OS_REGION_NAME)</p> 14541 <ul> 14542 <li>Config: region</li> 14543 <li>Env Var: RCLONE_SWIFT_REGION</li> 14544 <li>Type: string</li> 14545 <li>Default: ""</li> 14546 </ul> 14547 <h4 id="swift-storage-url">–swift-storage-url</h4> 14548 <p>Storage URL - optional (OS_STORAGE_URL)</p> 14549 <ul> 14550 <li>Config: storage_url</li> 14551 <li>Env Var: RCLONE_SWIFT_STORAGE_URL</li> 14552 <li>Type: string</li> 14553 <li>Default: ""</li> 14554 </ul> 14555 <h4 id="swift-auth-token">–swift-auth-token</h4> 14556 <p>Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)</p> 14557 <ul> 14558 <li>Config: auth_token</li> 14559 <li>Env Var: RCLONE_SWIFT_AUTH_TOKEN</li> 14560 <li>Type: string</li> 14561 <li>Default: ""</li> 14562 </ul> 14563 <h4 id="swift-application-credential-id">–swift-application-credential-id</h4> 14564 <p>Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)</p> 14565 <ul> 14566 <li>Config: application_credential_id</li> 14567 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID</li> 14568 <li>Type: string</li> 14569 <li>Default: ""</li> 14570 </ul> 14571 <h4 id="swift-application-credential-name">–swift-application-credential-name</h4> 14572 <p>Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)</p> 14573 <ul> 14574 <li>Config: application_credential_name</li> 14575 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME</li> 14576 <li>Type: string</li> 14577 <li>Default: ""</li> 14578 </ul> 14579 <h4 id="swift-application-credential-secret">–swift-application-credential-secret</h4> 14580 <p>Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)</p> 14581 <ul> 14582 <li>Config: application_credential_secret</li> 14583 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET</li> 14584 <li>Type: string</li> 14585 <li>Default: ""</li> 14586 </ul> 14587 <h4 id="swift-auth-version">–swift-auth-version</h4> 14588 <p>AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)</p> 14589 <ul> 14590 <li>Config: auth_version</li> 14591 <li>Env Var: RCLONE_SWIFT_AUTH_VERSION</li> 14592 <li>Type: int</li> 14593 <li>Default: 0</li> 14594 </ul> 14595 <h4 id="swift-endpoint-type">–swift-endpoint-type</h4> 14596 <p>Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE)</p> 14597 <ul> 14598 <li>Config: endpoint_type</li> 14599 <li>Env Var: RCLONE_SWIFT_ENDPOINT_TYPE</li> 14600 <li>Type: string</li> 14601 <li>Default: “public”</li> 14602 <li>Examples: 14603 <ul> 14604 <li>“public” 14605 <ul> 14606 <li>Public (default, choose this if not sure)</li> 14607 </ul></li> 14608 <li>“internal” 14609 <ul> 14610 <li>Internal (use internal service net)</li> 14611 </ul></li> 14612 <li>“admin” 14613 <ul> 14614 <li>Admin</li> 14615 </ul></li> 14616 </ul></li> 14617 </ul> 14618 <h4 id="swift-storage-policy">–swift-storage-policy</h4> 14619 <p>The storage policy to use when creating a new container</p> 14620 <p>This applies the specified storage policy when creating a new container. The policy cannot be changed afterwards. The allowed configuration values and their meaning depend on your Swift storage provider.</p> 14621 <ul> 14622 <li>Config: storage_policy</li> 14623 <li>Env Var: RCLONE_SWIFT_STORAGE_POLICY</li> 14624 <li>Type: string</li> 14625 <li>Default: ""</li> 14626 <li>Examples: 14627 <ul> 14628 <li>"" 14629 <ul> 14630 <li>Default</li> 14631 </ul></li> 14632 <li>“pcs” 14633 <ul> 14634 <li>OVH Public Cloud Storage</li> 14635 </ul></li> 14636 <li>“pca” 14637 <ul> 14638 <li>OVH Public Cloud Archive</li> 14639 </ul></li> 14640 </ul></li> 14641 </ul> 14642 <h3 id="advanced-options-24">Advanced Options</h3> 14643 <p>Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).</p> 14644 <h4 id="swift-chunk-size">–swift-chunk-size</h4> 14645 <p>Above this size files will be chunked into a _segments container.</p> 14646 <p>Above this size files will be chunked into a _segments container. The default for this is 5GB which is its maximum value.</p> 14647 <ul> 14648 <li>Config: chunk_size</li> 14649 <li>Env Var: RCLONE_SWIFT_CHUNK_SIZE</li> 14650 <li>Type: SizeSuffix</li> 14651 <li>Default: 5G</li> 14652 </ul> 14653 <h4 id="swift-no-chunk">–swift-no-chunk</h4> 14654 <p>Don’t chunk files during streaming upload.</p> 14655 <p>When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.</p> 14656 <p>This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.</p> 14657 <p>Rclone will still chunk files bigger than chunk_size when doing normal copy operations.</p> 14658 <ul> 14659 <li>Config: no_chunk</li> 14660 <li>Env Var: RCLONE_SWIFT_NO_CHUNK</li> 14661 <li>Type: bool</li> 14662 <li>Default: false</li> 14663 </ul> 14664 <h4 id="swift-encoding">–swift-encoding</h4> 14665 <p>This sets the encoding for the backend.</p> 14666 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14667 <ul> 14668 <li>Config: encoding</li> 14669 <li>Env Var: RCLONE_SWIFT_ENCODING</li> 14670 <li>Type: MultiEncoder</li> 14671 <li>Default: Slash,InvalidUtf8</li> 14672 </ul> 14673 <h3 id="modified-time-11">Modified time</h3> 14674 <p>The modified time is stored as metadata on the object as <code>X-Object-Meta-Mtime</code> as floating point since the epoch accurate to 1 ns.</p> 14675 <p>This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p> 14676 <h3 id="restricted-filename-characters-19">Restricted filename characters</h3> 14677 <table> 14678 <thead> 14679 <tr class="header"> 14680 <th>Character</th> 14681 <th style="text-align: center;">Value</th> 14682 <th style="text-align: center;">Replacement</th> 14683 </tr> 14684 </thead> 14685 <tbody> 14686 <tr class="odd"> 14687 <td>NUL</td> 14688 <td style="text-align: center;">0x00</td> 14689 <td style="text-align: center;">␀</td> 14690 </tr> 14691 <tr class="even"> 14692 <td>/</td> 14693 <td style="text-align: center;">0x2F</td> 14694 <td style="text-align: center;">／</td> 14695 </tr> 14696 </tbody> 14697 </table> 14698 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 14699 <h3 id="limitations-17">Limitations</h3> 14700 <p>The Swift API doesn’t return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won’t check or use the MD5SUM for these.</p> 14701 <h3 id="troubleshooting-2">Troubleshooting</h3> 14702 <h4 id="rclone-gives-failed-to-create-file-system-for-remote-bad-request">Rclone gives Failed to create file system for “remote:”: Bad Request</h4> 14703 <p>Due to an oddity of the underlying swift library, it gives a “Bad Request” error rather than a more sensible error when the authentication fails for Swift.</p> 14704 <p>So this most likely means your username / password is wrong. You can investigate further with the <code>--dump-bodies</code> flag.</p> 14705 <p>This may also be caused by specifying the region when you shouldn’t have (eg OVH).</p> 14706 <h4 id="rclone-gives-failed-to-create-file-system-response-didnt-have-storage-url-and-auth-token">Rclone gives Failed to create file system: Response didn’t have storage url and auth token</h4> 14707 <p>This is most likely caused by forgetting to specify your tenant when setting up a swift remote.</p> 14708 <h2 id="pcloud">pCloud</h2> 14709 <p>Paths are specified as <code>remote:path</code></p> 14710 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 14711 <p>The initial setup for pCloud involves getting a token from pCloud which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 14712 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 14713 <pre><code> rclone config</code></pre> 14714 <p>This will guide you through an interactive setup process:</p> 14715 <pre><code>No remotes found - make a new one 14716 n) New remote 14717 s) Set configuration password 14718 q) Quit config 14719 n/s/q> n 14720 name> remote 14721 Type of storage to configure. 14722 Choose a number from below, or type in your own value 14723 [snip] 14724 XX / Pcloud 14725 \ "pcloud" 14726 [snip] 14727 Storage> pcloud 14728 Pcloud App Client Id - leave blank normally. 14729 client_id> 14730 Pcloud App Client Secret - leave blank normally. 14731 client_secret> 14732 Remote config 14733 Use auto config? 14734 * Say Y if not sure 14735 * Say N if you are working on a remote or headless machine 14736 y) Yes 14737 n) No 14738 y/n> y 14739 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 14740 Log in and authorize rclone for access 14741 Waiting for code... 14742 Got code 14743 -------------------- 14744 [remote] 14745 client_id = 14746 client_secret = 14747 token = {"access_token":"XXX","token_type":"bearer","expiry":"0001-01-01T00:00:00Z"} 14748 -------------------- 14749 y) Yes this is OK 14750 e) Edit this remote 14751 d) Delete this remote 14752 y/e/d> y</code></pre> 14753 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 14754 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from pCloud. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 14755 <p>Once configured you can then use <code>rclone</code> like this,</p> 14756 <p>List directories in top level of your pCloud</p> 14757 <pre><code>rclone lsd remote:</code></pre> 14758 <p>List all the files in your pCloud</p> 14759 <pre><code>rclone ls remote:</code></pre> 14760 <p>To copy a local directory to an pCloud directory called backup</p> 14761 <pre><code>rclone copy /home/source remote:backup</code></pre> 14762 <h3 id="modified-time-and-hashes-8">Modified time and hashes</h3> 14763 <p>pCloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. In order to set a Modification time pCloud requires the object be re-uploaded.</p> 14764 <p>pCloud supports MD5 and SHA1 type hashes, so you can use the <code>--checksum</code> flag.</p> 14765 <h4 id="restricted-filename-characters-20">Restricted filename characters</h4> 14766 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 14767 <table> 14768 <thead> 14769 <tr class="header"> 14770 <th>Character</th> 14771 <th style="text-align: center;">Value</th> 14772 <th style="text-align: center;">Replacement</th> 14773 </tr> 14774 </thead> 14775 <tbody> 14776 <tr class="odd"> 14777 <td>\</td> 14778 <td style="text-align: center;">0x5C</td> 14779 <td style="text-align: center;">＼</td> 14780 </tr> 14781 </tbody> 14782 </table> 14783 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 14784 <h3 id="deleting-files-6">Deleting files</h3> 14785 <p>Deleted files will be moved to the trash. Your subscription level will determine how long items stay in the trash. <code>rclone cleanup</code> can be used to empty the trash.</p> 14786 <h3 id="root-folder-id-2">Root folder ID</h3> 14787 <p>You can set the <code>root_folder_id</code> for rclone. This is the directory (identified by its <code>Folder ID</code>) that rclone considers to be the root of your pCloud drive.</p> 14788 <p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p> 14789 <p>However you can set this to restrict rclone to a specific folder hierarchy.</p> 14790 <p>In order to do this you will have to find the <code>Folder ID</code> of the directory you wish rclone to display. This will be the <code>folder</code> field of the URL when you open the relevant folder in the pCloud web interface.</p> 14791 <p>So if the folder you want rclone to use has a URL which looks like <code>https://my.pcloud.com/#page=filemanager&folder=5xxxxxxxx8&tpl=foldergrid</code> in the browser, then you use <code>5xxxxxxxx8</code> as the <code>root_folder_id</code> in the config.</p> 14792 <h3 id="standard-options-25">Standard Options</h3> 14793 <p>Here are the standard options specific to pcloud (Pcloud).</p> 14794 <h4 id="pcloud-client-id">–pcloud-client-id</h4> 14795 <p>Pcloud App Client Id Leave blank normally.</p> 14796 <ul> 14797 <li>Config: client_id</li> 14798 <li>Env Var: RCLONE_PCLOUD_CLIENT_ID</li> 14799 <li>Type: string</li> 14800 <li>Default: ""</li> 14801 </ul> 14802 <h4 id="pcloud-client-secret">–pcloud-client-secret</h4> 14803 <p>Pcloud App Client Secret Leave blank normally.</p> 14804 <ul> 14805 <li>Config: client_secret</li> 14806 <li>Env Var: RCLONE_PCLOUD_CLIENT_SECRET</li> 14807 <li>Type: string</li> 14808 <li>Default: ""</li> 14809 </ul> 14810 <h3 id="advanced-options-25">Advanced Options</h3> 14811 <p>Here are the advanced options specific to pcloud (Pcloud).</p> 14812 <h4 id="pcloud-encoding">–pcloud-encoding</h4> 14813 <p>This sets the encoding for the backend.</p> 14814 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14815 <ul> 14816 <li>Config: encoding</li> 14817 <li>Env Var: RCLONE_PCLOUD_ENCODING</li> 14818 <li>Type: MultiEncoder</li> 14819 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 14820 </ul> 14821 <h4 id="pcloud-root-folder-id">–pcloud-root-folder-id</h4> 14822 <p>Fill in for rclone to use a non root folder as its starting point.</p> 14823 <ul> 14824 <li>Config: root_folder_id</li> 14825 <li>Env Var: RCLONE_PCLOUD_ROOT_FOLDER_ID</li> 14826 <li>Type: string</li> 14827 <li>Default: “d0”</li> 14828 </ul> 14829 <h2 id="premiumize.me">premiumize.me</h2> 14830 <p>Paths are specified as <code>remote:path</code></p> 14831 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 14832 <p>The initial setup for <a href="https://premiumize.me/">premiumize.me</a> involves getting a token from premiumize.me which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 14833 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 14834 <pre><code> rclone config</code></pre> 14835 <p>This will guide you through an interactive setup process:</p> 14836 <pre><code>No remotes found - make a new one 14837 n) New remote 14838 s) Set configuration password 14839 q) Quit config 14840 n/s/q> n 14841 name> remote 14842 Type of storage to configure. 14843 Enter a string value. Press Enter for the default (""). 14844 Choose a number from below, or type in your own value 14845 [snip] 14846 XX / premiumize.me 14847 \ "premiumizeme" 14848 [snip] 14849 Storage> premiumizeme 14850 ** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ ** 14851 14852 Remote config 14853 Use auto config? 14854 * Say Y if not sure 14855 * Say N if you are working on a remote or headless machine 14856 y) Yes 14857 n) No 14858 y/n> y 14859 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 14860 Log in and authorize rclone for access 14861 Waiting for code... 14862 Got code 14863 -------------------- 14864 [remote] 14865 type = premiumizeme 14866 token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2029-08-07T18:44:15.548915378+01:00"} 14867 -------------------- 14868 y) Yes this is OK 14869 e) Edit this remote 14870 d) Delete this remote 14871 y/e/d> </code></pre> 14872 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 14873 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from premiumize.me. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 14874 <p>Once configured you can then use <code>rclone</code> like this,</p> 14875 <p>List directories in top level of your premiumize.me</p> 14876 <pre><code>rclone lsd remote:</code></pre> 14877 <p>List all the files in your premiumize.me</p> 14878 <pre><code>rclone ls remote:</code></pre> 14879 <p>To copy a local directory to an premiumize.me directory called backup</p> 14880 <pre><code>rclone copy /home/source remote:backup</code></pre> 14881 <h3 id="modified-time-and-hashes-9">Modified time and hashes</h3> 14882 <p>premiumize.me does not support modification times or hashes, therefore syncing will default to <code>--size-only</code> checking. Note that using <code>--update</code> will work.</p> 14883 <h4 id="restricted-filename-characters-21">Restricted filename characters</h4> 14884 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 14885 <table> 14886 <thead> 14887 <tr class="header"> 14888 <th>Character</th> 14889 <th style="text-align: center;">Value</th> 14890 <th style="text-align: center;">Replacement</th> 14891 </tr> 14892 </thead> 14893 <tbody> 14894 <tr class="odd"> 14895 <td>\</td> 14896 <td style="text-align: center;">0x5C</td> 14897 <td style="text-align: center;">＼</td> 14898 </tr> 14899 <tr class="even"> 14900 <td>"</td> 14901 <td style="text-align: center;">0x22</td> 14902 <td style="text-align: center;">＂</td> 14903 </tr> 14904 </tbody> 14905 </table> 14906 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 14907 <h3 id="standard-options-26">Standard Options</h3> 14908 <p>Here are the standard options specific to premiumizeme (premiumize.me).</p> 14909 <h4 id="premiumizeme-api-key">–premiumizeme-api-key</h4> 14910 <p>API Key.</p> 14911 <p>This is not normally used - use oauth instead.</p> 14912 <ul> 14913 <li>Config: api_key</li> 14914 <li>Env Var: RCLONE_PREMIUMIZEME_API_KEY</li> 14915 <li>Type: string</li> 14916 <li>Default: ""</li> 14917 </ul> 14918 <h3 id="advanced-options-26">Advanced Options</h3> 14919 <p>Here are the advanced options specific to premiumizeme (premiumize.me).</p> 14920 <h4 id="premiumizeme-encoding">–premiumizeme-encoding</h4> 14921 <p>This sets the encoding for the backend.</p> 14922 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14923 <ul> 14924 <li>Config: encoding</li> 14925 <li>Env Var: RCLONE_PREMIUMIZEME_ENCODING</li> 14926 <li>Type: MultiEncoder</li> 14927 <li>Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 14928 </ul> 14929 <h3 id="limitations-18">Limitations</h3> 14930 <p>Note that premiumize.me is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 14931 <p>premiumize.me file names can’t have the <code>\</code> or <code>"</code> characters in. rclone maps these to and from an identical looking unicode equivalents <code>＼</code> and <code>＂</code></p> 14932 <p>premiumize.me only supports filenames up to 255 characters in length.</p> 14933 <h2 id="put.io">put.io</h2> 14934 <p>Paths are specified as <code>remote:path</code></p> 14935 <p>put.io paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 14936 <p>The initial setup for put.io involves getting a token from put.io which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 14937 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 14938 <pre><code> rclone config</code></pre> 14939 <p>This will guide you through an interactive setup process:</p> 14940 <pre><code>No remotes found - make a new one 14941 n) New remote 14942 s) Set configuration password 14943 q) Quit config 14944 n/s/q> n 14945 name> putio 14946 Type of storage to configure. 14947 Enter a string value. Press Enter for the default (""). 14948 Choose a number from below, or type in your own value 14949 [snip] 14950 XX / Put.io 14951 \ "putio" 14952 [snip] 14953 Storage> putio 14954 ** See help for putio backend at: https://rclone.org/putio/ ** 14955 14956 Remote config 14957 Use auto config? 14958 * Say Y if not sure 14959 * Say N if you are working on a remote or headless machine 14960 y) Yes 14961 n) No 14962 y/n> y 14963 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 14964 Log in and authorize rclone for access 14965 Waiting for code... 14966 Got code 14967 -------------------- 14968 [putio] 14969 type = putio 14970 token = {"access_token":"XXXXXXXX","expiry":"0001-01-01T00:00:00Z"} 14971 -------------------- 14972 y) Yes this is OK 14973 e) Edit this remote 14974 d) Delete this remote 14975 y/e/d> y 14976 Current remotes: 14977 14978 Name Type 14979 ==== ==== 14980 putio putio 14981 14982 e) Edit existing remote 14983 n) New remote 14984 d) Delete remote 14985 r) Rename remote 14986 c) Copy remote 14987 s) Set configuration password 14988 q) Quit config 14989 e/n/d/r/c/s/q> q</code></pre> 14990 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p> 14991 <p>You can then use it like this,</p> 14992 <p>List directories in top level of your put.io</p> 14993 <pre><code>rclone lsd remote:</code></pre> 14994 <p>List all the files in your put.io</p> 14995 <pre><code>rclone ls remote:</code></pre> 14996 <p>To copy a local directory to a put.io directory called backup</p> 14997 <pre><code>rclone copy /home/source remote:backup</code></pre> 14998 <h4 id="restricted-filename-characters-22">Restricted filename characters</h4> 14999 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 15000 <table> 15001 <thead> 15002 <tr class="header"> 15003 <th>Character</th> 15004 <th style="text-align: center;">Value</th> 15005 <th style="text-align: center;">Replacement</th> 15006 </tr> 15007 </thead> 15008 <tbody> 15009 <tr class="odd"> 15010 <td>\</td> 15011 <td style="text-align: center;">0x5C</td> 15012 <td style="text-align: center;">＼</td> 15013 </tr> 15014 </tbody> 15015 </table> 15016 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 15017 <h3 id="advanced-options-27">Advanced Options</h3> 15018 <p>Here are the advanced options specific to putio (Put.io).</p> 15019 <h4 id="putio-encoding">–putio-encoding</h4> 15020 <p>This sets the encoding for the backend.</p> 15021 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 15022 <ul> 15023 <li>Config: encoding</li> 15024 <li>Env Var: RCLONE_PUTIO_ENCODING</li> 15025 <li>Type: MultiEncoder</li> 15026 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 15027 </ul> 15028 <h2 id="seafile">Seafile</h2> 15029 <p>This is a backend for the <a href="https://www.seafile.com/">Seafile</a> storage service: - It works with both the free community edition or the professional edition. - Seafile versions 6.x and 7.x are all supported. - Encrypted libraries are also supported. - It supports 2FA enabled users</p> 15030 <h3 id="root-mode-vs-library-mode">Root mode vs Library mode</h3> 15031 <p>There are two distinct modes you can setup your remote: - you point your remote to the <strong>root of the server</strong>, meaning you don’t specify a library during the configuration: Paths are specified as <code>remote:library</code>. You may put subdirectories in too, eg <code>remote:library/path/to/dir</code>. - you point your remote to a specific library during the configuration: Paths are specified as <code>remote:path/to/dir</code>. <strong>This is the recommended mode when using encrypted libraries</strong>. (<em>This mode is possibly slightly faster than the root mode</em>)</p> 15032 <h3 id="configuration-in-root-mode">Configuration in root mode</h3> 15033 <p>Here is an example of making a seafile configuration for a user with <strong>no</strong> two-factor authentication. First run</p> 15034 <pre><code>rclone config</code></pre> 15035 <p>This will guide you through an interactive setup process. To authenticate you will need the URL of your server, your email (or username) and your password.</p> 15036 <pre><code>No remotes found - make a new one 15037 n) New remote 15038 s) Set configuration password 15039 q) Quit config 15040 n/s/q> n 15041 name> seafile 15042 Type of storage to configure. 15043 Enter a string value. Press Enter for the default (""). 15044 Choose a number from below, or type in your own value 15045 [snip] 15046 XX / Seafile 15047 \ "seafile" 15048 [snip] 15049 Storage> seafile 15050 ** See help for seafile backend at: https://rclone.org/seafile/ ** 15051 15052 URL of seafile host to connect to 15053 Enter a string value. Press Enter for the default (""). 15054 Choose a number from below, or type in your own value 15055 1 / Connect to cloud.seafile.com 15056 \ "https://cloud.seafile.com/" 15057 url> http://my.seafile.server/ 15058 User name (usually email address) 15059 Enter a string value. Press Enter for the default (""). 15060 user> me@example.com 15061 Password 15062 y) Yes type in my own password 15063 g) Generate random password 15064 n) No leave this optional password blank (default) 15065 y/g> y 15066 Enter the password: 15067 password: 15068 Confirm the password: 15069 password: 15070 Two-factor authentication ('true' if the account has 2FA enabled) 15071 Enter a boolean value (true or false). Press Enter for the default ("false"). 15072 2fa> false 15073 Name of the library. Leave blank to access all non-encrypted libraries. 15074 Enter a string value. Press Enter for the default (""). 15075 library> 15076 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 15077 y) Yes type in my own password 15078 g) Generate random password 15079 n) No leave this optional password blank (default) 15080 y/g/n> n 15081 Edit advanced config? (y/n) 15082 y) Yes 15083 n) No (default) 15084 y/n> n 15085 Remote config 15086 Two-factor authentication is not enabled on this account. 15087 -------------------- 15088 [seafile] 15089 type = seafile 15090 url = http://my.seafile.server/ 15091 user = me@example.com 15092 pass = *** ENCRYPTED *** 15093 2fa = false 15094 -------------------- 15095 y) Yes this is OK (default) 15096 e) Edit this remote 15097 d) Delete this remote 15098 y/e/d> y</code></pre> 15099 <p>This remote is called <code>seafile</code>. It’s pointing to the root of your seafile server and can now be used like this:</p> 15100 <p>See all libraries</p> 15101 <pre><code>rclone lsd seafile:</code></pre> 15102 <p>Create a new library</p> 15103 <pre><code>rclone mkdir seafile:library</code></pre> 15104 <p>List the contents of a library</p> 15105 <pre><code>rclone ls seafile:library</code></pre> 15106 <p>Sync <code>/home/local/directory</code> to the remote library, deleting any excess files in the library.</p> 15107 <pre><code>rclone sync /home/local/directory seafile:library</code></pre> 15108 <h3 id="configuration-in-library-mode">Configuration in library mode</h3> 15109 <p>Here’s an example of a configuration in library mode with a user that has the two-factor authentication enabled. Your 2FA code will be asked at the end of the configuration, and will attempt to authenticate you:</p> 15110 <pre><code>No remotes found - make a new one 15111 n) New remote 15112 s) Set configuration password 15113 q) Quit config 15114 n/s/q> n 15115 name> seafile 15116 Type of storage to configure. 15117 Enter a string value. Press Enter for the default (""). 15118 Choose a number from below, or type in your own value 15119 [snip] 15120 XX / Seafile 15121 \ "seafile" 15122 [snip] 15123 Storage> seafile 15124 ** See help for seafile backend at: https://rclone.org/seafile/ ** 15125 15126 URL of seafile host to connect to 15127 Enter a string value. Press Enter for the default (""). 15128 Choose a number from below, or type in your own value 15129 1 / Connect to cloud.seafile.com 15130 \ "https://cloud.seafile.com/" 15131 url> http://my.seafile.server/ 15132 User name (usually email address) 15133 Enter a string value. Press Enter for the default (""). 15134 user> me@example.com 15135 Password 15136 y) Yes type in my own password 15137 g) Generate random password 15138 n) No leave this optional password blank (default) 15139 y/g> y 15140 Enter the password: 15141 password: 15142 Confirm the password: 15143 password: 15144 Two-factor authentication ('true' if the account has 2FA enabled) 15145 Enter a boolean value (true or false). Press Enter for the default ("false"). 15146 2fa> true 15147 Name of the library. Leave blank to access all non-encrypted libraries. 15148 Enter a string value. Press Enter for the default (""). 15149 library> My Library 15150 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 15151 y) Yes type in my own password 15152 g) Generate random password 15153 n) No leave this optional password blank (default) 15154 y/g/n> n 15155 Edit advanced config? (y/n) 15156 y) Yes 15157 n) No (default) 15158 y/n> n 15159 Remote config 15160 Two-factor authentication: please enter your 2FA code 15161 2fa code> 123456 15162 Authenticating... 15163 Success! 15164 -------------------- 15165 [seafile] 15166 type = seafile 15167 url = http://my.seafile.server/ 15168 user = me@example.com 15169 pass = 15170 2fa = true 15171 library = My Library 15172 -------------------- 15173 y) Yes this is OK (default) 15174 e) Edit this remote 15175 d) Delete this remote 15176 y/e/d> y</code></pre> 15177 <p>You’ll notice your password is blank in the configuration. It’s because we only need the password to authenticate you once.</p> 15178 <p>You specified <code>My Library</code> during the configuration. The root of the remote is pointing at the root of the library <code>My Library</code>:</p> 15179 <p>See all files in the library:</p> 15180 <pre><code>rclone lsd seafile:</code></pre> 15181 <p>Create a new directory inside the library</p> 15182 <pre><code>rclone mkdir seafile:directory</code></pre> 15183 <p>List the contents of a directory</p> 15184 <pre><code>rclone ls seafile:directory</code></pre> 15185 <p>Sync <code>/home/local/directory</code> to the remote library, deleting any excess files in the library.</p> 15186 <pre><code>rclone sync /home/local/directory seafile:</code></pre> 15187 <h3 id="fast-list-10">–fast-list</h3> 15188 <p>Seafile version 7+ supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details. Please note this is not supported on seafile server version 6.x</p> 15189 <h4 id="restricted-filename-characters-23">Restricted filename characters</h4> 15190 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 15191 <table> 15192 <thead> 15193 <tr class="header"> 15194 <th>Character</th> 15195 <th style="text-align: center;">Value</th> 15196 <th style="text-align: center;">Replacement</th> 15197 </tr> 15198 </thead> 15199 <tbody> 15200 <tr class="odd"> 15201 <td>/</td> 15202 <td style="text-align: center;">0x2F</td> 15203 <td style="text-align: center;">／</td> 15204 </tr> 15205 <tr class="even"> 15206 <td>"</td> 15207 <td style="text-align: center;">0x22</td> 15208 <td style="text-align: center;">＂</td> 15209 </tr> 15210 <tr class="odd"> 15211 <td>\</td> 15212 <td style="text-align: center;">0x5C</td> 15213 <td style="text-align: center;">＼</td> 15214 </tr> 15215 </tbody> 15216 </table> 15217 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 15218 <h3 id="seafile-and-rclone-link">Seafile and rclone link</h3> 15219 <p>Rclone supports generating share links for non-encrypted libraries only. They can either be for a file or a directory:</p> 15220 <pre><code>rclone link seafile:seafile-tutorial.doc 15221 http://my.seafile.server/f/fdcd8a2f93f84b8b90f4/ 15222 </code></pre> 15223 <p>or if run on a directory you will get:</p> 15224 <pre><code>rclone link seafile:dir 15225 http://my.seafile.server/d/9ea2455f6f55478bbb0d/</code></pre> 15226 <p>Please note a share link is unique for each file or directory. If you run a link command on a file/dir that has already been shared, you will get the exact same link.</p> 15227 <h3 id="compatibility">Compatibility</h3> 15228 <p>It has been actively tested using the <a href="https://github.com/haiwen/seafile-docker">seafile docker image</a> of these versions: - 6.3.4 community edition - 7.0.5 community edition - 7.1.3 community edition</p> 15229 <p>Versions below 6.0 are not supported. Versions between 6.0 and 6.3 haven’t been tested and might not work properly.</p> 15230 <h3 id="standard-options-27">Standard Options</h3> 15231 <p>Here are the standard options specific to seafile (seafile).</p> 15232 <h4 id="seafile-url">–seafile-url</h4> 15233 <p>URL of seafile host to connect to</p> 15234 <ul> 15235 <li>Config: url</li> 15236 <li>Env Var: RCLONE_SEAFILE_URL</li> 15237 <li>Type: string</li> 15238 <li>Default: ""</li> 15239 <li>Examples: 15240 <ul> 15241 <li>“https://cloud.seafile.com/” 15242 <ul> 15243 <li>Connect to cloud.seafile.com</li> 15244 </ul></li> 15245 </ul></li> 15246 </ul> 15247 <h4 id="seafile-user">–seafile-user</h4> 15248 <p>User name (usually email address)</p> 15249 <ul> 15250 <li>Config: user</li> 15251 <li>Env Var: RCLONE_SEAFILE_USER</li> 15252 <li>Type: string</li> 15253 <li>Default: ""</li> 15254 </ul> 15255 <h4 id="seafile-pass">–seafile-pass</h4> 15256 <p>Password</p> 15257 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 15258 <ul> 15259 <li>Config: pass</li> 15260 <li>Env Var: RCLONE_SEAFILE_PASS</li> 15261 <li>Type: string</li> 15262 <li>Default: ""</li> 15263 </ul> 15264 <h4 id="seafile-2fa">–seafile-2fa</h4> 15265 <p>Two-factor authentication (‘true’ if the account has 2FA enabled)</p> 15266 <ul> 15267 <li>Config: 2fa</li> 15268 <li>Env Var: RCLONE_SEAFILE_2FA</li> 15269 <li>Type: bool</li> 15270 <li>Default: false</li> 15271 </ul> 15272 <h4 id="seafile-library">–seafile-library</h4> 15273 <p>Name of the library. Leave blank to access all non-encrypted libraries.</p> 15274 <ul> 15275 <li>Config: library</li> 15276 <li>Env Var: RCLONE_SEAFILE_LIBRARY</li> 15277 <li>Type: string</li> 15278 <li>Default: ""</li> 15279 </ul> 15280 <h4 id="seafile-library-key">–seafile-library-key</h4> 15281 <p>Library password (for encrypted libraries only). Leave blank if you pass it through the command line.</p> 15282 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 15283 <ul> 15284 <li>Config: library_key</li> 15285 <li>Env Var: RCLONE_SEAFILE_LIBRARY_KEY</li> 15286 <li>Type: string</li> 15287 <li>Default: ""</li> 15288 </ul> 15289 <h4 id="seafile-auth-token">–seafile-auth-token</h4> 15290 <p>Authentication token</p> 15291 <ul> 15292 <li>Config: auth_token</li> 15293 <li>Env Var: RCLONE_SEAFILE_AUTH_TOKEN</li> 15294 <li>Type: string</li> 15295 <li>Default: ""</li> 15296 </ul> 15297 <h3 id="advanced-options-28">Advanced Options</h3> 15298 <p>Here are the advanced options specific to seafile (seafile).</p> 15299 <h4 id="seafile-create-library">–seafile-create-library</h4> 15300 <p>Should rclone create a library if it doesn’t exist</p> 15301 <ul> 15302 <li>Config: create_library</li> 15303 <li>Env Var: RCLONE_SEAFILE_CREATE_LIBRARY</li> 15304 <li>Type: bool</li> 15305 <li>Default: false</li> 15306 </ul> 15307 <h4 id="seafile-encoding">–seafile-encoding</h4> 15308 <p>This sets the encoding for the backend.</p> 15309 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 15310 <ul> 15311 <li>Config: encoding</li> 15312 <li>Env Var: RCLONE_SEAFILE_ENCODING</li> 15313 <li>Type: MultiEncoder</li> 15314 <li>Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8</li> 15315 </ul> 15316 <h2 id="sftp">SFTP</h2> 15317 <p>SFTP is the <a href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">Secure (or SSH) File Transfer Protocol</a>.</p> 15318 <p>The SFTP backend can be used with a number of different providers:</p> 15319 <ul> 15320 <li>C14</li> 15321 <li>rsync.net</li> 15322 </ul> 15323 <p>SFTP runs over SSH v2 and is installed as standard with most modern SSH installations.</p> 15324 <p>Paths are specified as <code>remote:path</code>. If the path does not begin with a <code>/</code> it is relative to the home directory of the user. An empty path <code>remote:</code> refers to the user’s home directory.</p> 15325 <p>"Note that some SFTP servers will need the leading / - Synology is a good example of this. rsync.net, on the other hand, requires users to OMIT the leading /.</p> 15326 <p>Here is an example of making an SFTP configuration. First run</p> 15327 <pre><code>rclone config</code></pre> 15328 <p>This will guide you through an interactive setup process.</p> 15329 <pre><code>No remotes found - make a new one 15330 n) New remote 15331 s) Set configuration password 15332 q) Quit config 15333 n/s/q> n 15334 name> remote 15335 Type of storage to configure. 15336 Choose a number from below, or type in your own value 15337 [snip] 15338 XX / SSH/SFTP Connection 15339 \ "sftp" 15340 [snip] 15341 Storage> sftp 15342 SSH host to connect to 15343 Choose a number from below, or type in your own value 15344 1 / Connect to example.com 15345 \ "example.com" 15346 host> example.com 15347 SSH username, leave blank for current username, ncw 15348 user> sftpuser 15349 SSH port, leave blank to use default (22) 15350 port> 15351 SSH password, leave blank to use ssh-agent. 15352 y) Yes type in my own password 15353 g) Generate random password 15354 n) No leave this optional password blank 15355 y/g/n> n 15356 Path to unencrypted PEM-encoded private key file, leave blank to use ssh-agent. 15357 key_file> 15358 Remote config 15359 -------------------- 15360 [remote] 15361 host = example.com 15362 user = sftpuser 15363 port = 15364 pass = 15365 key_file = 15366 -------------------- 15367 y) Yes this is OK 15368 e) Edit this remote 15369 d) Delete this remote 15370 y/e/d> y</code></pre> 15371 <p>This remote is called <code>remote</code> and can now be used like this:</p> 15372 <p>See all directories in the home directory</p> 15373 <pre><code>rclone lsd remote:</code></pre> 15374 <p>Make a new directory</p> 15375 <pre><code>rclone mkdir remote:path/to/directory</code></pre> 15376 <p>List the contents of a directory</p> 15377 <pre><code>rclone ls remote:path/to/directory</code></pre> 15378 <p>Sync <code>/home/local/directory</code> to the remote directory, deleting any excess files in the directory.</p> 15379 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 15380 <h3 id="ssh-authentication">SSH Authentication</h3> 15381 <p>The SFTP remote supports three authentication methods:</p> 15382 <ul> 15383 <li>Password</li> 15384 <li>Key file</li> 15385 <li>ssh-agent</li> 15386 </ul> 15387 <p>Key files should be PEM-encoded private key files. For instance <code>/home/$USER/.ssh/id_rsa</code>. Only unencrypted OpenSSH or PEM encrypted files are supported.</p> 15388 <p>The key file can be specified in either an external file (key_file) or contained within the rclone config file (key_pem). If using key_pem in the config file, the entry should be on a single line with new line (‘’ or ‘’) separating lines. i.e. </p> 15389 <p>key_pem = —–BEGIN RSA PRIVATE KEY—–0gAMbMbaSsd—–END RSA PRIVATE KEY—–</p> 15390 <p>This will generate it correctly for key_pem for use in the config:</p> 15391 <pre><code>awk '{printf "%s\\n", $0}' < ~/.ssh/id_rsa</code></pre> 15392 <p>If you don’t specify <code>pass</code>, <code>key_file</code>, or <code>key_pem</code> then rclone will attempt to contact an ssh-agent.</p> 15393 <p>You can also specify <code>key_use_agent</code> to force the usage of an ssh-agent. In this case <code>key_file</code> or <code>key_pem</code> can also be specified to force the usage of a specific key in the ssh-agent.</p> 15394 <p>Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment.</p> 15395 <p>If you set the <code>--sftp-ask-password</code> option, rclone will prompt for a password when needed and no password has been configured.</p> 15396 <h3 id="ssh-agent-on-macos">ssh-agent on macOS</h3> 15397 <p>Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around seems to be to start an ssh-agent in each session, eg</p> 15398 <pre><code>eval `ssh-agent -s` && ssh-add -A</code></pre> 15399 <p>And then at the end of the session</p> 15400 <pre><code>eval `ssh-agent -k`</code></pre> 15401 <p>These commands can be used in scripts of course.</p> 15402 <h3 id="modified-time-12">Modified time</h3> 15403 <p>Modified times are stored on the server to 1 second precision.</p> 15404 <p>Modified times are used in syncing and are fully supported.</p> 15405 <p>Some SFTP servers disable setting/modifying the file modification time after upload (for example, certain configurations of ProFTPd with mod_sftp). If you are using one of these servers, you can set the option <code>set_modtime = false</code> in your RClone backend configuration to disable this behaviour.</p> 15406 <h3 id="standard-options-28">Standard Options</h3> 15407 <p>Here are the standard options specific to sftp (SSH/SFTP Connection).</p> 15408 <h4 id="sftp-host">–sftp-host</h4> 15409 <p>SSH host to connect to</p> 15410 <ul> 15411 <li>Config: host</li> 15412 <li>Env Var: RCLONE_SFTP_HOST</li> 15413 <li>Type: string</li> 15414 <li>Default: ""</li> 15415 <li>Examples: 15416 <ul> 15417 <li>“example.com” 15418 <ul> 15419 <li>Connect to example.com</li> 15420 </ul></li> 15421 </ul></li> 15422 </ul> 15423 <h4 id="sftp-user">–sftp-user</h4> 15424 <p>SSH username, leave blank for current username, ncw</p> 15425 <ul> 15426 <li>Config: user</li> 15427 <li>Env Var: RCLONE_SFTP_USER</li> 15428 <li>Type: string</li> 15429 <li>Default: ""</li> 15430 </ul> 15431 <h4 id="sftp-port">–sftp-port</h4> 15432 <p>SSH port, leave blank to use default (22)</p> 15433 <ul> 15434 <li>Config: port</li> 15435 <li>Env Var: RCLONE_SFTP_PORT</li> 15436 <li>Type: string</li> 15437 <li>Default: ""</li> 15438 </ul> 15439 <h4 id="sftp-pass">–sftp-pass</h4> 15440 <p>SSH password, leave blank to use ssh-agent.</p> 15441 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 15442 <ul> 15443 <li>Config: pass</li> 15444 <li>Env Var: RCLONE_SFTP_PASS</li> 15445 <li>Type: string</li> 15446 <li>Default: ""</li> 15447 </ul> 15448 <h4 id="sftp-key-pem">–sftp-key-pem</h4> 15449 <p>Raw PEM-encoded private key, If specified, will override key_file parameter.</p> 15450 <ul> 15451 <li>Config: key_pem</li> 15452 <li>Env Var: RCLONE_SFTP_KEY_PEM</li> 15453 <li>Type: string</li> 15454 <li>Default: ""</li> 15455 </ul> 15456 <h4 id="sftp-key-file">–sftp-key-file</h4> 15457 <p>Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.</p> 15458 <ul> 15459 <li>Config: key_file</li> 15460 <li>Env Var: RCLONE_SFTP_KEY_FILE</li> 15461 <li>Type: string</li> 15462 <li>Default: ""</li> 15463 </ul> 15464 <h4 id="sftp-key-file-pass">–sftp-key-file-pass</h4> 15465 <p>The passphrase to decrypt the PEM-encoded private key file.</p> 15466 <p>Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys in the new OpenSSH format can’t be used.</p> 15467 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 15468 <ul> 15469 <li>Config: key_file_pass</li> 15470 <li>Env Var: RCLONE_SFTP_KEY_FILE_PASS</li> 15471 <li>Type: string</li> 15472 <li>Default: ""</li> 15473 </ul> 15474 <h4 id="sftp-key-use-agent">–sftp-key-use-agent</h4> 15475 <p>When set forces the usage of the ssh-agent.</p> 15476 <p>When key-file is also set, the “.pub” file of the specified key-file is read and only the associated key is requested from the ssh-agent. This allows to avoid <code>Too many authentication failures for *username*</code> errors when the ssh-agent contains many keys.</p> 15477 <ul> 15478 <li>Config: key_use_agent</li> 15479 <li>Env Var: RCLONE_SFTP_KEY_USE_AGENT</li> 15480 <li>Type: bool</li> 15481 <li>Default: false</li> 15482 </ul> 15483 <h4 id="sftp-use-insecure-cipher">–sftp-use-insecure-cipher</h4> 15484 <p>Enable the use of insecure ciphers and key exchange methods.</p> 15485 <p>This enables the use of the following insecure ciphers and key exchange methods:</p> 15486 <ul> 15487 <li>aes128-cbc</li> 15488 <li>aes192-cbc</li> 15489 <li>aes256-cbc</li> 15490 <li>3des-cbc</li> 15491 <li>diffie-hellman-group-exchange-sha256</li> 15492 <li>diffie-hellman-group-exchange-sha1</li> 15493 </ul> 15494 <p>Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.</p> 15495 <ul> 15496 <li>Config: use_insecure_cipher</li> 15497 <li>Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER</li> 15498 <li>Type: bool</li> 15499 <li>Default: false</li> 15500 <li>Examples: 15501 <ul> 15502 <li>“false” 15503 <ul> 15504 <li>Use default Cipher list.</li> 15505 </ul></li> 15506 <li>“true” 15507 <ul> 15508 <li>Enables the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange.</li> 15509 </ul></li> 15510 </ul></li> 15511 </ul> 15512 <h4 id="sftp-disable-hashcheck">–sftp-disable-hashcheck</h4> 15513 <p>Disable the execution of SSH commands to determine if remote file hashing is available. Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.</p> 15514 <ul> 15515 <li>Config: disable_hashcheck</li> 15516 <li>Env Var: RCLONE_SFTP_DISABLE_HASHCHECK</li> 15517 <li>Type: bool</li> 15518 <li>Default: false</li> 15519 </ul> 15520 <h3 id="advanced-options-29">Advanced Options</h3> 15521 <p>Here are the advanced options specific to sftp (SSH/SFTP Connection).</p> 15522 <h4 id="sftp-ask-password">–sftp-ask-password</h4> 15523 <p>Allow asking for SFTP password when needed.</p> 15524 <p>If this is set and no password is supplied then rclone will: - ask for a password - not contact the ssh agent</p> 15525 <ul> 15526 <li>Config: ask_password</li> 15527 <li>Env Var: RCLONE_SFTP_ASK_PASSWORD</li> 15528 <li>Type: bool</li> 15529 <li>Default: false</li> 15530 </ul> 15531 <h4 id="sftp-path-override">–sftp-path-override</h4> 15532 <p>Override path used by SSH connection.</p> 15533 <p>This allows checksum calculation when SFTP and SSH paths are different. This issue affects among others Synology NAS boxes.</p> 15534 <p>Shared folders can be found in directories representing volumes</p> 15535 <pre><code>rclone sync /home/local/directory remote:/directory --ssh-path-override /volume2/directory</code></pre> 15536 <p>Home directory can be found in a shared folder called “home”</p> 15537 <pre><code>rclone sync /home/local/directory remote:/home/directory --ssh-path-override /volume1/homes/USER/directory</code></pre> 15538 <ul> 15539 <li>Config: path_override</li> 15540 <li>Env Var: RCLONE_SFTP_PATH_OVERRIDE</li> 15541 <li>Type: string</li> 15542 <li>Default: ""</li> 15543 </ul> 15544 <h4 id="sftp-set-modtime">–sftp-set-modtime</h4> 15545 <p>Set the modified time on the remote if set.</p> 15546 <ul> 15547 <li>Config: set_modtime</li> 15548 <li>Env Var: RCLONE_SFTP_SET_MODTIME</li> 15549 <li>Type: bool</li> 15550 <li>Default: true</li> 15551 </ul> 15552 <h4 id="sftp-md5sum-command">–sftp-md5sum-command</h4> 15553 <p>The command used to read md5 hashes. Leave blank for autodetect.</p> 15554 <ul> 15555 <li>Config: md5sum_command</li> 15556 <li>Env Var: RCLONE_SFTP_MD5SUM_COMMAND</li> 15557 <li>Type: string</li> 15558 <li>Default: ""</li> 15559 </ul> 15560 <h4 id="sftp-sha1sum-command">–sftp-sha1sum-command</h4> 15561 <p>The command used to read sha1 hashes. Leave blank for autodetect.</p> 15562 <ul> 15563 <li>Config: sha1sum_command</li> 15564 <li>Env Var: RCLONE_SFTP_SHA1SUM_COMMAND</li> 15565 <li>Type: string</li> 15566 <li>Default: ""</li> 15567 </ul> 15568 <h4 id="sftp-skip-links">–sftp-skip-links</h4> 15569 <p>Set to skip any symlinks and any other non regular files.</p> 15570 <ul> 15571 <li>Config: skip_links</li> 15572 <li>Env Var: RCLONE_SFTP_SKIP_LINKS</li> 15573 <li>Type: bool</li> 15574 <li>Default: false</li> 15575 </ul> 15576 <h3 id="limitations-19">Limitations</h3> 15577 <p>SFTP supports checksums if the same login has shell access and <code>md5sum</code> or <code>sha1sum</code> as well as <code>echo</code> are in the remote’s PATH. This remote checksumming (file hashing) is recommended and enabled by default. Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option <code>disable_hashcheck</code> to <code>true</code> to disable checksumming.</p> 15578 <p>SFTP also supports <code>about</code> if the same login has shell access and <code>df</code> are in the remote’s PATH. <code>about</code> will return the total space, free space, and used space on the remote for the disk of the specified path on the remote or, if not set, the disk of the root on the remote. <code>about</code> will fail if it does not have shell access or if <code>df</code> is not in the remote’s PATH.</p> 15579 <p>Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can’t be calculated properly. For them using <code>disable_hashcheck</code> is a good idea.</p> 15580 <p>The only ssh agent supported under Windows is Putty’s pageant.</p> 15581 <p>The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the <code>use_insecure_cipher</code> setting in the configuration file to <code>true</code>. Further details on the insecurity of this cipher can be found [in this paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf).</p> 15582 <p>SFTP isn’t supported under plan9 until <a href="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p> 15583 <p>Note that since SFTP isn’t HTTP based the following flags don’t work with it: <code>--dump-headers</code>, <code>--dump-bodies</code>, <code>--dump-auth</code></p> 15584 <p>Note that <code>--timeout</code> isn’t supported (but <code>--contimeout</code> is).</p> 15585 <h2 id="c14">C14</h2> 15586 <p>C14 is supported through the SFTP backend.</p> 15587 <p>See <a href="https://www.online.net/en/storage/c14-cold-storage">C14’s documentation</a></p> 15588 <h2 id="rsync-net">rsync.net</h2> 15589 <p>rsync.net is supported through the SFTP backend.</p> 15590 <p>See <a href="https://www.rsync.net/products/rclone.html">rsync.net’s documentation of rclone examples</a>.</p> 15591 <h2 id="sugarsync">SugarSync</h2> 15592 <p><a href="https://sugarsync.com">SugarSync</a> is a cloud service that enables active synchronization of files across computers and other devices for file backup, access, syncing, and sharing.</p> 15593 <p>The initial setup for SugarSync involves getting a token from SugarSync which you can do with rclone. <code>rclone config</code> walks you through it.</p> 15594 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 15595 <pre><code> rclone config</code></pre> 15596 <p>This will guide you through an interactive setup process:</p> 15597 <pre><code>No remotes found - make a new one 15598 n) New remote 15599 s) Set configuration password 15600 q) Quit config 15601 n/s/q> n 15602 name> remote 15603 Type of storage to configure. 15604 Enter a string value. Press Enter for the default (""). 15605 Choose a number from below, or type in your own value 15606 [snip] 15607 XX / Sugarsync 15608 \ "sugarsync" 15609 [snip] 15610 Storage> sugarsync 15611 ** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** 15612 15613 Sugarsync App ID. 15614 Leave blank to use rclone's. 15615 Enter a string value. Press Enter for the default (""). 15616 app_id> 15617 Sugarsync Access Key ID. 15618 Leave blank to use rclone's. 15619 Enter a string value. Press Enter for the default (""). 15620 access_key_id> 15621 Sugarsync Private Access Key 15622 Leave blank to use rclone's. 15623 Enter a string value. Press Enter for the default (""). 15624 private_access_key> 15625 Permanently delete files if true 15626 otherwise put them in the deleted files. 15627 Enter a boolean value (true or false). Press Enter for the default ("false"). 15628 hard_delete> 15629 Edit advanced config? (y/n) 15630 y) Yes 15631 n) No (default) 15632 y/n> n 15633 Remote config 15634 Username (email address)> nick@craig-wood.com 15635 Your Sugarsync password is only required during setup and will not be stored. 15636 password: 15637 -------------------- 15638 [remote] 15639 type = sugarsync 15640 refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX 15641 -------------------- 15642 y) Yes this is OK (default) 15643 e) Edit this remote 15644 d) Delete this remote 15645 y/e/d> y</code></pre> 15646 <p>Note that the config asks for your email and password but doesn’t store them, it only uses them to get the initial token.</p> 15647 <p>Once configured you can then use <code>rclone</code> like this,</p> 15648 <p>List directories (sync folders) in top level of your SugarSync</p> 15649 <pre><code>rclone lsd remote:</code></pre> 15650 <p>List all the files in your SugarSync folder “Test”</p> 15651 <pre><code>rclone ls remote:Test</code></pre> 15652 <p>To copy a local directory to an SugarSync folder called backup</p> 15653 <pre><code>rclone copy /home/source remote:backup</code></pre> 15654 <p>Paths are specified as <code>remote:path</code></p> 15655 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 15656 <p><strong>NB</strong> you can’t create files in the top level folder you have to create a folder, which rclone will create as a “Sync Folder” with SugarSync.</p> 15657 <h3 id="modified-time-and-hashes-10">Modified time and hashes</h3> 15658 <p>SugarSync does not support modification times or hashes, therefore syncing will default to <code>--size-only</code> checking. Note that using <code>--update</code> will work as rclone can read the time files were uploaded.</p> 15659 <h4 id="restricted-filename-characters-24">Restricted filename characters</h4> 15660 <p>SugarSync replaces the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> except for DEL.</p> 15661 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in XML strings.</p> 15662 <h3 id="deleting-files-7">Deleting files</h3> 15663 <p>Deleted files will be moved to the “Deleted items” folder by default.</p> 15664 <p>However you can supply the flag <code>--sugarsync-hard-delete</code> or set the config parameter <code>hard_delete = true</code> if you would like files to be deleted straight away.</p> 15665 <h3 id="standard-options-29">Standard Options</h3> 15666 <p>Here are the standard options specific to sugarsync (Sugarsync).</p> 15667 <h4 id="sugarsync-app-id">–sugarsync-app-id</h4> 15668 <p>Sugarsync App ID.</p> 15669 <p>Leave blank to use rclone’s.</p> 15670 <ul> 15671 <li>Config: app_id</li> 15672 <li>Env Var: RCLONE_SUGARSYNC_APP_ID</li> 15673 <li>Type: string</li> 15674 <li>Default: ""</li> 15675 </ul> 15676 <h4 id="sugarsync-access-key-id">–sugarsync-access-key-id</h4> 15677 <p>Sugarsync Access Key ID.</p> 15678 <p>Leave blank to use rclone’s.</p> 15679 <ul> 15680 <li>Config: access_key_id</li> 15681 <li>Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID</li> 15682 <li>Type: string</li> 15683 <li>Default: ""</li> 15684 </ul> 15685 <h4 id="sugarsync-private-access-key">–sugarsync-private-access-key</h4> 15686 <p>Sugarsync Private Access Key</p> 15687 <p>Leave blank to use rclone’s.</p> 15688 <ul> 15689 <li>Config: private_access_key</li> 15690 <li>Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY</li> 15691 <li>Type: string</li> 15692 <li>Default: ""</li> 15693 </ul> 15694 <h4 id="sugarsync-hard-delete">–sugarsync-hard-delete</h4> 15695 <p>Permanently delete files if true otherwise put them in the deleted files.</p> 15696 <ul> 15697 <li>Config: hard_delete</li> 15698 <li>Env Var: RCLONE_SUGARSYNC_HARD_DELETE</li> 15699 <li>Type: bool</li> 15700 <li>Default: false</li> 15701 </ul> 15702 <h3 id="advanced-options-30">Advanced Options</h3> 15703 <p>Here are the advanced options specific to sugarsync (Sugarsync).</p> 15704 <h4 id="sugarsync-refresh-token">–sugarsync-refresh-token</h4> 15705 <p>Sugarsync refresh token</p> 15706 <p>Leave blank normally, will be auto configured by rclone.</p> 15707 <ul> 15708 <li>Config: refresh_token</li> 15709 <li>Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN</li> 15710 <li>Type: string</li> 15711 <li>Default: ""</li> 15712 </ul> 15713 <h4 id="sugarsync-authorization">–sugarsync-authorization</h4> 15714 <p>Sugarsync authorization</p> 15715 <p>Leave blank normally, will be auto configured by rclone.</p> 15716 <ul> 15717 <li>Config: authorization</li> 15718 <li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION</li> 15719 <li>Type: string</li> 15720 <li>Default: ""</li> 15721 </ul> 15722 <h4 id="sugarsync-authorization-expiry">–sugarsync-authorization-expiry</h4> 15723 <p>Sugarsync authorization expiry</p> 15724 <p>Leave blank normally, will be auto configured by rclone.</p> 15725 <ul> 15726 <li>Config: authorization_expiry</li> 15727 <li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY</li> 15728 <li>Type: string</li> 15729 <li>Default: ""</li> 15730 </ul> 15731 <h4 id="sugarsync-user">–sugarsync-user</h4> 15732 <p>Sugarsync user</p> 15733 <p>Leave blank normally, will be auto configured by rclone.</p> 15734 <ul> 15735 <li>Config: user</li> 15736 <li>Env Var: RCLONE_SUGARSYNC_USER</li> 15737 <li>Type: string</li> 15738 <li>Default: ""</li> 15739 </ul> 15740 <h4 id="sugarsync-root-id">–sugarsync-root-id</h4> 15741 <p>Sugarsync root id</p> 15742 <p>Leave blank normally, will be auto configured by rclone.</p> 15743 <ul> 15744 <li>Config: root_id</li> 15745 <li>Env Var: RCLONE_SUGARSYNC_ROOT_ID</li> 15746 <li>Type: string</li> 15747 <li>Default: ""</li> 15748 </ul> 15749 <h4 id="sugarsync-deleted-id">–sugarsync-deleted-id</h4> 15750 <p>Sugarsync deleted folder id</p> 15751 <p>Leave blank normally, will be auto configured by rclone.</p> 15752 <ul> 15753 <li>Config: deleted_id</li> 15754 <li>Env Var: RCLONE_SUGARSYNC_DELETED_ID</li> 15755 <li>Type: string</li> 15756 <li>Default: ""</li> 15757 </ul> 15758 <h4 id="sugarsync-encoding">–sugarsync-encoding</h4> 15759 <p>This sets the encoding for the backend.</p> 15760 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 15761 <ul> 15762 <li>Config: encoding</li> 15763 <li>Env Var: RCLONE_SUGARSYNC_ENCODING</li> 15764 <li>Type: MultiEncoder</li> 15765 <li>Default: Slash,Ctl,InvalidUtf8,Dot</li> 15766 </ul> 15767 <h2 id="tardigrade">Tardigrade</h2> 15768 <p><a href="https://tardigrade.io">Tardigrade</a> is an encrypted, secure, and cost-effective object storage service that enables you to store, back up, and archive large amounts of data in a decentralized manner.</p> 15769 <h2 id="setup-3">Setup</h2> 15770 <p>To make a new Tardigrade configuration you need one of the following: * Access Grant that someone else shared with you. * <a href="https://documentation.tardigrade.io/getting-started/uploading-your-first-object/create-an-api-key">API Key</a> of a Tardigrade project you are a member of.</p> 15771 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 15772 <pre><code> rclone config</code></pre> 15773 <p>This will guide you through an interactive setup process:</p> 15774 <h3 id="setup-with-access-grant">Setup with access grant</h3> 15775 <pre><code>No remotes found - make a new one 15776 n) New remote 15777 s) Set configuration password 15778 q) Quit config 15779 n/s/q> n 15780 name> remote 15781 Type of storage to configure. 15782 Enter a string value. Press Enter for the default (""). 15783 Choose a number from below, or type in your own value 15784 [snip] 15785 XX / Tardigrade Decentralized Cloud Storage 15786 \ "tardigrade" 15787 [snip] 15788 Storage> tardigrade 15789 ** See help for tardigrade backend at: https://rclone.org/tardigrade/ ** 15790 15791 Choose an authentication method. 15792 Enter a string value. Press Enter for the default ("existing"). 15793 Choose a number from below, or type in your own value 15794 1 / Use an existing access grant. 15795 \ "existing" 15796 2 / Create a new access grant from satellite address, API key, and passphrase. 15797 \ "new" 15798 provider> existing 15799 Access Grant. 15800 Enter a string value. Press Enter for the default (""). 15801 access_grant> your-access-grant-received-by-someone-else 15802 Remote config 15803 -------------------- 15804 [remote] 15805 type = tardigrade 15806 access_grant = your-access-grant-received-by-someone-else 15807 -------------------- 15808 y) Yes this is OK (default) 15809 e) Edit this remote 15810 d) Delete this remote 15811 y/e/d> y</code></pre> 15812 <h3 id="setup-with-api-key-and-passhprase">Setup with API key and passhprase</h3> 15813 <pre><code>No remotes found - make a new one 15814 n) New remote 15815 s) Set configuration password 15816 q) Quit config 15817 n/s/q> n 15818 name> remote 15819 Type of storage to configure. 15820 Enter a string value. Press Enter for the default (""). 15821 Choose a number from below, or type in your own value 15822 [snip] 15823 XX / Tardigrade Decentralized Cloud Storage 15824 \ "tardigrade" 15825 [snip] 15826 Storage> tardigrade 15827 ** See help for tardigrade backend at: https://rclone.org/tardigrade/ ** 15828 15829 Choose an authentication method. 15830 Enter a string value. Press Enter for the default ("existing"). 15831 Choose a number from below, or type in your own value 15832 1 / Use an existing access grant. 15833 \ "existing" 15834 2 / Create a new access grant from satellite address, API key, and passphrase. 15835 \ "new" 15836 provider> new 15837 Satellite Address. Custom satellite address should match the format: `<nodeid>@<address>:<port>`. 15838 Enter a string value. Press Enter for the default ("us-central-1.tardigrade.io"). 15839 Choose a number from below, or type in your own value 15840 1 / US Central 1 15841 \ "us-central-1.tardigrade.io" 15842 2 / Europe West 1 15843 \ "europe-west-1.tardigrade.io" 15844 3 / Asia East 1 15845 \ "asia-east-1.tardigrade.io" 15846 satellite_address> 1 15847 API Key. 15848 Enter a string value. Press Enter for the default (""). 15849 api_key> your-api-key-for-your-tardigrade-project 15850 Encryption Passphrase. To access existing objects enter passphrase used for uploading. 15851 Enter a string value. Press Enter for the default (""). 15852 passphrase> your-human-readable-encryption-passphrase 15853 Remote config 15854 -------------------- 15855 [remote] 15856 type = tardigrade 15857 satellite_address = 12EayRS2V1kEsWESU9QMRseFhdxYxKicsiFmxrsLZHeLUtdps3S@us-central-1.tardigrade.io:7777 15858 api_key = your-api-key-for-your-tardigrade-project 15859 passphrase = your-human-readable-encryption-passphrase 15860 access_grant = the-access-grant-generated-from-the-api-key-and-passphrase 15861 -------------------- 15862 y) Yes this is OK (default) 15863 e) Edit this remote 15864 d) Delete this remote 15865 y/e/d> y</code></pre> 15866 <h2 id="usage-1">Usage</h2> 15867 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsf</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p> 15868 <p>Once configured you can then use <code>rclone</code> like this.</p> 15869 <h3 id="create-a-new-bucket">Create a new bucket</h3> 15870 <p>Use the <code>mkdir</code> command to create new bucket, e.g. <code>bucket</code>.</p> 15871 <pre><code>rclone mkdir remote:bucket</code></pre> 15872 <h3 id="list-all-buckets">List all buckets</h3> 15873 <p>Use the <code>lsf</code> command to list all buckets.</p> 15874 <pre><code>rclone lsf remote:</code></pre> 15875 <p>Note the colon (<code>:</code>) character at the end of the command line.</p> 15876 <h3 id="delete-a-bucket">Delete a bucket</h3> 15877 <p>Use the <code>rmdir</code> command to delete an empty bucket.</p> 15878 <pre><code>rclone rmdir remote:bucket</code></pre> 15879 <p>Use the <code>purge</code> command to delete a non-empty bucket with all its content.</p> 15880 <pre><code>rclone purge remote:bucket</code></pre> 15881 <h3 id="upload-objects">Upload objects</h3> 15882 <p>Use the <code>copy</code> command to upload an object.</p> 15883 <pre><code>rclone copy --progress /home/local/directory/file.ext remote:bucket/path/to/dir/</code></pre> 15884 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don’t need this information.</p> 15885 <p>Use a folder in the local path to upload all its objects.</p> 15886 <pre><code>rclone copy --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre> 15887 <p>Only modified files will be copied.</p> 15888 <h3 id="list-objects">List objects</h3> 15889 <p>Use the <code>ls</code> command to list recursively all objects in a bucket.</p> 15890 <pre><code>rclone ls remote:bucket</code></pre> 15891 <p>Add the folder to the remote path to list recursively all objects in this folder.</p> 15892 <pre><code>rclone ls remote:bucket/path/to/dir/</code></pre> 15893 <p>Use the <code>lsf</code> command to list non-recursively all objects in a bucket or a folder.</p> 15894 <pre><code>rclone lsf remote:bucket/path/to/dir/</code></pre> 15895 <h3 id="download-objects">Download objects</h3> 15896 <p>Use the <code>copy</code> command to download an object.</p> 15897 <pre><code>rclone copy --progress remote:bucket/path/to/dir/file.ext /home/local/directory/</code></pre> 15898 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don’t need this information.</p> 15899 <p>Use a folder in the remote path to download all its objects.</p> 15900 <pre><code>rclone copy --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre> 15901 <h3 id="delete-objects">Delete objects</h3> 15902 <p>Use the <code>deletefile</code> command to delete a single object.</p> 15903 <pre><code>rclone deletefile remote:bucket/path/to/dir/file.ext</code></pre> 15904 <p>Use the <code>delete</code> command to delete all object in a folder.</p> 15905 <pre><code>rclone delete remote:bucket/path/to/dir/</code></pre> 15906 <h3 id="print-the-total-size-of-objects">Print the total size of objects</h3> 15907 <p>Use the <code>size</code> command to print the total size of objects in a bucket or a folder.</p> 15908 <pre><code>rclone size remote:bucket/path/to/dir/</code></pre> 15909 <h3 id="sync-two-locations">Sync two Locations</h3> 15910 <p>Use the <code>sync</code> command to sync the source to the destination, changing the destination only, deleting any excess files.</p> 15911 <pre><code>rclone sync --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre> 15912 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don’t need this information.</p> 15913 <p>Since this can cause data loss, test first with the <code>--dry-run</code> flag to see exactly what would be copied and deleted.</p> 15914 <p>The sync can be done also from Tardigrade to the local file system.</p> 15915 <pre><code>rclone sync --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre> 15916 <p>Or between two Tardigrade buckets.</p> 15917 <pre><code>rclone sync --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/</code></pre> 15918 <p>Or even between another cloud storage and Tardigrade.</p> 15919 <pre><code>rclone sync --progress s3:bucket/path/to/dir/ tardigrade:bucket/path/to/dir/</code></pre> 15920 <h3 id="standard-options-30">Standard Options</h3> 15921 <p>Here are the standard options specific to tardigrade (Tardigrade Decentralized Cloud Storage).</p> 15922 <h4 id="tardigrade-provider">–tardigrade-provider</h4> 15923 <p>Choose an authentication method.</p> 15924 <ul> 15925 <li>Config: provider</li> 15926 <li>Env Var: RCLONE_TARDIGRADE_PROVIDER</li> 15927 <li>Type: string</li> 15928 <li>Default: “existing”</li> 15929 <li>Examples: 15930 <ul> 15931 <li>“existing” 15932 <ul> 15933 <li>Use an existing access grant.</li> 15934 </ul></li> 15935 <li>“new” 15936 <ul> 15937 <li>Create a new access grant from satellite address, API key, and passphrase.</li> 15938 </ul></li> 15939 </ul></li> 15940 </ul> 15941 <h4 id="tardigrade-access-grant">–tardigrade-access-grant</h4> 15942 <p>Access Grant.</p> 15943 <ul> 15944 <li>Config: access_grant</li> 15945 <li>Env Var: RCLONE_TARDIGRADE_ACCESS_GRANT</li> 15946 <li>Type: string</li> 15947 <li>Default: ""</li> 15948 </ul> 15949 <h4 id="tardigrade-satellite-address">–tardigrade-satellite-address</h4> 15950 <p>Satellite Address. Custom satellite address should match the format: <code><nodeid>@<address>:<port></code>.</p> 15951 <ul> 15952 <li>Config: satellite_address</li> 15953 <li>Env Var: RCLONE_TARDIGRADE_SATELLITE_ADDRESS</li> 15954 <li>Type: string</li> 15955 <li>Default: “us-central-1.tardigrade.io”</li> 15956 <li>Examples: 15957 <ul> 15958 <li>“us-central-1.tardigrade.io” 15959 <ul> 15960 <li>US Central 1</li> 15961 </ul></li> 15962 <li>“europe-west-1.tardigrade.io” 15963 <ul> 15964 <li>Europe West 1</li> 15965 </ul></li> 15966 <li>“asia-east-1.tardigrade.io” 15967 <ul> 15968 <li>Asia East 1</li> 15969 </ul></li> 15970 </ul></li> 15971 </ul> 15972 <h4 id="tardigrade-api-key">–tardigrade-api-key</h4> 15973 <p>API Key.</p> 15974 <ul> 15975 <li>Config: api_key</li> 15976 <li>Env Var: RCLONE_TARDIGRADE_API_KEY</li> 15977 <li>Type: string</li> 15978 <li>Default: ""</li> 15979 </ul> 15980 <h4 id="tardigrade-passphrase">–tardigrade-passphrase</h4> 15981 <p>Encryption Passphrase. To access existing objects enter passphrase used for uploading.</p> 15982 <ul> 15983 <li>Config: passphrase</li> 15984 <li>Env Var: RCLONE_TARDIGRADE_PASSPHRASE</li> 15985 <li>Type: string</li> 15986 <li>Default: ""</li> 15987 </ul> 15988 <h2 id="union">Union</h2> 15989 <p>The <code>union</code> remote provides a unification similar to UnionFS using other remotes.</p> 15990 <p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p> 15991 <p>During the initial setup with <code>rclone config</code> you will specify the upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes.</p> 15992 <p>Attribute <code>:ro</code> and <code>:nc</code> can be attach to the end of path to tag the remote as <strong>read only</strong> or <strong>no create</strong>, eg <code>remote:directory/subdirectory:ro</code> or <code>remote:directory/subdirectory:nc</code>.</p> 15993 <p>Subfolders can be used in upstream remotes. Assume a union remote named <code>backup</code> with the remotes <code>mydrive:private/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive2:/backup/desktop</code>.</p> 15994 <p>There will be no special handling of paths containing <code>..</code> segments. Invoking <code>rclone mkdir backup:../desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive2:/backup/../desktop</code>.</p> 15995 <h3 id="behavior-policies">Behavior / Policies</h3> 15996 <p>The behavior of union backend is inspired by <a href="https://github.com/trapexit/mergerfs">trapexit/mergerfs</a>. All functions are grouped into 3 categories: <strong>action</strong>, <strong>create</strong> and <strong>search</strong>. These functions and categories can be assigned a policy which dictates what file or directory is chosen when performing that behavior. Any policy can be assigned to a function or category though some may not be very useful in practice. For instance: <strong>rand</strong> (random) may be useful for file creation (create) but could lead to very odd behavior if used for <code>delete</code> if there were more than one copy of the file.</p> 15997 <h4 id="function-category-classifications">Function / Category classifications</h4> 15998 <table> 15999 <colgroup> 16000 <col style="width: 8%" /> 16001 <col style="width: 21%" /> 16002 <col style="width: 70%" /> 16003 </colgroup> 16004 <thead> 16005 <tr class="header"> 16006 <th>Category</th> 16007 <th>Description</th> 16008 <th>Functions</th> 16009 </tr> 16010 </thead> 16011 <tbody> 16012 <tr class="odd"> 16013 <td>action</td> 16014 <td>Writing Existing file</td> 16015 <td>move, rmdir, rmdirs, delete, purge and copy, sync (as destination when file exist)</td> 16016 </tr> 16017 <tr class="even"> 16018 <td>create</td> 16019 <td>Create non-existing file</td> 16020 <td>copy, sync (as destination when file not exist)</td> 16021 </tr> 16022 <tr class="odd"> 16023 <td>search</td> 16024 <td>Reading and listing file</td> 16025 <td>ls, lsd, lsl, cat, md5sum, sha1sum and copy, sync (as source)</td> 16026 </tr> 16027 <tr class="even"> 16028 <td>N/A</td> 16029 <td></td> 16030 <td>size, about</td> 16031 </tr> 16032 </tbody> 16033 </table> 16034 <h4 id="path-preservation">Path Preservation</h4> 16035 <p>Policies, as described below, are of two basic types. <code>path preserving</code> and <code>non-path preserving</code>.</p> 16036 <p>All policies which start with <code>ep</code> (<strong>epff</strong>, <strong>eplfs</strong>, <strong>eplus</strong>, <strong>epmfs</strong>, <strong>eprand</strong>) are <code>path preserving</code>. <code>ep</code> stands for <code>existing path</code>.</p> 16037 <p>A path preserving policy will only consider upstreams where the relative path being accessed already exists.</p> 16038 <p>When using non-path preserving policies paths will be created in target upstreams as necessary.</p> 16039 <h4 id="quota-relevant-policies">Quota Relevant Policies</h4> 16040 <p>Some policies rely on quota information. These policies should be used only if your upstreams support the respective quota fields.</p> 16041 <table> 16042 <thead> 16043 <tr class="header"> 16044 <th>Policy</th> 16045 <th>Required Field</th> 16046 </tr> 16047 </thead> 16048 <tbody> 16049 <tr class="odd"> 16050 <td>lfs, eplfs</td> 16051 <td>Free</td> 16052 </tr> 16053 <tr class="even"> 16054 <td>mfs, epmfs</td> 16055 <td>Free</td> 16056 </tr> 16057 <tr class="odd"> 16058 <td>lus, eplus</td> 16059 <td>Used</td> 16060 </tr> 16061 <tr class="even"> 16062 <td>lno, eplno</td> 16063 <td>Objects</td> 16064 </tr> 16065 </tbody> 16066 </table> 16067 <p>To check if your upstream supports the field, run <code>rclone about remote: [flags]</code> and see if the required field exists.</p> 16068 <h4 id="filters-1">Filters</h4> 16069 <p>Policies basically search upstream remotes and create a list of files / paths for functions to work on. The policy is responsible for filtering and sorting. The policy type defines the sorting but filtering is mostly uniform as described below.</p> 16070 <ul> 16071 <li>No <strong>search</strong> policies filter.</li> 16072 <li>All <strong>action</strong> policies will filter out remotes which are tagged as <strong>read-only</strong>.</li> 16073 <li>All <strong>create</strong> policies will filter out remotes which are tagged <strong>read-only</strong> or <strong>no-create</strong>.</li> 16074 </ul> 16075 <p>If all remotes are filtered an error will be returned.</p> 16076 <h4 id="policy-descriptions">Policy descriptions</h4> 16077 <p>The policies definition are inspired by <a href="https://github.com/trapexit/mergerfs">trapexit/mergerfs</a> but not exactly the same. Some policy definition could be different due to the much larger latency of remote file systems.</p> 16078 <table> 16079 <colgroup> 16080 <col style="width: 23%" /> 16081 <col style="width: 76%" /> 16082 </colgroup> 16083 <thead> 16084 <tr class="header"> 16085 <th>Policy</th> 16086 <th>Description</th> 16087 </tr> 16088 </thead> 16089 <tbody> 16090 <tr class="odd"> 16091 <td>all</td> 16092 <td>Search category: same as <strong>epall</strong>. Action category: same as <strong>epall</strong>. Create category: act on all upstreams.</td> 16093 </tr> 16094 <tr class="even"> 16095 <td>epall (existing path, all)</td> 16096 <td>Search category: Given this order configured, act on the first one found where the relative path exists. Action category: apply to all found. Create category: act on all upstreams where the relative path exists.</td> 16097 </tr> 16098 <tr class="odd"> 16099 <td>epff (existing path, first found)</td> 16100 <td>Act on the first one found, by the time upstreams reply, where the relative path exists.</td> 16101 </tr> 16102 <tr class="even"> 16103 <td>eplfs (existing path, least free space)</td> 16104 <td>Of all the upstreams on which the relative path exists choose the one with the least free space.</td> 16105 </tr> 16106 <tr class="odd"> 16107 <td>eplus (existing path, least used space)</td> 16108 <td>Of all the upstreams on which the relative path exists choose the one with the least used space.</td> 16109 </tr> 16110 <tr class="even"> 16111 <td>eplno (existing path, least number of objects)</td> 16112 <td>Of all the upstreams on which the relative path exists choose the one with the least number of objects.</td> 16113 </tr> 16114 <tr class="odd"> 16115 <td>epmfs (existing path, most free space)</td> 16116 <td>Of all the upstreams on which the relative path exists choose the one with the most free space.</td> 16117 </tr> 16118 <tr class="even"> 16119 <td>eprand (existing path, random)</td> 16120 <td>Calls <strong>epall</strong> and then randomizes. Returns only one upstream.</td> 16121 </tr> 16122 <tr class="odd"> 16123 <td>ff (first found)</td> 16124 <td>Search category: same as <strong>epff</strong>. Action category: same as <strong>epff</strong>. Create category: Act on the first one found by the time upstreams reply.</td> 16125 </tr> 16126 <tr class="even"> 16127 <td>lfs (least free space)</td> 16128 <td>Search category: same as <strong>eplfs</strong>. Action category: same as <strong>eplfs</strong>. Create category: Pick the upstream with the least available free space.</td> 16129 </tr> 16130 <tr class="odd"> 16131 <td>lus (least used space)</td> 16132 <td>Search category: same as <strong>eplus</strong>. Action category: same as <strong>eplus</strong>. Create category: Pick the upstream with the least used space.</td> 16133 </tr> 16134 <tr class="even"> 16135 <td>lno (least number of objects)</td> 16136 <td>Search category: same as <strong>eplno</strong>. Action category: same as <strong>eplno</strong>. Create category: Pick the upstream with the least number of objects.</td> 16137 </tr> 16138 <tr class="odd"> 16139 <td>mfs (most free space)</td> 16140 <td>Search category: same as <strong>epmfs</strong>. Action category: same as <strong>epmfs</strong>. Create category: Pick the upstream with the most available free space.</td> 16141 </tr> 16142 <tr class="even"> 16143 <td>newest</td> 16144 <td>Pick the file / directory with the largest mtime.</td> 16145 </tr> 16146 <tr class="odd"> 16147 <td>rand (random)</td> 16148 <td>Calls <strong>all</strong> and then randomizes. Returns only one upstream.</td> 16149 </tr> 16150 </tbody> 16151 </table> 16152 <h3 id="setup-4">Setup</h3> 16153 <p>Here is an example of how to make a union called <code>remote</code> for local folders. First run:</p> 16154 <pre><code> rclone config</code></pre> 16155 <p>This will guide you through an interactive setup process:</p> 16156 <pre><code>No remotes found - make a new one 16157 n) New remote 16158 s) Set configuration password 16159 q) Quit config 16160 n/s/q> n 16161 name> remote 16162 Type of storage to configure. 16163 Choose a number from below, or type in your own value 16164 [snip] 16165 XX / Union merges the contents of several remotes 16166 \ "union" 16167 [snip] 16168 Storage> union 16169 List of space separated upstreams. 16170 Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. 16171 Enter a string value. Press Enter for the default (""). 16172 upstreams> 16173 Policy to choose upstream on ACTION class. 16174 Enter a string value. Press Enter for the default ("epall"). 16175 action_policy> 16176 Policy to choose upstream on CREATE class. 16177 Enter a string value. Press Enter for the default ("epmfs"). 16178 create_policy> 16179 Policy to choose upstream on SEARCH class. 16180 Enter a string value. Press Enter for the default ("ff"). 16181 search_policy> 16182 Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. 16183 Enter a signed integer. Press Enter for the default ("120"). 16184 cache_time> 16185 Remote config 16186 -------------------- 16187 [remote] 16188 type = union 16189 upstreams = C:\dir1 C:\dir2 C:\dir3 16190 -------------------- 16191 y) Yes this is OK 16192 e) Edit this remote 16193 d) Delete this remote 16194 y/e/d> y 16195 Current remotes: 16196 16197 Name Type 16198 ==== ==== 16199 remote union 16200 16201 e) Edit existing remote 16202 n) New remote 16203 d) Delete remote 16204 r) Rename remote 16205 c) Copy remote 16206 s) Set configuration password 16207 q) Quit config 16208 e/n/d/r/c/s/q> q</code></pre> 16209 <p>Once configured you can then use <code>rclone</code> like this,</p> 16210 <p>List directories in top level in <code>C:\dir1</code>, <code>C:\dir2</code> and <code>C:\dir3</code></p> 16211 <pre><code>rclone lsd remote:</code></pre> 16212 <p>List all the files in <code>C:\dir1</code>, <code>C:\dir2</code> and <code>C:\dir3</code></p> 16213 <pre><code>rclone ls remote:</code></pre> 16214 <p>Copy another local directory to the union directory called source, which will be placed into <code>C:\dir3</code></p> 16215 <pre><code>rclone copy C:\source remote:source</code></pre> 16216 <h3 id="standard-options-31">Standard Options</h3> 16217 <p>Here are the standard options specific to union (Union merges the contents of several upstream fs).</p> 16218 <h4 id="union-upstreams">–union-upstreams</h4> 16219 <p>List of space separated upstreams. Can be ‘upstreama:test/dir upstreamb:’, ‘“upstreama:test/space:ro dir” upstreamb:’, etc.</p> 16220 <ul> 16221 <li>Config: upstreams</li> 16222 <li>Env Var: RCLONE_UNION_UPSTREAMS</li> 16223 <li>Type: string</li> 16224 <li>Default: ""</li> 16225 </ul> 16226 <h4 id="union-action-policy">–union-action-policy</h4> 16227 <p>Policy to choose upstream on ACTION category.</p> 16228 <ul> 16229 <li>Config: action_policy</li> 16230 <li>Env Var: RCLONE_UNION_ACTION_POLICY</li> 16231 <li>Type: string</li> 16232 <li>Default: “epall”</li> 16233 </ul> 16234 <h4 id="union-create-policy">–union-create-policy</h4> 16235 <p>Policy to choose upstream on CREATE category.</p> 16236 <ul> 16237 <li>Config: create_policy</li> 16238 <li>Env Var: RCLONE_UNION_CREATE_POLICY</li> 16239 <li>Type: string</li> 16240 <li>Default: “epmfs”</li> 16241 </ul> 16242 <h4 id="union-search-policy">–union-search-policy</h4> 16243 <p>Policy to choose upstream on SEARCH category.</p> 16244 <ul> 16245 <li>Config: search_policy</li> 16246 <li>Env Var: RCLONE_UNION_SEARCH_POLICY</li> 16247 <li>Type: string</li> 16248 <li>Default: “ff”</li> 16249 </ul> 16250 <h4 id="union-cache-time">–union-cache-time</h4> 16251 <p>Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used.</p> 16252 <ul> 16253 <li>Config: cache_time</li> 16254 <li>Env Var: RCLONE_UNION_CACHE_TIME</li> 16255 <li>Type: int</li> 16256 <li>Default: 120</li> 16257 </ul> 16258 <h2 id="webdav">WebDAV</h2> 16259 <p>Paths are specified as <code>remote:path</code></p> 16260 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 16261 <p>To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are connecting to then rclone can enable extra features.</p> 16262 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 16263 <pre><code> rclone config</code></pre> 16264 <p>This will guide you through an interactive setup process:</p> 16265 <pre><code>No remotes found - make a new one 16266 n) New remote 16267 s) Set configuration password 16268 q) Quit config 16269 n/s/q> n 16270 name> remote 16271 Type of storage to configure. 16272 Choose a number from below, or type in your own value 16273 [snip] 16274 XX / Webdav 16275 \ "webdav" 16276 [snip] 16277 Storage> webdav 16278 URL of http host to connect to 16279 Choose a number from below, or type in your own value 16280 1 / Connect to example.com 16281 \ "https://example.com" 16282 url> https://example.com/remote.php/webdav/ 16283 Name of the Webdav site/service/software you are using 16284 Choose a number from below, or type in your own value 16285 1 / Nextcloud 16286 \ "nextcloud" 16287 2 / Owncloud 16288 \ "owncloud" 16289 3 / Sharepoint 16290 \ "sharepoint" 16291 4 / Other site/service or software 16292 \ "other" 16293 vendor> 1 16294 User name 16295 user> user 16296 Password. 16297 y) Yes type in my own password 16298 g) Generate random password 16299 n) No leave this optional password blank 16300 y/g/n> y 16301 Enter the password: 16302 password: 16303 Confirm the password: 16304 password: 16305 Bearer token instead of user/pass (eg a Macaroon) 16306 bearer_token> 16307 Remote config 16308 -------------------- 16309 [remote] 16310 type = webdav 16311 url = https://example.com/remote.php/webdav/ 16312 vendor = nextcloud 16313 user = user 16314 pass = *** ENCRYPTED *** 16315 bearer_token = 16316 -------------------- 16317 y) Yes this is OK 16318 e) Edit this remote 16319 d) Delete this remote 16320 y/e/d> y</code></pre> 16321 <p>Once configured you can then use <code>rclone</code> like this,</p> 16322 <p>List directories in top level of your WebDAV</p> 16323 <pre><code>rclone lsd remote:</code></pre> 16324 <p>List all the files in your WebDAV</p> 16325 <pre><code>rclone ls remote:</code></pre> 16326 <p>To copy a local directory to an WebDAV directory called backup</p> 16327 <pre><code>rclone copy /home/source remote:backup</code></pre> 16328 <h3 id="modified-time-and-hashes-11">Modified time and hashes</h3> 16329 <p>Plain WebDAV does not support modified times. However when used with Owncloud or Nextcloud rclone will support modified times.</p> 16330 <p>Likewise plain WebDAV does not support hashes, however when used with Owncloud or Nextcloud rclone will support SHA1 and MD5 hashes. Depending on the exact version of Owncloud or Nextcloud hashes may appear on all objects, or only on objects which had a hash uploaded with them.</p> 16331 <h3 id="standard-options-32">Standard Options</h3> 16332 <p>Here are the standard options specific to webdav (Webdav).</p> 16333 <h4 id="webdav-url">–webdav-url</h4> 16334 <p>URL of http host to connect to</p> 16335 <ul> 16336 <li>Config: url</li> 16337 <li>Env Var: RCLONE_WEBDAV_URL</li> 16338 <li>Type: string</li> 16339 <li>Default: ""</li> 16340 <li>Examples: 16341 <ul> 16342 <li>“https://example.com” 16343 <ul> 16344 <li>Connect to example.com</li> 16345 </ul></li> 16346 </ul></li> 16347 </ul> 16348 <h4 id="webdav-vendor">–webdav-vendor</h4> 16349 <p>Name of the Webdav site/service/software you are using</p> 16350 <ul> 16351 <li>Config: vendor</li> 16352 <li>Env Var: RCLONE_WEBDAV_VENDOR</li> 16353 <li>Type: string</li> 16354 <li>Default: ""</li> 16355 <li>Examples: 16356 <ul> 16357 <li>“nextcloud” 16358 <ul> 16359 <li>Nextcloud</li> 16360 </ul></li> 16361 <li>“owncloud” 16362 <ul> 16363 <li>Owncloud</li> 16364 </ul></li> 16365 <li>“sharepoint” 16366 <ul> 16367 <li>Sharepoint</li> 16368 </ul></li> 16369 <li>“other” 16370 <ul> 16371 <li>Other site/service or software</li> 16372 </ul></li> 16373 </ul></li> 16374 </ul> 16375 <h4 id="webdav-user">–webdav-user</h4> 16376 <p>User name</p> 16377 <ul> 16378 <li>Config: user</li> 16379 <li>Env Var: RCLONE_WEBDAV_USER</li> 16380 <li>Type: string</li> 16381 <li>Default: ""</li> 16382 </ul> 16383 <h4 id="webdav-pass">–webdav-pass</h4> 16384 <p>Password.</p> 16385 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 16386 <ul> 16387 <li>Config: pass</li> 16388 <li>Env Var: RCLONE_WEBDAV_PASS</li> 16389 <li>Type: string</li> 16390 <li>Default: ""</li> 16391 </ul> 16392 <h4 id="webdav-bearer-token">–webdav-bearer-token</h4> 16393 <p>Bearer token instead of user/pass (eg a Macaroon)</p> 16394 <ul> 16395 <li>Config: bearer_token</li> 16396 <li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN</li> 16397 <li>Type: string</li> 16398 <li>Default: ""</li> 16399 </ul> 16400 <h3 id="advanced-options-31">Advanced Options</h3> 16401 <p>Here are the advanced options specific to webdav (Webdav).</p> 16402 <h4 id="webdav-bearer-token-command">–webdav-bearer-token-command</h4> 16403 <p>Command to run to get a bearer token</p> 16404 <ul> 16405 <li>Config: bearer_token_command</li> 16406 <li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND</li> 16407 <li>Type: string</li> 16408 <li>Default: ""</li> 16409 </ul> 16410 <h2 id="provider-notes">Provider notes</h2> 16411 <p>See below for notes on specific providers.</p> 16412 <h3 id="owncloud">Owncloud</h3> 16413 <p>Click on the settings cog in the bottom right of the page and this will show the WebDAV URL that rclone needs in the config step. It will look something like <code>https://example.com/remote.php/webdav/</code>.</p> 16414 <p>Owncloud supports modified times using the <code>X-OC-Mtime</code> header.</p> 16415 <h3 id="nextcloud">Nextcloud</h3> 16416 <p>This is configured in an identical way to Owncloud. Note that Nextcloud does not support streaming of files (<code>rcat</code>) whereas Owncloud does. This <a href="https://github.com/nextcloud/nextcloud-snap/issues/365">may be fixed</a> in the future.</p> 16417 <h3 id="sharepoint">Sharepoint</h3> 16418 <p>Rclone can be used with Sharepoint provided by OneDrive for Business or Office365 Education Accounts. This feature is only needed for a few of these Accounts, mostly Office365 Education ones. These accounts are sometimes not verified by the domain owner <a href="https://github.com/rclone/rclone/issues/1975">github#1975</a></p> 16419 <p>This means that these accounts can’t be added using the official API (other Accounts should work with the “onedrive” option). However, it is possible to access them using webdav.</p> 16420 <p>To use a sharepoint remote with rclone, add it like this: First, you need to get your remote’s URL:</p> 16421 <ul> 16422 <li>Go <a href="https://onedrive.live.com/about/en-us/signin/">here</a> to open your OneDrive or to sign in</li> 16423 <li>Now take a look at your address bar, the URL should look like this: <code>https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/_layouts/15/onedrive.aspx</code></li> 16424 </ul> 16425 <p>You’ll only need this URL up to the email address. After that, you’ll most likely want to add “/Documents”. That subdirectory contains the actual data stored on your OneDrive.</p> 16426 <p>Add the remote to rclone like this: Configure the <code>url</code> as <code>https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents</code> and use your normal account email and password for <code>user</code> and <code>pass</code>. If you have 2FA enabled, you have to generate an app password. Set the <code>vendor</code> to <code>sharepoint</code>.</p> 16427 <p>Your config file should look like this:</p> 16428 <pre><code>[sharepoint] 16429 type = webdav 16430 url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents 16431 vendor = other 16432 user = YourEmailAddress 16433 pass = encryptedpassword</code></pre> 16434 <h4 id="required-flags-for-sharepoint">Required Flags for SharePoint</h4> 16435 <p>As SharePoint does some special things with uploaded documents, you won’t be able to use the documents size or the documents hash to compare if a file has been changed since the upload / which file is newer.</p> 16436 <p>For Rclone calls copying files (especially Office files such as .docx, .xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should append these flags to ensure Rclone uses the “Last Modified” datetime property to compare your documents:</p> 16437 <pre><code>--ignore-size --ignore-checksum --update</code></pre> 16438 <h3 id="dcache">dCache</h3> 16439 <p>dCache is a storage system that supports many protocols and authentication/authorisation schemes. For WebDAV clients, it allows users to authenticate with username and password (BASIC), X.509, Kerberos, and various bearer tokens, including <a href="https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anupam_macaroons_v02.pdf">Macaroons</a> and <a href="https://en.wikipedia.org/wiki/OpenID_Connect">OpenID-Connect</a> access tokens.</p> 16440 <p>Configure as normal using the <code>other</code> type. Don’t enter a username or password, instead enter your Macaroon as the <code>bearer_token</code>.</p> 16441 <p>The config will end up looking something like this.</p> 16442 <pre><code>[dcache] 16443 type = webdav 16444 url = https://dcache... 16445 vendor = other 16446 user = 16447 pass = 16448 bearer_token = your-macaroon</code></pre> 16449 <p>There is a <a href="https://github.com/sara-nl/GridScripts/blob/master/get-macaroon">script</a> that obtains a Macaroon from a dCache WebDAV endpoint, and creates an rclone config file.</p> 16450 <p>Macaroons may also be obtained from the dCacheView web-browser/JavaScript client that comes with dCache.</p> 16451 <h3 id="openid-connect">OpenID-Connect</h3> 16452 <p>dCache also supports authenticating with OpenID-Connect access tokens. OpenID-Connect is a protocol (based on OAuth 2.0) that allows services to identify users who have authenticated with some central service.</p> 16453 <p>Support for OpenID-Connect in rclone is currently achieved using another software package called <a href="https://github.com/indigo-dc/oidc-agent">oidc-agent</a>. This is a command-line tool that facilitates obtaining an access token. Once installed and configured, an access token is obtained by running the <code>oidc-token</code> command. The following example shows a (shortened) access token obtained from the <em>XDC</em> OIDC Provider.</p> 16454 <pre><code>paul@celebrimbor:~$ oidc-token XDC 16455 eyJraWQ[...]QFXDt0 16456 paul@celebrimbor:~$</code></pre> 16457 <p><strong>Note</strong> Before the <code>oidc-token</code> command will work, the refresh token must be loaded into the oidc agent. This is done with the <code>oidc-add</code> command (e.g., <code>oidc-add XDC</code>). This is typically done once per login session. Full details on this and how to register oidc-agent with your OIDC Provider are provided in the <a href="https://indigo-dc.gitbooks.io/oidc-agent/">oidc-agent documentation</a>.</p> 16458 <p>The rclone <code>bearer_token_command</code> configuration option is used to fetch the access token from oidc-agent.</p> 16459 <p>Configure as a normal WebDAV endpoint, using the ‘other’ vendor, leaving the username and password empty. When prompted, choose to edit the advanced config and enter the command to get a bearer token (e.g., <code>oidc-agent XDC</code>).</p> 16460 <p>The following example config shows a WebDAV endpoint that uses oidc-agent to supply an access token from the <em>XDC</em> OIDC Provider.</p> 16461 <pre><code>[dcache] 16462 type = webdav 16463 url = https://dcache.example.org/ 16464 vendor = other 16465 bearer_token_command = oidc-token XDC</code></pre> 16466 <h2 id="yandex-disk">Yandex Disk</h2> 16467 <p><a href="https://disk.yandex.com">Yandex Disk</a> is a cloud storage solution created by <a href="https://yandex.com">Yandex</a>.</p> 16468 <p>Here is an example of making a yandex configuration. First run</p> 16469 <pre><code>rclone config</code></pre> 16470 <p>This will guide you through an interactive setup process:</p> 16471 <pre><code>No remotes found - make a new one 16472 n) New remote 16473 s) Set configuration password 16474 n/s> n 16475 name> remote 16476 Type of storage to configure. 16477 Choose a number from below, or type in your own value 16478 [snip] 16479 XX / Yandex Disk 16480 \ "yandex" 16481 [snip] 16482 Storage> yandex 16483 Yandex Client Id - leave blank normally. 16484 client_id> 16485 Yandex Client Secret - leave blank normally. 16486 client_secret> 16487 Remote config 16488 Use auto config? 16489 * Say Y if not sure 16490 * Say N if you are working on a remote or headless machine 16491 y) Yes 16492 n) No 16493 y/n> y 16494 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 16495 Log in and authorize rclone for access 16496 Waiting for code... 16497 Got code 16498 -------------------- 16499 [remote] 16500 client_id = 16501 client_secret = 16502 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","expiry":"2016-12-29T12:27:11.362788025Z"} 16503 -------------------- 16504 y) Yes this is OK 16505 e) Edit this remote 16506 d) Delete this remote 16507 y/e/d> y</code></pre> 16508 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> 16509 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Yandex Disk. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 16510 <p>Once configured you can then use <code>rclone</code> like this,</p> 16511 <p>See top level directories</p> 16512 <pre><code>rclone lsd remote:</code></pre> 16513 <p>Make a new directory</p> 16514 <pre><code>rclone mkdir remote:directory</code></pre> 16515 <p>List the contents of a directory</p> 16516 <pre><code>rclone ls remote:directory</code></pre> 16517 <p>Sync <code>/home/local/directory</code> to the remote path, deleting any excess files in the path.</p> 16518 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 16519 <p>Yandex paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 16520 <h3 id="modified-time-13">Modified time</h3> 16521 <p>Modified times are supported and are stored accurate to 1 ns in custom metadata called <code>rclone_modified</code> in RFC3339 with nanoseconds format.</p> 16522 <h3 id="md5-checksums">MD5 checksums</h3> 16523 <p>MD5 checksums are natively supported by Yandex Disk.</p> 16524 <h3 id="emptying-trash-2">Emptying Trash</h3> 16525 <p>If you wish to empty your trash you can use the <code>rclone cleanup remote:</code> command which will permanently delete all your trashed files. This command does not take any path arguments.</p> 16526 <h3 id="quota-information-3">Quota information</h3> 16527 <p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (quota) and the current usage.</p> 16528 <h4 id="restricted-filename-characters-25">Restricted filename characters</h4> 16529 <p>The <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> are replaced.</p> 16530 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be used in JSON strings.</p> 16531 <h3 id="limitations-20">Limitations</h3> 16532 <p>When uploading very large files (bigger than about 5GB) you will need to increase the <code>--timeout</code> parameter. This is because Yandex pauses (perhaps to calculate the MD5SUM for the entire file) before returning confirmation that the file has been uploaded. The default handling of timeouts in rclone is to assume a 5 minute pause is an error and close the connection - you’ll see <code>net/http: timeout awaiting response headers</code> errors in the logs if this is happening. Setting the timeout to twice the max size of file in GB should be enough, so if you want to upload a 30GB file set a timeout of <code>2 * 30 = 60m</code>, that is <code>--timeout 60m</code>.</p> 16533 <h3 id="standard-options-33">Standard Options</h3> 16534 <p>Here are the standard options specific to yandex (Yandex Disk).</p> 16535 <h4 id="yandex-client-id">–yandex-client-id</h4> 16536 <p>Yandex Client Id Leave blank normally.</p> 16537 <ul> 16538 <li>Config: client_id</li> 16539 <li>Env Var: RCLONE_YANDEX_CLIENT_ID</li> 16540 <li>Type: string</li> 16541 <li>Default: ""</li> 16542 </ul> 16543 <h4 id="yandex-client-secret">–yandex-client-secret</h4> 16544 <p>Yandex Client Secret Leave blank normally.</p> 16545 <ul> 16546 <li>Config: client_secret</li> 16547 <li>Env Var: RCLONE_YANDEX_CLIENT_SECRET</li> 16548 <li>Type: string</li> 16549 <li>Default: ""</li> 16550 </ul> 16551 <h3 id="advanced-options-32">Advanced Options</h3> 16552 <p>Here are the advanced options specific to yandex (Yandex Disk).</p> 16553 <h4 id="yandex-unlink">–yandex-unlink</h4> 16554 <p>Remove existing public link to file/folder with link command rather than creating. Default is false, meaning link command will create or retrieve public link.</p> 16555 <ul> 16556 <li>Config: unlink</li> 16557 <li>Env Var: RCLONE_YANDEX_UNLINK</li> 16558 <li>Type: bool</li> 16559 <li>Default: false</li> 16560 </ul> 16561 <h4 id="yandex-encoding">–yandex-encoding</h4> 16562 <p>This sets the encoding for the backend.</p> 16563 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 16564 <ul> 16565 <li>Config: encoding</li> 16566 <li>Env Var: RCLONE_YANDEX_ENCODING</li> 16567 <li>Type: MultiEncoder</li> 16568 <li>Default: Slash,Del,Ctl,InvalidUtf8,Dot</li> 16569 </ul> 16570 <h2 id="local-filesystem">Local Filesystem</h2> 16571 <p>Local paths are specified as normal filesystem paths, eg <code>/path/to/wherever</code>, so</p> 16572 <pre><code>rclone sync /home/source /tmp/destination</code></pre> 16573 <p>Will sync <code>/home/source</code> to <code>/tmp/destination</code></p> 16574 <p>These can be configured into the config file for consistencies sake, but it is probably easier not to.</p> 16575 <h3 id="modified-time-14">Modified time</h3> 16576 <p>Rclone reads and writes the modified time using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.</p> 16577 <h3 id="filenames">Filenames</h3> 16578 <p>Filenames should be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.</p> 16579 <p>There is a bit more uncertainty in the Linux world, but new distributions will have UTF-8 encoded files names. If you are using an old Linux filesystem with non UTF-8 file names (eg latin1) then you can use the <code>convmv</code> tool to convert the filesystem to UTF-8. This tool is available in most distributions’ package managers.</p> 16580 <p>If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. The name <code>gro\xdf</code> will be transferred as <code>gro‛DF</code>. <code>rclone</code> will emit a debug message in this case (use <code>-v</code> to see), eg</p> 16581 <pre><code>Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"</code></pre> 16582 <h4 id="restricted-characters-1">Restricted characters</h4> 16583 <p>On non Windows platforms the following characters are replaced when handling file names.</p> 16584 <table> 16585 <thead> 16586 <tr class="header"> 16587 <th>Character</th> 16588 <th style="text-align: center;">Value</th> 16589 <th style="text-align: center;">Replacement</th> 16590 </tr> 16591 </thead> 16592 <tbody> 16593 <tr class="odd"> 16594 <td>NUL</td> 16595 <td style="text-align: center;">0x00</td> 16596 <td style="text-align: center;">␀</td> 16597 </tr> 16598 <tr class="even"> 16599 <td>/</td> 16600 <td style="text-align: center;">0x2F</td> 16601 <td style="text-align: center;">／</td> 16602 </tr> 16603 </tbody> 16604 </table> 16605 <p>When running on Windows the following characters are replaced. This list is based on the <a href="https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions">Windows file naming conventions</a>.</p> 16606 <table> 16607 <thead> 16608 <tr class="header"> 16609 <th>Character</th> 16610 <th style="text-align: center;">Value</th> 16611 <th style="text-align: center;">Replacement</th> 16612 </tr> 16613 </thead> 16614 <tbody> 16615 <tr class="odd"> 16616 <td>NUL</td> 16617 <td style="text-align: center;">0x00</td> 16618 <td style="text-align: center;">␀</td> 16619 </tr> 16620 <tr class="even"> 16621 <td>SOH</td> 16622 <td style="text-align: center;">0x01</td> 16623 <td style="text-align: center;">␁</td> 16624 </tr> 16625 <tr class="odd"> 16626 <td>STX</td> 16627 <td style="text-align: center;">0x02</td> 16628 <td style="text-align: center;">␂</td> 16629 </tr> 16630 <tr class="even"> 16631 <td>ETX</td> 16632 <td style="text-align: center;">0x03</td> 16633 <td style="text-align: center;">␃</td> 16634 </tr> 16635 <tr class="odd"> 16636 <td>EOT</td> 16637 <td style="text-align: center;">0x04</td> 16638 <td style="text-align: center;">␄</td> 16639 </tr> 16640 <tr class="even"> 16641 <td>ENQ</td> 16642 <td style="text-align: center;">0x05</td> 16643 <td style="text-align: center;">␅</td> 16644 </tr> 16645 <tr class="odd"> 16646 <td>ACK</td> 16647 <td style="text-align: center;">0x06</td> 16648 <td style="text-align: center;">␆</td> 16649 </tr> 16650 <tr class="even"> 16651 <td>BEL</td> 16652 <td style="text-align: center;">0x07</td> 16653 <td style="text-align: center;">␇</td> 16654 </tr> 16655 <tr class="odd"> 16656 <td>BS</td> 16657 <td style="text-align: center;">0x08</td> 16658 <td style="text-align: center;">␈</td> 16659 </tr> 16660 <tr class="even"> 16661 <td>HT</td> 16662 <td style="text-align: center;">0x09</td> 16663 <td style="text-align: center;">␉</td> 16664 </tr> 16665 <tr class="odd"> 16666 <td>LF</td> 16667 <td style="text-align: center;">0x0A</td> 16668 <td style="text-align: center;">␊</td> 16669 </tr> 16670 <tr class="even"> 16671 <td>VT</td> 16672 <td style="text-align: center;">0x0B</td> 16673 <td style="text-align: center;">␋</td> 16674 </tr> 16675 <tr class="odd"> 16676 <td>FF</td> 16677 <td style="text-align: center;">0x0C</td> 16678 <td style="text-align: center;">␌</td> 16679 </tr> 16680 <tr class="even"> 16681 <td>CR</td> 16682 <td style="text-align: center;">0x0D</td> 16683 <td style="text-align: center;">␍</td> 16684 </tr> 16685 <tr class="odd"> 16686 <td>SO</td> 16687 <td style="text-align: center;">0x0E</td> 16688 <td style="text-align: center;">␎</td> 16689 </tr> 16690 <tr class="even"> 16691 <td>SI</td> 16692 <td style="text-align: center;">0x0F</td> 16693 <td style="text-align: center;">␏</td> 16694 </tr> 16695 <tr class="odd"> 16696 <td>DLE</td> 16697 <td style="text-align: center;">0x10</td> 16698 <td style="text-align: center;">␐</td> 16699 </tr> 16700 <tr class="even"> 16701 <td>DC1</td> 16702 <td style="text-align: center;">0x11</td> 16703 <td style="text-align: center;">␑</td> 16704 </tr> 16705 <tr class="odd"> 16706 <td>DC2</td> 16707 <td style="text-align: center;">0x12</td> 16708 <td style="text-align: center;">␒</td> 16709 </tr> 16710 <tr class="even"> 16711 <td>DC3</td> 16712 <td style="text-align: center;">0x13</td> 16713 <td style="text-align: center;">␓</td> 16714 </tr> 16715 <tr class="odd"> 16716 <td>DC4</td> 16717 <td style="text-align: center;">0x14</td> 16718 <td style="text-align: center;">␔</td> 16719 </tr> 16720 <tr class="even"> 16721 <td>NAK</td> 16722 <td style="text-align: center;">0x15</td> 16723 <td style="text-align: center;">␕</td> 16724 </tr> 16725 <tr class="odd"> 16726 <td>SYN</td> 16727 <td style="text-align: center;">0x16</td> 16728 <td style="text-align: center;">␖</td> 16729 </tr> 16730 <tr class="even"> 16731 <td>ETB</td> 16732 <td style="text-align: center;">0x17</td> 16733 <td style="text-align: center;">␗</td> 16734 </tr> 16735 <tr class="odd"> 16736 <td>CAN</td> 16737 <td style="text-align: center;">0x18</td> 16738 <td style="text-align: center;">␘</td> 16739 </tr> 16740 <tr class="even"> 16741 <td>EM</td> 16742 <td style="text-align: center;">0x19</td> 16743 <td style="text-align: center;">␙</td> 16744 </tr> 16745 <tr class="odd"> 16746 <td>SUB</td> 16747 <td style="text-align: center;">0x1A</td> 16748 <td style="text-align: center;">␚</td> 16749 </tr> 16750 <tr class="even"> 16751 <td>ESC</td> 16752 <td style="text-align: center;">0x1B</td> 16753 <td style="text-align: center;">␛</td> 16754 </tr> 16755 <tr class="odd"> 16756 <td>FS</td> 16757 <td style="text-align: center;">0x1C</td> 16758 <td style="text-align: center;">␜</td> 16759 </tr> 16760 <tr class="even"> 16761 <td>GS</td> 16762 <td style="text-align: center;">0x1D</td> 16763 <td style="text-align: center;">␝</td> 16764 </tr> 16765 <tr class="odd"> 16766 <td>RS</td> 16767 <td style="text-align: center;">0x1E</td> 16768 <td style="text-align: center;">␞</td> 16769 </tr> 16770 <tr class="even"> 16771 <td>US</td> 16772 <td style="text-align: center;">0x1F</td> 16773 <td style="text-align: center;">␟</td> 16774 </tr> 16775 <tr class="odd"> 16776 <td>/</td> 16777 <td style="text-align: center;">0x2F</td> 16778 <td style="text-align: center;">／</td> 16779 </tr> 16780 <tr class="even"> 16781 <td>"</td> 16782 <td style="text-align: center;">0x22</td> 16783 <td style="text-align: center;">＂</td> 16784 </tr> 16785 <tr class="odd"> 16786 <td>*</td> 16787 <td style="text-align: center;">0x2A</td> 16788 <td style="text-align: center;">＊</td> 16789 </tr> 16790 <tr class="even"> 16791 <td>:</td> 16792 <td style="text-align: center;">0x3A</td> 16793 <td style="text-align: center;">：</td> 16794 </tr> 16795 <tr class="odd"> 16796 <td><</td> 16797 <td style="text-align: center;">0x3C</td> 16798 <td style="text-align: center;">＜</td> 16799 </tr> 16800 <tr class="even"> 16801 <td>></td> 16802 <td style="text-align: center;">0x3E</td> 16803 <td style="text-align: center;">＞</td> 16804 </tr> 16805 <tr class="odd"> 16806 <td>?</td> 16807 <td style="text-align: center;">0x3F</td> 16808 <td style="text-align: center;">？</td> 16809 </tr> 16810 <tr class="even"> 16811 <td>\</td> 16812 <td style="text-align: center;">0x5C</td> 16813 <td style="text-align: center;">＼</td> 16814 </tr> 16815 <tr class="odd"> 16816 <td>|</td> 16817 <td style="text-align: center;">0x7C</td> 16818 <td style="text-align: center;">｜</td> 16819 </tr> 16820 </tbody> 16821 </table> 16822 <p>File names on Windows can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 16823 <table> 16824 <thead> 16825 <tr class="header"> 16826 <th>Character</th> 16827 <th style="text-align: center;">Value</th> 16828 <th style="text-align: center;">Replacement</th> 16829 </tr> 16830 </thead> 16831 <tbody> 16832 <tr class="odd"> 16833 <td>SP</td> 16834 <td style="text-align: center;">0x20</td> 16835 <td style="text-align: center;">␠</td> 16836 </tr> 16837 <tr class="even"> 16838 <td>.</td> 16839 <td style="text-align: center;">0x2E</td> 16840 <td style="text-align: center;">．</td> 16841 </tr> 16842 </tbody> 16843 </table> 16844 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can’t be converted to UTF-16.</p> 16845 <h3 id="long-paths-on-windows">Long paths on Windows</h3> 16846 <p>Rclone handles long paths automatically, by converting all paths to long <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#maxpath">UNC paths</a> which allows paths up to 32,767 characters.</p> 16847 <p>This is why you will see that your paths, for instance <code>c:\files</code> is converted to the UNC path <code>\\?\c:\files</code> in the output, and <code>\\server\share</code> is converted to <code>\\?\UNC\server\share</code>.</p> 16848 <p>However, in rare cases this may cause problems with buggy file system drivers like <a href="https://github.com/rclone/rclone/issues/261">EncFS</a>. To disable UNC conversion globally, add this to your <code>.rclone.conf</code> file:</p> 16849 <pre><code>[local] 16850 nounc = true</code></pre> 16851 <p>If you want to selectively disable UNC, you can add it to a separate entry like this:</p> 16852 <pre><code>[nounc] 16853 type = local 16854 nounc = true</code></pre> 16855 <p>And use rclone like this:</p> 16856 <p><code>rclone copy c:\src nounc:z:\dst</code></p> 16857 <p>This will use UNC paths on <code>c:\src</code> but not on <code>z:\dst</code>. Of course this will cause problems if the absolute path length of a file exceeds 258 characters on z, so only use this option if you have to.</p> 16858 <h3 id="symlinks-junction-points">Symlinks / Junction points</h3> 16859 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 16860 <p>If you supply <code>--copy-links</code> or <code>-L</code> then rclone will follow the symlink and copy the pointed to file or directory. Note that this flag is incompatible with <code>-links</code> / <code>-l</code>.</p> 16861 <p>This flag applies to all commands.</p> 16862 <p>For example, supposing you have a directory structure like this</p> 16863 <pre><code>$ tree /tmp/a 16864 /tmp/a 16865 ├── b -> ../b 16866 ├── expected -> ../expected 16867 ├── one 16868 └── two 16869 └── three</code></pre> 16870 <p>Then you can see the difference with and without the flag like this</p> 16871 <pre><code>$ rclone ls /tmp/a 16872 6 one 16873 6 two/three</code></pre> 16874 <p>and</p> 16875 <pre><code>$ rclone -L ls /tmp/a 16876 4174 expected 16877 6 one 16878 6 two/three 16879 6 b/two 16880 6 b/one</code></pre> 16881 <h4 id="links--l">–links, -l</h4> 16882 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 16883 <p>If you supply this flag then rclone will copy symbolic links from the local storage, and store them as text files, with a ‘.rclonelink’ suffix in the remote storage.</p> 16884 <p>The text file will contain the target of the symbolic link (see example).</p> 16885 <p>This flag applies to all commands.</p> 16886 <p>For example, supposing you have a directory structure like this</p> 16887 <pre><code>$ tree /tmp/a 16888 /tmp/a 16889 ├── file1 -> ./file4 16890 └── file2 -> /home/user/file3</code></pre> 16891 <p>Copying the entire directory with ‘-l’</p> 16892 <pre><code>$ rclone copyto -l /tmp/a/file1 remote:/tmp/a/</code></pre> 16893 <p>The remote files are created with a ‘.rclonelink’ suffix</p> 16894 <pre><code>$ rclone ls remote:/tmp/a 16895 5 file1.rclonelink 16896 14 file2.rclonelink</code></pre> 16897 <p>The remote files will contain the target of the symbolic links</p> 16898 <pre><code>$ rclone cat remote:/tmp/a/file1.rclonelink 16899 ./file4 16900 16901 $ rclone cat remote:/tmp/a/file2.rclonelink 16902 /home/user/file3</code></pre> 16903 <p>Copying them back with ‘-l’</p> 16904 <pre><code>$ rclone copyto -l remote:/tmp/a/ /tmp/b/ 16905 16906 $ tree /tmp/b 16907 /tmp/b 16908 ├── file1 -> ./file4 16909 └── file2 -> /home/user/file3</code></pre> 16910 <p>However, if copied back without ‘-l’</p> 16911 <pre><code>$ rclone copyto remote:/tmp/a/ /tmp/b/ 16912 16913 $ tree /tmp/b 16914 /tmp/b 16915 ├── file1.rclonelink 16916 └── file2.rclonelink</code></pre> 16917 <p>Note that this flag is incompatible with <code>-copy-links</code> / <code>-L</code>.</p> 16918 <h3 id="restricting-filesystems-with-one-file-system">Restricting filesystems with –one-file-system</h3> 16919 <p>Normally rclone will recurse through filesystems as mounted.</p> 16920 <p>However if you set <code>--one-file-system</code> or <code>-x</code> this tells rclone to stay in the filesystem specified by the root and not to recurse into different file systems.</p> 16921 <p>For example if you have a directory hierarchy like this</p> 16922 <pre><code>root 16923 ├── disk1 - disk1 mounted on the root 16924 │ └── file3 - stored on disk1 16925 ├── disk2 - disk2 mounted on the root 16926 │ └── file4 - stored on disk12 16927 ├── file1 - stored on the root disk 16928 └── file2 - stored on the root disk</code></pre> 16929 <p>Using <code>rclone --one-file-system copy root remote:</code> will only copy <code>file1</code> and <code>file2</code>. Eg</p> 16930 <pre><code>$ rclone -q --one-file-system ls root 16931 0 file1 16932 0 file2</code></pre> 16933 <pre><code>$ rclone -q ls root 16934 0 disk1/file3 16935 0 disk2/file4 16936 0 file1 16937 0 file2</code></pre> 16938 <p><strong>NB</strong> Rclone (like most unix tools such as <code>du</code>, <code>rsync</code> and <code>tar</code>) treats a bind mount to the same device as being on the same filesystem.</p> 16939 <p><strong>NB</strong> This flag is only available on Unix based systems. On systems where it isn’t supported (eg Windows) it will be ignored.</p> 16940 <h3 id="standard-options-34">Standard Options</h3> 16941 <p>Here are the standard options specific to local (Local Disk).</p> 16942 <h4 id="local-nounc">–local-nounc</h4> 16943 <p>Disable UNC (long path names) conversion on Windows</p> 16944 <ul> 16945 <li>Config: nounc</li> 16946 <li>Env Var: RCLONE_LOCAL_NOUNC</li> 16947 <li>Type: string</li> 16948 <li>Default: ""</li> 16949 <li>Examples: 16950 <ul> 16951 <li>“true” 16952 <ul> 16953 <li>Disables long file names</li> 16954 </ul></li> 16955 </ul></li> 16956 </ul> 16957 <h3 id="advanced-options-33">Advanced Options</h3> 16958 <p>Here are the advanced options specific to local (Local Disk).</p> 16959 <h4 id="copy-links--l">–copy-links / -L</h4> 16960 <p>Follow symlinks and copy the pointed to item.</p> 16961 <ul> 16962 <li>Config: copy_links</li> 16963 <li>Env Var: RCLONE_LOCAL_COPY_LINKS</li> 16964 <li>Type: bool</li> 16965 <li>Default: false</li> 16966 </ul> 16967 <h4 id="links--l-1">–links / -l</h4> 16968 <p>Translate symlinks to/from regular files with a ‘.rclonelink’ extension</p> 16969 <ul> 16970 <li>Config: links</li> 16971 <li>Env Var: RCLONE_LOCAL_LINKS</li> 16972 <li>Type: bool</li> 16973 <li>Default: false</li> 16974 </ul> 16975 <h4 id="skip-links">–skip-links</h4> 16976 <p>Don’t warn about skipped symlinks. This flag disables warning messages on skipped symlinks or junction points, as you explicitly acknowledge that they should be skipped.</p> 16977 <ul> 16978 <li>Config: skip_links</li> 16979 <li>Env Var: RCLONE_LOCAL_SKIP_LINKS</li> 16980 <li>Type: bool</li> 16981 <li>Default: false</li> 16982 </ul> 16983 <h4 id="local-no-unicode-normalization">–local-no-unicode-normalization</h4> 16984 <p>Don’t apply unicode normalization to paths and filenames (Deprecated)</p> 16985 <p>This flag is deprecated now. Rclone no longer normalizes unicode file names, but it compares them with unicode normalization in the sync routine instead.</p> 16986 <ul> 16987 <li>Config: no_unicode_normalization</li> 16988 <li>Env Var: RCLONE_LOCAL_NO_UNICODE_NORMALIZATION</li> 16989 <li>Type: bool</li> 16990 <li>Default: false</li> 16991 </ul> 16992 <h4 id="local-no-check-updated">–local-no-check-updated</h4> 16993 <p>Don’t check to see if the files change during upload</p> 16994 <p>Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts “can’t copy - source file is being updated” if the file changes during upload.</p> 16995 <p>However on some file systems this modification time check may fail (eg <a href="https://github.com/rclone/rclone/issues/2206">Glusterfs #2206</a>) so this check can be disabled with this flag.</p> 16996 <ul> 16997 <li>Config: no_check_updated</li> 16998 <li>Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED</li> 16999 <li>Type: bool</li> 17000 <li>Default: false</li> 17001 </ul> 17002 <h4 id="one-file-system--x">–one-file-system / -x</h4> 17003 <p>Don’t cross filesystem boundaries (unix/macOS only).</p> 17004 <ul> 17005 <li>Config: one_file_system</li> 17006 <li>Env Var: RCLONE_LOCAL_ONE_FILE_SYSTEM</li> 17007 <li>Type: bool</li> 17008 <li>Default: false</li> 17009 </ul> 17010 <h4 id="local-case-sensitive">–local-case-sensitive</h4> 17011 <p>Force the filesystem to report itself as case sensitive.</p> 17012 <p>Normally the local backend declares itself as case insensitive on Windows/macOS and case sensitive for everything else. Use this flag to override the default choice.</p> 17013 <ul> 17014 <li>Config: case_sensitive</li> 17015 <li>Env Var: RCLONE_LOCAL_CASE_SENSITIVE</li> 17016 <li>Type: bool</li> 17017 <li>Default: false</li> 17018 </ul> 17019 <h4 id="local-case-insensitive">–local-case-insensitive</h4> 17020 <p>Force the filesystem to report itself as case insensitive</p> 17021 <p>Normally the local backend declares itself as case insensitive on Windows/macOS and case sensitive for everything else. Use this flag to override the default choice.</p> 17022 <ul> 17023 <li>Config: case_insensitive</li> 17024 <li>Env Var: RCLONE_LOCAL_CASE_INSENSITIVE</li> 17025 <li>Type: bool</li> 17026 <li>Default: false</li> 17027 </ul> 17028 <h4 id="local-no-sparse">–local-no-sparse</h4> 17029 <p>Disable sparse files for multi-thread downloads</p> 17030 <p>On Windows platforms rclone will make sparse files when doing multi-thread downloads. This avoids long pauses on large files where the OS zeros the file. However sparse files may be undesirable as they cause disk fragmentation and can be slow to work with.</p> 17031 <ul> 17032 <li>Config: no_sparse</li> 17033 <li>Env Var: RCLONE_LOCAL_NO_SPARSE</li> 17034 <li>Type: bool</li> 17035 <li>Default: false</li> 17036 </ul> 17037 <h4 id="local-encoding">–local-encoding</h4> 17038 <p>This sets the encoding for the backend.</p> 17039 <p>See: the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 17040 <ul> 17041 <li>Config: encoding</li> 17042 <li>Env Var: RCLONE_LOCAL_ENCODING</li> 17043 <li>Type: MultiEncoder</li> 17044 <li>Default: Slash,Dot</li> 17045 </ul> 17046 <h3 id="backend-commands-3">Backend commands</h3> 17047 <p>Here are the commands specific to the local backend.</p> 17048 <p>Run them with</p> 17049 <pre><code>rclone backend COMMAND remote:</code></pre> 17050 <p>The help below will explain what arguments each command takes.</p> 17051 <p>See <a href="https://rclone.org/commands/rclone_backend/">the “rclone backend” command</a> for more info on how to pass options and arguments.</p> 17052 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend/command">backend/command</a>.</p> 17053 <h4 id="noop">noop</h4> 17054 <p>A null operation for testing backend commands</p> 17055 <pre><code>rclone backend noop remote: [options] [<arguments>+]</code></pre> 17056 <p>This is a test command which has some options you can try to change the output.</p> 17057 <p>Options:</p> 17058 <ul> 17059 <li>“echo”: echo the input arguments</li> 17060 <li>“error”: return an error based on option value</li> 17061 </ul> 17062 <h1 id="changelog">Changelog</h1> 17063 <h2 id="v1.52.2---2020-06-24">v1.52.2 - 2020-06-24</h2> 17064 <p><a href="https://github.com/rclone/rclone/compare/v1.52.1...v1.52.2">See commits</a></p> 17065 <ul> 17066 <li>Bug Fixes 17067 <ul> 17068 <li>build 17069 <ul> 17070 <li>Fix docker release build action (Nick Craig-Wood)</li> 17071 <li>Fix custom timezone in Docker image (NoLooseEnds)</li> 17072 </ul></li> 17073 <li>check: Fix misleading message which printed errors instead of differences (Nick Craig-Wood)</li> 17074 <li>errors: Add WSAECONNREFUSED and more to the list of retriable Windows errors (Nick Craig-Wood)</li> 17075 <li>rcd: Fix incorrect prometheus metrics (Gary Kim)</li> 17076 <li>serve restic: Fix flags so they use environment variables (Nick Craig-Wood)</li> 17077 <li>serve webdav: Fix flags so they use environment variables (Nick Craig-Wood)</li> 17078 <li>sync: Fix –track-renames-strategy modtime (Nick Craig-Wood)</li> 17079 </ul></li> 17080 <li>Drive 17081 <ul> 17082 <li>Fix not being able to delete a directory with a trashed shortcut (Nick Craig-Wood)</li> 17083 <li>Fix creating a directory inside a shortcut (Nick Craig-Wood)</li> 17084 <li>Fix –drive-impersonate with cached root_folder_id (Nick Craig-Wood)</li> 17085 </ul></li> 17086 <li>SFTP 17087 <ul> 17088 <li>Fix SSH key PEM loading (Zac Rubin)</li> 17089 </ul></li> 17090 <li>Swift 17091 <ul> 17092 <li>Speed up deletes by not retrying segment container deletes (Nick Craig-Wood)</li> 17093 </ul></li> 17094 <li>Tardigrade 17095 <ul> 17096 <li>Upgrade to uplink v1.1.1 (Caleb Case)</li> 17097 </ul></li> 17098 <li>WebDAV 17099 <ul> 17100 <li>Fix free/used display for rclone about/df for certain backends (Nick Craig-Wood)</li> 17101 </ul></li> 17102 </ul> 17103 <h2 id="v1.52.1---2020-06-10">v1.52.1 - 2020-06-10</h2> 17104 <p><a href="https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1">See commits</a></p> 17105 <ul> 17106 <li>Bug Fixes 17107 <ul> 17108 <li>lib/file: Fix SetSparse on Windows 7 which fixes downloads of files > 250MB (Nick Craig-Wood)</li> 17109 <li>build 17110 <ul> 17111 <li>Update go.mod to go1.14 to enable -mod=vendor build (Nick Craig-Wood)</li> 17112 <li>Remove quicktest from Dockerfile (Nick Craig-Wood)</li> 17113 <li>Build Docker images with GitHub actions (Matteo Pietro Dazzi)</li> 17114 <li>Update Docker build workflows (Nick Craig-Wood)</li> 17115 <li>Set user_allow_other in /etc/fuse.conf in the Docker image (Nick Craig-Wood)</li> 17116 <li>Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)</li> 17117 </ul></li> 17118 <li>docs 17119 <ul> 17120 <li>Add link to source and modified time to footer of every page (Nick Craig-Wood)</li> 17121 <li>Remove manually set dates and use git dates instead (Nick Craig-Wood)</li> 17122 <li>Minor tense, punctuation, brevity and positivity changes for the home page (edwardxml)</li> 17123 <li>Remove leading slash in page reference in footer when present (Nick Craig-Wood)</li> 17124 <li>Note commands which need obscured input in the docs (Nick Craig-Wood)</li> 17125 <li>obscure: Write more help as we are referencing it elsewhere (Nick Craig-Wood)</li> 17126 </ul></li> 17127 </ul></li> 17128 <li>VFS 17129 <ul> 17130 <li>Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick Craig-Wood)</li> 17131 </ul></li> 17132 <li>Drive 17133 <ul> 17134 <li>Fix missing items when listing using –fast-list / ListR (Nick Craig-Wood)</li> 17135 </ul></li> 17136 <li>Putio 17137 <ul> 17138 <li>Fix panic on Object.Open (Cenk Alti)</li> 17139 </ul></li> 17140 <li>S3 17141 <ul> 17142 <li>Fix upload of single files into buckets without create permission (Nick Craig-Wood)</li> 17143 <li>Fix –header-upload (Nick Craig-Wood)</li> 17144 </ul></li> 17145 <li>Tardigrade 17146 <ul> 17147 <li>Fix listing bug by upgrading to v1.0.7</li> 17148 <li>Set UserAgent to rclone (Caleb Case)</li> 17149 </ul></li> 17150 </ul> 17151 <h2 id="v1.52.0---2020-05-27">v1.52.0 - 2020-05-27</h2> 17152 <p>Special thanks to Martin Michlmayr for proof reading and correcting all the docs and Edward Barker for helping re-write the front page.</p> 17153 <p><a href="https://github.com/rclone/rclone/compare/v1.51.0...v1.52.0">See commits</a></p> 17154 <ul> 17155 <li>New backends 17156 <ul> 17157 <li><a href="https://rclone.org/tardigrade/">Tardigrade</a> backend for use with storj.io (Caleb Case)</li> 17158 <li><a href="https://rclone.org/union/">Union</a> re-write to have multiple writable remotes (Max Sum)</li> 17159 <li><a href="/seafile">Seafile</a> for Seafile server (Fred <span class="citation" data-cites="creativeprojects">@creativeprojects</span>)</li> 17160 </ul></li> 17161 <li>New commands 17162 <ul> 17163 <li>backend: command for backend specific commands (see backends) (Nick Craig-Wood)</li> 17164 <li>cachestats: Deprecate in favour of <code>rclone backend stats cache:</code> (Nick Craig-Wood)</li> 17165 <li>dbhashsum: Deprecate in favour of <code>rclone hashsum DropboxHash</code> (Nick Craig-Wood)</li> 17166 </ul></li> 17167 <li>New Features 17168 <ul> 17169 <li>Add <code>--header-download</code> and <code>--header-upload</code> flags for setting HTTP headers when uploading/downloading (Tim Gallant)</li> 17170 <li>Add <code>--header</code> flag to add HTTP headers to every HTTP transaction (Nick Craig-Wood)</li> 17171 <li>Add <code>--check-first</code> to do all checking before starting transfers (Nick Craig-Wood)</li> 17172 <li>Add <code>--track-renames-strategy</code> for configurable matching criteria for <code>--track-renames</code> (Bernd Schoolmann)</li> 17173 <li>Add <code>--cutoff-mode</code> hard,soft,catious (Shing Kit Chan & Franklyn Tackitt)</li> 17174 <li>Filter flags (eg <code>--files-from -</code>) can read from stdin (fishbullet)</li> 17175 <li>Add <code>--error-on-no-transfer</code> option (Jon Fautley)</li> 17176 <li>Implement <code>--order-by xxx,mixed</code> for copying some small and some big files (Nick Craig-Wood)</li> 17177 <li>Allow <code>--max-backlog</code> to be negative meaning as large as possible (Nick Craig-Wood)</li> 17178 <li>Added <code>--no-unicode-normalization</code> flag to allow Unicode filenames to remain unique (Ben Zenker)</li> 17179 <li>Allow <code>--min-age</code>/<code>--max-age</code> to take a date as well as a duration (Nick Craig-Wood)</li> 17180 <li>Add rename statistics for file and directory renames (Nick Craig-Wood)</li> 17181 <li>Add statistics output to JSON log (reddi)</li> 17182 <li>Make stats be printed on non-zero exit code (Nick Craig-Wood)</li> 17183 <li>When running <code>--password-command</code> allow use of stdin (Sébastien Gross)</li> 17184 <li>Stop empty strings being a valid remote path (Nick Craig-Wood)</li> 17185 <li>accounting: support WriterTo for less memory copying (Nick Craig-Wood)</li> 17186 <li>build 17187 <ul> 17188 <li>Update to use go1.14 for the build (Nick Craig-Wood)</li> 17189 <li>Add <code>-trimpath</code> to release build for reproduceable builds (Nick Craig-Wood)</li> 17190 <li>Remove GOOS and GOARCH from Dockerfile (Brandon Philips)</li> 17191 </ul></li> 17192 <li>config 17193 <ul> 17194 <li>Fsync the config file after writing to save more reliably (Nick Craig-Wood)</li> 17195 <li>Add <code>--obscure</code> and <code>--no-obscure</code> flags to <code>config create</code>/<code>update</code> (Nick Craig-Wood)</li> 17196 <li>Make <code>config show</code> take <code>remote:</code> as well as <code>remote</code> (Nick Craig-Wood)</li> 17197 </ul></li> 17198 <li>copyurl: Add <code>--no-clobber</code> flag (Denis)</li> 17199 <li>delete: Added <code>--rmdirs</code> flag to delete directories as well (Kush)</li> 17200 <li>filter: Added <code>--files-from-raw</code> flag (Ankur Gupta)</li> 17201 <li>genautocomplete: Add support for fish shell (Matan Rosenberg)</li> 17202 <li>log: Add support for syslog LOCAL facilities (Patryk Jakuszew)</li> 17203 <li>lsjson: Add <code>--hash-type</code> parameter and use it in lsf to speed up hashing (Nick Craig-Wood)</li> 17204 <li>rc 17205 <ul> 17206 <li>Add <code>-o</code>/<code>--opt</code> and <code>-a</code>/<code>--arg</code> for more structured input (Nick Craig-Wood)</li> 17207 <li>Implement <code>backend/command</code> for running backend specific commands remotely (Nick Craig-Wood)</li> 17208 <li>Add <code>mount/mount</code> command for starting <code>rclone mount</code> via the API (Chaitanya)</li> 17209 </ul></li> 17210 <li>rcd: Add Prometheus metrics support (Gary Kim)</li> 17211 <li>serve http 17212 <ul> 17213 <li>Added a <code>--template</code> flag for user defined markup (calistri)</li> 17214 <li>Add Last-Modified headers to files and directories (Nick Craig-Wood)</li> 17215 </ul></li> 17216 <li>serve sftp: Add support for multiple host keys by repeating <code>--key</code> flag (Maxime Suret)</li> 17217 <li>touch: Add <code>--localtime</code> flag to make <code>--timestamp</code> localtime not UTC (Nick Craig-Wood)</li> 17218 </ul></li> 17219 <li>Bug Fixes 17220 <ul> 17221 <li>accounting 17222 <ul> 17223 <li>Restore “Max number of stats groups reached” log line (Michał Matczuk)</li> 17224 <li>Correct exitcode on Transfer Limit Exceeded flag. (Anuar Serdaliyev)</li> 17225 <li>Reset bytes read during copy retry (Ankur Gupta)</li> 17226 <li>Fix race clearing stats (Nick Craig-Wood)</li> 17227 </ul></li> 17228 <li>copy: Only create empty directories when they don’t exist on the remote (Ishuah Kariuki)</li> 17229 <li>dedupe: Stop dedupe deleting files with identical IDs (Nick Craig-Wood)</li> 17230 <li>oauth 17231 <ul> 17232 <li>Use custom http client so that <code>--no-check-certificate</code> is honored by oauth token fetch (Mark Spieth)</li> 17233 <li>Replace deprecated oauth2.NoContext (Lars Lehtonen)</li> 17234 </ul></li> 17235 <li>operations 17236 <ul> 17237 <li>Fix setting the timestamp on Windows for multithread copy (Nick Craig-Wood)</li> 17238 <li>Make rcat obey <code>--ignore-checksum</code> (Nick Craig-Wood)</li> 17239 <li>Make <code>--max-transfer</code> more accurate (Nick Craig-Wood)</li> 17240 </ul></li> 17241 <li>rc 17242 <ul> 17243 <li>Fix dropped error (Lars Lehtonen)</li> 17244 <li>Fix misplaced http server config (Xiaoxing Ye)</li> 17245 <li>Disable duplicate log (ElonH)</li> 17246 </ul></li> 17247 <li>serve dlna 17248 <ul> 17249 <li>Cds: don’t specify childCount at all when unknown (Dan Walters)</li> 17250 <li>Cds: use modification time as date in dlna metadata (Dan Walters)</li> 17251 </ul></li> 17252 <li>serve restic: Fix tests after restic project removed vendoring (Nick Craig-Wood)</li> 17253 <li>sync 17254 <ul> 17255 <li>Fix incorrect “nothing to transfer” message using <code>--delete-before</code> (Nick Craig-Wood)</li> 17256 <li>Only create empty directories when they don’t exist on the remote (Ishuah Kariuki)</li> 17257 </ul></li> 17258 </ul></li> 17259 <li>Mount 17260 <ul> 17261 <li>Add <code>--async-read</code> flag to disable asynchronous reads (Nick Craig-Wood)</li> 17262 <li>Ignore <code>--allow-root</code> flag with a warning as it has been removed upstream (Nick Craig-Wood)</li> 17263 <li>Warn if <code>--allow-non-empty</code> used on Windows and clarify docs (Nick Craig-Wood)</li> 17264 <li>Constrain to go1.13 or above otherwise bazil.org/fuse fails to compile (Nick Craig-Wood)</li> 17265 <li>Fix fail because of too long volume name (evileye)</li> 17266 <li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li> 17267 <li>Map more rclone errors into file systems errors (Nick Craig-Wood)</li> 17268 <li>Fix disappearing cwd problem (Nick Craig-Wood)</li> 17269 <li>Use ReaddirPlus on Windows to improve directory listing performance (Nick Craig-Wood)</li> 17270 <li>Send a hint as to whether the filesystem is case insensitive or not (Nick Craig-Wood)</li> 17271 <li>Add rc command <code>mount/types</code> (Nick Craig-Wood)</li> 17272 <li>Change maximum leaf name length to 1024 bytes (Nick Craig-Wood)</li> 17273 </ul></li> 17274 <li>VFS 17275 <ul> 17276 <li>Add <code>--vfs-read-wait</code> and <code>--vfs-write-wait</code> flags to control time waiting for a sequential read/write (Nick Craig-Wood)</li> 17277 <li>Change default <code>--vfs-read-wait</code> to 20ms (it was 5ms and not configurable) (Nick Craig-Wood)</li> 17278 <li>Make <code>df</code> output more consistent on a rclone mount. (Yves G)</li> 17279 <li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li> 17280 <li>Fix race condition caused by unlocked reading of Dir.path (Nick Craig-Wood)</li> 17281 <li>Make File lock and Dir lock not overlap to avoid deadlock (Nick Craig-Wood)</li> 17282 <li>Implement lock ordering between File and Dir to eliminate deadlocks (Nick Craig-Wood)</li> 17283 <li>Factor the vfs cache into its own package (Nick Craig-Wood)</li> 17284 <li>Pin the Fs in use in the Fs cache (Nick Craig-Wood)</li> 17285 <li>Add SetSys() methods to Node to allow caching stuff on a node (Nick Craig-Wood)</li> 17286 <li>Ignore file not found errors from Hash in Read.Release (Nick Craig-Wood)</li> 17287 <li>Fix hang in read wait code (Nick Craig-Wood)</li> 17288 </ul></li> 17289 <li>Local 17290 <ul> 17291 <li>Speed up multi thread downloads by using sparse files on Windows (Nick Craig-Wood)</li> 17292 <li>Implement <code>--local-no-sparse</code> flag for disabling sparse files (Nick Craig-Wood)</li> 17293 <li>Implement <code>rclone backend noop</code> for testing purposes (Nick Craig-Wood)</li> 17294 <li>Fix “file not found” errors on post transfer Hash calculation (Nick Craig-Wood)</li> 17295 </ul></li> 17296 <li>Cache 17297 <ul> 17298 <li>Implement <code>rclone backend stats</code> command (Nick Craig-Wood)</li> 17299 <li>Fix Server Side Copy with Temp Upload (Brandon McNama)</li> 17300 <li>Remove Unused Functions (Lars Lehtonen)</li> 17301 <li>Disable race tests until bbolt is fixed (Nick Craig-Wood)</li> 17302 <li>Move methods used for testing into test file (greatroar)</li> 17303 <li>Add Pin and Unpin and canonicalised lookup (Nick Craig-Wood)</li> 17304 <li>Use proper import path go.etcd.io/bbolt (Robert-André Mauchin)</li> 17305 </ul></li> 17306 <li>Crypt 17307 <ul> 17308 <li>Calculate hashes for uploads from local disk (Nick Craig-Wood) 17309 <ul> 17310 <li>This allows crypted Jottacloud uploads without using local disk</li> 17311 <li>This means crypted s3/b2 uploads will now have hashes</li> 17312 </ul></li> 17313 <li>Added <code>rclone backend decode</code>/<code>encode</code> commands to replicate functionality of <code>cryptdecode</code> (Anagh Kumar Baranwal)</li> 17314 <li>Get rid of the unused Cipher interface as it obfuscated the code (Nick Craig-Wood)</li> 17315 </ul></li> 17316 <li>Azure Blob 17317 <ul> 17318 <li>Implement streaming of unknown sized files so <code>rcat</code> is now supported (Nick Craig-Wood)</li> 17319 <li>Implement memory pooling to control memory use (Nick Craig-Wood)</li> 17320 <li>Add <code>--azureblob-disable-checksum</code> flag (Nick Craig-Wood)</li> 17321 <li>Retry <code>InvalidBlobOrBlock</code> error as it may indicate block concurrency problems (Nick Craig-Wood)</li> 17322 <li>Remove unused <code>Object.parseTimeString()</code> (Lars Lehtonen)</li> 17323 <li>Fix permission error on SAS URL limited to container (Nick Craig-Wood)</li> 17324 </ul></li> 17325 <li>B2 17326 <ul> 17327 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17328 <li>Ignore directory markers at the root also (Nick Craig-Wood)</li> 17329 <li>Force the case of the SHA1 to lowercase (Nick Craig-Wood)</li> 17330 <li>Remove unused <code>largeUpload.clearUploadURL()</code> (Lars Lehtonen)</li> 17331 </ul></li> 17332 <li>Box 17333 <ul> 17334 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17335 <li>Implement About to read size used (Nick Craig-Wood)</li> 17336 <li>Add token renew function for jwt auth (David Bramwell)</li> 17337 <li>Added support for interchangeable root folder for Box backend (Sunil Patra)</li> 17338 <li>Remove unnecessary iat from jws claims (David)</li> 17339 </ul></li> 17340 <li>Drive 17341 <ul> 17342 <li>Follow shortcuts by default, skip with <code>--drive-skip-shortcuts</code> (Nick Craig-Wood)</li> 17343 <li>Implement <code>rclone backend shortcut</code> command for creating shortcuts (Nick Craig-Wood)</li> 17344 <li>Added <code>rclone backend</code> command to change <code>service_account_file</code> and <code>chunk_size</code> (Anagh Kumar Baranwal)</li> 17345 <li>Fix missing files when using <code>--fast-list</code> and <code>--drive-shared-with-me</code> (Nick Craig-Wood)</li> 17346 <li>Fix duplicate items when using <code>--drive-shared-with-me</code> (Nick Craig-Wood)</li> 17347 <li>Extend <code>--drive-stop-on-upload-limit</code> to respond to <code>teamDriveFileLimitExceeded</code>. (harry)</li> 17348 <li>Don’t delete files with multiple parents to avoid data loss (Nick Craig-Wood)</li> 17349 <li>Server side copy docs use default description if empty (Nick Craig-Wood)</li> 17350 </ul></li> 17351 <li>Dropbox 17352 <ul> 17353 <li>Make error insufficient space to be fatal (harry)</li> 17354 <li>Add info about required redirect url (Elan Ruusamäe)</li> 17355 </ul></li> 17356 <li>Fichier 17357 <ul> 17358 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17359 <li>Implement custom pacer to deal with the new rate limiting (buengese)</li> 17360 </ul></li> 17361 <li>FTP 17362 <ul> 17363 <li>Fix lockup when using concurrency limit on failed connections (Nick Craig-Wood)</li> 17364 <li>Fix lockup on failed upload when using concurrency limit (Nick Craig-Wood)</li> 17365 <li>Fix lockup on Close failures when using concurrency limit (Nick Craig-Wood)</li> 17366 <li>Work around pureftp sending spurious 150 messages (Nick Craig-Wood)</li> 17367 </ul></li> 17368 <li>Google Cloud Storage 17369 <ul> 17370 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 17371 <li>Add <code>ARCHIVE</code> storage class to help (Adam Stroud)</li> 17372 <li>Ignore directory markers at the root (Nick Craig-Wood)</li> 17373 </ul></li> 17374 <li>Googlephotos 17375 <ul> 17376 <li>Make the start year configurable (Daven)</li> 17377 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17378 <li>Create feature/favorites directory (Brandon Philips)</li> 17379 <li>Fix “concurrent map write” error (Nick Craig-Wood)</li> 17380 <li>Don’t put an image in error message (Nick Craig-Wood)</li> 17381 </ul></li> 17382 <li>HTTP 17383 <ul> 17384 <li>Improved directory listing with new template from Caddy project (calisro)</li> 17385 </ul></li> 17386 <li>Jottacloud 17387 <ul> 17388 <li>Implement <code>--jottacloud-trashed-only</code> (buengese)</li> 17389 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17390 <li>Use <code>RawURLEncoding</code> when decoding base64 encoded login token (buengese)</li> 17391 <li>Implement cleanup (buengese)</li> 17392 <li>Update docs regarding cleanup, removed remains from old auth, and added warning about special mountpoints. (albertony)</li> 17393 </ul></li> 17394 <li>Mailru 17395 <ul> 17396 <li>Describe 2FA requirements (valery1707)</li> 17397 </ul></li> 17398 <li>Onedrive 17399 <ul> 17400 <li>Implement <code>--onedrive-server-side-across-configs</code> (Nick Craig-Wood)</li> 17401 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17402 <li>Fix occasional 416 errors on multipart uploads (Nick Craig-Wood)</li> 17403 <li>Added maximum chunk size limit warning in the docs (Harry)</li> 17404 <li>Fix missing drive on config (Nick Craig-Wood)</li> 17405 <li>Make error <code>quotaLimitReached</code> to be fatal (harry)</li> 17406 </ul></li> 17407 <li>Opendrive 17408 <ul> 17409 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17410 </ul></li> 17411 <li>Pcloud 17412 <ul> 17413 <li>Added support for interchangeable root folder for pCloud backend (Sunil Patra)</li> 17414 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17415 <li>Fix initial config “Auth state doesn’t match” message (Nick Craig-Wood)</li> 17416 </ul></li> 17417 <li>Premiumizeme 17418 <ul> 17419 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17420 <li>Prune unused functions (Lars Lehtonen)</li> 17421 </ul></li> 17422 <li>Putio 17423 <ul> 17424 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 17425 <li>Make downloading files use the rclone http Client (Nick Craig-Wood)</li> 17426 <li>Fix parsing of remotes with leading and trailing / (Nick Craig-Wood)</li> 17427 </ul></li> 17428 <li>Qingstor 17429 <ul> 17430 <li>Make <code>rclone cleanup</code> remove pending multipart uploads older than 24h (Nick Craig-Wood)</li> 17431 <li>Try harder to cancel failed multipart uploads (Nick Craig-Wood)</li> 17432 <li>Prune <code>multiUploader.list()</code> (Lars Lehtonen)</li> 17433 <li>Lint fix (Lars Lehtonen)</li> 17434 </ul></li> 17435 <li>S3 17436 <ul> 17437 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17438 <li>Use memory pool for buffer allocations (Maciej Zimnoch)</li> 17439 <li>Add SSE-C support for AWS, Ceph, and MinIO (Jack Anderson)</li> 17440 <li>Fail fast multipart upload (Michał Matczuk)</li> 17441 <li>Report errors on bucket creation (mkdir) correctly (Nick Craig-Wood)</li> 17442 <li>Specify that Minio supports URL encoding in listings (Nick Craig-Wood)</li> 17443 <li>Added 500 as retryErrorCode (Michał Matczuk)</li> 17444 <li>Use <code>--low-level-retries</code> as the number of SDK retries (Aleksandar Janković)</li> 17445 <li>Fix multipart abort context (Aleksandar Jankovic)</li> 17446 <li>Replace deprecated <code>session.New()</code> with <code>session.NewSession()</code> (Lars Lehtonen)</li> 17447 <li>Use the provided size parameter when allocating a new memory pool (Joachim Brandon LeBlanc)</li> 17448 <li>Use rclone’s low level retries instead of AWS SDK to fix listing retries (Nick Craig-Wood)</li> 17449 <li>Ignore directory markers at the root also (Nick Craig-Wood)</li> 17450 <li>Use single memory pool (Michał Matczuk)</li> 17451 <li>Do not resize buf on put to memBuf (Michał Matczuk)</li> 17452 <li>Improve docs for <code>--s3-disable-checksum</code> (Nick Craig-Wood)</li> 17453 <li>Don’t leak memory or tokens in edge cases for multipart upload (Nick Craig-Wood)</li> 17454 </ul></li> 17455 <li>Seafile 17456 <ul> 17457 <li>Implement 2FA (Fred)</li> 17458 </ul></li> 17459 <li>SFTP 17460 <ul> 17461 <li>Added <code>--sftp-pem-key</code> to support inline key files (calisro)</li> 17462 <li>Fix post transfer copies failing with 0 size when using <code>set_modtime=false</code> (Nick Craig-Wood)</li> 17463 </ul></li> 17464 <li>Sharefile 17465 <ul> 17466 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17467 </ul></li> 17468 <li>Sugarsync 17469 <ul> 17470 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17471 </ul></li> 17472 <li>Swift 17473 <ul> 17474 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 17475 <li>Fix cosmetic issue in error message (Martin Michlmayr)</li> 17476 </ul></li> 17477 <li>Union 17478 <ul> 17479 <li>Implement multiple writable remotes (Max Sum)</li> 17480 <li>Fix server-side copy (Max Sum)</li> 17481 <li>Implement ListR (Max Sum)</li> 17482 <li>Enable ListR when upstreams contain local (Max Sum)</li> 17483 </ul></li> 17484 <li>WebDAV 17485 <ul> 17486 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17487 <li>Fix <code>X-OC-Mtime</code> header for Transip compatibility (Nick Craig-Wood)</li> 17488 <li>Report full and consistent usage with <code>about</code> (Yves G)</li> 17489 </ul></li> 17490 <li>Yandex 17491 <ul> 17492 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 17493 </ul></li> 17494 </ul> 17495 <h2 id="v1.51.0---2020-02-01">v1.51.0 - 2020-02-01</h2> 17496 <ul> 17497 <li>New backends 17498 <ul> 17499 <li><a href="https://rclone.org/memory/">Memory</a> (Nick Craig-Wood)</li> 17500 <li><a href="https://rclone.org/sugarsync/">Sugarsync</a> (Nick Craig-Wood)</li> 17501 </ul></li> 17502 <li>New Features 17503 <ul> 17504 <li>Adjust all backends to have <code>--backend-encoding</code> parameter (Nick Craig-Wood) 17505 <ul> 17506 <li>this enables the encoding for special characters to be adjusted or disabled</li> 17507 </ul></li> 17508 <li>Add <code>--max-duration</code> flag to control the maximum duration of a transfer session (boosh)</li> 17509 <li>Add <code>--expect-continue-timeout</code> flag, default 1s (Nick Craig-Wood)</li> 17510 <li>Add <code>--no-check-dest</code> flag for copying without testing the destination (Nick Craig-Wood)</li> 17511 <li>Implement <code>--order-by</code> flag to order transfers (Nick Craig-Wood)</li> 17512 <li>accounting 17513 <ul> 17514 <li>Don’t show entries in both transferring and checking (Nick Craig-Wood)</li> 17515 <li>Add option to delete stats (Aleksandar Jankovic)</li> 17516 </ul></li> 17517 <li>build 17518 <ul> 17519 <li>Compress the test builds with gzip (Nick Craig-Wood)</li> 17520 <li>Implement a framework for starting test servers during tests (Nick Craig-Wood)</li> 17521 </ul></li> 17522 <li>cmd: Always print elapsed time to tenth place seconds in progress (Gary Kim)</li> 17523 <li>config 17524 <ul> 17525 <li>Add <code>--password-command</code> to allow dynamic config password (Damon Permezel)</li> 17526 <li>Give config questions default values (Nick Craig-Wood)</li> 17527 <li>Check a remote exists when creating a new one (Nick Craig-Wood)</li> 17528 </ul></li> 17529 <li>copyurl: Add <code>--stdout</code> flag to write to stdout (Nick Craig-Wood)</li> 17530 <li>dedupe: Implement keep smallest too (Nick Craig-Wood)</li> 17531 <li>hashsum: Add flag <code>--base64</code> flag (landall)</li> 17532 <li>lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick Craig-Wood)</li> 17533 <li>lsjson: Add <code>--no-mimetype</code> flag (Nick Craig-Wood)</li> 17534 <li>rc: Add methods to turn on blocking and mutex profiling (Nick Craig-Wood)</li> 17535 <li>rcd 17536 <ul> 17537 <li>Adding group parameter to stats (Chaitanya)</li> 17538 <li>Move webgui apart; option to disable browser (Xiaoxing Ye)</li> 17539 </ul></li> 17540 <li>serve sftp: Add support for public key with auth proxy (Paul Tinsley)</li> 17541 <li>stats: Show deletes in stats and hide zero stats (anuar45)</li> 17542 </ul></li> 17543 <li>Bug Fixes 17544 <ul> 17545 <li>accounting 17546 <ul> 17547 <li>Fix error counter counting multiple times (Ankur Gupta)</li> 17548 <li>Fix error count shown as checks (Cnly)</li> 17549 <li>Clear finished transfer in stats-reset (Maciej Zimnoch)</li> 17550 <li>Added StatsInfo locking in statsGroups sum function (Michał Matczuk)</li> 17551 </ul></li> 17552 <li>asyncreader: Fix EOF error (buengese)</li> 17553 <li>check: Fix <code>--one-way</code> recursing more directories than it needs to (Nick Craig-Wood)</li> 17554 <li>chunkedreader: Disable hash calculation for first segment (Nick Craig-Wood)</li> 17555 <li>config 17556 <ul> 17557 <li>Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye)</li> 17558 <li>SetValueAndSave ignore error if config section does not exist yet (buengese)</li> 17559 </ul></li> 17560 <li>cmd: Fix completion with an encrypted config (Danil Semelenov)</li> 17561 <li>dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick Craig-Wood)</li> 17562 <li>dedupe: Add missing modes to help string (Nick Craig-Wood)</li> 17563 <li>operations 17564 <ul> 17565 <li>Fix dedupe continuing on errors like insufficientFilePermisson (SezalAgrawal)</li> 17566 <li>Clear accounting before low level retry (Maciej Zimnoch)</li> 17567 <li>Write debug message when hashes could not be checked (Ole Schütt)</li> 17568 <li>Move interface assertion to tests to remove pflag dependency (Nick Craig-Wood)</li> 17569 <li>Make NewOverrideObjectInfo public and factor uses (Nick Craig-Wood)</li> 17570 </ul></li> 17571 <li>proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood)</li> 17572 <li>vendor 17573 <ul> 17574 <li>Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood)</li> 17575 <li>Update github.com/t3rm1n4l/go-mega to fix mega “illegal base64 data at input byte 22” (Nick Craig-Wood)</li> 17576 <li>Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu)</li> 17577 <li>Update t3rm1n4l/go-mega - fixes mega: couldn’t login: crypto/aes: invalid key size 0 (Nick Craig-Wood)</li> 17578 </ul></li> 17579 </ul></li> 17580 <li>Mount 17581 <ul> 17582 <li>Enable async reads for a 20% speedup (Nick Craig-Wood)</li> 17583 <li>Replace use of WriteAt with Write for cache mode >= writes and O_APPEND (Brett Dutro)</li> 17584 <li>Make sure we call unmount when exiting (Nick Craig-Wood)</li> 17585 <li>Don’t build on go1.10 as bazil/fuse no longer supports it (Nick Craig-Wood)</li> 17586 <li>When setting dates discard out of range dates (Nick Craig-Wood)</li> 17587 </ul></li> 17588 <li>VFS 17589 <ul> 17590 <li>Add a newly created file straight into the directory (Nick Craig-Wood)</li> 17591 <li>Only calculate one hash for reads for a speedup (Nick Craig-Wood)</li> 17592 <li>Make ReadAt for non cached files work better with non-sequential reads (Nick Craig-Wood)</li> 17593 <li>Fix edge cases when reading ModTime from file (Nick Craig-Wood)</li> 17594 <li>Make sure existing files opened for write show correct size (Nick Craig-Wood)</li> 17595 <li>Don’t cache the path in RW file objects to fix renaming (Nick Craig-Wood)</li> 17596 <li>Fix rename of open files when using the VFS cache (Nick Craig-Wood)</li> 17597 <li>When renaming files in the cache, rename the cache item in memory too (Nick Craig-Wood)</li> 17598 <li>Fix open file renaming on drive when using <code>--vfs-cache-mode writes</code> (Nick Craig-Wood)</li> 17599 <li>Fix incorrect modtime for mv into mount with <code>--vfs-cache-modes writes</code> (Nick Craig-Wood)</li> 17600 <li>On rename, rename in cache too if the file exists (Anagh Kumar Baranwal)</li> 17601 </ul></li> 17602 <li>Local 17603 <ul> 17604 <li>Make source file being updated errors be NoLowLevelRetry errors (Nick Craig-Wood)</li> 17605 <li>Fix update of hidden files on Windows (Nick Craig-Wood)</li> 17606 </ul></li> 17607 <li>Cache 17608 <ul> 17609 <li>Follow move of upstream library github.com/coreos/bbolt github.com/etcd-io/bbolt (Nick Craig-Wood)</li> 17610 <li>Fix <code>fatal error: concurrent map writes</code> (Nick Craig-Wood)</li> 17611 </ul></li> 17612 <li>Crypt 17613 <ul> 17614 <li>Reorder the filename encryption options (Thomas Eales)</li> 17615 <li>Correctly handle trailing dot (buengese)</li> 17616 </ul></li> 17617 <li>Chunker 17618 <ul> 17619 <li>Reduce length of temporary suffix (Ivan Andreev)</li> 17620 </ul></li> 17621 <li>Drive 17622 <ul> 17623 <li>Add <code>--drive-stop-on-upload-limit</code> flag to stop syncs when upload limit reached (Nick Craig-Wood)</li> 17624 <li>Add <code>--drive-use-shared-date</code> to use date file was shared instead of modified date (Garry McNulty)</li> 17625 <li>Make sure invalid auth for teamdrives always reports an error (Nick Craig-Wood)</li> 17626 <li>Fix <code>--fast-list</code> when using appDataFolder (Nick Craig-Wood)</li> 17627 <li>Use multipart resumable uploads for streaming and uploads in mount (Nick Craig-Wood)</li> 17628 <li>Log an ERROR if an incomplete search is returned (Nick Craig-Wood)</li> 17629 <li>Hide dangerous config from the configurator (Nick Craig-Wood)</li> 17630 </ul></li> 17631 <li>Dropbox 17632 <ul> 17633 <li>Treat <code>insufficient_space</code> errors as non retriable errors (Nick Craig-Wood)</li> 17634 </ul></li> 17635 <li>Jottacloud 17636 <ul> 17637 <li>Use new auth method used by official client (buengese)</li> 17638 <li>Add URL to generate Login Token to config wizard (Nick Craig-Wood)</li> 17639 <li>Add support whitelabel versions (buengese)</li> 17640 </ul></li> 17641 <li>Koofr 17642 <ul> 17643 <li>Use rclone HTTP client. (jaKa)</li> 17644 </ul></li> 17645 <li>Onedrive 17646 <ul> 17647 <li>Add Sites.Read.All permission (Benjamin Richter)</li> 17648 <li>Add support “Retry-After” header (Motonori IWAMURO)</li> 17649 </ul></li> 17650 <li>Opendrive 17651 <ul> 17652 <li>Implement <code>--opendrive-chunk-size</code> (Nick Craig-Wood)</li> 17653 </ul></li> 17654 <li>S3 17655 <ul> 17656 <li>Re-implement multipart upload to fix memory issues (Nick Craig-Wood)</li> 17657 <li>Add <code>--s3-copy-cutoff</code> for size to switch to multipart copy (Nick Craig-Wood)</li> 17658 <li>Add new region Asia Patific (Hong Kong) (Outvi V)</li> 17659 <li>Reduce memory usage streaming files by reducing max stream upload size (Nick Craig-Wood)</li> 17660 <li>Add <code>--s3-list-chunk</code> option for bucket listing (Thomas Kriechbaumer)</li> 17661 <li>Force path style bucket access to off for AWS deprecation (Nick Craig-Wood)</li> 17662 <li>Use AWS web identity role provider if available (Tennix)</li> 17663 <li>Add StackPath Object Storage Support (Dave Koston)</li> 17664 <li>Fix ExpiryWindow value (Aleksandar Jankovic)</li> 17665 <li>Fix DisableChecksum condition (Aleksandar Janković)</li> 17666 <li>Fix URL decoding of NextMarker (Nick Craig-Wood)</li> 17667 </ul></li> 17668 <li>SFTP 17669 <ul> 17670 <li>Add <code>--sftp-skip-links</code> to skip symlinks and non regular files (Nick Craig-Wood)</li> 17671 <li>Retry Creation of Connection (Sebastian Brandt)</li> 17672 <li>Fix “failed to parse private key file: ssh: not an encrypted key” error (Nick Craig-Wood)</li> 17673 <li>Open files for update write only to fix AWS SFTP interop (Nick Craig-Wood)</li> 17674 </ul></li> 17675 <li>Swift 17676 <ul> 17677 <li>Reserve segments of dynamic large object when delete objects in container what was enabled versioning. (Nguyễn Hữu Luân)</li> 17678 <li>Fix parsing of X-Object-Manifest (Nick Craig-Wood)</li> 17679 <li>Update OVH API endpoint (unbelauscht)</li> 17680 </ul></li> 17681 <li>WebDAV 17682 <ul> 17683 <li>Make nextcloud only upload SHA1 checksums (Nick Craig-Wood)</li> 17684 <li>Fix case of “Bearer” in Authorization: header to agree with RFC (Nick Craig-Wood)</li> 17685 <li>Add Referer header to fix problems with WAFs (Nick Craig-Wood)</li> 17686 </ul></li> 17687 </ul> 17688 <h2 id="v1.50.2---2019-11-19">v1.50.2 - 2019-11-19</h2> 17689 <ul> 17690 <li>Bug Fixes 17691 <ul> 17692 <li>accounting: Fix memory leak on retries operations (Nick Craig-Wood)</li> 17693 </ul></li> 17694 <li>Drive 17695 <ul> 17696 <li>Fix listing of the root directory with drive.files scope (Nick Craig-Wood)</li> 17697 <li>Fix –drive-root-folder-id with team/shared drives (Nick Craig-Wood)</li> 17698 </ul></li> 17699 </ul> 17700 <h2 id="v1.50.1---2019-11-02">v1.50.1 - 2019-11-02</h2> 17701 <ul> 17702 <li>Bug Fixes 17703 <ul> 17704 <li>hash: Fix accidentally changed hash names for <code>DropboxHash</code> and <code>CRC-32</code> (Nick Craig-Wood)</li> 17705 <li>fshttp: Fix error reporting on tpslimit token bucket errors (Nick Craig-Wood)</li> 17706 <li>fshttp: Don’t print token bucket errors on context cancelled (Nick Craig-Wood)</li> 17707 </ul></li> 17708 <li>Local 17709 <ul> 17710 <li>Fix listings of . on Windows (Nick Craig-Wood)</li> 17711 </ul></li> 17712 <li>Onedrive 17713 <ul> 17714 <li>Fix DirMove/Move after Onedrive change (Xiaoxing Ye)</li> 17715 </ul></li> 17716 </ul> 17717 <h2 id="v1.50.0---2019-10-26">v1.50.0 - 2019-10-26</h2> 17718 <ul> 17719 <li>New backends 17720 <ul> 17721 <li><a href="https://rclone.org/sharefile/">Citrix Sharefile</a> (Nick Craig-Wood)</li> 17722 <li><a href="https://rclone.org/chunker/">Chunker</a> - an overlay backend to split files into smaller parts (Ivan Andreev)</li> 17723 <li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a> (Ivan Andreev)</li> 17724 </ul></li> 17725 <li>New Features 17726 <ul> 17727 <li>encodings (Fabian Möller & Nick Craig-Wood) 17728 <ul> 17729 <li>All backends now use file name encoding to ensure any file name can be written to any backend.</li> 17730 <li>See the <a href="https://rclone.org/overview/#restricted-filenames">restricted file name docs</a> for more info and the <a href="/local/#filenames">local backend docs</a>.</li> 17731 <li>Some file names may look different in rclone if you are using any control characters in names or <a href="https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block)">unicode FULLWIDTH symbols</a>.</li> 17732 </ul></li> 17733 <li>build 17734 <ul> 17735 <li>Update to use go1.13 for the build (Nick Craig-Wood)</li> 17736 <li>Drop support for go1.9 (Nick Craig-Wood)</li> 17737 <li>Build rclone with GitHub actions (Nick Craig-Wood)</li> 17738 <li>Convert python scripts to python3 (Nick Craig-Wood)</li> 17739 <li>Swap Azure/go-ansiterm for mattn/go-colorable (Nick Craig-Wood)</li> 17740 <li>Dockerfile fixes (Matei David)</li> 17741 <li>Add <a href="https://github.com/rclone/rclone/blob/master/CONTRIBUTING.md#writing-a-plugin">plugin support</a> for backends and commands (Richard Patel)</li> 17742 </ul></li> 17743 <li>config 17744 <ul> 17745 <li>Use alternating Red/Green in config to make more obvious (Nick Craig-Wood)</li> 17746 </ul></li> 17747 <li>contrib 17748 <ul> 17749 <li>Add sample DLNA server Docker Compose manifest. (pataquets)</li> 17750 <li>Add sample WebDAV server Docker Compose manifest. (pataquets)</li> 17751 </ul></li> 17752 <li>copyurl 17753 <ul> 17754 <li>Add <code>--auto-filename</code> flag for using file name from URL in destination path (Denis)</li> 17755 </ul></li> 17756 <li>serve dlna: 17757 <ul> 17758 <li>Many compatibility improvements (Dan Walters)</li> 17759 <li>Support for external srt subtitles (Dan Walters)</li> 17760 </ul></li> 17761 <li>rc 17762 <ul> 17763 <li>Added command core/quit (Saksham Khanna)</li> 17764 </ul></li> 17765 </ul></li> 17766 <li>Bug Fixes 17767 <ul> 17768 <li>sync 17769 <ul> 17770 <li>Make <code>--update</code>/<code>-u</code> not transfer files that haven’t changed (Nick Craig-Wood)</li> 17771 <li>Free objects after they come out of the transfer pipe to save memory (Nick Craig-Wood)</li> 17772 <li>Fix <code>--files-from without --no-traverse</code> doing a recursive scan (Nick Craig-Wood)</li> 17773 </ul></li> 17774 <li>operations 17775 <ul> 17776 <li>Fix accounting for server side copies (Nick Craig-Wood)</li> 17777 <li>Display ‘All duplicates removed’ only if dedupe successful (Sezal Agrawal)</li> 17778 <li>Display ‘Deleted X extra copies’ only if dedupe successful (Sezal Agrawal)</li> 17779 </ul></li> 17780 <li>accounting 17781 <ul> 17782 <li>Only allow up to 100 completed transfers in the accounting list to save memory (Nick Craig-Wood)</li> 17783 <li>Cull the old time ranges when possible to save memory (Nick Craig-Wood)</li> 17784 <li>Fix panic due to server-side copy fallback (Ivan Andreev)</li> 17785 <li>Fix memory leak noticeable for transfers of large numbers of objects (Nick Craig-Wood)</li> 17786 <li>Fix total duration calculation (Nick Craig-Wood)</li> 17787 </ul></li> 17788 <li>cmd 17789 <ul> 17790 <li>Fix environment variables not setting command line flags (Nick Craig-Wood)</li> 17791 <li>Make autocomplete compatible with bash’s posix mode for macOS (Danil Semelenov)</li> 17792 <li>Make <code>--progress</code> work in git bash on Windows (Nick Craig-Wood)</li> 17793 <li>Fix ‘compopt: command not found’ on autocomplete on macOS (Danil Semelenov)</li> 17794 </ul></li> 17795 <li>config 17796 <ul> 17797 <li>Fix setting of non top level flags from environment variables (Nick Craig-Wood)</li> 17798 <li>Check config names more carefully and report errors (Nick Craig-Wood)</li> 17799 <li>Remove error: can’t use <code>--size-only</code> and <code>--ignore-size</code> together. (Nick Craig-Wood)</li> 17800 </ul></li> 17801 <li>filter: Prevent mixing options when <code>--files-from</code> is in use (Michele Caci)</li> 17802 <li>serve sftp: Fix crash on unsupported operations (eg Readlink) (Nick Craig-Wood)</li> 17803 </ul></li> 17804 <li>Mount 17805 <ul> 17806 <li>Allow files of unknown size to be read properly (Nick Craig-Wood)</li> 17807 <li>Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood)</li> 17808 <li>Fix panic on File.Open (Nick Craig-Wood)</li> 17809 <li>Fix “mount_fusefs: -o timeout=: option not supported” on FreeBSD (Nick Craig-Wood)</li> 17810 <li>Don’t pass huge filenames (>4k) to FUSE as it can’t cope (Nick Craig-Wood)</li> 17811 </ul></li> 17812 <li>VFS 17813 <ul> 17814 <li>Add flag <code>--vfs-case-insensitive</code> for windows/macOS mounts (Ivan Andreev)</li> 17815 <li>Make objects of unknown size readable through the VFS (Nick Craig-Wood)</li> 17816 <li>Move writeback of dirty data out of close() method into its own method (FlushWrites) and remove close() call from Flush() (Brett Dutro)</li> 17817 <li>Stop empty dirs disappearing when renamed on bucket based remotes (Nick Craig-Wood)</li> 17818 <li>Stop change notify polling clearing so much of the directory cache (Nick Craig-Wood)</li> 17819 </ul></li> 17820 <li>Azure Blob 17821 <ul> 17822 <li>Disable logging to the Windows event log (Nick Craig-Wood)</li> 17823 </ul></li> 17824 <li>B2 17825 <ul> 17826 <li>Remove <code>unverified:</code> prefix on sha1 to improve interop (eg with CyberDuck) (Nick Craig-Wood)</li> 17827 </ul></li> 17828 <li>Box 17829 <ul> 17830 <li>Add options to get access token via JWT auth (David)</li> 17831 </ul></li> 17832 <li>Drive 17833 <ul> 17834 <li>Disable HTTP/2 by default to work around INTERNAL_ERROR problems (Nick Craig-Wood)</li> 17835 <li>Make sure that drive root ID is always canonical (Nick Craig-Wood)</li> 17836 <li>Fix <code>--drive-shared-with-me</code> from the root with lsand <code>--fast-list</code> (Nick Craig-Wood)</li> 17837 <li>Fix ChangeNotify polling for shared drives (Nick Craig-Wood)</li> 17838 <li>Fix change notify polling when using appDataFolder (Nick Craig-Wood)</li> 17839 </ul></li> 17840 <li>Dropbox 17841 <ul> 17842 <li>Make disallowed filenames errors not retry (Nick Craig-Wood)</li> 17843 <li>Fix nil pointer exception on restricted files (Nick Craig-Wood)</li> 17844 </ul></li> 17845 <li>Fichier 17846 <ul> 17847 <li>Fix accessing files > 2GB on 32 bit systems (Nick Craig-Wood)</li> 17848 </ul></li> 17849 <li>FTP 17850 <ul> 17851 <li>Allow disabling EPSV mode (Jon Fautley)</li> 17852 </ul></li> 17853 <li>HTTP 17854 <ul> 17855 <li>HEAD directory entries in parallel to speedup (Nick Craig-Wood)</li> 17856 <li>Add <code>--http-no-head</code> to stop rclone doing HEAD in listings (Nick Craig-Wood)</li> 17857 </ul></li> 17858 <li>Putio 17859 <ul> 17860 <li>Add ability to resume uploads (Cenk Alti)</li> 17861 </ul></li> 17862 <li>S3 17863 <ul> 17864 <li>Fix signature v2_auth headers (Anthony Rusdi)</li> 17865 <li>Fix encoding for control characters (Nick Craig-Wood)</li> 17866 <li>Only ask for URL encoded directory listings if we need them on Ceph (Nick Craig-Wood)</li> 17867 <li>Add option for multipart failure behaviour (Aleksandar Jankovic)</li> 17868 <li>Support for multipart copy (庄天翼)</li> 17869 <li>Fix nil pointer reference if no metadata returned for object (Nick Craig-Wood)</li> 17870 </ul></li> 17871 <li>SFTP 17872 <ul> 17873 <li>Fix <code>--sftp-ask-password</code> trying to contact the ssh agent (Nick Craig-Wood)</li> 17874 <li>Fix hashes of files with backslashes (Nick Craig-Wood)</li> 17875 <li>Include more ciphers with <code>--sftp-use-insecure-cipher</code> (Carlos Ferreyra)</li> 17876 </ul></li> 17877 <li>WebDAV 17878 <ul> 17879 <li>Parse and return Sharepoint error response (Henning Surmeier)</li> 17880 </ul></li> 17881 </ul> 17882 <h2 id="v1.49.5---2019-10-05">v1.49.5 - 2019-10-05</h2> 17883 <ul> 17884 <li>Bug Fixes 17885 <ul> 17886 <li>Revert back to go1.12.x for the v1.49.x builds as go1.13.x was causing issues (Nick Craig-Wood)</li> 17887 <li>Fix rpm packages by using master builds of nfpm (Nick Craig-Wood)</li> 17888 <li>Fix macOS build after brew changes (Nick Craig-Wood)</li> 17889 </ul></li> 17890 </ul> 17891 <h2 id="v1.49.4---2019-09-29">v1.49.4 - 2019-09-29</h2> 17892 <ul> 17893 <li>Bug Fixes 17894 <ul> 17895 <li>cmd/rcd: Address ZipSlip vulnerability (Richard Patel)</li> 17896 <li>accounting: Fix file handle leak on errors (Nick Craig-Wood)</li> 17897 <li>oauthutil: Fix security problem when running with two users on the same machine (Nick Craig-Wood)</li> 17898 </ul></li> 17899 <li>FTP 17900 <ul> 17901 <li>Fix listing of an empty root returning: error dir not found (Nick Craig-Wood)</li> 17902 </ul></li> 17903 <li>S3 17904 <ul> 17905 <li>Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get tier (Nick Craig-Wood)</li> 17906 </ul></li> 17907 </ul> 17908 <h2 id="v1.49.3---2019-09-15">v1.49.3 - 2019-09-15</h2> 17909 <ul> 17910 <li>Bug Fixes 17911 <ul> 17912 <li>accounting 17913 <ul> 17914 <li>Fix total duration calculation (Aleksandar Jankovic)</li> 17915 <li>Fix “file already closed” on transfer retries (Nick Craig-Wood)</li> 17916 </ul></li> 17917 </ul></li> 17918 </ul> 17919 <h2 id="v1.49.2---2019-09-08">v1.49.2 - 2019-09-08</h2> 17920 <ul> 17921 <li>New Features 17922 <ul> 17923 <li>build: Add Docker workflow support (Alfonso Montero)</li> 17924 </ul></li> 17925 <li>Bug Fixes 17926 <ul> 17927 <li>accounting: Fix locking in Transfer to avoid deadlock with <code>--progress</code> (Nick Craig-Wood)</li> 17928 <li>docs: Fix template argument for mktemp in install.sh (Cnly)</li> 17929 <li>operations: Fix <code>-u</code>/<code>--update</code> with google photos / files of unknown size (Nick Craig-Wood)</li> 17930 <li>rc: Fix docs for config/create /update /password (Nick Craig-Wood)</li> 17931 </ul></li> 17932 <li>Google Cloud Storage 17933 <ul> 17934 <li>Fix need for elevated permissions on SetModTime (Nick Craig-Wood)</li> 17935 </ul></li> 17936 </ul> 17937 <h2 id="v1.49.1---2019-08-28">v1.49.1 - 2019-08-28</h2> 17938 <ul> 17939 <li>Bug Fixes 17940 <ul> 17941 <li>config: Fix generated passwords being stored as empty password (Nick Craig-Wood)</li> 17942 <li>rcd: Added missing parameter for web-gui info logs. (Chaitanya)</li> 17943 </ul></li> 17944 <li>Googlephotos 17945 <ul> 17946 <li>Fix crash on error response (Nick Craig-Wood)</li> 17947 </ul></li> 17948 <li>Onedrive 17949 <ul> 17950 <li>Fix crash on error response (Nick Craig-Wood)</li> 17951 </ul></li> 17952 </ul> 17953 <h2 id="v1.49.0---2019-08-26">v1.49.0 - 2019-08-26</h2> 17954 <ul> 17955 <li>New backends 17956 <ul> 17957 <li><a href="https://rclone.org/fichier/">1fichier</a> (Laura Hausmann)</li> 17958 <li><a href="https://rclone.org/googlephotos/">Google Photos</a> (Nick Craig-Wood)</li> 17959 <li><a href="https://rclone.org/putio/">Putio</a> (Cenk Alti)</li> 17960 <li><a href="https://rclone.org/premiumizeme/">premiumize.me</a> (Nick Craig-Wood)</li> 17961 </ul></li> 17962 <li>New Features 17963 <ul> 17964 <li>Experimental <a href="https://rclone.org/gui/">web GUI</a> (Chaitanya Bankanhal)</li> 17965 <li>Implement <code>--compare-dest</code> & <code>--copy-dest</code> (yparitcher)</li> 17966 <li>Implement <code>--suffix</code> without <code>--backup-dir</code> for backup to current dir (yparitcher)</li> 17967 <li><code>config reconnect</code> to re-login (re-run the oauth login) for the backend. (Nick Craig-Wood)</li> 17968 <li><code>config userinfo</code> to discover which user you are logged in as. (Nick Craig-Wood)</li> 17969 <li><code>config disconnect</code> to disconnect you (log out) from the backend. (Nick Craig-Wood)</li> 17970 <li>Add <code>--use-json-log</code> for JSON logging (justinalin)</li> 17971 <li>Add context propagation to rclone (Aleksandar Jankovic)</li> 17972 <li>Reworking internal statistics interfaces so they work with rc jobs (Aleksandar Jankovic)</li> 17973 <li>Add Higher units for ETA (AbelThar)</li> 17974 <li>Update rclone logos to new design (Andreas Chlupka)</li> 17975 <li>hash: Add CRC-32 support (Cenk Alti)</li> 17976 <li>help showbackend: Fixed advanced option category when there are no standard options (buengese)</li> 17977 <li>ncdu: Display/Copy to Clipboard Current Path (Gary Kim)</li> 17978 <li>operations: 17979 <ul> 17980 <li>Run hashing operations in parallel (Nick Craig-Wood)</li> 17981 <li>Don’t calculate checksums when using <code>--ignore-checksum</code> (Nick Craig-Wood)</li> 17982 <li>Check transfer hashes when using <code>--size-only</code> mode (Nick Craig-Wood)</li> 17983 <li>Disable multi thread copy for local to local copies (Nick Craig-Wood)</li> 17984 <li>Debug successful hashes as well as failures (Nick Craig-Wood)</li> 17985 </ul></li> 17986 <li>rc 17987 <ul> 17988 <li>Add ability to stop async jobs (Aleksandar Jankovic)</li> 17989 <li>Return current settings if core/bwlimit called without parameters (Nick Craig-Wood)</li> 17990 <li>Rclone-WebUI integration with rclone (Chaitanya Bankanhal)</li> 17991 <li>Added command line parameter to control the cross origin resource sharing (CORS) in the rcd. (Security Improvement) (Chaitanya Bankanhal)</li> 17992 <li>Add anchor tags to the docs so links are consistent (Nick Craig-Wood)</li> 17993 <li>Remove _async key from input parameters after parsing so later operations won’t get confused (buengese)</li> 17994 <li>Add call to clear stats (Aleksandar Jankovic)</li> 17995 </ul></li> 17996 <li>rcd 17997 <ul> 17998 <li>Auto-login for web-gui (Chaitanya Bankanhal)</li> 17999 <li>Implement <code>--baseurl</code> for rcd and web-gui (Chaitanya Bankanhal)</li> 18000 </ul></li> 18001 <li>serve dlna 18002 <ul> 18003 <li>Only select interfaces which can multicast for SSDP (Nick Craig-Wood)</li> 18004 <li>Add more builtin mime types to cover standard audio/video (Nick Craig-Wood)</li> 18005 <li>Fix missing mime types on Android causing missing videos (Nick Craig-Wood)</li> 18006 </ul></li> 18007 <li>serve ftp 18008 <ul> 18009 <li>Refactor to bring into line with other serve commands (Nick Craig-Wood)</li> 18010 <li>Implement <code>--auth-proxy</code> (Nick Craig-Wood)</li> 18011 </ul></li> 18012 <li>serve http: Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 18013 <li>serve restic: Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 18014 <li>serve sftp 18015 <ul> 18016 <li>Implement auth proxy (Nick Craig-Wood)</li> 18017 <li>Fix detection of whether server is authorized (Nick Craig-Wood)</li> 18018 </ul></li> 18019 <li>serve webdav 18020 <ul> 18021 <li>Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 18022 <li>Support <code>--auth-proxy</code> (Nick Craig-Wood)</li> 18023 </ul></li> 18024 </ul></li> 18025 <li>Bug Fixes 18026 <ul> 18027 <li>Make “bad record MAC” a retriable error (Nick Craig-Wood)</li> 18028 <li>copyurl: Fix copying files that return HTTP errors (Nick Craig-Wood)</li> 18029 <li>march: Fix checking sub-directories when using <code>--no-traverse</code> (buengese)</li> 18030 <li>rc 18031 <ul> 18032 <li>Fix unmarshalable http.AuthFn in options and put in test for marshalability (Nick Craig-Wood)</li> 18033 <li>Move job expire flags to rc to fix initialization problem (Nick Craig-Wood)</li> 18034 <li>Fix <code>--loopback</code> with rc/list and others (Nick Craig-Wood)</li> 18035 </ul></li> 18036 <li>rcat: Fix slowdown on systems with multiple hashes (Nick Craig-Wood)</li> 18037 <li>rcd: Fix permissions problems on cache directory with web gui download (Nick Craig-Wood)</li> 18038 </ul></li> 18039 <li>Mount 18040 <ul> 18041 <li>Default <code>--deamon-timout</code> to 15 minutes on macOS and FreeBSD (Nick Craig-Wood)</li> 18042 <li>Update docs to show mounting from root OK for bucket based (Nick Craig-Wood)</li> 18043 <li>Remove nonseekable flag from write files (Nick Craig-Wood)</li> 18044 </ul></li> 18045 <li>VFS 18046 <ul> 18047 <li>Make write without cache more efficient (Nick Craig-Wood)</li> 18048 <li>Fix <code>--vfs-cache-mode minimal</code> and <code>writes</code> ignoring cached files (Nick Craig-Wood)</li> 18049 </ul></li> 18050 <li>Local 18051 <ul> 18052 <li>Add <code>--local-case-sensitive</code> and <code>--local-case-insensitive</code> (Nick Craig-Wood)</li> 18053 <li>Avoid polluting page cache when uploading local files to remote backends (Michał Matczuk)</li> 18054 <li>Don’t calculate any hashes by default (Nick Craig-Wood)</li> 18055 <li>Fadvise run syscall on a dedicated go routine (Michał Matczuk)</li> 18056 </ul></li> 18057 <li>Azure Blob 18058 <ul> 18059 <li>Azure Storage Emulator support (Sandeep)</li> 18060 <li>Updated config help details to remove connection string references (Sandeep)</li> 18061 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18062 </ul></li> 18063 <li>B2 18064 <ul> 18065 <li>Implement link sharing (yparitcher)</li> 18066 <li>Enable server side copy to copy between buckets (Nick Craig-Wood)</li> 18067 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18068 </ul></li> 18069 <li>Drive 18070 <ul> 18071 <li>Fix server side copy of big files (Nick Craig-Wood)</li> 18072 <li>Update API for teamdrive use (Nick Craig-Wood)</li> 18073 <li>Add error for purge with <code>--drive-trashed-only</code> (ginvine)</li> 18074 </ul></li> 18075 <li>Fichier 18076 <ul> 18077 <li>Make FolderID int and adjust related code (buengese)</li> 18078 </ul></li> 18079 <li>Google Cloud Storage 18080 <ul> 18081 <li>Reduce oauth scope requested as suggested by Google (Nick Craig-Wood)</li> 18082 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18083 </ul></li> 18084 <li>HTTP 18085 <ul> 18086 <li>Add <code>--http-headers</code> flag for setting arbitrary headers (Nick Craig-Wood)</li> 18087 </ul></li> 18088 <li>Jottacloud 18089 <ul> 18090 <li>Use new api for retrieving internal username (buengese)</li> 18091 <li>Refactor configuration and minor cleanup (buengese)</li> 18092 </ul></li> 18093 <li>Koofr 18094 <ul> 18095 <li>Support setting modification times on Koofr backend. (jaKa)</li> 18096 </ul></li> 18097 <li>Opendrive 18098 <ul> 18099 <li>Refactor to use existing lib/rest facilities for uploads (Nick Craig-Wood)</li> 18100 </ul></li> 18101 <li>Qingstor 18102 <ul> 18103 <li>Upgrade to v3 SDK and fix listing loop (Nick Craig-Wood)</li> 18104 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18105 </ul></li> 18106 <li>S3 18107 <ul> 18108 <li>Add INTELLIGENT_TIERING storage class (Matti Niemenmaa)</li> 18109 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18110 </ul></li> 18111 <li>SFTP 18112 <ul> 18113 <li>Add missing interface check and fix About (Nick Craig-Wood)</li> 18114 <li>Completely ignore all modtime checks if SetModTime=false (Jon Fautley)</li> 18115 <li>Support md5/sha1 with rsync.net (Nick Craig-Wood)</li> 18116 <li>Save the md5/sha1 command in use to the config file for efficiency (Nick Craig-Wood)</li> 18117 <li>Opt-in support for diffie-hellman-group-exchange-sha256 diffie-hellman-group-exchange-sha1 (Yi FU)</li> 18118 </ul></li> 18119 <li>Swift 18120 <ul> 18121 <li>Use FixRangeOption to fix 0 length files via the VFS (Nick Craig-Wood)</li> 18122 <li>Fix upload when using no_chunk to return the correct size (Nick Craig-Wood)</li> 18123 <li>Make all operations work from the root (Nick Craig-Wood)</li> 18124 <li>Fix segments leak during failed large file uploads. (nguyenhuuluan434)</li> 18125 </ul></li> 18126 <li>WebDAV 18127 <ul> 18128 <li>Add <code>--webdav-bearer-token-command</code> (Nick Craig-Wood)</li> 18129 <li>Refresh token when it expires with <code>--webdav-bearer-token-command</code> (Nick Craig-Wood)</li> 18130 <li>Add docs for using bearer_token_command with oidc-agent (Paul Millar)</li> 18131 </ul></li> 18132 </ul> 18133 <h2 id="v1.48.0---2019-06-15">v1.48.0 - 2019-06-15</h2> 18134 <ul> 18135 <li>New commands 18136 <ul> 18137 <li>serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood)</li> 18138 </ul></li> 18139 <li>New Features 18140 <ul> 18141 <li>Multi threaded downloads to local storage (Nick Craig-Wood) 18142 <ul> 18143 <li>controlled with <code>--multi-thread-cutoff</code> and <code>--multi-thread-streams</code></li> 18144 </ul></li> 18145 <li>Use rclone.conf from rclone executable directory to enable portable use (albertony)</li> 18146 <li>Allow sync of a file and a directory with the same name (forgems) 18147 <ul> 18148 <li>this is common on bucket based remotes, eg s3, gcs</li> 18149 </ul></li> 18150 <li>Add <code>--ignore-case-sync</code> for forced case insensitivity (garry415)</li> 18151 <li>Implement <code>--stats-one-line-date</code> and <code>--stats-one-line-date-format</code> (Peter Berbec)</li> 18152 <li>Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood)</li> 18153 <li>Use go-homedir to read the home directory more reliably (Nick Craig-Wood)</li> 18154 <li>Enable creating encrypted config through external script invocation (Wojciech Smigielski)</li> 18155 <li>build: Drop support for go1.8 (Nick Craig-Wood)</li> 18156 <li>config: Make config create/update encrypt passwords where necessary (Nick Craig-Wood)</li> 18157 <li>copyurl: Honor <code>--no-check-certificate</code> (Stefan Breunig)</li> 18158 <li>install: Linux skip man pages if no mandb (didil)</li> 18159 <li>lsf: Support showing the Tier of the object (Nick Craig-Wood)</li> 18160 <li>lsjson 18161 <ul> 18162 <li>Added EncryptedPath to output (calisro)</li> 18163 <li>Support showing the Tier of the object (Nick Craig-Wood)</li> 18164 <li>Add IsBucket field for bucket based remote listing of the root (Nick Craig-Wood)</li> 18165 </ul></li> 18166 <li>rc 18167 <ul> 18168 <li>Add <code>--loopback</code> flag to run commands directly without a server (Nick Craig-Wood)</li> 18169 <li>Add operations/fsinfo: Return information about the remote (Nick Craig-Wood)</li> 18170 <li>Skip auth for OPTIONS request (Nick Craig-Wood)</li> 18171 <li>cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick Craig-Wood)</li> 18172 <li>jobs: Make job expiry timeouts configurable (Aleksandar Jankovic)</li> 18173 </ul></li> 18174 <li>serve dlna reworked and improved (Dan Walters)</li> 18175 <li>serve ftp: add <code>--ftp-public-ip</code> flag to specify public IP (calistri)</li> 18176 <li>serve restic: Add support for <code>--private-repos</code> in <code>serve restic</code> (Florian Apolloner)</li> 18177 <li>serve webdav: Combine serve webdav and serve http (Gary Kim)</li> 18178 <li>size: Ignore negative sizes when calculating total (Garry McNulty)</li> 18179 </ul></li> 18180 <li>Bug Fixes 18181 <ul> 18182 <li>Make move and copy individual files obey <code>--backup-dir</code> (Nick Craig-Wood)</li> 18183 <li>If <code>--ignore-checksum</code> is in effect, don’t calculate checksum (Nick Craig-Wood)</li> 18184 <li>moveto: Fix case-insensitive same remote move (Gary Kim)</li> 18185 <li>rc: Fix serving bucket based objects with <code>--rc-serve</code> (Nick Craig-Wood)</li> 18186 <li>serve webdav: Fix serveDir not being updated with changes from webdav (Gary Kim)</li> 18187 </ul></li> 18188 <li>Mount 18189 <ul> 18190 <li>Fix poll interval documentation (Animosity022)</li> 18191 </ul></li> 18192 <li>VFS 18193 <ul> 18194 <li>Make WriteAt for non cached files work with non-sequential writes (Nick Craig-Wood)</li> 18195 </ul></li> 18196 <li>Local 18197 <ul> 18198 <li>Only calculate the required hashes for big speedup (Nick Craig-Wood)</li> 18199 <li>Log errors when listing instead of returning an error (Nick Craig-Wood)</li> 18200 <li>Fix preallocate warning on Linux with ZFS (Nick Craig-Wood)</li> 18201 </ul></li> 18202 <li>Crypt 18203 <ul> 18204 <li>Make rclone dedupe work through crypt (Nick Craig-Wood)</li> 18205 <li>Fix wrapping of ChangeNotify to decrypt directories properly (Nick Craig-Wood)</li> 18206 <li>Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood)</li> 18207 <li>Implement Optional methods SetTier, GetTier (Nick Craig-Wood)</li> 18208 </ul></li> 18209 <li>B2 18210 <ul> 18211 <li>Implement server side copy (Nick Craig-Wood)</li> 18212 <li>Implement SetModTime (Nick Craig-Wood)</li> 18213 </ul></li> 18214 <li>Drive 18215 <ul> 18216 <li>Fix move and copy from TeamDrive to GDrive (Fionera)</li> 18217 <li>Add notes that cleanup works in the background on drive (Nick Craig-Wood)</li> 18218 <li>Add <code>--drive-server-side-across-configs</code> to default back to old server side copy semantics by default (Nick Craig-Wood)</li> 18219 <li>Add <code>--drive-size-as-quota</code> to show storage quota usage for file size (Garry McNulty)</li> 18220 </ul></li> 18221 <li>FTP 18222 <ul> 18223 <li>Add FTP List timeout (Jeff Quinn)</li> 18224 <li>Add FTP over TLS support (Gary Kim)</li> 18225 <li>Add <code>--ftp-no-check-certificate</code> option for FTPS (Gary Kim)</li> 18226 </ul></li> 18227 <li>Google Cloud Storage 18228 <ul> 18229 <li>Fix upload errors when uploading pre 1970 files (Nick Craig-Wood)</li> 18230 </ul></li> 18231 <li>Jottacloud 18232 <ul> 18233 <li>Add support for selecting device and mountpoint. (buengese)</li> 18234 </ul></li> 18235 <li>Mega 18236 <ul> 18237 <li>Add cleanup support (Gary Kim)</li> 18238 </ul></li> 18239 <li>Onedrive 18240 <ul> 18241 <li>More accurately check if root is found (Cnly)</li> 18242 </ul></li> 18243 <li>S3 18244 <ul> 18245 <li>Support S3 Accelerated endpoints with <code>--s3-use-accelerate-endpoint</code> (Nick Craig-Wood)</li> 18246 <li>Add config info for Wasabi’s EU Central endpoint (Robert Marko)</li> 18247 <li>Make SetModTime work for GLACIER while syncing (Philip Harvey)</li> 18248 </ul></li> 18249 <li>SFTP 18250 <ul> 18251 <li>Add About support (Gary Kim)</li> 18252 <li>Fix about parsing of <code>df</code> results so it can cope with -ve results (Nick Craig-Wood)</li> 18253 <li>Send custom client version and debug server version (Nick Craig-Wood)</li> 18254 </ul></li> 18255 <li>WebDAV 18256 <ul> 18257 <li>Retry on 423 Locked errors (Nick Craig-Wood)</li> 18258 </ul></li> 18259 </ul> 18260 <h2 id="v1.47.0---2019-04-13">v1.47.0 - 2019-04-13</h2> 18261 <ul> 18262 <li>New backends 18263 <ul> 18264 <li>Backend for Koofr cloud storage service. (jaKa)</li> 18265 </ul></li> 18266 <li>New Features 18267 <ul> 18268 <li>Resume downloads if the reader fails in copy (Nick Craig-Wood) 18269 <ul> 18270 <li>this means rclone will restart transfers if the source has an error</li> 18271 <li>this is most useful for downloads or cloud to cloud copies</li> 18272 </ul></li> 18273 <li>Use <code>--fast-list</code> for listing operations where it won’t use more memory (Nick Craig-Wood) 18274 <ul> 18275 <li>this should speed up the following operations on remotes which support <code>ListR</code></li> 18276 <li><code>dedupe</code>, <code>serve restic</code> <code>lsf</code>, <code>ls</code>, <code>lsl</code>, <code>lsjson</code>, <code>lsd</code>, <code>md5sum</code>, <code>sha1sum</code>, <code>hashsum</code>, <code>size</code>, <code>delete</code>, <code>cat</code>, <code>settier</code></li> 18277 <li>use <code>--disable ListR</code> to get old behaviour if required</li> 18278 </ul></li> 18279 <li>Make <code>--files-from</code> traverse the destination unless <code>--no-traverse</code> is set (Nick Craig-Wood) 18280 <ul> 18281 <li>this fixes <code>--files-from</code> with Google drive and excessive API use in general.</li> 18282 </ul></li> 18283 <li>Make server side copy account bytes and obey <code>--max-transfer</code> (Nick Craig-Wood)</li> 18284 <li>Add <code>--create-empty-src-dirs</code> flag and default to not creating empty dirs (ishuah)</li> 18285 <li>Add client side TLS/SSL flags <code>--ca-cert</code>/<code>--client-cert</code>/<code>--client-key</code> (Nick Craig-Wood)</li> 18286 <li>Implement <code>--suffix-keep-extension</code> for use with <code>--suffix</code> (Nick Craig-Wood)</li> 18287 <li>build: 18288 <ul> 18289 <li>Switch to semvar compliant version tags to be go modules compliant (Nick Craig-Wood)</li> 18290 <li>Update to use go1.12.x for the build (Nick Craig-Wood)</li> 18291 </ul></li> 18292 <li>serve dlna: Add connection manager service description to improve compatibility (Dan Walters)</li> 18293 <li>lsf: Add ‘e’ format to show encrypted names and ‘o’ for original IDs (Nick Craig-Wood)</li> 18294 <li>lsjson: Added <code>--files-only</code> and <code>--dirs-only</code> flags (calistri)</li> 18295 <li>rc: Implement operations/publiclink the equivalent of <code>rclone link</code> (Nick Craig-Wood)</li> 18296 </ul></li> 18297 <li>Bug Fixes 18298 <ul> 18299 <li>accounting: Fix total ETA when <code>--stats-unit bits</code> is in effect (Nick Craig-Wood)</li> 18300 <li>Bash TAB completion 18301 <ul> 18302 <li>Use private custom func to fix clash between rclone and kubectl (Nick Craig-Wood)</li> 18303 <li>Fix for remotes with underscores in their names (Six)</li> 18304 <li>Fix completion of remotes (Florian Gamböck)</li> 18305 <li>Fix autocompletion of remote paths with spaces (Danil Semelenov)</li> 18306 </ul></li> 18307 <li>serve dlna: Fix root XML service descriptor (Dan Walters)</li> 18308 <li>ncdu: Fix display corruption with Chinese characters (Nick Craig-Wood)</li> 18309 <li>Add SIGTERM to signals which run the exit handlers on unix (Nick Craig-Wood)</li> 18310 <li>rc: Reload filter when the options are set via the rc (Nick Craig-Wood)</li> 18311 </ul></li> 18312 <li>VFS / Mount 18313 <ul> 18314 <li>Fix FreeBSD: Ignore Truncate if called with no readers and already the correct size (Nick Craig-Wood)</li> 18315 <li>Read directory and check for a file before mkdir (Nick Craig-Wood)</li> 18316 <li>Shorten the locking window for vfs/refresh (Nick Craig-Wood)</li> 18317 </ul></li> 18318 <li>Azure Blob 18319 <ul> 18320 <li>Enable MD5 checksums when uploading files bigger than the “Cutoff” (Dr.Rx)</li> 18321 <li>Fix SAS URL support (Nick Craig-Wood)</li> 18322 </ul></li> 18323 <li>B2 18324 <ul> 18325 <li>Allow manual configuration of backblaze downloadUrl (Vince)</li> 18326 <li>Ignore already_hidden error on remove (Nick Craig-Wood)</li> 18327 <li>Ignore malformed <code>src_last_modified_millis</code> (Nick Craig-Wood)</li> 18328 </ul></li> 18329 <li>Drive 18330 <ul> 18331 <li>Add <code>--skip-checksum-gphotos</code> to ignore incorrect checksums on Google Photos (Nick Craig-Wood)</li> 18332 <li>Allow server side move/copy between different remotes. (Fionera)</li> 18333 <li>Add docs on team drives and <code>--fast-list</code> eventual consistency (Nestar47)</li> 18334 <li>Fix imports of text files (Nick Craig-Wood)</li> 18335 <li>Fix range requests on 0 length files (Nick Craig-Wood)</li> 18336 <li>Fix creation of duplicates with server side copy (Nick Craig-Wood)</li> 18337 </ul></li> 18338 <li>Dropbox 18339 <ul> 18340 <li>Retry blank errors to fix long listings (Nick Craig-Wood)</li> 18341 </ul></li> 18342 <li>FTP 18343 <ul> 18344 <li>Add <code>--ftp-concurrency</code> to limit maximum number of connections (Nick Craig-Wood)</li> 18345 </ul></li> 18346 <li>Google Cloud Storage 18347 <ul> 18348 <li>Fall back to default application credentials (marcintustin)</li> 18349 <li>Allow bucket policy only buckets (Nick Craig-Wood)</li> 18350 </ul></li> 18351 <li>HTTP 18352 <ul> 18353 <li>Add <code>--http-no-slash</code> for websites with directories with no slashes (Nick Craig-Wood)</li> 18354 <li>Remove duplicates from listings (Nick Craig-Wood)</li> 18355 <li>Fix socket leak on 404 errors (Nick Craig-Wood)</li> 18356 </ul></li> 18357 <li>Jottacloud 18358 <ul> 18359 <li>Fix token refresh (Sebastian Bünger)</li> 18360 <li>Add device registration (Oliver Heyme)</li> 18361 </ul></li> 18362 <li>Onedrive 18363 <ul> 18364 <li>Implement graceful cancel of multipart uploads if rclone is interrupted (Cnly)</li> 18365 <li>Always add trailing colon to path when addressing items, (Cnly)</li> 18366 <li>Return errors instead of panic for invalid uploads (Fabian Möller)</li> 18367 </ul></li> 18368 <li>S3 18369 <ul> 18370 <li>Add support for “Glacier Deep Archive” storage class (Manu)</li> 18371 <li>Update Dreamhost endpoint (Nick Craig-Wood)</li> 18372 <li>Note incompatibility with CEPH Jewel (Nick Craig-Wood)</li> 18373 </ul></li> 18374 <li>SFTP 18375 <ul> 18376 <li>Allow custom ssh client config (Alexandru Bumbacea)</li> 18377 </ul></li> 18378 <li>Swift 18379 <ul> 18380 <li>Obey Retry-After to enable OVH restore from cold storage (Nick Craig-Wood)</li> 18381 <li>Work around token expiry on CEPH (Nick Craig-Wood)</li> 18382 </ul></li> 18383 <li>WebDAV 18384 <ul> 18385 <li>Allow IsCollection property to be integer or boolean (Nick Craig-Wood)</li> 18386 <li>Fix race when creating directories (Nick Craig-Wood)</li> 18387 <li>Fix About/df when reading the available/total returns 0 (Nick Craig-Wood)</li> 18388 </ul></li> 18389 </ul> 18390 <h2 id="v1.46---2019-02-09">v1.46 - 2019-02-09</h2> 18391 <ul> 18392 <li>New backends 18393 <ul> 18394 <li>Support Alibaba Cloud (Aliyun) OSS via the s3 backend (Nick Craig-Wood)</li> 18395 </ul></li> 18396 <li>New commands 18397 <ul> 18398 <li>serve dlna: serves a remove via DLNA for the local network (nicolov)</li> 18399 </ul></li> 18400 <li>New Features 18401 <ul> 18402 <li>copy, move: Restore deprecated <code>--no-traverse</code> flag (Nick Craig-Wood) 18403 <ul> 18404 <li>This is useful for when transferring a small number of files into a large destination</li> 18405 </ul></li> 18406 <li>genautocomplete: Add remote path completion for bash completion (Christopher Peterson & Danil Semelenov)</li> 18407 <li>Buffer memory handling reworked to return memory to the OS better (Nick Craig-Wood) 18408 <ul> 18409 <li>Buffer recycling library to replace sync.Pool</li> 18410 <li>Optionally use memory mapped memory for better memory shrinking</li> 18411 <li>Enable with <code>--use-mmap</code> if having memory problems - not default yet</li> 18412 </ul></li> 18413 <li>Parallelise reading of files specified by <code>--files-from</code> (Nick Craig-Wood)</li> 18414 <li>check: Add stats showing total files matched. (Dario Guzik)</li> 18415 <li>Allow rename/delete open files under Windows (Nick Craig-Wood)</li> 18416 <li>lsjson: Use exactly the correct number of decimal places in the seconds (Nick Craig-Wood)</li> 18417 <li>Add cookie support with cmdline switch <code>--use-cookies</code> for all HTTP based remotes (qip)</li> 18418 <li>Warn if <code>--checksum</code> is set but there are no hashes available (Nick Craig-Wood)</li> 18419 <li>Rework rate limiting (pacer) to be more accurate and allow bursting (Nick Craig-Wood)</li> 18420 <li>Improve error reporting for too many/few arguments in commands (Nick Craig-Wood)</li> 18421 <li>listremotes: Remove <code>-l</code> short flag as it conflicts with the new global flag (weetmuts)</li> 18422 <li>Make http serving with auth generate INFO messages on auth fail (Nick Craig-Wood)</li> 18423 </ul></li> 18424 <li>Bug Fixes 18425 <ul> 18426 <li>Fix layout of stats (Nick Craig-Wood)</li> 18427 <li>Fix <code>--progress</code> crash under Windows Jenkins (Nick Craig-Wood)</li> 18428 <li>Fix transfer of google/onedrive docs by calling Rcat in Copy when size is -1 (Cnly)</li> 18429 <li>copyurl: Fix checking of <code>--dry-run</code> (Denis Skovpen)</li> 18430 </ul></li> 18431 <li>Mount 18432 <ul> 18433 <li>Check that mountpoint and local directory to mount don’t overlap (Nick Craig-Wood)</li> 18434 <li>Fix mount size under 32 bit Windows (Nick Craig-Wood)</li> 18435 </ul></li> 18436 <li>VFS 18437 <ul> 18438 <li>Implement renaming of directories for backends without DirMove (Nick Craig-Wood) 18439 <ul> 18440 <li>now all backends except b2 support renaming directories</li> 18441 </ul></li> 18442 <li>Implement <code>--vfs-cache-max-size</code> to limit the total size of the cache (Nick Craig-Wood)</li> 18443 <li>Add <code>--dir-perms</code> and <code>--file-perms</code> flags to set default permissions (Nick Craig-Wood)</li> 18444 <li>Fix deadlock on concurrent operations on a directory (Nick Craig-Wood)</li> 18445 <li>Fix deadlock between RWFileHandle.close and File.Remove (Nick Craig-Wood)</li> 18446 <li>Fix renaming/deleting open files with cache mode “writes” under Windows (Nick Craig-Wood)</li> 18447 <li>Fix panic on rename with <code>--dry-run</code> set (Nick Craig-Wood)</li> 18448 <li>Fix vfs/refresh with recurse=true needing the <code>--fast-list</code> flag</li> 18449 </ul></li> 18450 <li>Local 18451 <ul> 18452 <li>Add support for <code>-l</code>/<code>--links</code> (symbolic link translation) (yair@unicorn) 18453 <ul> 18454 <li>this works by showing links as <code>link.rclonelink</code> - see local backend docs for more info</li> 18455 <li>this errors if used with <code>-L</code>/<code>--copy-links</code></li> 18456 </ul></li> 18457 <li>Fix renaming/deleting open files on Windows (Nick Craig-Wood)</li> 18458 </ul></li> 18459 <li>Crypt 18460 <ul> 18461 <li>Check for maximum length before decrypting filename to fix panic (Garry McNulty)</li> 18462 </ul></li> 18463 <li>Azure Blob 18464 <ul> 18465 <li>Allow building azureblob backend on *BSD (themylogin)</li> 18466 <li>Use the rclone HTTP client to support <code>--dump headers</code>, <code>--tpslimit</code> etc (Nick Craig-Wood)</li> 18467 <li>Use the s3 pacer for 0 delay in non error conditions (Nick Craig-Wood)</li> 18468 <li>Ignore directory markers (Nick Craig-Wood)</li> 18469 <li>Stop Mkdir attempting to create existing containers (Nick Craig-Wood)</li> 18470 </ul></li> 18471 <li>B2 18472 <ul> 18473 <li>cleanup: will remove unfinished large files >24hrs old (Garry McNulty)</li> 18474 <li>For a bucket limited application key check the bucket name (Nick Craig-Wood) 18475 <ul> 18476 <li>before this, rclone would use the authorised bucket regardless of what you put on the command line</li> 18477 </ul></li> 18478 <li>Added <code>--b2-disable-checksum</code> flag (Wojciech Smigielski) 18479 <ul> 18480 <li>this enables large files to be uploaded without a SHA-1 hash for speed reasons</li> 18481 </ul></li> 18482 </ul></li> 18483 <li>Drive 18484 <ul> 18485 <li>Set default pacer to 100ms for 10 tps (Nick Craig-Wood) 18486 <ul> 18487 <li>This fits the Google defaults much better and reduces the 403 errors massively</li> 18488 <li>Add <code>--drive-pacer-min-sleep</code> and <code>--drive-pacer-burst</code> to control the pacer</li> 18489 </ul></li> 18490 <li>Improve ChangeNotify support for items with multiple parents (Fabian Möller)</li> 18491 <li>Fix ListR for items with multiple parents - this fixes oddities with <code>vfs/refresh</code> (Fabian Möller)</li> 18492 <li>Fix using <code>--drive-impersonate</code> and appfolders (Nick Craig-Wood)</li> 18493 <li>Fix google docs in rclone mount for some (not all) applications (Nick Craig-Wood)</li> 18494 </ul></li> 18495 <li>Dropbox 18496 <ul> 18497 <li>Retry-After support for Dropbox backend (Mathieu Carbou)</li> 18498 </ul></li> 18499 <li>FTP 18500 <ul> 18501 <li>Wait for 60 seconds for a connection to Close then declare it dead (Nick Craig-Wood) 18502 <ul> 18503 <li>helps with indefinite hangs on some FTP servers</li> 18504 </ul></li> 18505 </ul></li> 18506 <li>Google Cloud Storage 18507 <ul> 18508 <li>Update google cloud storage endpoints (weetmuts)</li> 18509 </ul></li> 18510 <li>HTTP 18511 <ul> 18512 <li>Add an example with username and password which is supported but wasn’t documented (Nick Craig-Wood)</li> 18513 <li>Fix backend with <code>--files-from</code> and non-existent files (Nick Craig-Wood)</li> 18514 </ul></li> 18515 <li>Hubic 18516 <ul> 18517 <li>Make error message more informative if authentication fails (Nick Craig-Wood)</li> 18518 </ul></li> 18519 <li>Jottacloud 18520 <ul> 18521 <li>Resume and deduplication support (Oliver Heyme)</li> 18522 <li>Use token auth for all API requests Don’t store password anymore (Sebastian Bünger)</li> 18523 <li>Add support for 2-factor authentication (Sebastian Bünger)</li> 18524 </ul></li> 18525 <li>Mega 18526 <ul> 18527 <li>Implement v2 account login which fixes logins for newer Mega accounts (Nick Craig-Wood)</li> 18528 <li>Return error if an unknown length file is attempted to be uploaded (Nick Craig-Wood)</li> 18529 <li>Add new error codes for better error reporting (Nick Craig-Wood)</li> 18530 </ul></li> 18531 <li>Onedrive 18532 <ul> 18533 <li>Fix broken support for “shared with me” folders (Alex Chen)</li> 18534 <li>Fix root ID not normalised (Cnly)</li> 18535 <li>Return err instead of panic on unknown-sized uploads (Cnly)</li> 18536 </ul></li> 18537 <li>Qingstor 18538 <ul> 18539 <li>Fix go routine leak on multipart upload errors (Nick Craig-Wood)</li> 18540 <li>Add upload chunk size/concurrency/cutoff control (Nick Craig-Wood)</li> 18541 <li>Default <code>--qingstor-upload-concurrency</code> to 1 to work around bug (Nick Craig-Wood)</li> 18542 </ul></li> 18543 <li>S3 18544 <ul> 18545 <li>Implement <code>--s3-upload-cutoff</code> for single part uploads below this (Nick Craig-Wood)</li> 18546 <li>Change <code>--s3-upload-concurrency</code> default to 4 to increase performance (Nick Craig-Wood)</li> 18547 <li>Add <code>--s3-bucket-acl</code> to control bucket ACL (Nick Craig-Wood)</li> 18548 <li>Auto detect region for buckets on operation failure (Nick Craig-Wood)</li> 18549 <li>Add GLACIER storage class (William Cocker)</li> 18550 <li>Add Scaleway to s3 documentation (Rémy Léone)</li> 18551 <li>Add AWS endpoint eu-north-1 (weetmuts)</li> 18552 </ul></li> 18553 <li>SFTP 18554 <ul> 18555 <li>Add support for PEM encrypted private keys (Fabian Möller)</li> 18556 <li>Add option to force the usage of an ssh-agent (Fabian Möller)</li> 18557 <li>Perform environment variable expansion on key-file (Fabian Möller)</li> 18558 <li>Fix rmdir on Windows based servers (eg CrushFTP) (Nick Craig-Wood)</li> 18559 <li>Fix rmdir deleting directory contents on some SFTP servers (Nick Craig-Wood)</li> 18560 <li>Fix error on dangling symlinks (Nick Craig-Wood)</li> 18561 </ul></li> 18562 <li>Swift 18563 <ul> 18564 <li>Add <code>--swift-no-chunk</code> to disable segmented uploads in rcat/mount (Nick Craig-Wood)</li> 18565 <li>Introduce application credential auth support (kayrus)</li> 18566 <li>Fix memory usage by slimming Object (Nick Craig-Wood)</li> 18567 <li>Fix extra requests on upload (Nick Craig-Wood)</li> 18568 <li>Fix reauth on big files (Nick Craig-Wood)</li> 18569 </ul></li> 18570 <li>Union 18571 <ul> 18572 <li>Fix poll-interval not working (Nick Craig-Wood)</li> 18573 </ul></li> 18574 <li>WebDAV 18575 <ul> 18576 <li>Support About which means rclone mount will show the correct disk size (Nick Craig-Wood)</li> 18577 <li>Support MD5 and SHA1 hashes with Owncloud and Nextcloud (Nick Craig-Wood)</li> 18578 <li>Fail soft on time parsing errors (Nick Craig-Wood)</li> 18579 <li>Fix infinite loop on failed directory creation (Nick Craig-Wood)</li> 18580 <li>Fix identification of directories for Bitrix Site Manager (Nick Craig-Wood)</li> 18581 <li>Fix upload of 0 length files on some servers (Nick Craig-Wood)</li> 18582 <li>Fix if MKCOL fails with 423 Locked assume the directory exists (Nick Craig-Wood)</li> 18583 </ul></li> 18584 </ul> 18585 <h2 id="v1.45---2018-11-24">v1.45 - 2018-11-24</h2> 18586 <ul> 18587 <li>New backends 18588 <ul> 18589 <li>The Yandex backend was re-written - see below for details (Sebastian Bünger)</li> 18590 </ul></li> 18591 <li>New commands 18592 <ul> 18593 <li>rcd: New command just to serve the remote control API (Nick Craig-Wood)</li> 18594 </ul></li> 18595 <li>New Features 18596 <ul> 18597 <li>The remote control API (rc) was greatly expanded to allow full control over rclone (Nick Craig-Wood) 18598 <ul> 18599 <li>sensitive operations require authorization or the <code>--rc-no-auth</code> flag</li> 18600 <li>config/* operations to configure rclone</li> 18601 <li>options/* for reading/setting command line flags</li> 18602 <li>operations/* for all low level operations, eg copy file, list directory</li> 18603 <li>sync/* for sync, copy and move</li> 18604 <li><code>--rc-files</code> flag to serve files on the rc http server 18605 <ul> 18606 <li>this is for building web native GUIs for rclone</li> 18607 </ul></li> 18608 <li>Optionally serving objects on the rc http server</li> 18609 <li>Ensure rclone fails to start up if the <code>--rc</code> port is in use already</li> 18610 <li>See <a href="https://rclone.org/rc/">the rc docs</a> for more info</li> 18611 </ul></li> 18612 <li>sync/copy/move 18613 <ul> 18614 <li>Make <code>--files-from</code> only read the objects specified and don’t scan directories (Nick Craig-Wood) 18615 <ul> 18616 <li>This is a huge speed improvement for destinations with lots of files</li> 18617 </ul></li> 18618 </ul></li> 18619 <li>filter: Add <code>--ignore-case</code> flag (Nick Craig-Wood)</li> 18620 <li>ncdu: Add remove function (‘d’ key) (Henning Surmeier)</li> 18621 <li>rc command 18622 <ul> 18623 <li>Add <code>--json</code> flag for structured JSON input (Nick Craig-Wood)</li> 18624 <li>Add <code>--user</code> and <code>--pass</code> flags and interpret <code>--rc-user</code>, <code>--rc-pass</code>, <code>--rc-addr</code> (Nick Craig-Wood)</li> 18625 </ul></li> 18626 <li>build 18627 <ul> 18628 <li>Require go1.8 or later for compilation (Nick Craig-Wood)</li> 18629 <li>Enable softfloat on MIPS arch (Scott Edlund)</li> 18630 <li>Integration test framework revamped with a better report and better retries (Nick Craig-Wood)</li> 18631 </ul></li> 18632 </ul></li> 18633 <li>Bug Fixes 18634 <ul> 18635 <li>cmd: Make <code>--progress</code> update the stats correctly at the end (Nick Craig-Wood)</li> 18636 <li>config: Create config directory on save if it is missing (Nick Craig-Wood)</li> 18637 <li>dedupe: Check for existing filename before renaming a dupe file (ssaqua)</li> 18638 <li>move: Don’t create directories with <code>--dry-run</code> (Nick Craig-Wood)</li> 18639 <li>operations: Fix Purge and Rmdirs when dir is not the root (Nick Craig-Wood)</li> 18640 <li>serve http/webdav/restic: Ensure rclone exits if the port is in use (Nick Craig-Wood)</li> 18641 </ul></li> 18642 <li>Mount 18643 <ul> 18644 <li>Make <code>--volname</code> work for Windows and macOS (Nick Craig-Wood)</li> 18645 </ul></li> 18646 <li>Azure Blob 18647 <ul> 18648 <li>Avoid context deadline exceeded error by setting a large TryTimeout value (brused27)</li> 18649 <li>Fix erroneous Rmdir error “directory not empty” (Nick Craig-Wood)</li> 18650 <li>Wait for up to 60s to create a just deleted container (Nick Craig-Wood)</li> 18651 </ul></li> 18652 <li>Dropbox 18653 <ul> 18654 <li>Add dropbox impersonate support (Jake Coggiano)</li> 18655 </ul></li> 18656 <li>Jottacloud 18657 <ul> 18658 <li>Fix bug in <code>--fast-list</code> handing of empty folders (albertony)</li> 18659 </ul></li> 18660 <li>Opendrive 18661 <ul> 18662 <li>Fix transfer of files with <code>+</code> and <code>&</code> in (Nick Craig-Wood)</li> 18663 <li>Fix retries of upload chunks (Nick Craig-Wood)</li> 18664 </ul></li> 18665 <li>S3 18666 <ul> 18667 <li>Set ACL for server side copies to that provided by the user (Nick Craig-Wood)</li> 18668 <li>Fix role_arn, credential_source, … (Erik Swanson)</li> 18669 <li>Add config info for Wasabi’s US-West endpoint (Henry Ptasinski)</li> 18670 </ul></li> 18671 <li>SFTP 18672 <ul> 18673 <li>Ensure file hash checking is really disabled (Jon Fautley)</li> 18674 </ul></li> 18675 <li>Swift 18676 <ul> 18677 <li>Add pacer for retries to make swift more reliable (Nick Craig-Wood)</li> 18678 </ul></li> 18679 <li>WebDAV 18680 <ul> 18681 <li>Add Content-Type to PUT requests (Nick Craig-Wood)</li> 18682 <li>Fix config parsing so <code>--webdav-user</code> and <code>--webdav-pass</code> flags work (Nick Craig-Wood)</li> 18683 <li>Add RFC3339 date format (Ralf Hemberger)</li> 18684 </ul></li> 18685 <li>Yandex 18686 <ul> 18687 <li>The yandex backend was re-written (Sebastian Bünger) 18688 <ul> 18689 <li>This implements low level retries (Sebastian Bünger)</li> 18690 <li>Copy, Move, DirMove, PublicLink and About optional interfaces (Sebastian Bünger)</li> 18691 <li>Improved general error handling (Sebastian Bünger)</li> 18692 <li>Removed ListR for now due to inconsistent behaviour (Sebastian Bünger)</li> 18693 </ul></li> 18694 </ul></li> 18695 </ul> 18696 <h2 id="v1.44---2018-10-15">v1.44 - 2018-10-15</h2> 18697 <ul> 18698 <li>New commands 18699 <ul> 18700 <li>serve ftp: Add ftp server (Antoine GIRARD)</li> 18701 <li>settier: perform storage tier changes on supported remotes (sandeepkru)</li> 18702 </ul></li> 18703 <li>New Features 18704 <ul> 18705 <li>Reworked command line help 18706 <ul> 18707 <li>Make default help less verbose (Nick Craig-Wood)</li> 18708 <li>Split flags up into global and backend flags (Nick Craig-Wood)</li> 18709 <li>Implement specialised help for flags and backends (Nick Craig-Wood)</li> 18710 <li>Show URL of backend help page when starting config (Nick Craig-Wood)</li> 18711 </ul></li> 18712 <li>stats: Long names now split in center (Joanna Marek)</li> 18713 <li>Add <code>--log-format</code> flag for more control over log output (dcpu)</li> 18714 <li>rc: Add support for OPTIONS and basic CORS (frenos)</li> 18715 <li>stats: show FatalErrors and NoRetryErrors in stats (Cédric Connes)</li> 18716 </ul></li> 18717 <li>Bug Fixes 18718 <ul> 18719 <li>Fix -P not ending with a new line (Nick Craig-Wood)</li> 18720 <li>config: don’t create default config dir when user supplies <code>--config</code> (albertony)</li> 18721 <li>Don’t print non-ASCII characters with <code>--progress</code> on windows (Nick Craig-Wood)</li> 18722 <li>Correct logs for excluded items (ssaqua)</li> 18723 </ul></li> 18724 <li>Mount 18725 <ul> 18726 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 18727 </ul></li> 18728 <li>VFS 18729 <ul> 18730 <li>Fix race condition detected by serve ftp tests (Nick Craig-Wood)</li> 18731 <li>Add vfs/poll-interval rc command (Fabian Möller)</li> 18732 <li>Enable rename for nearly all remotes using server side Move or Copy (Nick Craig-Wood)</li> 18733 <li>Reduce directory cache cleared by poll-interval (Fabian Möller)</li> 18734 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 18735 </ul></li> 18736 <li>Local 18737 <ul> 18738 <li>Skip bad symlinks in dir listing with -L enabled (Cédric Connes)</li> 18739 <li>Preallocate files on Windows to reduce fragmentation (Nick Craig-Wood)</li> 18740 <li>Preallocate files on linux with fallocate(2) (Nick Craig-Wood)</li> 18741 </ul></li> 18742 <li>Cache 18743 <ul> 18744 <li>Add cache/fetch rc function (Fabian Möller)</li> 18745 <li>Fix worker scale down (Fabian Möller)</li> 18746 <li>Improve performance by not sending info requests for cached chunks (dcpu)</li> 18747 <li>Fix error return value of cache/fetch rc method (Fabian Möller)</li> 18748 <li>Documentation fix for cache-chunk-total-size (Anagh Kumar Baranwal)</li> 18749 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 18750 <li>Add plex_insecure option to skip certificate validation (Fabian Möller)</li> 18751 <li>Remove entries that no longer exist in the source (dcpu)</li> 18752 </ul></li> 18753 <li>Crypt 18754 <ul> 18755 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 18756 </ul></li> 18757 <li>Alias 18758 <ul> 18759 <li>Fix handling of Windows network paths (Nick Craig-Wood)</li> 18760 </ul></li> 18761 <li>Azure Blob 18762 <ul> 18763 <li>Add <code>--azureblob-list-chunk</code> parameter (Santiago Rodríguez)</li> 18764 <li>Implemented settier command support on azureblob remote. (sandeepkru)</li> 18765 <li>Work around SDK bug which causes errors for chunk-sized files (Nick Craig-Wood)</li> 18766 </ul></li> 18767 <li>Box 18768 <ul> 18769 <li>Implement link sharing. (Sebastian Bünger)</li> 18770 </ul></li> 18771 <li>Drive 18772 <ul> 18773 <li>Add <code>--drive-import-formats</code> - google docs can now be imported (Fabian Möller) 18774 <ul> 18775 <li>Rewrite mime type and extension handling (Fabian Möller)</li> 18776 <li>Add document links (Fabian Möller)</li> 18777 <li>Add support for multipart document extensions (Fabian Möller)</li> 18778 <li>Add support for apps-script to json export (Fabian Möller)</li> 18779 <li>Fix escaped chars in documents during list (Fabian Möller)</li> 18780 </ul></li> 18781 <li>Add <code>--drive-v2-download-min-size</code> a workaround for slow downloads (Fabian Möller)</li> 18782 <li>Improve directory notifications in ChangeNotify (Fabian Möller)</li> 18783 <li>When listing team drives in config, continue on failure (Nick Craig-Wood)</li> 18784 </ul></li> 18785 <li>FTP 18786 <ul> 18787 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 18788 </ul></li> 18789 <li>Google Cloud Storage 18790 <ul> 18791 <li>Fix service_account_file being ignored (Fabian Möller)</li> 18792 </ul></li> 18793 <li>Jottacloud 18794 <ul> 18795 <li>Minor improvement in quota info (omit if unlimited) (albertony)</li> 18796 <li>Add <code>--fast-list</code> support (albertony)</li> 18797 <li>Add permanent delete support: <code>--jottacloud-hard-delete</code> (albertony)</li> 18798 <li>Add link sharing support (albertony)</li> 18799 <li>Fix handling of reserved characters. (Sebastian Bünger)</li> 18800 <li>Fix socket leak on Object.Remove (Nick Craig-Wood)</li> 18801 </ul></li> 18802 <li>Onedrive 18803 <ul> 18804 <li>Rework to support Microsoft Graph (Cnly) 18805 <ul> 18806 <li><strong>NB</strong> this will require re-authenticating the remote</li> 18807 </ul></li> 18808 <li>Removed upload cutoff and always do session uploads (Oliver Heyme)</li> 18809 <li>Use single-part upload for empty files (Cnly)</li> 18810 <li>Fix new fields not saved when editing old config (Alex Chen)</li> 18811 <li>Fix sometimes special chars in filenames not replaced (Alex Chen)</li> 18812 <li>Ignore OneNote files by default (Alex Chen)</li> 18813 <li>Add link sharing support (jackyzy823)</li> 18814 </ul></li> 18815 <li>S3 18816 <ul> 18817 <li>Use custom pacer, to retry operations when reasonable (Craig Miskell)</li> 18818 <li>Use configured server-side-encryption and storage class options when calling CopyObject() (Paul Kohout)</li> 18819 <li>Make <code>--s3-v2-auth</code> flag (Nick Craig-Wood)</li> 18820 <li>Fix v2 auth on files with spaces (Nick Craig-Wood)</li> 18821 </ul></li> 18822 <li>Union 18823 <ul> 18824 <li>Implement union backend which reads from multiple backends (Felix Brucker)</li> 18825 <li>Implement optional interfaces (Move, DirMove, Copy etc) (Nick Craig-Wood)</li> 18826 <li>Fix ChangeNotify to support multiple remotes (Fabian Möller)</li> 18827 <li>Fix <code>--backup-dir</code> on union backend (Nick Craig-Wood)</li> 18828 </ul></li> 18829 <li>WebDAV 18830 <ul> 18831 <li>Add another time format (Nick Craig-Wood)</li> 18832 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 18833 <li>Add workaround for missing mtime (buergi)</li> 18834 <li>Sharepoint: Renew cookies after 12hrs (Henning Surmeier)</li> 18835 </ul></li> 18836 <li>Yandex 18837 <ul> 18838 <li>Remove redundant nil checks (teresy)</li> 18839 </ul></li> 18840 </ul> 18841 <h2 id="v1.43.1---2018-09-07">v1.43.1 - 2018-09-07</h2> 18842 <p>Point release to fix hubic and azureblob backends.</p> 18843 <ul> 18844 <li>Bug Fixes 18845 <ul> 18846 <li>ncdu: Return error instead of log.Fatal in Show (Fabian Möller)</li> 18847 <li>cmd: Fix crash with <code>--progress</code> and <code>--stats 0</code> (Nick Craig-Wood)</li> 18848 <li>docs: Tidy website display (Anagh Kumar Baranwal)</li> 18849 </ul></li> 18850 <li>Azure Blob: 18851 <ul> 18852 <li>Fix multi-part uploads. (sandeepkru)</li> 18853 </ul></li> 18854 <li>Hubic 18855 <ul> 18856 <li>Fix uploads (Nick Craig-Wood)</li> 18857 <li>Retry auth fetching if it fails to make hubic more reliable (Nick Craig-Wood)</li> 18858 </ul></li> 18859 </ul> 18860 <h2 id="v1.43---2018-09-01">v1.43 - 2018-09-01</h2> 18861 <ul> 18862 <li>New backends 18863 <ul> 18864 <li>Jottacloud (Sebastian Bünger)</li> 18865 </ul></li> 18866 <li>New commands 18867 <ul> 18868 <li>copyurl: copies a URL to a remote (Denis)</li> 18869 </ul></li> 18870 <li>New Features 18871 <ul> 18872 <li>Reworked config for backends (Nick Craig-Wood) 18873 <ul> 18874 <li>All backend config can now be supplied by command line, env var or config file</li> 18875 <li>Advanced section in the config wizard for the optional items</li> 18876 <li>A large step towards rclone backends being usable in other go software</li> 18877 <li>Allow on the fly remotes with :backend: syntax</li> 18878 </ul></li> 18879 <li>Stats revamp 18880 <ul> 18881 <li>Add <code>--progress</code>/<code>-P</code> flag to show interactive progress (Nick Craig-Wood)</li> 18882 <li>Show the total progress of the sync in the stats (Nick Craig-Wood)</li> 18883 <li>Add <code>--stats-one-line</code> flag for single line stats (Nick Craig-Wood)</li> 18884 </ul></li> 18885 <li>Added weekday schedule into <code>--bwlimit</code> (Mateusz)</li> 18886 <li>lsjson: Add option to show the original object IDs (Fabian Möller)</li> 18887 <li>serve webdav: Make Content-Type without reading the file and add <code>--etag-hash</code> (Nick Craig-Wood)</li> 18888 <li>build 18889 <ul> 18890 <li>Build macOS with native compiler (Nick Craig-Wood)</li> 18891 <li>Update to use go1.11 for the build (Nick Craig-Wood)</li> 18892 </ul></li> 18893 <li>rc 18894 <ul> 18895 <li>Added core/stats to return the stats (reddi1)</li> 18896 </ul></li> 18897 <li><code>version --check</code>: Prints the current release and beta versions (Nick Craig-Wood)</li> 18898 </ul></li> 18899 <li>Bug Fixes 18900 <ul> 18901 <li>accounting 18902 <ul> 18903 <li>Fix time to completion estimates (Nick Craig-Wood)</li> 18904 <li>Fix moving average speed for file stats (Nick Craig-Wood)</li> 18905 </ul></li> 18906 <li>config: Fix error reading password from piped input (Nick Craig-Wood)</li> 18907 <li>move: Fix <code>--delete-empty-src-dirs</code> flag to delete all empty dirs on move (ishuah)</li> 18908 </ul></li> 18909 <li>Mount 18910 <ul> 18911 <li>Implement <code>--daemon-timeout</code> flag for OSXFUSE (Nick Craig-Wood)</li> 18912 <li>Fix mount <code>--daemon</code> not working with encrypted config (Alex Chen)</li> 18913 <li>Clip the number of blocks to 2^32-1 on macOS - fixes borg backup (Nick Craig-Wood)</li> 18914 </ul></li> 18915 <li>VFS 18916 <ul> 18917 <li>Enable vfs-read-chunk-size by default (Fabian Möller)</li> 18918 <li>Add the vfs/refresh rc command (Fabian Möller)</li> 18919 <li>Add non recursive mode to vfs/refresh rc command (Fabian Möller)</li> 18920 <li>Try to seek buffer on read only files (Fabian Möller)</li> 18921 </ul></li> 18922 <li>Local 18923 <ul> 18924 <li>Fix crash when deprecated <code>--local-no-unicode-normalization</code> is supplied (Nick Craig-Wood)</li> 18925 <li>Fix mkdir error when trying to copy files to the root of a drive on windows (Nick Craig-Wood)</li> 18926 </ul></li> 18927 <li>Cache 18928 <ul> 18929 <li>Fix nil pointer deref when using lsjson on cached directory (Nick Craig-Wood)</li> 18930 <li>Fix nil pointer deref for occasional crash on playback (Nick Craig-Wood)</li> 18931 </ul></li> 18932 <li>Crypt 18933 <ul> 18934 <li>Fix accounting when checking hashes on upload (Nick Craig-Wood)</li> 18935 </ul></li> 18936 <li>Amazon Cloud Drive 18937 <ul> 18938 <li>Make very clear in the docs that rclone has no ACD keys (Nick Craig-Wood)</li> 18939 </ul></li> 18940 <li>Azure Blob 18941 <ul> 18942 <li>Add connection string and SAS URL auth (Nick Craig-Wood)</li> 18943 <li>List the container to see if it exists (Nick Craig-Wood)</li> 18944 <li>Port new Azure Blob Storage SDK (sandeepkru)</li> 18945 <li>Added blob tier, tier between Hot, Cool and Archive. (sandeepkru)</li> 18946 <li>Remove leading / from paths (Nick Craig-Wood)</li> 18947 </ul></li> 18948 <li>B2 18949 <ul> 18950 <li>Support Application Keys (Nick Craig-Wood)</li> 18951 <li>Remove leading / from paths (Nick Craig-Wood)</li> 18952 </ul></li> 18953 <li>Box 18954 <ul> 18955 <li>Fix upload of > 2GB files on 32 bit platforms (Nick Craig-Wood)</li> 18956 <li>Make <code>--box-commit-retries</code> flag defaulting to 100 to fix large uploads (Nick Craig-Wood)</li> 18957 </ul></li> 18958 <li>Drive 18959 <ul> 18960 <li>Add <code>--drive-keep-revision-forever</code> flag (lewapm)</li> 18961 <li>Handle gdocs when filtering file names in list (Fabian Möller)</li> 18962 <li>Support using <code>--fast-list</code> for large speedups (Fabian Möller)</li> 18963 </ul></li> 18964 <li>FTP 18965 <ul> 18966 <li>Fix Put mkParentDir failed: 521 for BunnyCDN (Nick Craig-Wood)</li> 18967 </ul></li> 18968 <li>Google Cloud Storage 18969 <ul> 18970 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 18971 </ul></li> 18972 <li>Jottacloud 18973 <ul> 18974 <li>Fix MD5 error check (Oliver Heyme)</li> 18975 <li>Handle empty time values (Martin Polden)</li> 18976 <li>Calculate missing MD5s (Oliver Heyme)</li> 18977 <li>Docs, fixes and tests for MD5 calculation (Nick Craig-Wood)</li> 18978 <li>Add optional MimeTyper interface. (Sebastian Bünger)</li> 18979 <li>Implement optional About interface (for <code>df</code> support). (Sebastian Bünger)</li> 18980 </ul></li> 18981 <li>Mega 18982 <ul> 18983 <li>Wait for events instead of arbitrary sleeping (Nick Craig-Wood)</li> 18984 <li>Add <code>--mega-hard-delete</code> flag (Nick Craig-Wood)</li> 18985 <li>Fix failed logins with upper case chars in email (Nick Craig-Wood)</li> 18986 </ul></li> 18987 <li>Onedrive 18988 <ul> 18989 <li>Shared folder support (Yoni Jah)</li> 18990 <li>Implement DirMove (Cnly)</li> 18991 <li>Fix rmdir sometimes deleting directories with contents (Nick Craig-Wood)</li> 18992 </ul></li> 18993 <li>Pcloud 18994 <ul> 18995 <li>Delete half uploaded files on upload error (Nick Craig-Wood)</li> 18996 </ul></li> 18997 <li>Qingstor 18998 <ul> 18999 <li>Remove leading / from paths (Nick Craig-Wood)</li> 19000 </ul></li> 19001 <li>S3 19002 <ul> 19003 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 19004 <li>Add <code>--s3-force-path-style</code> (Nick Craig-Wood)</li> 19005 <li>Add support for KMS Key ID (bsteiss)</li> 19006 <li>Remove leading / from paths (Nick Craig-Wood)</li> 19007 </ul></li> 19008 <li>Swift 19009 <ul> 19010 <li>Add <code>storage_policy</code> (Ruben Vandamme)</li> 19011 <li>Make it so just <code>storage_url</code> or <code>auth_token</code> can be overridden (Nick Craig-Wood)</li> 19012 <li>Fix server side copy bug for unusual file names (Nick Craig-Wood)</li> 19013 <li>Remove leading / from paths (Nick Craig-Wood)</li> 19014 </ul></li> 19015 <li>WebDAV 19016 <ul> 19017 <li>Ensure we call MKCOL with a URL with a trailing / for QNAP interop (Nick Craig-Wood)</li> 19018 <li>If root ends with / then don’t check if it is a file (Nick Craig-Wood)</li> 19019 <li>Don’t accept redirects when reading metadata (Nick Craig-Wood)</li> 19020 <li>Add bearer token (Macaroon) support for dCache (Nick Craig-Wood)</li> 19021 <li>Document dCache and Macaroons (Onno Zweers)</li> 19022 <li>Sharepoint recursion with different depth (Henning)</li> 19023 <li>Attempt to remove failed uploads (Nick Craig-Wood)</li> 19024 </ul></li> 19025 <li>Yandex 19026 <ul> 19027 <li>Fix listing/deleting files in the root (Nick Craig-Wood)</li> 19028 </ul></li> 19029 </ul> 19030 <h2 id="v1.42---2018-06-16">v1.42 - 2018-06-16</h2> 19031 <ul> 19032 <li>New backends 19033 <ul> 19034 <li>OpenDrive (Oliver Heyme, Jakub Karlicek, ncw)</li> 19035 </ul></li> 19036 <li>New commands 19037 <ul> 19038 <li>deletefile command (Filip Bartodziej)</li> 19039 </ul></li> 19040 <li>New Features 19041 <ul> 19042 <li>copy, move: Copy single files directly, don’t use <code>--files-from</code> work-around 19043 <ul> 19044 <li>this makes them much more efficient</li> 19045 </ul></li> 19046 <li>Implement <code>--max-transfer</code> flag to quit transferring at a limit 19047 <ul> 19048 <li>make exit code 8 for <code>--max-transfer</code> exceeded</li> 19049 </ul></li> 19050 <li>copy: copy empty source directories to destination (Ishuah Kariuki)</li> 19051 <li>check: Add <code>--one-way</code> flag (Kasper Byrdal Nielsen)</li> 19052 <li>Add siginfo handler for macOS for ctrl-T stats (kubatasiemski)</li> 19053 <li>rc 19054 <ul> 19055 <li>add core/gc to run a garbage collection on demand</li> 19056 <li>enable go profiling by default on the <code>--rc</code> port</li> 19057 <li>return error from remote on failure</li> 19058 </ul></li> 19059 <li>lsf 19060 <ul> 19061 <li>Add <code>--absolute</code> flag to add a leading / onto path names</li> 19062 <li>Add <code>--csv</code> flag for compliant CSV output</li> 19063 <li>Add ‘m’ format specifier to show the MimeType</li> 19064 <li>Implement ‘i’ format for showing object ID</li> 19065 </ul></li> 19066 <li>lsjson 19067 <ul> 19068 <li>Add MimeType to the output</li> 19069 <li>Add ID field to output to show Object ID</li> 19070 </ul></li> 19071 <li>Add <code>--retries-sleep</code> flag (Benjamin Joseph Dag)</li> 19072 <li>Oauth tidy up web page and error handling (Henning Surmeier)</li> 19073 </ul></li> 19074 <li>Bug Fixes 19075 <ul> 19076 <li>Password prompt output with <code>--log-file</code> fixed for unix (Filip Bartodziej)</li> 19077 <li>Calculate ModifyWindow each time on the fly to fix various problems (Stefan Breunig)</li> 19078 </ul></li> 19079 <li>Mount 19080 <ul> 19081 <li>Only print “File.rename error” if there actually is an error (Stefan Breunig)</li> 19082 <li>Delay rename if file has open writers instead of failing outright (Stefan Breunig)</li> 19083 <li>Ensure atexit gets run on interrupt</li> 19084 <li>macOS enhancements 19085 <ul> 19086 <li>Make <code>--noappledouble</code> <code>--noapplexattr</code></li> 19087 <li>Add <code>--volname</code> flag and remove special chars from it</li> 19088 <li>Make Get/List/Set/Remove xattr return ENOSYS for efficiency</li> 19089 <li>Make <code>--daemon</code> work for macOS without CGO</li> 19090 </ul></li> 19091 </ul></li> 19092 <li>VFS 19093 <ul> 19094 <li>Add <code>--vfs-read-chunk-size</code> and <code>--vfs-read-chunk-size-limit</code> (Fabian Möller)</li> 19095 <li>Fix ChangeNotify for new or changed folders (Fabian Möller)</li> 19096 </ul></li> 19097 <li>Local 19098 <ul> 19099 <li>Fix symlink/junction point directory handling under Windows 19100 <ul> 19101 <li><strong>NB</strong> you will need to add <code>-L</code> to your command line to copy files with reparse points</li> 19102 </ul></li> 19103 </ul></li> 19104 <li>Cache 19105 <ul> 19106 <li>Add non cached dirs on notifications (Remus Bunduc)</li> 19107 <li>Allow root to be expired from rc (Remus Bunduc)</li> 19108 <li>Clean remaining empty folders from temp upload path (Remus Bunduc)</li> 19109 <li>Cache lists using batch writes (Remus Bunduc)</li> 19110 <li>Use secure websockets for HTTPS Plex addresses (John Clayton)</li> 19111 <li>Reconnect plex websocket on failures (Remus Bunduc)</li> 19112 <li>Fix panic when running without plex configs (Remus Bunduc)</li> 19113 <li>Fix root folder caching (Remus Bunduc)</li> 19114 </ul></li> 19115 <li>Crypt 19116 <ul> 19117 <li>Check the crypted hash of files when uploading for extra data security</li> 19118 </ul></li> 19119 <li>Dropbox 19120 <ul> 19121 <li>Make Dropbox for business folders accessible using an initial <code>/</code> in the path</li> 19122 </ul></li> 19123 <li>Google Cloud Storage 19124 <ul> 19125 <li>Low level retry all operations if necessary</li> 19126 </ul></li> 19127 <li>Google Drive 19128 <ul> 19129 <li>Add <code>--drive-acknowledge-abuse</code> to download flagged files</li> 19130 <li>Add <code>--drive-alternate-export</code> to fix large doc export</li> 19131 <li>Don’t attempt to choose Team Drives when using rclone config create</li> 19132 <li>Fix change list polling with team drives</li> 19133 <li>Fix ChangeNotify for folders (Fabian Möller)</li> 19134 <li>Fix about (and df on a mount) for team drives</li> 19135 </ul></li> 19136 <li>Onedrive 19137 <ul> 19138 <li>Errorhandler for onedrive for business requests (Henning Surmeier)</li> 19139 </ul></li> 19140 <li>S3 19141 <ul> 19142 <li>Adjust upload concurrency with <code>--s3-upload-concurrency</code> (themylogin)</li> 19143 <li>Fix <code>--s3-chunk-size</code> which was always using the minimum</li> 19144 </ul></li> 19145 <li>SFTP 19146 <ul> 19147 <li>Add <code>--ssh-path-override</code> flag (Piotr Oleszczyk)</li> 19148 <li>Fix slow downloads for long latency connections</li> 19149 </ul></li> 19150 <li>Webdav 19151 <ul> 19152 <li>Add workarounds for biz.mail.ru</li> 19153 <li>Ignore Reason-Phrase in status line to fix 4shared (Rodrigo)</li> 19154 <li>Better error message generation</li> 19155 </ul></li> 19156 </ul> 19157 <h2 id="v1.41---2018-04-28">v1.41 - 2018-04-28</h2> 19158 <ul> 19159 <li>New backends 19160 <ul> 19161 <li>Mega support added</li> 19162 <li>Webdav now supports SharePoint cookie authentication (hensur)</li> 19163 </ul></li> 19164 <li>New commands 19165 <ul> 19166 <li>link: create public link to files and folders (Stefan Breunig)</li> 19167 <li>about: gets quota info from a remote (a-roussos, ncw)</li> 19168 <li>hashsum: a generic tool for any hash to produce md5sum like output</li> 19169 </ul></li> 19170 <li>New Features 19171 <ul> 19172 <li>lsd: Add -R flag and fix and update docs for all ls commands</li> 19173 <li>ncdu: added a “refresh” key - CTRL-L (Keith Goldfarb)</li> 19174 <li>serve restic: Add append-only mode (Steve Kriss)</li> 19175 <li>serve restic: Disallow overwriting files in append-only mode (Alexander Neumann)</li> 19176 <li>serve restic: Print actual listener address (Matt Holt)</li> 19177 <li>size: Add –json flag (Matthew Holt)</li> 19178 <li>sync: implement –ignore-errors (Mateusz Pabian)</li> 19179 <li>dedupe: Add dedupe largest functionality (Richard Yang)</li> 19180 <li>fs: Extend SizeSuffix to include TB and PB for rclone about</li> 19181 <li>fs: add –dump goroutines and –dump openfiles for debugging</li> 19182 <li>rc: implement core/memstats to print internal memory usage info</li> 19183 <li>rc: new call rc/pid (Michael P. Dubner)</li> 19184 </ul></li> 19185 <li>Compile 19186 <ul> 19187 <li>Drop support for go1.6</li> 19188 </ul></li> 19189 <li>Release 19190 <ul> 19191 <li>Fix <code>make tarball</code> (Chih-Hsuan Yen)</li> 19192 </ul></li> 19193 <li>Bug Fixes 19194 <ul> 19195 <li>filter: fix –min-age and –max-age together check</li> 19196 <li>fs: limit MaxIdleConns and MaxIdleConnsPerHost in transport</li> 19197 <li>lsd,lsf: make sure all times we output are in local time</li> 19198 <li>rc: fix setting bwlimit to unlimited</li> 19199 <li>rc: take note of the –rc-addr flag too as per the docs</li> 19200 </ul></li> 19201 <li>Mount 19202 <ul> 19203 <li>Use About to return the correct disk total/used/free (eg in <code>df</code>)</li> 19204 <li>Set <code>--attr-timeout default</code> to <code>1s</code> - fixes: 19205 <ul> 19206 <li>rclone using too much memory</li> 19207 <li>rclone not serving files to samba</li> 19208 <li>excessive time listing directories</li> 19209 </ul></li> 19210 <li>Fix <code>df -i</code> (upstream fix)</li> 19211 </ul></li> 19212 <li>VFS 19213 <ul> 19214 <li>Filter files <code>.</code> and <code>..</code> from directory listing</li> 19215 <li>Only make the VFS cache if –vfs-cache-mode > Off</li> 19216 </ul></li> 19217 <li>Local 19218 <ul> 19219 <li>Add –local-no-check-updated to disable updated file checks</li> 19220 <li>Retry remove on Windows sharing violation error</li> 19221 </ul></li> 19222 <li>Cache 19223 <ul> 19224 <li>Flush the memory cache after close</li> 19225 <li>Purge file data on notification</li> 19226 <li>Always forget parent dir for notifications</li> 19227 <li>Integrate with Plex websocket</li> 19228 <li>Add rc cache/stats (seuffert)</li> 19229 <li>Add info log on notification</li> 19230 </ul></li> 19231 <li>Box 19232 <ul> 19233 <li>Fix failure reading large directories - parse file/directory size as float</li> 19234 </ul></li> 19235 <li>Dropbox 19236 <ul> 19237 <li>Fix crypt+obfuscate on dropbox</li> 19238 <li>Fix repeatedly uploading the same files</li> 19239 </ul></li> 19240 <li>FTP 19241 <ul> 19242 <li>Work around strange response from box FTP server</li> 19243 <li>More workarounds for FTP servers to fix mkParentDir error</li> 19244 <li>Fix no error on listing non-existent directory</li> 19245 </ul></li> 19246 <li>Google Cloud Storage 19247 <ul> 19248 <li>Add service_account_credentials (Matt Holt)</li> 19249 <li>Detect bucket presence by listing it - minimises permissions needed</li> 19250 <li>Ignore zero length directory markers</li> 19251 </ul></li> 19252 <li>Google Drive 19253 <ul> 19254 <li>Add service_account_credentials (Matt Holt)</li> 19255 <li>Fix directory move leaving a hardlinked directory behind</li> 19256 <li>Return proper google errors when Opening files</li> 19257 <li>When initialized with a filepath, optional features used incorrect root path (Stefan Breunig)</li> 19258 </ul></li> 19259 <li>HTTP 19260 <ul> 19261 <li>Fix sync for servers which don’t return Content-Length in HEAD</li> 19262 </ul></li> 19263 <li>Onedrive 19264 <ul> 19265 <li>Add QuickXorHash support for OneDrive for business</li> 19266 <li>Fix socket leak in multipart session upload</li> 19267 </ul></li> 19268 <li>S3 19269 <ul> 19270 <li>Look in S3 named profile files for credentials</li> 19271 <li>Add <code>--s3-disable-checksum</code> to disable checksum uploading (Chris Redekop)</li> 19272 <li>Hierarchical configuration support (Giri Badanahatti)</li> 19273 <li>Add in config for all the supported S3 providers</li> 19274 <li>Add One Zone Infrequent Access storage class (Craig Rachel)</li> 19275 <li>Add –use-server-modtime support (Peter Baumgartner)</li> 19276 <li>Add –s3-chunk-size option to control multipart uploads</li> 19277 <li>Ignore zero length directory markers</li> 19278 </ul></li> 19279 <li>SFTP 19280 <ul> 19281 <li>Update docs to match code, fix typos and clarify disable_hashcheck prompt (Michael G. Noll)</li> 19282 <li>Update docs with Synology quirks</li> 19283 <li>Fail soft with a debug on hash failure</li> 19284 </ul></li> 19285 <li>Swift 19286 <ul> 19287 <li>Add –use-server-modtime support (Peter Baumgartner)</li> 19288 </ul></li> 19289 <li>Webdav 19290 <ul> 19291 <li>Support SharePoint cookie authentication (hensur)</li> 19292 <li>Strip leading and trailing / off root</li> 19293 </ul></li> 19294 </ul> 19295 <h2 id="v1.40---2018-03-19">v1.40 - 2018-03-19</h2> 19296 <ul> 19297 <li>New backends 19298 <ul> 19299 <li>Alias backend to create aliases for existing remote names (Fabian Möller)</li> 19300 </ul></li> 19301 <li>New commands 19302 <ul> 19303 <li><code>lsf</code>: list for parsing purposes (Jakub Tasiemski) 19304 <ul> 19305 <li>by default this is a simple non recursive list of files and directories</li> 19306 <li>it can be configured to add more info in an easy to parse way</li> 19307 </ul></li> 19308 <li><code>serve restic</code>: for serving a remote as a Restic REST endpoint 19309 <ul> 19310 <li>This enables restic to use any backends that rclone can access</li> 19311 <li>Thanks Alexander Neumann for help, patches and review</li> 19312 </ul></li> 19313 <li><code>rc</code>: enable the remote control of a running rclone 19314 <ul> 19315 <li>The running rclone must be started with –rc and related flags.</li> 19316 <li>Currently there is support for bwlimit, and flushing for mount and cache.</li> 19317 </ul></li> 19318 </ul></li> 19319 <li>New Features 19320 <ul> 19321 <li><code>--max-delete</code> flag to add a delete threshold (Bjørn Erik Pedersen)</li> 19322 <li>All backends now support RangeOption for ranged Open 19323 <ul> 19324 <li><code>cat</code>: Use RangeOption for limited fetches to make more efficient</li> 19325 <li><code>cryptcheck</code>: make reading of nonce more efficient with RangeOption</li> 19326 </ul></li> 19327 <li>serve http/webdav/restic 19328 <ul> 19329 <li>support SSL/TLS</li> 19330 <li>add <code>--user</code> <code>--pass</code> and <code>--htpasswd</code> for authentication</li> 19331 </ul></li> 19332 <li><code>copy</code>/<code>move</code>: detect file size change during copy/move and abort transfer (ishuah)</li> 19333 <li><code>cryptdecode</code>: added option to return encrypted file names. (ishuah)</li> 19334 <li><code>lsjson</code>: add <code>--encrypted</code> to show encrypted name (Jakub Tasiemski)</li> 19335 <li>Add <code>--stats-file-name-length</code> to specify the printed file name length for stats (Will Gunn)</li> 19336 </ul></li> 19337 <li>Compile 19338 <ul> 19339 <li>Code base was shuffled and factored 19340 <ul> 19341 <li>backends moved into a backend directory</li> 19342 <li>large packages split up</li> 19343 <li>See the CONTRIBUTING.md doc for info as to what lives where now</li> 19344 </ul></li> 19345 <li>Update to using go1.10 as the default go version</li> 19346 <li>Implement daily <a href="https://pub.rclone.org/integration-tests/">full integration tests</a></li> 19347 </ul></li> 19348 <li>Release 19349 <ul> 19350 <li>Include a source tarball and sign it and the binaries</li> 19351 <li>Sign the git tags as part of the release process</li> 19352 <li>Add .deb and .rpm packages as part of the build</li> 19353 <li>Make a beta release for all branches on the main repo (but not pull requests)</li> 19354 </ul></li> 19355 <li>Bug Fixes 19356 <ul> 19357 <li>config: fixes errors on non existing config by loading config file only on first access</li> 19358 <li>config: retry saving the config after failure (Mateusz)</li> 19359 <li>sync: when using <code>--backup-dir</code> don’t delete files if we can’t set their modtime 19360 <ul> 19361 <li>this fixes odd behaviour with Dropbox and <code>--backup-dir</code></li> 19362 </ul></li> 19363 <li>fshttp: fix idle timeouts for HTTP connections</li> 19364 <li><code>serve http</code>: fix serving files with : in - fixes</li> 19365 <li>Fix <code>--exclude-if-present</code> to ignore directories which it doesn’t have permission for (Iakov Davydov)</li> 19366 <li>Make accounting work properly with crypt and b2</li> 19367 <li>remove <code>--no-traverse</code> flag because it is obsolete</li> 19368 </ul></li> 19369 <li>Mount 19370 <ul> 19371 <li>Add <code>--attr-timeout</code> flag to control attribute caching in kernel 19372 <ul> 19373 <li>this now defaults to 0 which is correct but less efficient</li> 19374 <li>see <a href="https://rclone.org/commands/rclone_mount/#attribute-caching">the mount docs</a> for more info</li> 19375 </ul></li> 19376 <li>Add <code>--daemon</code> flag to allow mount to run in the background (ishuah)</li> 19377 <li>Fix: Return ENOSYS rather than EIO on attempted link 19378 <ul> 19379 <li>This fixes FileZilla accessing an rclone mount served over sftp.</li> 19380 </ul></li> 19381 <li>Fix setting modtime twice</li> 19382 <li>Mount tests now run on CI for Linux (mount & cmount)/Mac/Windows</li> 19383 <li>Many bugs fixed in the VFS layer - see below</li> 19384 </ul></li> 19385 <li>VFS 19386 <ul> 19387 <li>Many fixes for <code>--vfs-cache-mode</code> writes and above 19388 <ul> 19389 <li>Update cached copy if we know it has changed (fixes stale data)</li> 19390 <li>Clean path names before using them in the cache</li> 19391 <li>Disable cache cleaner if <code>--vfs-cache-poll-interval=0</code></li> 19392 <li>Fill and clean the cache immediately on startup</li> 19393 </ul></li> 19394 <li>Fix Windows opening every file when it stats the file</li> 19395 <li>Fix applying modtime for an open Write Handle</li> 19396 <li>Fix creation of files when truncating</li> 19397 <li>Write 0 bytes when flushing unwritten handles to avoid race conditions in FUSE</li> 19398 <li>Downgrade “poll-interval is not supported” message to Info</li> 19399 <li>Make OpenFile and friends return EINVAL if O_RDONLY and O_TRUNC</li> 19400 </ul></li> 19401 <li>Local 19402 <ul> 19403 <li>Downgrade “invalid cross-device link: trying copy” to debug</li> 19404 <li>Make DirMove return fs.ErrorCantDirMove to allow fallback to Copy for cross device</li> 19405 <li>Fix race conditions updating the hashes</li> 19406 </ul></li> 19407 <li>Cache 19408 <ul> 19409 <li>Add support for polling - cache will update when remote changes on supported backends</li> 19410 <li>Reduce log level for Plex api</li> 19411 <li>Fix dir cache issue</li> 19412 <li>Implement <code>--cache-db-wait-time</code> flag</li> 19413 <li>Improve efficiency with RangeOption and RangeSeek</li> 19414 <li>Fix dirmove with temp fs enabled</li> 19415 <li>Notify vfs when using temp fs</li> 19416 <li>Offline uploading</li> 19417 <li>Remote control support for path flushing</li> 19418 </ul></li> 19419 <li>Amazon cloud drive 19420 <ul> 19421 <li>Rclone no longer has any working keys - disable integration tests</li> 19422 <li>Implement DirChangeNotify to notify cache/vfs/mount of changes</li> 19423 </ul></li> 19424 <li>Azureblob 19425 <ul> 19426 <li>Don’t check for bucket/container presence if listing was OK 19427 <ul> 19428 <li>this makes rclone do one less request per invocation</li> 19429 </ul></li> 19430 <li>Improve accounting for chunked uploads</li> 19431 </ul></li> 19432 <li>Backblaze B2 19433 <ul> 19434 <li>Don’t check for bucket/container presence if listing was OK 19435 <ul> 19436 <li>this makes rclone do one less request per invocation</li> 19437 </ul></li> 19438 </ul></li> 19439 <li>Box 19440 <ul> 19441 <li>Improve accounting for chunked uploads</li> 19442 </ul></li> 19443 <li>Dropbox 19444 <ul> 19445 <li>Fix custom oauth client parameters</li> 19446 </ul></li> 19447 <li>Google Cloud Storage 19448 <ul> 19449 <li>Don’t check for bucket/container presence if listing was OK 19450 <ul> 19451 <li>this makes rclone do one less request per invocation</li> 19452 </ul></li> 19453 </ul></li> 19454 <li>Google Drive 19455 <ul> 19456 <li>Migrate to api v3 (Fabian Möller)</li> 19457 <li>Add scope configuration and root folder selection</li> 19458 <li>Add <code>--drive-impersonate</code> for service accounts 19459 <ul> 19460 <li>thanks to everyone who tested, explored and contributed docs</li> 19461 </ul></li> 19462 <li>Add <code>--drive-use-created-date</code> to use created date as modified date (nbuchanan)</li> 19463 <li>Request the export formats only when required 19464 <ul> 19465 <li>This makes rclone quicker when there are no google docs</li> 19466 </ul></li> 19467 <li>Fix finding paths with latin1 chars (a workaround for a drive bug)</li> 19468 <li>Fix copying of a single Google doc file</li> 19469 <li>Fix <code>--drive-auth-owner-only</code> to look in all directories</li> 19470 </ul></li> 19471 <li>HTTP 19472 <ul> 19473 <li>Fix handling of directories with & in</li> 19474 </ul></li> 19475 <li>Onedrive 19476 <ul> 19477 <li>Removed upload cutoff and always do session uploads 19478 <ul> 19479 <li>this stops the creation of multiple versions on business onedrive</li> 19480 </ul></li> 19481 <li>Overwrite object size value with real size when reading file. (Victor) 19482 <ul> 19483 <li>this fixes oddities when onedrive misreports the size of images</li> 19484 </ul></li> 19485 </ul></li> 19486 <li>Pcloud 19487 <ul> 19488 <li>Remove unused chunked upload flag and code</li> 19489 </ul></li> 19490 <li>Qingstor 19491 <ul> 19492 <li>Don’t check for bucket/container presence if listing was OK 19493 <ul> 19494 <li>this makes rclone do one less request per invocation</li> 19495 </ul></li> 19496 </ul></li> 19497 <li>S3 19498 <ul> 19499 <li>Support hashes for multipart files (Chris Redekop)</li> 19500 <li>Initial support for IBM COS (S3) (Giri Badanahatti)</li> 19501 <li>Update docs to discourage use of v2 auth with CEPH and others</li> 19502 <li>Don’t check for bucket/container presence if listing was OK 19503 <ul> 19504 <li>this makes rclone do one less request per invocation</li> 19505 </ul></li> 19506 <li>Fix server side copy and set modtime on files with + in</li> 19507 </ul></li> 19508 <li>SFTP 19509 <ul> 19510 <li>Add option to disable remote hash check command execution (Jon Fautley)</li> 19511 <li>Add <code>--sftp-ask-password</code> flag to prompt for password when needed (Leo R. Lundgren)</li> 19512 <li>Add <code>set_modtime</code> configuration option</li> 19513 <li>Fix following of symlinks</li> 19514 <li>Fix reading config file outside of Fs setup</li> 19515 <li>Fix reading $USER in username fallback not $HOME</li> 19516 <li>Fix running under crontab - Use correct OS way of reading username</li> 19517 </ul></li> 19518 <li>Swift 19519 <ul> 19520 <li>Fix refresh of authentication token 19521 <ul> 19522 <li>in v1.39 a bug was introduced which ignored new tokens - this fixes it</li> 19523 </ul></li> 19524 <li>Fix extra HEAD transaction when uploading a new file</li> 19525 <li>Don’t check for bucket/container presence if listing was OK 19526 <ul> 19527 <li>this makes rclone do one less request per invocation</li> 19528 </ul></li> 19529 </ul></li> 19530 <li>Webdav 19531 <ul> 19532 <li>Add new time formats to support mydrive.ch and others</li> 19533 </ul></li> 19534 </ul> 19535 <h2 id="v1.39---2017-12-23">v1.39 - 2017-12-23</h2> 19536 <ul> 19537 <li>New backends 19538 <ul> 19539 <li>WebDAV 19540 <ul> 19541 <li>tested with nextcloud, owncloud, put.io and others!</li> 19542 </ul></li> 19543 <li>Pcloud</li> 19544 <li>cache - wraps a cache around other backends (Remus Bunduc) 19545 <ul> 19546 <li>useful in combination with mount</li> 19547 <li>NB this feature is in beta so use with care</li> 19548 </ul></li> 19549 </ul></li> 19550 <li>New commands 19551 <ul> 19552 <li>serve command with subcommands: 19553 <ul> 19554 <li>serve webdav: this implements a webdav server for any rclone remote.</li> 19555 <li>serve http: command to serve a remote over HTTP</li> 19556 </ul></li> 19557 <li>config: add sub commands for full config file management 19558 <ul> 19559 <li>create/delete/dump/edit/file/password/providers/show/update</li> 19560 </ul></li> 19561 <li>touch: to create or update the timestamp of a file (Jakub Tasiemski)</li> 19562 </ul></li> 19563 <li>New Features 19564 <ul> 19565 <li>curl install for rclone (Filip Bartodziej)</li> 19566 <li>–stats now shows percentage, size, rate and ETA in condensed form (Ishuah Kariuki)</li> 19567 <li>–exclude-if-present to exclude a directory if a file is present (Iakov Davydov)</li> 19568 <li>rmdirs: add –leave-root flag (lewapm)</li> 19569 <li>move: add –delete-empty-src-dirs flag to remove dirs after move (Ishuah Kariuki)</li> 19570 <li>Add –dump flag, introduce –dump requests, responses and remove –dump-auth, –dump-filters 19571 <ul> 19572 <li>Obscure X-Auth-Token: from headers when dumping too</li> 19573 </ul></li> 19574 <li>Document and implement exit codes for different failure modes (Ishuah Kariuki)</li> 19575 </ul></li> 19576 <li>Compile</li> 19577 <li>Bug Fixes 19578 <ul> 19579 <li>Retry lots more different types of errors to make multipart transfers more reliable</li> 19580 <li>Save the config before asking for a token, fixes disappearing oauth config</li> 19581 <li>Warn the user if –include and –exclude are used together (Ernest Borowski)</li> 19582 <li>Fix duplicate files (eg on Google drive) causing spurious copies</li> 19583 <li>Allow trailing and leading whitespace for passwords (Jason Rose)</li> 19584 <li>ncdu: fix crashes on empty directories</li> 19585 <li>rcat: fix goroutine leak</li> 19586 <li>moveto/copyto: Fix to allow copying to the same name</li> 19587 </ul></li> 19588 <li>Mount 19589 <ul> 19590 <li>–vfs-cache mode to make writes into mounts more reliable. 19591 <ul> 19592 <li>this requires caching files on the disk (see –cache-dir)</li> 19593 <li>As this is a new feature, use with care</li> 19594 </ul></li> 19595 <li>Use sdnotify to signal systemd the mount is ready (Fabian Möller)</li> 19596 <li>Check if directory is not empty before mounting (Ernest Borowski)</li> 19597 </ul></li> 19598 <li>Local 19599 <ul> 19600 <li>Add error message for cross file system moves</li> 19601 <li>Fix equality check for times</li> 19602 </ul></li> 19603 <li>Dropbox 19604 <ul> 19605 <li>Rework multipart upload 19606 <ul> 19607 <li>buffer the chunks when uploading large files so they can be retried</li> 19608 <li>change default chunk size to 48MB now we are buffering them in memory</li> 19609 <li>retry every error after the first chunk is done successfully</li> 19610 </ul></li> 19611 <li>Fix error when renaming directories</li> 19612 </ul></li> 19613 <li>Swift 19614 <ul> 19615 <li>Fix crash on bad authentication</li> 19616 </ul></li> 19617 <li>Google Drive 19618 <ul> 19619 <li>Add service account support (Tim Cooijmans)</li> 19620 </ul></li> 19621 <li>S3 19622 <ul> 19623 <li>Make it work properly with Digital Ocean Spaces (Andrew Starr-Bochicchio)</li> 19624 <li>Fix crash if a bad listing is received</li> 19625 <li>Add support for ECS task IAM roles (David Minor)</li> 19626 </ul></li> 19627 <li>Backblaze B2 19628 <ul> 19629 <li>Fix multipart upload retries</li> 19630 <li>Fix –hard-delete to make it work 100% of the time</li> 19631 </ul></li> 19632 <li>Swift 19633 <ul> 19634 <li>Allow authentication with storage URL and auth key (Giovanni Pizzi)</li> 19635 <li>Add new fields for swift configuration to support IBM Bluemix Swift (Pierre Carlson)</li> 19636 <li>Add OS_TENANT_ID and OS_USER_ID to config</li> 19637 <li>Allow configs with user id instead of user name</li> 19638 <li>Check if swift segments container exists before creating (John Leach)</li> 19639 <li>Fix memory leak in swift transfers (upstream fix)</li> 19640 </ul></li> 19641 <li>SFTP 19642 <ul> 19643 <li>Add option to enable the use of aes128-cbc cipher (Jon Fautley)</li> 19644 </ul></li> 19645 <li>Amazon cloud drive 19646 <ul> 19647 <li>Fix download of large files failing with “Only one auth mechanism allowed”</li> 19648 </ul></li> 19649 <li>crypt 19650 <ul> 19651 <li>Option to encrypt directory names or leave them intact</li> 19652 <li>Implement DirChangeNotify (Fabian Möller)</li> 19653 </ul></li> 19654 <li>onedrive 19655 <ul> 19656 <li>Add option to choose resourceURL during setup of OneDrive Business account if more than one is available for user</li> 19657 </ul></li> 19658 </ul> 19659 <h2 id="v1.38---2017-09-30">v1.38 - 2017-09-30</h2> 19660 <ul> 19661 <li>New backends 19662 <ul> 19663 <li>Azure Blob Storage (thanks Andrei Dragomir)</li> 19664 <li>Box</li> 19665 <li>Onedrive for Business (thanks Oliver Heyme)</li> 19666 <li>QingStor from QingCloud (thanks wuyu)</li> 19667 </ul></li> 19668 <li>New commands 19669 <ul> 19670 <li><code>rcat</code> - read from standard input and stream upload</li> 19671 <li><code>tree</code> - shows a nicely formatted recursive listing</li> 19672 <li><code>cryptdecode</code> - decode crypted file names (thanks ishuah)</li> 19673 <li><code>config show</code> - print the config file</li> 19674 <li><code>config file</code> - print the config file location</li> 19675 </ul></li> 19676 <li>New Features 19677 <ul> 19678 <li>Empty directories are deleted on <code>sync</code></li> 19679 <li><code>dedupe</code> - implement merging of duplicate directories</li> 19680 <li><code>check</code> and <code>cryptcheck</code> made more consistent and use less memory</li> 19681 <li><code>cleanup</code> for remaining remotes (thanks ishuah)</li> 19682 <li><code>--immutable</code> for ensuring that files don’t change (thanks Jacob McNamee)</li> 19683 <li><code>--user-agent</code> option (thanks Alex McGrath Kraak)</li> 19684 <li><code>--disable</code> flag to disable optional features</li> 19685 <li><code>--bind</code> flag for choosing the local addr on outgoing connections</li> 19686 <li>Support for zsh auto-completion (thanks bpicode)</li> 19687 <li>Stop normalizing file names but do a normalized compare in <code>sync</code></li> 19688 </ul></li> 19689 <li>Compile 19690 <ul> 19691 <li>Update to using go1.9 as the default go version</li> 19692 <li>Remove snapd build due to maintenance problems</li> 19693 </ul></li> 19694 <li>Bug Fixes 19695 <ul> 19696 <li>Improve retriable error detection which makes multipart uploads better</li> 19697 <li>Make <code>check</code> obey <code>--ignore-size</code></li> 19698 <li>Fix bwlimit toggle in conjunction with schedules (thanks cbruegg)</li> 19699 <li><code>config</code> ensures newly written config is on the same mount</li> 19700 </ul></li> 19701 <li>Local 19702 <ul> 19703 <li>Revert to copy when moving file across file system boundaries</li> 19704 <li><code>--skip-links</code> to suppress symlink warnings (thanks Zhiming Wang)</li> 19705 </ul></li> 19706 <li>Mount 19707 <ul> 19708 <li>Re-use <code>rcat</code> internals to support uploads from all remotes</li> 19709 </ul></li> 19710 <li>Dropbox 19711 <ul> 19712 <li>Fix “entry doesn’t belong in directory” error</li> 19713 <li>Stop using deprecated API methods</li> 19714 </ul></li> 19715 <li>Swift 19716 <ul> 19717 <li>Fix server side copy to empty container with <code>--fast-list</code></li> 19718 </ul></li> 19719 <li>Google Drive 19720 <ul> 19721 <li>Change the default for <code>--drive-use-trash</code> to <code>true</code></li> 19722 </ul></li> 19723 <li>S3 19724 <ul> 19725 <li>Set session token when using STS (thanks Girish Ramakrishnan)</li> 19726 <li>Glacier docs and error messages (thanks Jan Varho)</li> 19727 <li>Read 1000 (not 1024) items in dir listings to fix Wasabi</li> 19728 </ul></li> 19729 <li>Backblaze B2 19730 <ul> 19731 <li>Fix SHA1 mismatch when downloading files with no SHA1</li> 19732 <li>Calculate missing hashes on the fly instead of spooling</li> 19733 <li><code>--b2-hard-delete</code> to permanently delete (not hide) files (thanks John Papandriopoulos)</li> 19734 </ul></li> 19735 <li>Hubic 19736 <ul> 19737 <li>Fix creating containers - no longer have to use the <code>default</code> container</li> 19738 </ul></li> 19739 <li>Swift 19740 <ul> 19741 <li>Optionally configure from a standard set of OpenStack environment vars</li> 19742 <li>Add <code>endpoint_type</code> config</li> 19743 </ul></li> 19744 <li>Google Cloud Storage 19745 <ul> 19746 <li>Fix bucket creation to work with limited permission users</li> 19747 </ul></li> 19748 <li>SFTP 19749 <ul> 19750 <li>Implement connection pooling for multiple ssh connections</li> 19751 <li>Limit new connections per second</li> 19752 <li>Add support for MD5 and SHA1 hashes where available (thanks Christian Brüggemann)</li> 19753 </ul></li> 19754 <li>HTTP 19755 <ul> 19756 <li>Fix URL encoding issues</li> 19757 <li>Fix directories with <code>:</code> in</li> 19758 <li>Fix panic with URL encoded content</li> 19759 </ul></li> 19760 </ul> 19761 <h2 id="v1.37---2017-07-22">v1.37 - 2017-07-22</h2> 19762 <ul> 19763 <li>New backends 19764 <ul> 19765 <li>FTP - thanks to Antonio Messina</li> 19766 <li>HTTP - thanks to Vasiliy Tolstov</li> 19767 </ul></li> 19768 <li>New commands 19769 <ul> 19770 <li>rclone ncdu - for exploring a remote with a text based user interface.</li> 19771 <li>rclone lsjson - for listing with a machine readable output</li> 19772 <li>rclone dbhashsum - to show Dropbox style hashes of files (local or Dropbox)</li> 19773 </ul></li> 19774 <li>New Features 19775 <ul> 19776 <li>Implement –fast-list flag 19777 <ul> 19778 <li>This allows remotes to list recursively if they can</li> 19779 <li>This uses less transactions (important if you pay for them)</li> 19780 <li>This may or may not be quicker</li> 19781 <li>This will use more memory as it has to hold the listing in memory</li> 19782 <li>–old-sync-method deprecated - the remaining uses are covered by –fast-list</li> 19783 <li>This involved a major re-write of all the listing code</li> 19784 </ul></li> 19785 <li>Add –tpslimit and –tpslimit-burst to limit transactions per second 19786 <ul> 19787 <li>this is useful in conjunction with <code>rclone mount</code> to limit external apps</li> 19788 </ul></li> 19789 <li>Add –stats-log-level so can see –stats without -v</li> 19790 <li>Print password prompts to stderr - Hraban Luyat</li> 19791 <li>Warn about duplicate files when syncing</li> 19792 <li>Oauth improvements 19793 <ul> 19794 <li>allow auth_url and token_url to be set in the config file</li> 19795 <li>Print redirection URI if using own credentials.</li> 19796 </ul></li> 19797 <li>Don’t Mkdir at the start of sync to save transactions</li> 19798 </ul></li> 19799 <li>Compile 19800 <ul> 19801 <li>Update build to go1.8.3</li> 19802 <li>Require go1.6 for building rclone</li> 19803 <li>Compile 386 builds with “GO386=387” for maximum compatibility</li> 19804 </ul></li> 19805 <li>Bug Fixes 19806 <ul> 19807 <li>Fix menu selection when no remotes</li> 19808 <li>Config saving reworked to not kill the file if disk gets full</li> 19809 <li>Don’t delete remote if name does not change while renaming</li> 19810 <li>moveto, copyto: report transfers and checks as per move and copy</li> 19811 </ul></li> 19812 <li>Local 19813 <ul> 19814 <li>Add –local-no-unicode-normalization flag - Bob Potter</li> 19815 </ul></li> 19816 <li>Mount 19817 <ul> 19818 <li>Now supported on Windows using cgofuse and WinFsp - thanks to Bill Zissimopoulos for much help</li> 19819 <li>Compare checksums on upload/download via FUSE</li> 19820 <li>Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM - Jérôme Vizcaino</li> 19821 <li>On read only open of file, make open pending until first read</li> 19822 <li>Make –read-only reject modify operations</li> 19823 <li>Implement ModTime via FUSE for remotes that support it</li> 19824 <li>Allow modTime to be changed even before all writers are closed</li> 19825 <li>Fix panic on renames</li> 19826 <li>Fix hang on errored upload</li> 19827 </ul></li> 19828 <li>Crypt 19829 <ul> 19830 <li>Report the name:root as specified by the user</li> 19831 <li>Add an “obfuscate” option for filename encryption - Stephen Harris</li> 19832 </ul></li> 19833 <li>Amazon Drive 19834 <ul> 19835 <li>Fix initialization order for token renewer</li> 19836 <li>Remove revoked credentials, allow oauth proxy config and update docs</li> 19837 </ul></li> 19838 <li>B2 19839 <ul> 19840 <li>Reduce minimum chunk size to 5MB</li> 19841 </ul></li> 19842 <li>Drive 19843 <ul> 19844 <li>Add team drive support</li> 19845 <li>Reduce bandwidth by adding fields for partial responses - Martin Kristensen</li> 19846 <li>Implement –drive-shared-with-me flag to view shared with me files - Danny Tsai</li> 19847 <li>Add –drive-trashed-only to read only the files in the trash</li> 19848 <li>Remove obsolete –drive-full-list</li> 19849 <li>Add missing seek to start on retries of chunked uploads</li> 19850 <li>Fix stats accounting for upload</li> 19851 <li>Convert / in names to a unicode equivalent (／)</li> 19852 <li>Poll for Google Drive changes when mounted</li> 19853 </ul></li> 19854 <li>OneDrive 19855 <ul> 19856 <li>Fix the uploading of files with spaces</li> 19857 <li>Fix initialization order for token renewer</li> 19858 <li>Display speeds accurately when uploading - Yoni Jah</li> 19859 <li>Swap to using http://localhost:53682/ as redirect URL - Michael Ledin</li> 19860 <li>Retry on token expired error, reset upload body on retry - Yoni Jah</li> 19861 </ul></li> 19862 <li>Google Cloud Storage 19863 <ul> 19864 <li>Add ability to specify location and storage class via config and command line - thanks gdm85</li> 19865 <li>Create container if necessary on server side copy</li> 19866 <li>Increase directory listing chunk to 1000 to increase performance</li> 19867 <li>Obtain a refresh token for GCS - Steven Lu</li> 19868 </ul></li> 19869 <li>Yandex 19870 <ul> 19871 <li>Fix the name reported in log messages (was empty)</li> 19872 <li>Correct error return for listing empty directory</li> 19873 </ul></li> 19874 <li>Dropbox 19875 <ul> 19876 <li>Rewritten to use the v2 API 19877 <ul> 19878 <li>Now supports ModTime 19879 <ul> 19880 <li>Can only set by uploading the file again</li> 19881 <li>If you uploaded with an old rclone, rclone may upload everything again</li> 19882 <li>Use <code>--size-only</code> or <code>--checksum</code> to avoid this</li> 19883 </ul></li> 19884 <li>Now supports the Dropbox content hashing scheme</li> 19885 <li>Now supports low level retries</li> 19886 </ul></li> 19887 </ul></li> 19888 <li>S3 19889 <ul> 19890 <li>Work around eventual consistency in bucket creation</li> 19891 <li>Create container if necessary on server side copy</li> 19892 <li>Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar Ahmed</li> 19893 </ul></li> 19894 <li>Swift, Hubic 19895 <ul> 19896 <li>Fix zero length directory markers showing in the subdirectory listing 19897 <ul> 19898 <li>this caused lots of duplicate transfers</li> 19899 </ul></li> 19900 <li>Fix paged directory listings 19901 <ul> 19902 <li>this caused duplicate directory errors</li> 19903 </ul></li> 19904 <li>Create container if necessary on server side copy</li> 19905 <li>Increase directory listing chunk to 1000 to increase performance</li> 19906 <li>Make sensible error if the user forgets the container</li> 19907 </ul></li> 19908 <li>SFTP 19909 <ul> 19910 <li>Add support for using ssh key files</li> 19911 <li>Fix under Windows</li> 19912 <li>Fix ssh agent on Windows</li> 19913 <li>Adapt to latest version of library - Igor Kharin</li> 19914 </ul></li> 19915 </ul> 19916 <h2 id="v1.36---2017-03-18">v1.36 - 2017-03-18</h2> 19917 <ul> 19918 <li>New Features 19919 <ul> 19920 <li>SFTP remote (Jack Schmidt)</li> 19921 <li>Re-implement sync routine to work a directory at a time reducing memory usage</li> 19922 <li>Logging revamped to be more inline with rsync - now much quieter * -v only shows transfers * -vv is for full debug * –syslog to log to syslog on capable platforms</li> 19923 <li>Implement –backup-dir and –suffix</li> 19924 <li>Implement –track-renames (initial implementation by Bjørn Erik Pedersen)</li> 19925 <li>Add time-based bandwidth limits (Lukas Loesche)</li> 19926 <li>rclone cryptcheck: checks integrity of crypt remotes</li> 19927 <li>Allow all config file variables and options to be set from environment variables</li> 19928 <li>Add –buffer-size parameter to control buffer size for copy</li> 19929 <li>Make –delete-after the default</li> 19930 <li>Add –ignore-checksum flag (fixed by Hisham Zarka)</li> 19931 <li>rclone check: Add –download flag to check all the data, not just hashes</li> 19932 <li>rclone cat: add –head, –tail, –offset, –count and –discard</li> 19933 <li>rclone config: when choosing from a list, allow the value to be entered too</li> 19934 <li>rclone config: allow rename and copy of remotes</li> 19935 <li>rclone obscure: for generating encrypted passwords for rclone’s config (T.C. Ferguson)</li> 19936 <li>Comply with XDG Base Directory specification (Dario Giovannetti) 19937 <ul> 19938 <li>this moves the default location of the config file in a backwards compatible way</li> 19939 </ul></li> 19940 <li>Release changes 19941 <ul> 19942 <li>Ubuntu snap support (Dedsec1)</li> 19943 <li>Compile with go 1.8</li> 19944 <li>MIPS/Linux big and little endian support</li> 19945 </ul></li> 19946 </ul></li> 19947 <li>Bug Fixes 19948 <ul> 19949 <li>Fix copyto copying things to the wrong place if the destination dir didn’t exist</li> 19950 <li>Fix parsing of remotes in moveto and copyto</li> 19951 <li>Fix –delete-before deleting files on copy</li> 19952 <li>Fix –files-from with an empty file copying everything</li> 19953 <li>Fix sync: don’t update mod times if –dry-run set</li> 19954 <li>Fix MimeType propagation</li> 19955 <li>Fix filters to add ** rules to directory rules</li> 19956 </ul></li> 19957 <li>Local 19958 <ul> 19959 <li>Implement -L, –copy-links flag to allow rclone to follow symlinks</li> 19960 <li>Open files in write only mode so rclone can write to an rclone mount</li> 19961 <li>Fix unnormalised unicode causing problems reading directories</li> 19962 <li>Fix interaction between -x flag and –max-depth</li> 19963 </ul></li> 19964 <li>Mount 19965 <ul> 19966 <li>Implement proper directory handling (mkdir, rmdir, renaming)</li> 19967 <li>Make include and exclude filters apply to mount</li> 19968 <li>Implement read and write async buffers - control with –buffer-size</li> 19969 <li>Fix fsync on for directories</li> 19970 <li>Fix retry on network failure when reading off crypt</li> 19971 </ul></li> 19972 <li>Crypt 19973 <ul> 19974 <li>Add –crypt-show-mapping to show encrypted file mapping</li> 19975 <li>Fix crypt writer getting stuck in a loop 19976 <ul> 19977 <li><strong>IMPORTANT</strong> this bug had the potential to cause data corruption when 19978 <ul> 19979 <li>reading data from a network based remote and</li> 19980 <li>writing to a crypt on Google Drive</li> 19981 </ul></li> 19982 <li>Use the cryptcheck command to validate your data if you are concerned</li> 19983 <li>If syncing two crypt remotes, sync the unencrypted remote</li> 19984 </ul></li> 19985 </ul></li> 19986 <li>Amazon Drive 19987 <ul> 19988 <li>Fix panics on Move (rename)</li> 19989 <li>Fix panic on token expiry</li> 19990 </ul></li> 19991 <li>B2 19992 <ul> 19993 <li>Fix inconsistent listings and rclone check</li> 19994 <li>Fix uploading empty files with go1.8</li> 19995 <li>Constrain memory usage when doing multipart uploads</li> 19996 <li>Fix upload url not being refreshed properly</li> 19997 </ul></li> 19998 <li>Drive 19999 <ul> 20000 <li>Fix Rmdir on directories with trashed files</li> 20001 <li>Fix “Ignoring unknown object” when downloading</li> 20002 <li>Add –drive-list-chunk</li> 20003 <li>Add –drive-skip-gdocs (Károly Oláh)</li> 20004 </ul></li> 20005 <li>OneDrive 20006 <ul> 20007 <li>Implement Move</li> 20008 <li>Fix Copy 20009 <ul> 20010 <li>Fix overwrite detection in Copy</li> 20011 <li>Fix waitForJob to parse errors correctly</li> 20012 </ul></li> 20013 <li>Use token renewer to stop auth errors on long uploads</li> 20014 <li>Fix uploading empty files with go1.8</li> 20015 </ul></li> 20016 <li>Google Cloud Storage 20017 <ul> 20018 <li>Fix depth 1 directory listings</li> 20019 </ul></li> 20020 <li>Yandex 20021 <ul> 20022 <li>Fix single level directory listing</li> 20023 </ul></li> 20024 <li>Dropbox 20025 <ul> 20026 <li>Normalise the case for single level directory listings</li> 20027 <li>Fix depth 1 listing</li> 20028 </ul></li> 20029 <li>S3 20030 <ul> 20031 <li>Added ca-central-1 region (Jon Yergatian)</li> 20032 </ul></li> 20033 </ul> 20034 <h2 id="v1.35---2017-01-02">v1.35 - 2017-01-02</h2> 20035 <ul> 20036 <li>New Features 20037 <ul> 20038 <li>moveto and copyto commands for choosing a destination name on copy/move</li> 20039 <li>rmdirs command to recursively delete empty directories</li> 20040 <li>Allow repeated –include/–exclude/–filter options</li> 20041 <li>Only show transfer stats on commands which transfer stuff 20042 <ul> 20043 <li>show stats on any command using the <code>--stats</code> flag</li> 20044 </ul></li> 20045 <li>Allow overlapping directories in move when server side dir move is supported</li> 20046 <li>Add –stats-unit option - thanks Scott McGillivray</li> 20047 </ul></li> 20048 <li>Bug Fixes 20049 <ul> 20050 <li>Fix the config file being overwritten when two rclone instances are running</li> 20051 <li>Make rclone lsd obey the filters properly</li> 20052 <li>Fix compilation on mips</li> 20053 <li>Fix not transferring files that don’t differ in size</li> 20054 <li>Fix panic on nil retry/fatal error</li> 20055 </ul></li> 20056 <li>Mount 20057 <ul> 20058 <li>Retry reads on error - should help with reliability a lot</li> 20059 <li>Report the modification times for directories from the remote</li> 20060 <li>Add bandwidth accounting and limiting (fixes –bwlimit)</li> 20061 <li>If –stats provided will show stats and which files are transferring</li> 20062 <li>Support R/W files if truncate is set.</li> 20063 <li>Implement statfs interface so df works</li> 20064 <li>Note that write is now supported on Amazon Drive</li> 20065 <li>Report number of blocks in a file - thanks Stefan Breunig</li> 20066 </ul></li> 20067 <li>Crypt 20068 <ul> 20069 <li>Prevent the user pointing crypt at itself</li> 20070 <li>Fix failed to authenticate decrypted block errors 20071 <ul> 20072 <li>these will now return the underlying unexpected EOF instead</li> 20073 </ul></li> 20074 </ul></li> 20075 <li>Amazon Drive 20076 <ul> 20077 <li>Add support for server side move and directory move - thanks Stefan Breunig</li> 20078 <li>Fix nil pointer deref on size attribute</li> 20079 </ul></li> 20080 <li>B2 20081 <ul> 20082 <li>Use new prefix and delimiter parameters in directory listings 20083 <ul> 20084 <li>This makes –max-depth 1 dir listings as used in mount much faster</li> 20085 </ul></li> 20086 <li>Reauth the account while doing uploads too - should help with token expiry</li> 20087 </ul></li> 20088 <li>Drive 20089 <ul> 20090 <li>Make DirMove more efficient and complain about moving the root</li> 20091 <li>Create destination directory on Move()</li> 20092 </ul></li> 20093 </ul> 20094 <h2 id="v1.34---2016-11-06">v1.34 - 2016-11-06</h2> 20095 <ul> 20096 <li>New Features 20097 <ul> 20098 <li>Stop single file and <code>--files-from</code> operations iterating through the source bucket.</li> 20099 <li>Stop removing failed upload to cloud storage remotes</li> 20100 <li>Make ContentType be preserved for cloud to cloud copies</li> 20101 <li>Add support to toggle bandwidth limits via SIGUSR2 - thanks Marco Paganini</li> 20102 <li><code>rclone check</code> shows count of hashes that couldn’t be checked</li> 20103 <li><code>rclone listremotes</code> command</li> 20104 <li>Support linux/arm64 build - thanks Fredrik Fornwall</li> 20105 <li>Remove <code>Authorization:</code> lines from <code>--dump-headers</code> output</li> 20106 </ul></li> 20107 <li>Bug Fixes 20108 <ul> 20109 <li>Ignore files with control characters in the names</li> 20110 <li>Fix <code>rclone move</code> command 20111 <ul> 20112 <li>Delete src files which already existed in dst</li> 20113 <li>Fix deletion of src file when dst file older</li> 20114 </ul></li> 20115 <li>Fix <code>rclone check</code> on crypted file systems</li> 20116 <li>Make failed uploads not count as “Transferred”</li> 20117 <li>Make sure high level retries show with <code>-q</code></li> 20118 <li>Use a vendor directory with godep for repeatable builds</li> 20119 </ul></li> 20120 <li><code>rclone mount</code> - FUSE 20121 <ul> 20122 <li>Implement FUSE mount options 20123 <ul> 20124 <li><code>--no-modtime</code>, <code>--debug-fuse</code>, <code>--read-only</code>, <code>--allow-non-empty</code>, <code>--allow-root</code>, <code>--allow-other</code></li> 20125 <li><code>--default-permissions</code>, <code>--write-back-cache</code>, <code>--max-read-ahead</code>, <code>--umask</code>, <code>--uid</code>, <code>--gid</code></li> 20126 </ul></li> 20127 <li>Add <code>--dir-cache-time</code> to control caching of directory entries</li> 20128 <li>Implement seek for files opened for read (useful for video players) 20129 <ul> 20130 <li>with <code>-no-seek</code> flag to disable</li> 20131 </ul></li> 20132 <li>Fix crash on 32 bit ARM (alignment of 64 bit counter)</li> 20133 <li>…and many more internal fixes and improvements!</li> 20134 </ul></li> 20135 <li>Crypt 20136 <ul> 20137 <li>Don’t show encrypted password in configurator to stop confusion</li> 20138 </ul></li> 20139 <li>Amazon Drive 20140 <ul> 20141 <li>New wait for upload option <code>--acd-upload-wait-per-gb</code> 20142 <ul> 20143 <li>upload timeouts scale by file size and can be disabled</li> 20144 </ul></li> 20145 <li>Add 502 Bad Gateway to list of errors we retry</li> 20146 <li>Fix overwriting a file with a zero length file</li> 20147 <li>Fix ACD file size warning limit - thanks Felix Bünemann</li> 20148 </ul></li> 20149 <li>Local 20150 <ul> 20151 <li>Unix: implement <code>-x</code>/<code>--one-file-system</code> to stay on a single file system 20152 <ul> 20153 <li>thanks Durval Menezes and Luiz Carlos Rumbelsperger Viana</li> 20154 </ul></li> 20155 <li>Windows: ignore the symlink bit on files</li> 20156 <li>Windows: Ignore directory based junction points</li> 20157 </ul></li> 20158 <li>B2 20159 <ul> 20160 <li>Make sure each upload has at least one upload slot - fixes strange upload stats</li> 20161 <li>Fix uploads when using crypt</li> 20162 <li>Fix download of large files (sha1 mismatch)</li> 20163 <li>Return error when we try to create a bucket which someone else owns</li> 20164 <li>Update B2 docs with Data usage, and Crypt section - thanks Tomasz Mazur</li> 20165 </ul></li> 20166 <li>S3 20167 <ul> 20168 <li>Command line and config file support for 20169 <ul> 20170 <li>Setting/overriding ACL - thanks Radek Senfeld</li> 20171 <li>Setting storage class - thanks Asko Tamm</li> 20172 </ul></li> 20173 </ul></li> 20174 <li>Drive 20175 <ul> 20176 <li>Make exponential backoff work exactly as per Google specification</li> 20177 <li>add <code>.epub</code>, <code>.odp</code> and <code>.tsv</code> as export formats.</li> 20178 </ul></li> 20179 <li>Swift 20180 <ul> 20181 <li>Don’t read metadata for directory marker objects</li> 20182 </ul></li> 20183 </ul> 20184 <h2 id="v1.33---2016-08-24">v1.33 - 2016-08-24</h2> 20185 <ul> 20186 <li>New Features 20187 <ul> 20188 <li>Implement encryption 20189 <ul> 20190 <li>data encrypted in NACL secretbox format</li> 20191 <li>with optional file name encryption</li> 20192 </ul></li> 20193 <li>New commands 20194 <ul> 20195 <li>rclone mount - implements FUSE mounting of remotes (EXPERIMENTAL) 20196 <ul> 20197 <li>works on Linux, FreeBSD and OS X (need testers for the last 2!)</li> 20198 </ul></li> 20199 <li>rclone cat - outputs remote file or files to the terminal</li> 20200 <li>rclone genautocomplete - command to make a bash completion script for rclone</li> 20201 </ul></li> 20202 <li>Editing a remote using <code>rclone config</code> now goes through the wizard</li> 20203 <li>Compile with go 1.7 - this fixes rclone on macOS Sierra and on 386 processors</li> 20204 <li>Use cobra for sub commands and docs generation</li> 20205 </ul></li> 20206 <li>drive 20207 <ul> 20208 <li>Document how to make your own client_id</li> 20209 </ul></li> 20210 <li>s3 20211 <ul> 20212 <li>User-configurable Amazon S3 ACL (thanks Radek Šenfeld)</li> 20213 </ul></li> 20214 <li>b2 20215 <ul> 20216 <li>Fix stats accounting for upload - no more jumping to 100% done</li> 20217 <li>On cleanup delete hide marker if it is the current file</li> 20218 <li>New B2 API endpoint (thanks Per Cederberg)</li> 20219 <li>Set maximum backoff to 5 Minutes</li> 20220 </ul></li> 20221 <li>onedrive 20222 <ul> 20223 <li>Fix URL escaping in file names - eg uploading files with <code>+</code> in them.</li> 20224 </ul></li> 20225 <li>amazon cloud drive 20226 <ul> 20227 <li>Fix token expiry during large uploads</li> 20228 <li>Work around 408 REQUEST_TIMEOUT and 504 GATEWAY_TIMEOUT errors</li> 20229 </ul></li> 20230 <li>local 20231 <ul> 20232 <li>Fix filenames with invalid UTF-8 not being uploaded</li> 20233 <li>Fix problem with some UTF-8 characters on OS X</li> 20234 </ul></li> 20235 </ul> 20236 <h2 id="v1.32---2016-07-13">v1.32 - 2016-07-13</h2> 20237 <ul> 20238 <li>Backblaze B2 20239 <ul> 20240 <li>Fix upload of files large files not in root</li> 20241 </ul></li> 20242 </ul> 20243 <h2 id="v1.31---2016-07-13">v1.31 - 2016-07-13</h2> 20244 <ul> 20245 <li>New Features 20246 <ul> 20247 <li>Reduce memory on sync by about 50%</li> 20248 <li>Implement –no-traverse flag to stop copy traversing the destination remote. 20249 <ul> 20250 <li>This can be used to reduce memory usage down to the smallest possible.</li> 20251 <li>Useful to copy a small number of files into a large destination folder.</li> 20252 </ul></li> 20253 <li>Implement cleanup command for emptying trash / removing old versions of files 20254 <ul> 20255 <li>Currently B2 only</li> 20256 </ul></li> 20257 <li>Single file handling improved 20258 <ul> 20259 <li>Now copied with –files-from</li> 20260 <li>Automatically sets –no-traverse when copying a single file</li> 20261 </ul></li> 20262 <li>Info on using installing with ansible - thanks Stefan Weichinger</li> 20263 <li>Implement –no-update-modtime flag to stop rclone fixing the remote modified times.</li> 20264 </ul></li> 20265 <li>Bug Fixes 20266 <ul> 20267 <li>Fix move command - stop it running for overlapping Fses - this was causing data loss.</li> 20268 </ul></li> 20269 <li>Local 20270 <ul> 20271 <li>Fix incomplete hashes - this was causing problems for B2.</li> 20272 </ul></li> 20273 <li>Amazon Drive 20274 <ul> 20275 <li>Rename Amazon Cloud Drive to Amazon Drive - no changes to config file needed.</li> 20276 </ul></li> 20277 <li>Swift 20278 <ul> 20279 <li>Add support for non-default project domain - thanks Antonio Messina.</li> 20280 </ul></li> 20281 <li>S3 20282 <ul> 20283 <li>Add instructions on how to use rclone with minio.</li> 20284 <li>Add ap-northeast-2 (Seoul) and ap-south-1 (Mumbai) regions.</li> 20285 <li>Skip setting the modified time for objects > 5GB as it isn’t possible.</li> 20286 </ul></li> 20287 <li>Backblaze B2 20288 <ul> 20289 <li>Add –b2-versions flag so old versions can be listed and retrieved.</li> 20290 <li>Treat 403 errors (eg cap exceeded) as fatal.</li> 20291 <li>Implement cleanup command for deleting old file versions.</li> 20292 <li>Make error handling compliant with B2 integrations notes.</li> 20293 <li>Fix handling of token expiry.</li> 20294 <li>Implement –b2-test-mode to set <code>X-Bz-Test-Mode</code> header.</li> 20295 <li>Set cutoff for chunked upload to 200MB as per B2 guidelines.</li> 20296 <li>Make upload multi-threaded.</li> 20297 </ul></li> 20298 <li>Dropbox 20299 <ul> 20300 <li>Don’t retry 461 errors.</li> 20301 </ul></li> 20302 </ul> 20303 <h2 id="v1.30---2016-06-18">v1.30 - 2016-06-18</h2> 20304 <ul> 20305 <li>New Features 20306 <ul> 20307 <li>Directory listing code reworked for more features and better error reporting (thanks to Klaus Post for help). This enables 20308 <ul> 20309 <li>Directory include filtering for efficiency</li> 20310 <li>–max-depth parameter</li> 20311 <li>Better error reporting</li> 20312 <li>More to come</li> 20313 </ul></li> 20314 <li>Retry more errors</li> 20315 <li>Add –ignore-size flag - for uploading images to onedrive</li> 20316 <li>Log -v output to stdout by default</li> 20317 <li>Display the transfer stats in more human readable form</li> 20318 <li>Make 0 size files specifiable with <code>--max-size 0b</code></li> 20319 <li>Add <code>b</code> suffix so we can specify bytes in –bwlimit, –min-size etc</li> 20320 <li>Use “password:” instead of “password>” prompt - thanks Klaus Post and Leigh Klotz</li> 20321 </ul></li> 20322 <li>Bug Fixes 20323 <ul> 20324 <li>Fix retry doing one too many retries</li> 20325 </ul></li> 20326 <li>Local 20327 <ul> 20328 <li>Fix problems with OS X and UTF-8 characters</li> 20329 </ul></li> 20330 <li>Amazon Drive 20331 <ul> 20332 <li>Check a file exists before uploading to help with 408 Conflict errors</li> 20333 <li>Reauth on 401 errors - this has been causing a lot of problems</li> 20334 <li>Work around spurious 403 errors</li> 20335 <li>Restart directory listings on error</li> 20336 </ul></li> 20337 <li>Google Drive 20338 <ul> 20339 <li>Check a file exists before uploading to help with duplicates</li> 20340 <li>Fix retry of multipart uploads</li> 20341 </ul></li> 20342 <li>Backblaze B2 20343 <ul> 20344 <li>Implement large file uploading</li> 20345 </ul></li> 20346 <li>S3 20347 <ul> 20348 <li>Add AES256 server-side encryption for - thanks Justin R. Wilson</li> 20349 </ul></li> 20350 <li>Google Cloud Storage 20351 <ul> 20352 <li>Make sure we don’t use conflicting content types on upload</li> 20353 <li>Add service account support - thanks Michal Witkowski</li> 20354 </ul></li> 20355 <li>Swift 20356 <ul> 20357 <li>Add auth version parameter</li> 20358 <li>Add domain option for openstack (v3 auth) - thanks Fabian Ruff</li> 20359 </ul></li> 20360 </ul> 20361 <h2 id="v1.29---2016-04-18">v1.29 - 2016-04-18</h2> 20362 <ul> 20363 <li>New Features 20364 <ul> 20365 <li>Implement <code>-I, --ignore-times</code> for unconditional upload</li> 20366 <li>Improve <code>dedupe</code>command 20367 <ul> 20368 <li>Now removes identical copies without asking</li> 20369 <li>Now obeys <code>--dry-run</code></li> 20370 <li>Implement <code>--dedupe-mode</code> for non interactive running 20371 <ul> 20372 <li><code>--dedupe-mode interactive</code> - interactive the default.</li> 20373 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 20374 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 20375 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 20376 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 20377 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 20378 </ul></li> 20379 </ul></li> 20380 </ul></li> 20381 <li>Bug fixes 20382 <ul> 20383 <li>Make rclone check obey the <code>--size-only</code> flag.</li> 20384 <li>Use “application/octet-stream” if discovered mime type is invalid.</li> 20385 <li>Fix missing “quit” option when there are no remotes.</li> 20386 </ul></li> 20387 <li>Google Drive 20388 <ul> 20389 <li>Increase default chunk size to 8 MB - increases upload speed of big files</li> 20390 <li>Speed up directory listings and make more reliable</li> 20391 <li>Add missing retries for Move and DirMove - increases reliability</li> 20392 <li>Preserve mime type on file update</li> 20393 </ul></li> 20394 <li>Backblaze B2 20395 <ul> 20396 <li>Enable mod time syncing 20397 <ul> 20398 <li>This means that B2 will now check modification times</li> 20399 <li>It will upload new files to update the modification times</li> 20400 <li>(there isn’t an API to just set the mod time.)</li> 20401 <li>If you want the old behaviour use <code>--size-only</code>.</li> 20402 </ul></li> 20403 <li>Update API to new version</li> 20404 <li>Fix parsing of mod time when not in metadata</li> 20405 </ul></li> 20406 <li>Swift/Hubic 20407 <ul> 20408 <li>Don’t return an MD5SUM for static large objects</li> 20409 </ul></li> 20410 <li>S3 20411 <ul> 20412 <li>Fix uploading files bigger than 50GB</li> 20413 </ul></li> 20414 </ul> 20415 <h2 id="v1.28---2016-03-01">v1.28 - 2016-03-01</h2> 20416 <ul> 20417 <li>New Features 20418 <ul> 20419 <li>Configuration file encryption - thanks Klaus Post</li> 20420 <li>Improve <code>rclone config</code> adding more help and making it easier to understand</li> 20421 <li>Implement <code>-u</code>/<code>--update</code> so creation times can be used on all remotes</li> 20422 <li>Implement <code>--low-level-retries</code> flag</li> 20423 <li>Optionally disable gzip compression on downloads with <code>--no-gzip-encoding</code></li> 20424 </ul></li> 20425 <li>Bug fixes 20426 <ul> 20427 <li>Don’t make directories if <code>--dry-run</code> set</li> 20428 <li>Fix and document the <code>move</code> command</li> 20429 <li>Fix redirecting stderr on unix-like OSes when using <code>--log-file</code></li> 20430 <li>Fix <code>delete</code> command to wait until all finished - fixes missing deletes.</li> 20431 </ul></li> 20432 <li>Backblaze B2 20433 <ul> 20434 <li>Use one upload URL per go routine fixes <code>more than one upload using auth token</code></li> 20435 <li>Add pacing, retries and reauthentication - fixes token expiry problems</li> 20436 <li>Upload without using a temporary file from local (and remotes which support SHA1)</li> 20437 <li>Fix reading metadata for all files when it shouldn’t have been</li> 20438 </ul></li> 20439 <li>Drive 20440 <ul> 20441 <li>Fix listing drive documents at root</li> 20442 <li>Disable copy and move for Google docs</li> 20443 </ul></li> 20444 <li>Swift 20445 <ul> 20446 <li>Fix uploading of chunked files with non ASCII characters</li> 20447 <li>Allow setting of <code>storage_url</code> in the config - thanks Xavier Lucas</li> 20448 </ul></li> 20449 <li>S3 20450 <ul> 20451 <li>Allow IAM role and credentials from environment variables - thanks Brian Stengaard</li> 20452 <li>Allow low privilege users to use S3 (check if directory exists during Mkdir) - thanks Jakub Gedeon</li> 20453 </ul></li> 20454 <li>Amazon Drive 20455 <ul> 20456 <li>Retry on more things to make directory listings more reliable</li> 20457 </ul></li> 20458 </ul> 20459 <h2 id="v1.27---2016-01-31">v1.27 - 2016-01-31</h2> 20460 <ul> 20461 <li>New Features 20462 <ul> 20463 <li>Easier headless configuration with <code>rclone authorize</code></li> 20464 <li>Add support for multiple hash types - we now check SHA1 as well as MD5 hashes.</li> 20465 <li><code>delete</code> command which does obey the filters (unlike <code>purge</code>)</li> 20466 <li><code>dedupe</code> command to deduplicate a remote. Useful with Google Drive.</li> 20467 <li>Add <code>--ignore-existing</code> flag to skip all files that exist on destination.</li> 20468 <li>Add <code>--delete-before</code>, <code>--delete-during</code>, <code>--delete-after</code> flags.</li> 20469 <li>Add <code>--memprofile</code> flag to debug memory use.</li> 20470 <li>Warn the user about files with same name but different case</li> 20471 <li>Make <code>--include</code> rules add their implicit exclude * at the end of the filter list</li> 20472 <li>Deprecate compiling with go1.3</li> 20473 </ul></li> 20474 <li>Amazon Drive 20475 <ul> 20476 <li>Fix download of files > 10 GB</li> 20477 <li>Fix directory traversal (“Next token is expired”) for large directory listings</li> 20478 <li>Remove 409 conflict from error codes we will retry - stops very long pauses</li> 20479 </ul></li> 20480 <li>Backblaze B2 20481 <ul> 20482 <li>SHA1 hashes now checked by rclone core</li> 20483 </ul></li> 20484 <li>Drive 20485 <ul> 20486 <li>Add <code>--drive-auth-owner-only</code> to only consider files owned by the user - thanks Björn Harrtell</li> 20487 <li>Export Google documents</li> 20488 </ul></li> 20489 <li>Dropbox 20490 <ul> 20491 <li>Make file exclusion error controllable with -q</li> 20492 </ul></li> 20493 <li>Swift 20494 <ul> 20495 <li>Fix upload from unprivileged user.</li> 20496 </ul></li> 20497 <li>S3 20498 <ul> 20499 <li>Fix updating of mod times of files with <code>+</code> in.</li> 20500 </ul></li> 20501 <li>Local 20502 <ul> 20503 <li>Add local file system option to disable UNC on Windows.</li> 20504 </ul></li> 20505 </ul> 20506 <h2 id="v1.26---2016-01-02">v1.26 - 2016-01-02</h2> 20507 <ul> 20508 <li>New Features 20509 <ul> 20510 <li>Yandex storage backend - thank you Dmitry Burdeev (“dibu”)</li> 20511 <li>Implement Backblaze B2 storage backend</li> 20512 <li>Add –min-age and –max-age flags - thank you Adriano Aurélio Meirelles</li> 20513 <li>Make ls/lsl/md5sum/size/check obey includes and excludes</li> 20514 </ul></li> 20515 <li>Fixes 20516 <ul> 20517 <li>Fix crash in http logging</li> 20518 <li>Upload releases to github too</li> 20519 </ul></li> 20520 <li>Swift 20521 <ul> 20522 <li>Fix sync for chunked files</li> 20523 </ul></li> 20524 <li>OneDrive 20525 <ul> 20526 <li>Re-enable server side copy</li> 20527 <li>Don’t mask HTTP error codes with JSON decode error</li> 20528 </ul></li> 20529 <li>S3 20530 <ul> 20531 <li>Fix corrupting Content-Type on mod time update (thanks Joseph Spurrier)</li> 20532 </ul></li> 20533 </ul> 20534 <h2 id="v1.25---2015-11-14">v1.25 - 2015-11-14</h2> 20535 <ul> 20536 <li>New features 20537 <ul> 20538 <li>Implement Hubic storage system</li> 20539 </ul></li> 20540 <li>Fixes 20541 <ul> 20542 <li>Fix deletion of some excluded files without –delete-excluded 20543 <ul> 20544 <li>This could have deleted files unexpectedly on sync</li> 20545 <li>Always check first with <code>--dry-run</code>!</li> 20546 </ul></li> 20547 </ul></li> 20548 <li>Swift 20549 <ul> 20550 <li>Stop SetModTime losing metadata (eg X-Object-Manifest) 20551 <ul> 20552 <li>This could have caused data loss for files > 5GB in size</li> 20553 </ul></li> 20554 <li>Use ContentType from Object to avoid lookups in listings</li> 20555 </ul></li> 20556 <li>OneDrive 20557 <ul> 20558 <li>disable server side copy as it seems to be broken at Microsoft</li> 20559 </ul></li> 20560 </ul> 20561 <h2 id="v1.24---2015-11-07">v1.24 - 2015-11-07</h2> 20562 <ul> 20563 <li>New features 20564 <ul> 20565 <li>Add support for Microsoft OneDrive</li> 20566 <li>Add <code>--no-check-certificate</code> option to disable server certificate verification</li> 20567 <li>Add async readahead buffer for faster transfer of big files</li> 20568 </ul></li> 20569 <li>Fixes 20570 <ul> 20571 <li>Allow spaces in remotes and check remote names for validity at creation time</li> 20572 <li>Allow ‘&’ and disallow ‘:’ in Windows filenames.</li> 20573 </ul></li> 20574 <li>Swift 20575 <ul> 20576 <li>Ignore directory marker objects where appropriate - allows working with Hubic</li> 20577 <li>Don’t delete the container if fs wasn’t at root</li> 20578 </ul></li> 20579 <li>S3 20580 <ul> 20581 <li>Don’t delete the bucket if fs wasn’t at root</li> 20582 </ul></li> 20583 <li>Google Cloud Storage 20584 <ul> 20585 <li>Don’t delete the bucket if fs wasn’t at root</li> 20586 </ul></li> 20587 </ul> 20588 <h2 id="v1.23---2015-10-03">v1.23 - 2015-10-03</h2> 20589 <ul> 20590 <li>New features 20591 <ul> 20592 <li>Implement <code>rclone size</code> for measuring remotes</li> 20593 </ul></li> 20594 <li>Fixes 20595 <ul> 20596 <li>Fix headless config for drive and gcs</li> 20597 <li>Tell the user they should try again if the webserver method failed</li> 20598 <li>Improve output of <code>--dump-headers</code></li> 20599 </ul></li> 20600 <li>S3 20601 <ul> 20602 <li>Allow anonymous access to public buckets</li> 20603 </ul></li> 20604 <li>Swift 20605 <ul> 20606 <li>Stop chunked operations logging “Failed to read info: Object Not Found”</li> 20607 <li>Use Content-Length on uploads for extra reliability</li> 20608 </ul></li> 20609 </ul> 20610 <h2 id="v1.22---2015-09-28">v1.22 - 2015-09-28</h2> 20611 <ul> 20612 <li>Implement rsync like include and exclude flags</li> 20613 <li>swift 20614 <ul> 20615 <li>Support files > 5GB - thanks Sergey Tolmachev</li> 20616 </ul></li> 20617 </ul> 20618 <h2 id="v1.21---2015-09-22">v1.21 - 2015-09-22</h2> 20619 <ul> 20620 <li>New features 20621 <ul> 20622 <li>Display individual transfer progress</li> 20623 <li>Make lsl output times in localtime</li> 20624 </ul></li> 20625 <li>Fixes 20626 <ul> 20627 <li>Fix allowing user to override credentials again in Drive, GCS and ACD</li> 20628 </ul></li> 20629 <li>Amazon Drive 20630 <ul> 20631 <li>Implement compliant pacing scheme</li> 20632 </ul></li> 20633 <li>Google Drive 20634 <ul> 20635 <li>Make directory reads concurrent for increased speed.</li> 20636 </ul></li> 20637 </ul> 20638 <h2 id="v1.20---2015-09-15">v1.20 - 2015-09-15</h2> 20639 <ul> 20640 <li>New features 20641 <ul> 20642 <li>Amazon Drive support</li> 20643 <li>Oauth support redone - fix many bugs and improve usability 20644 <ul> 20645 <li>Use “golang.org/x/oauth2” as oauth library of choice</li> 20646 <li>Improve oauth usability for smoother initial signup</li> 20647 <li>drive, googlecloudstorage: optionally use auto config for the oauth token</li> 20648 </ul></li> 20649 <li>Implement –dump-headers and –dump-bodies debug flags</li> 20650 <li>Show multiple matched commands if abbreviation too short</li> 20651 <li>Implement server side move where possible</li> 20652 </ul></li> 20653 <li>local 20654 <ul> 20655 <li>Always use UNC paths internally on Windows - fixes a lot of bugs</li> 20656 </ul></li> 20657 <li>dropbox 20658 <ul> 20659 <li>force use of our custom transport which makes timeouts work</li> 20660 </ul></li> 20661 <li>Thanks to Klaus Post for lots of help with this release</li> 20662 </ul> 20663 <h2 id="v1.19---2015-08-28">v1.19 - 2015-08-28</h2> 20664 <ul> 20665 <li>New features 20666 <ul> 20667 <li>Server side copies for s3/swift/drive/dropbox/gcs</li> 20668 <li>Move command - uses server side copies if it can</li> 20669 <li>Implement –retries flag - tries 3 times by default</li> 20670 <li>Build for plan9/amd64 and solaris/amd64 too</li> 20671 </ul></li> 20672 <li>Fixes 20673 <ul> 20674 <li>Make a current version download with a fixed URL for scripting</li> 20675 <li>Ignore rmdir in limited fs rather than throwing error</li> 20676 </ul></li> 20677 <li>dropbox 20678 <ul> 20679 <li>Increase chunk size to improve upload speeds massively</li> 20680 <li>Issue an error message when trying to upload bad file name</li> 20681 </ul></li> 20682 </ul> 20683 <h2 id="v1.18---2015-08-17">v1.18 - 2015-08-17</h2> 20684 <ul> 20685 <li>drive 20686 <ul> 20687 <li>Add <code>--drive-use-trash</code> flag so rclone trashes instead of deletes</li> 20688 <li>Add “Forbidden to download” message for files with no downloadURL</li> 20689 </ul></li> 20690 <li>dropbox 20691 <ul> 20692 <li>Remove datastore 20693 <ul> 20694 <li>This was deprecated and it caused a lot of problems</li> 20695 <li>Modification times and MD5SUMs no longer stored</li> 20696 </ul></li> 20697 <li>Fix uploading files > 2GB</li> 20698 </ul></li> 20699 <li>s3 20700 <ul> 20701 <li>use official AWS SDK from github.com/aws/aws-sdk-go</li> 20702 <li><strong>NB</strong> will most likely require you to delete and recreate remote</li> 20703 <li>enable multipart upload which enables files > 5GB</li> 20704 <li>tested with Ceph / RadosGW / S3 emulation</li> 20705 <li>many thanks to Sam Liston and Brian Haymore at the <a href="https://www.chpc.utah.edu/">Utah Center for High Performance Computing</a> for a Ceph test account</li> 20706 </ul></li> 20707 <li>misc 20708 <ul> 20709 <li>Show errors when reading the config file</li> 20710 <li>Do not print stats in quiet mode - thanks Leonid Shalupov</li> 20711 <li>Add FAQ</li> 20712 <li>Fix created directories not obeying umask</li> 20713 <li>Linux installation instructions - thanks Shimon Doodkin</li> 20714 </ul></li> 20715 </ul> 20716 <h2 id="v1.17---2015-06-14">v1.17 - 2015-06-14</h2> 20717 <ul> 20718 <li>dropbox: fix case insensitivity issues - thanks Leonid Shalupov</li> 20719 </ul> 20720 <h2 id="v1.16---2015-06-09">v1.16 - 2015-06-09</h2> 20721 <ul> 20722 <li>Fix uploading big files which was causing timeouts or panics</li> 20723 <li>Don’t check md5sum after download with –size-only</li> 20724 </ul> 20725 <h2 id="v1.15---2015-06-06">v1.15 - 2015-06-06</h2> 20726 <ul> 20727 <li>Add –checksum flag to only discard transfers by MD5SUM - thanks Alex Couper</li> 20728 <li>Implement –size-only flag to sync on size not checksum & modtime</li> 20729 <li>Expand docs and remove duplicated information</li> 20730 <li>Document rclone’s limitations with directories</li> 20731 <li>dropbox: update docs about case insensitivity</li> 20732 </ul> 20733 <h2 id="v1.14---2015-05-21">v1.14 - 2015-05-21</h2> 20734 <ul> 20735 <li>local: fix encoding of non utf-8 file names - fixes a duplicate file problem</li> 20736 <li>drive: docs about rate limiting</li> 20737 <li>google cloud storage: Fix compile after API change in “google.golang.org/api/storage/v1”</li> 20738 </ul> 20739 <h2 id="v1.13---2015-05-10">v1.13 - 2015-05-10</h2> 20740 <ul> 20741 <li>Revise documentation (especially sync)</li> 20742 <li>Implement –timeout and –conntimeout</li> 20743 <li>s3: ignore etags from multipart uploads which aren’t md5sums</li> 20744 </ul> 20745 <h2 id="v1.12---2015-03-15">v1.12 - 2015-03-15</h2> 20746 <ul> 20747 <li>drive: Use chunked upload for files above a certain size</li> 20748 <li>drive: add –drive-chunk-size and –drive-upload-cutoff parameters</li> 20749 <li>drive: switch to insert from update when a failed copy deletes the upload</li> 20750 <li>core: Log duplicate files if they are detected</li> 20751 </ul> 20752 <h2 id="v1.11---2015-03-04">v1.11 - 2015-03-04</h2> 20753 <ul> 20754 <li>swift: add region parameter</li> 20755 <li>drive: fix crash on failed to update remote mtime</li> 20756 <li>In remote paths, change native directory separators to /</li> 20757 <li>Add synchronization to ls/lsl/lsd output to stop corruptions</li> 20758 <li>Ensure all stats/log messages to go stderr</li> 20759 <li>Add –log-file flag to log everything (including panics) to file</li> 20760 <li>Make it possible to disable stats printing with –stats=0</li> 20761 <li>Implement –bwlimit to limit data transfer bandwidth</li> 20762 </ul> 20763 <h2 id="v1.10---2015-02-12">v1.10 - 2015-02-12</h2> 20764 <ul> 20765 <li>s3: list an unlimited number of items</li> 20766 <li>Fix getting stuck in the configurator</li> 20767 </ul> 20768 <h2 id="v1.09---2015-02-07">v1.09 - 2015-02-07</h2> 20769 <ul> 20770 <li>windows: Stop drive letters (eg C:) getting mixed up with remotes (eg drive:)</li> 20771 <li>local: Fix directory separators on Windows</li> 20772 <li>drive: fix rate limit exceeded errors</li> 20773 </ul> 20774 <h2 id="v1.08---2015-02-04">v1.08 - 2015-02-04</h2> 20775 <ul> 20776 <li>drive: fix subdirectory listing to not list entire drive</li> 20777 <li>drive: Fix SetModTime</li> 20778 <li>dropbox: adapt code to recent library changes</li> 20779 </ul> 20780 <h2 id="v1.07---2014-12-23">v1.07 - 2014-12-23</h2> 20781 <ul> 20782 <li>google cloud storage: fix memory leak</li> 20783 </ul> 20784 <h2 id="v1.06---2014-12-12">v1.06 - 2014-12-12</h2> 20785 <ul> 20786 <li>Fix “Couldn’t find home directory” on OSX</li> 20787 <li>swift: Add tenant parameter</li> 20788 <li>Use new location of Google API packages</li> 20789 </ul> 20790 <h2 id="v1.05---2014-08-09">v1.05 - 2014-08-09</h2> 20791 <ul> 20792 <li>Improved tests and consequently lots of minor fixes</li> 20793 <li>core: Fix race detected by go race detector</li> 20794 <li>core: Fixes after running errcheck</li> 20795 <li>drive: reset root directory on Rmdir and Purge</li> 20796 <li>fs: Document that Purger returns error on empty directory, test and fix</li> 20797 <li>google cloud storage: fix ListDir on subdirectory</li> 20798 <li>google cloud storage: re-read metadata in SetModTime</li> 20799 <li>s3: make reading metadata more reliable to work around eventual consistency problems</li> 20800 <li>s3: strip trailing / from ListDir()</li> 20801 <li>swift: return directories without / in ListDir</li> 20802 </ul> 20803 <h2 id="v1.04---2014-07-21">v1.04 - 2014-07-21</h2> 20804 <ul> 20805 <li>google cloud storage: Fix crash on Update</li> 20806 </ul> 20807 <h2 id="v1.03---2014-07-20">v1.03 - 2014-07-20</h2> 20808 <ul> 20809 <li>swift, s3, dropbox: fix updated files being marked as corrupted</li> 20810 <li>Make compile with go 1.1 again</li> 20811 </ul> 20812 <h2 id="v1.02---2014-07-19">v1.02 - 2014-07-19</h2> 20813 <ul> 20814 <li>Implement Dropbox remote</li> 20815 <li>Implement Google Cloud Storage remote</li> 20816 <li>Verify Md5sums and Sizes after copies</li> 20817 <li>Remove times from “ls” command - lists sizes only</li> 20818 <li>Add add “lsl” - lists times and sizes</li> 20819 <li>Add “md5sum” command</li> 20820 </ul> 20821 <h2 id="v1.01---2014-07-04">v1.01 - 2014-07-04</h2> 20822 <ul> 20823 <li>drive: fix transfer of big files using up lots of memory</li> 20824 </ul> 20825 <h2 id="v1.00---2014-07-03">v1.00 - 2014-07-03</h2> 20826 <ul> 20827 <li>drive: fix whole second dates</li> 20828 </ul> 20829 <h2 id="v0.99---2014-06-26">v0.99 - 2014-06-26</h2> 20830 <ul> 20831 <li>Fix –dry-run not working</li> 20832 <li>Make compatible with go 1.1</li> 20833 </ul> 20834 <h2 id="v0.98---2014-05-30">v0.98 - 2014-05-30</h2> 20835 <ul> 20836 <li>s3: Treat missing Content-Length as 0 for some ceph installations</li> 20837 <li>rclonetest: add file with a space in</li> 20838 </ul> 20839 <h2 id="v0.97---2014-05-05">v0.97 - 2014-05-05</h2> 20840 <ul> 20841 <li>Implement copying of single files</li> 20842 <li>s3 & swift: support paths inside containers/buckets</li> 20843 </ul> 20844 <h2 id="v0.96---2014-04-24">v0.96 - 2014-04-24</h2> 20845 <ul> 20846 <li>drive: Fix multiple files of same name being created</li> 20847 <li>drive: Use o.Update and fs.Put to optimise transfers</li> 20848 <li>Add version number, -V and –version</li> 20849 </ul> 20850 <h2 id="v0.95---2014-03-28">v0.95 - 2014-03-28</h2> 20851 <ul> 20852 <li>rclone.org: website, docs and graphics</li> 20853 <li>drive: fix path parsing</li> 20854 </ul> 20855 <h2 id="v0.94---2014-03-27">v0.94 - 2014-03-27</h2> 20856 <ul> 20857 <li>Change remote format one last time</li> 20858 <li>GNU style flags</li> 20859 </ul> 20860 <h2 id="v0.93---2014-03-16">v0.93 - 2014-03-16</h2> 20861 <ul> 20862 <li>drive: store token in config file</li> 20863 <li>cross compile other versions</li> 20864 <li>set strict permissions on config file</li> 20865 </ul> 20866 <h2 id="v0.92---2014-03-15">v0.92 - 2014-03-15</h2> 20867 <ul> 20868 <li>Config fixes and –config option</li> 20869 </ul> 20870 <h2 id="v0.91---2014-03-15">v0.91 - 2014-03-15</h2> 20871 <ul> 20872 <li>Make config file</li> 20873 </ul> 20874 <h2 id="v0.90---2013-06-27">v0.90 - 2013-06-27</h2> 20875 <ul> 20876 <li>Project named rclone</li> 20877 </ul> 20878 <h2 id="v0.00---2012-11-18">v0.00 - 2012-11-18</h2> 20879 <ul> 20880 <li>Project started</li> 20881 </ul> 20882 <h1 id="bugs-and-limitations">Bugs and Limitations</h1> 20883 <h2 id="limitations-21">Limitations</h2> 20884 <h3 id="directory-timestamps-arent-preserved">Directory timestamps aren’t preserved</h3> 20885 <p>Rclone doesn’t currently preserve the timestamps of directories. This is because rclone only really considers objects when syncing.</p> 20886 <h3 id="rclone-struggles-with-millions-of-files-in-a-directory">Rclone struggles with millions of files in a directory</h3> 20887 <p>Currently rclone loads each directory entirely into memory before using it. Since each Rclone object takes 0.5k-1k of memory this can take a very long time and use an extremely large amount of memory.</p> 20888 <p>Millions of files in a directory tend caused by software writing cloud storage (eg S3 buckets).</p> 20889 <h3 id="bucket-based-remotes-and-folders">Bucket based remotes and folders</h3> 20890 <p>Bucket based remotes (eg S3/GCS/Swift/B2) do not have a concept of directories. Rclone therefore cannot create directories in them which means that empty directories on a bucket based remote will tend to disappear.</p> 20891 <p>Some software creates empty keys ending in <code>/</code> as directory markers. Rclone doesn’t do this as it potentially creates more objects and costs more. It may do in future (probably with a flag).</p> 20892 <h2 id="bugs">Bugs</h2> 20893 <p>Bugs are stored in rclone’s GitHub project:</p> 20894 <ul> 20895 <li><a href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug">Reported bugs</a></li> 20896 <li><a href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22Known+Problem%22">Known issues</a></li> 20897 </ul> 20898 <h2 id="frequently-asked-questions">Frequently Asked Questions</h2> 20899 <h3 id="do-all-cloud-storage-systems-support-all-rclone-commands">Do all cloud storage systems support all rclone commands</h3> 20900 <p>Yes they do. All the rclone commands (eg <code>sync</code>, <code>copy</code> etc) will work on all the remote storage systems.</p> 20901 <h3 id="can-i-copy-the-config-from-one-machine-to-another">Can I copy the config from one machine to another</h3> 20902 <p>Sure! Rclone stores all of its config in a single file. If you want to find this file, run <code>rclone config file</code> which will tell you where it is.</p> 20903 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for more info.</p> 20904 <h3 id="how-do-i-configure-rclone-on-a-remote-headless-box-with-no-browser">How do I configure rclone on a remote / headless box with no browser?</h3> 20905 <p>This has now been documented in its own <a href="https://rclone.org/remote_setup/">remote setup page</a>.</p> 20906 <h3 id="can-rclone-sync-directly-from-drive-to-s3">Can rclone sync directly from drive to s3</h3> 20907 <p>Rclone can sync between two remote cloud storage systems just fine.</p> 20908 <p>Note that it effectively downloads the file and uploads it again, so the node running rclone would need to have lots of bandwidth.</p> 20909 <p>The syncs would be incremental (on a file by file basis).</p> 20910 <p>Eg</p> 20911 <pre><code>rclone sync drive:Folder s3:bucket</code></pre> 20912 <h3 id="using-rclone-from-multiple-locations-at-the-same-time">Using rclone from multiple locations at the same time</h3> 20913 <p>You can use rclone from multiple places at the same time if you choose different subdirectory for the output, eg</p> 20914 <pre><code>Server A> rclone sync /tmp/whatever remote:ServerA 20915 Server B> rclone sync /tmp/whatever remote:ServerB</code></pre> 20916 <p>If you sync to the same directory then you should use rclone copy otherwise the two instances of rclone may delete each other’s files, eg</p> 20917 <pre><code>Server A> rclone copy /tmp/whatever remote:Backup 20918 Server B> rclone copy /tmp/whatever remote:Backup</code></pre> 20919 <p>The file names you upload from Server A and Server B should be different in this case, otherwise some file systems (eg Drive) may make duplicates.</p> 20920 <h3 id="why-doesnt-rclone-support-partial-transfers-binary-diffs-like-rsync">Why doesn’t rclone support partial transfers / binary diffs like rsync?</h3> 20921 <p>Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload as expected using alternative access methods (eg using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system.</p> 20922 <p>Cloud storage systems (at least none I’ve come across yet) don’t support partially uploading an object. You can’t take an existing object, and change some bytes in the middle of it.</p> 20923 <p>It would be possible to make a sync system which stored binary diffs instead of whole objects like rclone does, but that would break the 1:1 mapping of files on your hard disk to objects in the remote cloud storage system.</p> 20924 <p>All the cloud storage systems support partial downloads of content, so it would be possible to make partial downloads work. However to make this work efficiently this would require storing a significant amount of metadata, which breaks the desired 1:1 mapping of files to objects.</p> 20925 <h3 id="can-rclone-do-bi-directional-sync">Can rclone do bi-directional sync?</h3> 20926 <p>No, not at present. rclone only does uni-directional sync from A -> B. It may do in the future though since it has all the primitives - it just requires writing the algorithm to do it.</p> 20927 <h3 id="can-i-use-rclone-with-an-http-proxy">Can I use rclone with an HTTP proxy?</h3> 20928 <p>Yes. rclone will follow the standard environment variables for proxies, similar to cURL and other programs.</p> 20929 <p>In general the variables are called <code>http_proxy</code> (for services reached over <code>http</code>) and <code>https_proxy</code> (for services reached over <code>https</code>). Most public services will be using <code>https</code>, but you may wish to set both.</p> 20930 <p>The content of the variable is <code>protocol://server:port</code>. The protocol value is the one used to talk to the proxy server, itself, and is commonly either <code>http</code> or <code>socks5</code>.</p> 20931 <p>Slightly annoyingly, there is no <em>standard</em> for the name; some applications may use <code>http_proxy</code> but another one <code>HTTP_PROXY</code>. The <code>Go</code> libraries used by <code>rclone</code> will try both variations, but you may wish to set all possibilities. So, on Linux, you may end up with code similar to</p> 20932 <pre><code>export http_proxy=http://proxyserver:12345 20933 export https_proxy=$http_proxy 20934 export HTTP_PROXY=$http_proxy 20935 export HTTPS_PROXY=$http_proxy</code></pre> 20936 <p>The <code>NO_PROXY</code> allows you to disable the proxy for specific hosts. Hosts must be comma separated, and can contain domains or parts. For instance “foo.com” also matches “bar.foo.com”.</p> 20937 <p>e.g.</p> 20938 <pre><code>export no_proxy=localhost,127.0.0.0/8,my.host.name 20939 export NO_PROXY=$no_proxy</code></pre> 20940 <p>Note that the ftp backend does not support <code>ftp_proxy</code> yet.</p> 20941 <h3 id="rclone-gives-x509-failed-to-load-system-roots-and-no-roots-provided-error">Rclone gives x509: failed to load system roots and no roots provided error</h3> 20942 <p>This means that <code>rclone</code> can’t file the SSL root certificates. Likely you are running <code>rclone</code> on a NAS with a cut-down Linux OS, or possibly on Solaris.</p> 20943 <p>Rclone (via the Go runtime) tries to load the root certificates from these places on Linux.</p> 20944 <pre><code>"/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu/Gentoo etc. 20945 "/etc/pki/tls/certs/ca-bundle.crt", // Fedora/RHEL 20946 "/etc/ssl/ca-bundle.pem", // OpenSUSE 20947 "/etc/pki/tls/cacert.pem", // OpenELEC</code></pre> 20948 <p>So doing something like this should fix the problem. It also sets the time which is important for SSL to work properly.</p> 20949 <pre><code>mkdir -p /etc/ssl/certs/ 20950 curl -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt 20951 ntpclient -s -h pool.ntp.org</code></pre> 20952 <p>The two environment variables <code>SSL_CERT_FILE</code> and <code>SSL_CERT_DIR</code>, mentioned in the <a href="https://godoc.org/crypto/x509">x509 package</a>, provide an additional way to provide the SSL root certificates.</p> 20953 <p>Note that you may need to add the <code>--insecure</code> option to the <code>curl</code> command line if it doesn’t work without.</p> 20954 <pre><code>curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt</code></pre> 20955 <h3 id="rclone-gives-failed-to-load-config-file-function-not-implemented-error">Rclone gives Failed to load config file: function not implemented error</h3> 20956 <p>Likely this means that you are running rclone on Linux version not supported by the go runtime, ie earlier than version 2.6.23.</p> 20957 <p>See the <a href="https://golang.org/doc/install">system requirements section in the go install docs</a> for full details.</p> 20958 <h3 id="all-my-uploaded-docxxlsxpptx-files-appear-as-archivezip">All my uploaded docx/xlsx/pptx files appear as archive/zip</h3> 20959 <p>This is caused by uploading these files from a Windows computer which hasn’t got the Microsoft Office suite installed. The easiest way to fix is to install the Word viewer and the Microsoft Office Compatibility Pack for Word, Excel, and PowerPoint 2007 and later versions’ file formats</p> 20960 <h3 id="tcp-lookup-some.domain.com-no-such-host">tcp lookup some.domain.com no such host</h3> 20961 <p>This happens when rclone cannot resolve a domain. Please check that your DNS setup is generally working, e.g.</p> 20962 <pre><code># both should print a long list of possible IP addresses 20963 dig www.googleapis.com # resolve using your default DNS 20964 dig www.googleapis.com @8.8.8.8 # resolve with Google's DNS server</code></pre> 20965 <p>If you are using <code>systemd-resolved</code> (default on Arch Linux), ensure it is at version 233 or higher. Previous releases contain a bug which causes not all domains to be resolved properly.</p> 20966 <p>Additionally with the <code>GODEBUG=netdns=</code> environment variable the Go resolver decision can be influenced. This also allows to resolve certain issues with DNS resolution. See the <a href="https://golang.org/pkg/net/#hdr-Name_Resolution">name resolution section in the go docs</a>.</p> 20967 <h3 id="the-total-size-reported-in-the-stats-for-a-sync-is-wrong-and-keeps-changing">The total size reported in the stats for a sync is wrong and keeps changing</h3> 20968 <p>It is likely you have more than 10,000 files that need to be synced. By default rclone only gets 10,000 files ahead in a sync so as not to use up too much memory. You can change this default with the <a href="https://rclone.org/docs/#max-backlog-n">–max-backlog</a> flag.</p> 20969 <h3 id="rclone-is-using-too-much-memory-or-appears-to-have-a-memory-leak">Rclone is using too much memory or appears to have a memory leak</h3> 20970 <p>Rclone is written in Go which uses a garbage collector. The default settings for the garbage collector mean that it runs when the heap size has doubled.</p> 20971 <p>However it is possible to tune the garbage collector to use less memory by <a href="https://dave.cheney.net/tag/gogc">setting GOGC</a> to a lower value, say <code>export GOGC=20</code>. This will make the garbage collector work harder, reducing memory size at the expense of CPU usage.</p> 20972 <p>The most common cause of rclone using lots of memory is a single directory with thousands or millions of files in. Rclone has to load this entirely into memory as rclone objects. Each rclone object takes 0.5k-1k of memory.</p> 20973 <h2 id="license">License</h2> 20974 <p>This is free software under the terms of MIT the license (check the COPYING file included with the source code).</p> 20975 <pre><code>Copyright (C) 2019 by Nick Craig-Wood https://www.craig-wood.com/nick/ 20976 20977 Permission is hereby granted, free of charge, to any person obtaining a copy 20978 of this software and associated documentation files (the "Software"), to deal 20979 in the Software without restriction, including without limitation the rights 20980 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 20981 copies of the Software, and to permit persons to whom the Software is 20982 furnished to do so, subject to the following conditions: 20983 20984 The above copyright notice and this permission notice shall be included in 20985 all copies or substantial portions of the Software. 20986 20987 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20988 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20989 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20990 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20991 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20992 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20993 THE SOFTWARE.</code></pre> 20994 <h2 id="authors">Authors</h2> 20995 <ul> 20996 <li>Nick Craig-Wood <a href="mailto:nick@craig-wood.com" class="email">nick@craig-wood.com</a></li> 20997 </ul> 20998 <h2 id="contributors">Contributors</h2> 20999 <p>{{< rem <code>email addresses removed from here need to be addeed to bin/.ignore-emails to make sure update-authors.py doesn't immediately put them back in again.</code> >}}</p> 21000 <ul> 21001 <li>Alex Couper <a href="mailto:amcouper@gmail.com" class="email">amcouper@gmail.com</a></li> 21002 <li>Leonid Shalupov <a href="mailto:leonid@shalupov.com" class="email">leonid@shalupov.com</a> <a href="mailto:shalupov@diverse.org.ru" class="email">shalupov@diverse.org.ru</a></li> 21003 <li>Shimon Doodkin <a href="mailto:helpmepro1@gmail.com" class="email">helpmepro1@gmail.com</a></li> 21004 <li>Colin Nicholson <a href="mailto:colin@colinn.com" class="email">colin@colinn.com</a></li> 21005 <li>Klaus Post <a href="mailto:klauspost@gmail.com" class="email">klauspost@gmail.com</a></li> 21006 <li>Sergey Tolmachev <a href="mailto:tolsi.ru@gmail.com" class="email">tolsi.ru@gmail.com</a></li> 21007 <li>Adriano Aurélio Meirelles <a href="mailto:adriano@atinge.com" class="email">adriano@atinge.com</a></li> 21008 <li>C. Bess <a href="mailto:cbess@users.noreply.github.com" class="email">cbess@users.noreply.github.com</a></li> 21009 <li>Dmitry Burdeev <a href="mailto:dibu28@gmail.com" class="email">dibu28@gmail.com</a></li> 21010 <li>Joseph Spurrier <a href="mailto:github@josephspurrier.com" class="email">github@josephspurrier.com</a></li> 21011 <li>Björn Harrtell <a href="mailto:bjorn@wololo.org" class="email">bjorn@wololo.org</a></li> 21012 <li>Xavier Lucas <a href="mailto:xavier.lucas@corp.ovh.com" class="email">xavier.lucas@corp.ovh.com</a></li> 21013 <li>Werner Beroux <a href="mailto:werner@beroux.com" class="email">werner@beroux.com</a></li> 21014 <li>Brian Stengaard <a href="mailto:brian@stengaard.eu" class="email">brian@stengaard.eu</a></li> 21015 <li>Jakub Gedeon <a href="mailto:jgedeon@sofi.com" class="email">jgedeon@sofi.com</a></li> 21016 <li>Jim Tittsler <a href="mailto:jwt@onjapan.net" class="email">jwt@onjapan.net</a></li> 21017 <li>Michal Witkowski <a href="mailto:michal@improbable.io" class="email">michal@improbable.io</a></li> 21018 <li>Fabian Ruff <a href="mailto:fabian.ruff@sap.com" class="email">fabian.ruff@sap.com</a></li> 21019 <li>Leigh Klotz <a href="mailto:klotz@quixey.com" class="email">klotz@quixey.com</a></li> 21020 <li>Romain Lapray <a href="mailto:lapray.romain@gmail.com" class="email">lapray.romain@gmail.com</a></li> 21021 <li>Justin R. Wilson <a href="mailto:jrw972@gmail.com" class="email">jrw972@gmail.com</a></li> 21022 <li>Antonio Messina <a href="mailto:antonio.s.messina@gmail.com" class="email">antonio.s.messina@gmail.com</a></li> 21023 <li>Stefan G. Weichinger <a href="mailto:office@oops.co.at" class="email">office@oops.co.at</a></li> 21024 <li>Per Cederberg <a href="mailto:cederberg@gmail.com" class="email">cederberg@gmail.com</a></li> 21025 <li>Radek Šenfeld <a href="mailto:rush@logic.cz" class="email">rush@logic.cz</a></li> 21026 <li>Fredrik Fornwall <a href="mailto:fredrik@fornwall.net" class="email">fredrik@fornwall.net</a></li> 21027 <li>Asko Tamm <a href="mailto:asko@deekit.net" class="email">asko@deekit.net</a></li> 21028 <li>xor-zz <a href="mailto:xor@gstocco.com" class="email">xor@gstocco.com</a></li> 21029 <li>Tomasz Mazur <a href="mailto:tmazur90@gmail.com" class="email">tmazur90@gmail.com</a></li> 21030 <li>Marco Paganini <a href="mailto:paganini@paganini.net" class="email">paganini@paganini.net</a></li> 21031 <li>Felix Bünemann <a href="mailto:buenemann@louis.info" class="email">buenemann@louis.info</a></li> 21032 <li>Durval Menezes <a href="mailto:jmrclone@durval.com" class="email">jmrclone@durval.com</a></li> 21033 <li>Luiz Carlos Rumbelsperger Viana <a href="mailto:maxd13_luiz_carlos@hotmail.com" class="email">maxd13_luiz_carlos@hotmail.com</a></li> 21034 <li>Stefan Breunig <a href="mailto:stefan-github@yrden.de" class="email">stefan-github@yrden.de</a></li> 21035 <li>Alishan Ladhani <a href="mailto:ali-l@users.noreply.github.com" class="email">ali-l@users.noreply.github.com</a></li> 21036 <li>0xJAKE <a href="mailto:0xJAKE@users.noreply.github.com" class="email">0xJAKE@users.noreply.github.com</a></li> 21037 <li>Thibault Molleman <a href="mailto:thibaultmol@users.noreply.github.com" class="email">thibaultmol@users.noreply.github.com</a></li> 21038 <li>Scott McGillivray <a href="mailto:scott.mcgillivray@gmail.com" class="email">scott.mcgillivray@gmail.com</a></li> 21039 <li>Bjørn Erik Pedersen <a href="mailto:bjorn.erik.pedersen@gmail.com" class="email">bjorn.erik.pedersen@gmail.com</a></li> 21040 <li>Lukas Loesche <a href="mailto:lukas@mesosphere.io" class="email">lukas@mesosphere.io</a></li> 21041 <li>emyarod <a href="mailto:allllaboutyou@gmail.com" class="email">allllaboutyou@gmail.com</a></li> 21042 <li>T.C. Ferguson <a href="mailto:tcf909@gmail.com" class="email">tcf909@gmail.com</a></li> 21043 <li>Brandur <a href="mailto:brandur@mutelight.org" class="email">brandur@mutelight.org</a></li> 21044 <li>Dario Giovannetti <a href="mailto:dev@dariogiovannetti.net" class="email">dev@dariogiovannetti.net</a></li> 21045 <li>Károly Oláh <a href="mailto:okaresz@aol.com" class="email">okaresz@aol.com</a></li> 21046 <li>Jon Yergatian <a href="mailto:jon@macfanatic.ca" class="email">jon@macfanatic.ca</a></li> 21047 <li>Jack Schmidt <a href="mailto:github@mowsey.org" class="email">github@mowsey.org</a></li> 21048 <li>Dedsec1 <a href="mailto:Dedsec1@users.noreply.github.com" class="email">Dedsec1@users.noreply.github.com</a></li> 21049 <li>Hisham Zarka <a href="mailto:hzarka@gmail.com" class="email">hzarka@gmail.com</a></li> 21050 <li>Jérôme Vizcaino <a href="mailto:jerome.vizcaino@gmail.com" class="email">jerome.vizcaino@gmail.com</a></li> 21051 <li>Mike Tesch <a href="mailto:mjt6129@rit.edu" class="email">mjt6129@rit.edu</a></li> 21052 <li>Marvin Watson <a href="mailto:marvwatson@users.noreply.github.com" class="email">marvwatson@users.noreply.github.com</a></li> 21053 <li>Danny Tsai <a href="mailto:danny8376@gmail.com" class="email">danny8376@gmail.com</a></li> 21054 <li>Yoni Jah <a href="mailto:yonjah+git@gmail.com" class="email">yonjah+git@gmail.com</a> <a href="mailto:yonjah+github@gmail.com" class="email">yonjah+github@gmail.com</a></li> 21055 <li>Stephen Harris <a href="mailto:github@spuddy.org" class="email">github@spuddy.org</a> <a href="mailto:sweharris@users.noreply.github.com" class="email">sweharris@users.noreply.github.com</a></li> 21056 <li>Ihor Dvoretskyi <a href="mailto:ihor.dvoretskyi@gmail.com" class="email">ihor.dvoretskyi@gmail.com</a></li> 21057 <li>Jon Craton <a href="mailto:jncraton@gmail.com" class="email">jncraton@gmail.com</a></li> 21058 <li>Hraban Luyat <a href="mailto:hraban@0brg.net" class="email">hraban@0brg.net</a></li> 21059 <li>Michael Ledin <a href="mailto:mledin89@gmail.com" class="email">mledin89@gmail.com</a></li> 21060 <li>Martin Kristensen <a href="mailto:me@azgul.com" class="email">me@azgul.com</a></li> 21061 <li>Too Much IO <a href="mailto:toomuchio@users.noreply.github.com" class="email">toomuchio@users.noreply.github.com</a></li> 21062 <li>Anisse Astier <a href="mailto:anisse@astier.eu" class="email">anisse@astier.eu</a></li> 21063 <li>Zahiar Ahmed <a href="mailto:zahiar@live.com" class="email">zahiar@live.com</a></li> 21064 <li>Igor Kharin <a href="mailto:igorkharin@gmail.com" class="email">igorkharin@gmail.com</a></li> 21065 <li>Bill Zissimopoulos <a href="mailto:billziss@navimatics.com" class="email">billziss@navimatics.com</a></li> 21066 <li>Bob Potter <a href="mailto:bobby.potter@gmail.com" class="email">bobby.potter@gmail.com</a></li> 21067 <li>Steven Lu <a href="mailto:tacticalazn@gmail.com" class="email">tacticalazn@gmail.com</a></li> 21068 <li>Sjur Fredriksen <a href="mailto:sjurtf@ifi.uio.no" class="email">sjurtf@ifi.uio.no</a></li> 21069 <li>Ruwbin <a href="mailto:hubus12345@gmail.com" class="email">hubus12345@gmail.com</a></li> 21070 <li>Fabian Möller <a href="mailto:fabianm88@gmail.com" class="email">fabianm88@gmail.com</a> <a href="mailto:f.moeller@nynex.de" class="email">f.moeller@nynex.de</a></li> 21071 <li>Edward Q. Bridges <a href="mailto:github@eqbridges.com" class="email">github@eqbridges.com</a></li> 21072 <li>Vasiliy Tolstov <a href="mailto:v.tolstov@selfip.ru" class="email">v.tolstov@selfip.ru</a></li> 21073 <li>Harshavardhana <a href="mailto:harsha@minio.io" class="email">harsha@minio.io</a></li> 21074 <li>sainaen <a href="mailto:sainaen@gmail.com" class="email">sainaen@gmail.com</a></li> 21075 <li>gdm85 <a href="mailto:gdm85@users.noreply.github.com" class="email">gdm85@users.noreply.github.com</a></li> 21076 <li>Yaroslav Halchenko <a href="mailto:debian@onerussian.com" class="email">debian@onerussian.com</a></li> 21077 <li>John Papandriopoulos <a href="mailto:jpap@users.noreply.github.com" class="email">jpap@users.noreply.github.com</a></li> 21078 <li>Zhiming Wang <a href="mailto:zmwangx@gmail.com" class="email">zmwangx@gmail.com</a></li> 21079 <li>Andy Pilate <a href="mailto:cubox@cubox.me" class="email">cubox@cubox.me</a></li> 21080 <li>Oliver Heyme <a href="mailto:olihey@googlemail.com" class="email">olihey@googlemail.com</a> <a href="mailto:olihey@users.noreply.github.com" class="email">olihey@users.noreply.github.com</a> <a href="mailto:de8olihe@lego.com" class="email">de8olihe@lego.com</a></li> 21081 <li>wuyu <a href="mailto:wuyu@yunify.com" class="email">wuyu@yunify.com</a></li> 21082 <li>Andrei Dragomir <a href="mailto:adragomi@adobe.com" class="email">adragomi@adobe.com</a></li> 21083 <li>Christian Brüggemann <a href="mailto:mail@cbruegg.com" class="email">mail@cbruegg.com</a></li> 21084 <li>Alex McGrath Kraak <a href="mailto:amkdude@gmail.com" class="email">amkdude@gmail.com</a></li> 21085 <li>bpicode <a href="mailto:bjoern.pirnay@googlemail.com" class="email">bjoern.pirnay@googlemail.com</a></li> 21086 <li>Daniel Jagszent <a href="mailto:daniel@jagszent.de" class="email">daniel@jagszent.de</a></li> 21087 <li>Josiah White <a href="mailto:thegenius2009@gmail.com" class="email">thegenius2009@gmail.com</a></li> 21088 <li>Ishuah Kariuki <a href="mailto:kariuki@ishuah.com" class="email">kariuki@ishuah.com</a> <a href="mailto:ishuah91@gmail.com" class="email">ishuah91@gmail.com</a></li> 21089 <li>Jan Varho <a href="mailto:jan@varho.org" class="email">jan@varho.org</a></li> 21090 <li>Girish Ramakrishnan <a href="mailto:girish@cloudron.io" class="email">girish@cloudron.io</a></li> 21091 <li>LingMan <a href="mailto:LingMan@users.noreply.github.com" class="email">LingMan@users.noreply.github.com</a></li> 21092 <li>Jacob McNamee <a href="mailto:jacobmcnamee@gmail.com" class="email">jacobmcnamee@gmail.com</a></li> 21093 <li>jersou <a href="mailto:jertux@gmail.com" class="email">jertux@gmail.com</a></li> 21094 <li>thierry <a href="mailto:thierry@substantiel.fr" class="email">thierry@substantiel.fr</a></li> 21095 <li>Simon Leinen <a href="mailto:simon.leinen@gmail.com" class="email">simon.leinen@gmail.com</a> <a href="mailto:ubuntu@s3-test.novalocal" class="email">ubuntu@s3-test.novalocal</a></li> 21096 <li>Dan Dascalescu <a href="mailto:ddascalescu+github@gmail.com" class="email">ddascalescu+github@gmail.com</a></li> 21097 <li>Jason Rose <a href="mailto:jason@jro.io" class="email">jason@jro.io</a></li> 21098 <li>Andrew Starr-Bochicchio <a href="mailto:a.starr.b@gmail.com" class="email">a.starr.b@gmail.com</a></li> 21099 <li>John Leach <a href="mailto:john@johnleach.co.uk" class="email">john@johnleach.co.uk</a></li> 21100 <li>Corban Raun <a href="mailto:craun@instructure.com" class="email">craun@instructure.com</a></li> 21101 <li>Pierre Carlson <a href="mailto:mpcarl@us.ibm.com" class="email">mpcarl@us.ibm.com</a></li> 21102 <li>Ernest Borowski <a href="mailto:er.borowski@gmail.com" class="email">er.borowski@gmail.com</a></li> 21103 <li>Remus Bunduc <a href="mailto:remus.bunduc@gmail.com" class="email">remus.bunduc@gmail.com</a></li> 21104 <li>Iakov Davydov <a href="mailto:iakov.davydov@unil.ch" class="email">iakov.davydov@unil.ch</a> <a href="mailto:dav05.gith@myths.ru" class="email">dav05.gith@myths.ru</a></li> 21105 <li>Jakub Tasiemski <a href="mailto:tasiemski@gmail.com" class="email">tasiemski@gmail.com</a></li> 21106 <li>David Minor <a href="mailto:dminor@saymedia.com" class="email">dminor@saymedia.com</a></li> 21107 <li>Tim Cooijmans <a href="mailto:cooijmans.tim@gmail.com" class="email">cooijmans.tim@gmail.com</a></li> 21108 <li>Laurence <a href="mailto:liuxy6@gmail.com" class="email">liuxy6@gmail.com</a></li> 21109 <li>Giovanni Pizzi <a href="mailto:gio.piz@gmail.com" class="email">gio.piz@gmail.com</a></li> 21110 <li>Filip Bartodziej <a href="mailto:filipbartodziej@gmail.com" class="email">filipbartodziej@gmail.com</a></li> 21111 <li>Jon Fautley <a href="mailto:jon@dead.li" class="email">jon@dead.li</a></li> 21112 <li>lewapm <a href="mailto:32110057+lewapm@users.noreply.github.com" class="email">32110057+lewapm@users.noreply.github.com</a></li> 21113 <li>Yassine Imounachen <a href="mailto:yassine256@gmail.com" class="email">yassine256@gmail.com</a></li> 21114 <li>Chris Redekop <a href="mailto:chris-redekop@users.noreply.github.com" class="email">chris-redekop@users.noreply.github.com</a> <a href="mailto:chris.redekop@gmail.com" class="email">chris.redekop@gmail.com</a></li> 21115 <li>Jon Fautley <a href="mailto:jon@adenoid.appstal.co.uk" class="email">jon@adenoid.appstal.co.uk</a></li> 21116 <li>Will Gunn <a href="mailto:WillGunn@users.noreply.github.com" class="email">WillGunn@users.noreply.github.com</a></li> 21117 <li>Lucas Bremgartner <a href="mailto:lucas@bremis.ch" class="email">lucas@bremis.ch</a></li> 21118 <li>Jody Frankowski <a href="mailto:jody.frankowski@gmail.com" class="email">jody.frankowski@gmail.com</a></li> 21119 <li>Andreas Roussos <a href="mailto:arouss1980@gmail.com" class="email">arouss1980@gmail.com</a></li> 21120 <li>nbuchanan <a href="mailto:nbuchanan@utah.gov" class="email">nbuchanan@utah.gov</a></li> 21121 <li>Durval Menezes <a href="mailto:rclone@durval.com" class="email">rclone@durval.com</a></li> 21122 <li>Victor <a href="mailto:vb-github@viblo.se" class="email">vb-github@viblo.se</a></li> 21123 <li>Mateusz <a href="mailto:pabian.mateusz@gmail.com" class="email">pabian.mateusz@gmail.com</a></li> 21124 <li>Daniel Loader <a href="mailto:spicypixel@gmail.com" class="email">spicypixel@gmail.com</a></li> 21125 <li>David0rk <a href="mailto:davidork@gmail.com" class="email">davidork@gmail.com</a></li> 21126 <li>Alexander Neumann <a href="mailto:alexander@bumpern.de" class="email">alexander@bumpern.de</a></li> 21127 <li>Giri Badanahatti <a href="mailto:gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local" class="email">gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local</a></li> 21128 <li>Leo R. Lundgren <a href="mailto:leo@finalresort.org" class="email">leo@finalresort.org</a></li> 21129 <li>wolfv <a href="mailto:wolfv6@users.noreply.github.com" class="email">wolfv6@users.noreply.github.com</a></li> 21130 <li>Dave Pedu <a href="mailto:dave@davepedu.com" class="email">dave@davepedu.com</a></li> 21131 <li>Stefan Lindblom <a href="mailto:lindblom@spotify.com" class="email">lindblom@spotify.com</a></li> 21132 <li>seuffert <a href="mailto:oliver@seuffert.biz" class="email">oliver@seuffert.biz</a></li> 21133 <li>gbadanahatti <a href="mailto:37121690+gbadanahatti@users.noreply.github.com" class="email">37121690+gbadanahatti@users.noreply.github.com</a></li> 21134 <li>Keith Goldfarb <a href="mailto:barkofdelight@gmail.com" class="email">barkofdelight@gmail.com</a></li> 21135 <li>Steve Kriss <a href="mailto:steve@heptio.com" class="email">steve@heptio.com</a></li> 21136 <li>Chih-Hsuan Yen <a href="mailto:yan12125@gmail.com" class="email">yan12125@gmail.com</a></li> 21137 <li>Alexander Neumann <a href="mailto:fd0@users.noreply.github.com" class="email">fd0@users.noreply.github.com</a></li> 21138 <li>Matt Holt <a href="mailto:mholt@users.noreply.github.com" class="email">mholt@users.noreply.github.com</a></li> 21139 <li>Eri Bastos <a href="mailto:bastos.eri@gmail.com" class="email">bastos.eri@gmail.com</a></li> 21140 <li>Michael P. Dubner <a href="mailto:pywebmail@list.ru" class="email">pywebmail@list.ru</a></li> 21141 <li>Antoine GIRARD <a href="mailto:sapk@users.noreply.github.com" class="email">sapk@users.noreply.github.com</a></li> 21142 <li>Mateusz Piotrowski <a href="mailto:mpp302@gmail.com" class="email">mpp302@gmail.com</a></li> 21143 <li>Animosity022 <a href="mailto:animosity22@users.noreply.github.com" class="email">animosity22@users.noreply.github.com</a> <a href="mailto:earl.texter@gmail.com" class="email">earl.texter@gmail.com</a></li> 21144 <li>Peter Baumgartner <a href="mailto:pete@lincolnloop.com" class="email">pete@lincolnloop.com</a></li> 21145 <li>Craig Rachel <a href="mailto:craig@craigrachel.com" class="email">craig@craigrachel.com</a></li> 21146 <li>Michael G. Noll <a href="mailto:miguno@users.noreply.github.com" class="email">miguno@users.noreply.github.com</a></li> 21147 <li>hensur <a href="mailto:me@hensur.de" class="email">me@hensur.de</a></li> 21148 <li>Oliver Heyme <a href="mailto:de8olihe@lego.com" class="email">de8olihe@lego.com</a></li> 21149 <li>Richard Yang <a href="mailto:richard@yenforyang.com" class="email">richard@yenforyang.com</a></li> 21150 <li>Piotr Oleszczyk <a href="mailto:piotr.oleszczyk@gmail.com" class="email">piotr.oleszczyk@gmail.com</a></li> 21151 <li>Rodrigo <a href="mailto:rodarima@gmail.com" class="email">rodarima@gmail.com</a></li> 21152 <li>NoLooseEnds <a href="mailto:NoLooseEnds@users.noreply.github.com" class="email">NoLooseEnds@users.noreply.github.com</a></li> 21153 <li>Jakub Karlicek <a href="mailto:jakub@karlicek.me" class="email">jakub@karlicek.me</a></li> 21154 <li>John Clayton <a href="mailto:john@codemonkeylabs.com" class="email">john@codemonkeylabs.com</a></li> 21155 <li>Kasper Byrdal Nielsen <a href="mailto:byrdal76@gmail.com" class="email">byrdal76@gmail.com</a></li> 21156 <li>Benjamin Joseph Dag <a href="mailto:bjdag1234@users.noreply.github.com" class="email">bjdag1234@users.noreply.github.com</a></li> 21157 <li>themylogin <a href="mailto:themylogin@gmail.com" class="email">themylogin@gmail.com</a></li> 21158 <li>Onno Zweers <a href="mailto:onno.zweers@surfsara.nl" class="email">onno.zweers@surfsara.nl</a></li> 21159 <li>Jasper Lievisse Adriaanse <a href="mailto:jasper@humppa.nl" class="email">jasper@humppa.nl</a></li> 21160 <li>sandeepkru <a href="mailto:sandeep.ummadi@gmail.com" class="email">sandeep.ummadi@gmail.com</a> <a href="mailto:sandeepkru@users.noreply.github.com" class="email">sandeepkru@users.noreply.github.com</a></li> 21161 <li>HerrH <a href="mailto:atomtigerzoo@users.noreply.github.com" class="email">atomtigerzoo@users.noreply.github.com</a></li> 21162 <li>Andrew <a href="mailto:4030760+sparkyman215@users.noreply.github.com" class="email">4030760+sparkyman215@users.noreply.github.com</a></li> 21163 <li>dan smith <a href="mailto:XX1011@gmail.com" class="email">XX1011@gmail.com</a></li> 21164 <li>Oleg Kovalov <a href="mailto:iamolegkovalov@gmail.com" class="email">iamolegkovalov@gmail.com</a></li> 21165 <li>Ruben Vandamme <a href="mailto:github-com-00ff86@vandamme.email" class="email">github-com-00ff86@vandamme.email</a></li> 21166 <li>Cnly <a href="mailto:minecnly@gmail.com" class="email">minecnly@gmail.com</a></li> 21167 <li>Andres Alvarez <a href="mailto:1671935+kir4h@users.noreply.github.com" class="email">1671935+kir4h@users.noreply.github.com</a></li> 21168 <li>reddi1 <a href="mailto:xreddi@gmail.com" class="email">xreddi@gmail.com</a></li> 21169 <li>Matt Tucker <a href="mailto:matthewtckr@gmail.com" class="email">matthewtckr@gmail.com</a></li> 21170 <li>Sebastian Bünger <a href="mailto:buengese@gmail.com" class="email">buengese@gmail.com</a></li> 21171 <li>Martin Polden <a href="mailto:mpolden@mpolden.no" class="email">mpolden@mpolden.no</a></li> 21172 <li>Alex Chen <a href="mailto:Cnly@users.noreply.github.com" class="email">Cnly@users.noreply.github.com</a></li> 21173 <li>Denis <a href="mailto:deniskovpen@gmail.com" class="email">deniskovpen@gmail.com</a></li> 21174 <li>bsteiss <a href="mailto:35940619+bsteiss@users.noreply.github.com" class="email">35940619+bsteiss@users.noreply.github.com</a></li> 21175 <li>Cédric Connes <a href="mailto:cedric.connes@gmail.com" class="email">cedric.connes@gmail.com</a></li> 21176 <li>Dr. Tobias Quathamer <a href="mailto:toddy15@users.noreply.github.com" class="email">toddy15@users.noreply.github.com</a></li> 21177 <li>dcpu <a href="mailto:42736967+dcpu@users.noreply.github.com" class="email">42736967+dcpu@users.noreply.github.com</a></li> 21178 <li>Sheldon Rupp <a href="mailto:me@shel.io" class="email">me@shel.io</a></li> 21179 <li>albertony <a href="mailto:12441419+albertony@users.noreply.github.com" class="email">12441419+albertony@users.noreply.github.com</a></li> 21180 <li>cron410 <a href="mailto:cron410@gmail.com" class="email">cron410@gmail.com</a></li> 21181 <li>Anagh Kumar Baranwal <a href="mailto:6824881+darthShadow@users.noreply.github.com" class="email">6824881+darthShadow@users.noreply.github.com</a></li> 21182 <li>Felix Brucker <a href="mailto:felix@felixbrucker.com" class="email">felix@felixbrucker.com</a></li> 21183 <li>Santiago Rodríguez <a href="mailto:scollazo@users.noreply.github.com" class="email">scollazo@users.noreply.github.com</a></li> 21184 <li>Craig Miskell <a href="mailto:craig.miskell@fluxfederation.com" class="email">craig.miskell@fluxfederation.com</a></li> 21185 <li>Antoine GIRARD <a href="mailto:sapk@sapk.fr" class="email">sapk@sapk.fr</a></li> 21186 <li>Joanna Marek <a href="mailto:joanna.marek@u2i.com" class="email">joanna.marek@u2i.com</a></li> 21187 <li>frenos <a href="mailto:frenos@users.noreply.github.com" class="email">frenos@users.noreply.github.com</a></li> 21188 <li>ssaqua <a href="mailto:ssaqua@users.noreply.github.com" class="email">ssaqua@users.noreply.github.com</a></li> 21189 <li>xnaas <a href="mailto:me@xnaas.info" class="email">me@xnaas.info</a></li> 21190 <li>Frantisek Fuka <a href="mailto:fuka@fuxoft.cz" class="email">fuka@fuxoft.cz</a></li> 21191 <li>Paul Kohout <a href="mailto:pauljkohout@yahoo.com" class="email">pauljkohout@yahoo.com</a></li> 21192 <li>dcpu <a href="mailto:43330287+dcpu@users.noreply.github.com" class="email">43330287+dcpu@users.noreply.github.com</a></li> 21193 <li>jackyzy823 <a href="mailto:jackyzy823@gmail.com" class="email">jackyzy823@gmail.com</a></li> 21194 <li>David Haguenauer <a href="mailto:ml@kurokatta.org" class="email">ml@kurokatta.org</a></li> 21195 <li>teresy <a href="mailto:hi.teresy@gmail.com" class="email">hi.teresy@gmail.com</a></li> 21196 <li>buergi <a href="mailto:patbuergi@gmx.de" class="email">patbuergi@gmx.de</a></li> 21197 <li>Florian Gamboeck <a href="mailto:mail@floga.de" class="email">mail@floga.de</a></li> 21198 <li>Ralf Hemberger <a href="mailto:10364191+rhemberger@users.noreply.github.com" class="email">10364191+rhemberger@users.noreply.github.com</a></li> 21199 <li>Scott Edlund <a href="mailto:sedlund@users.noreply.github.com" class="email">sedlund@users.noreply.github.com</a></li> 21200 <li>Erik Swanson <a href="mailto:erik@retailnext.net" class="email">erik@retailnext.net</a></li> 21201 <li>Jake Coggiano <a href="mailto:jake@stripe.com" class="email">jake@stripe.com</a></li> 21202 <li>brused27 <a href="mailto:brused27@noemailaddress" class="email">brused27@noemailaddress</a></li> 21203 <li>Peter Kaminski <a href="mailto:kaminski@istori.com" class="email">kaminski@istori.com</a></li> 21204 <li>Henry Ptasinski <a href="mailto:henry@logout.com" class="email">henry@logout.com</a></li> 21205 <li>Alexander <a href="mailto:kharkovalexander@gmail.com" class="email">kharkovalexander@gmail.com</a></li> 21206 <li>Garry McNulty <a href="mailto:garrmcnu@gmail.com" class="email">garrmcnu@gmail.com</a></li> 21207 <li>Mathieu Carbou <a href="mailto:mathieu.carbou@gmail.com" class="email">mathieu.carbou@gmail.com</a></li> 21208 <li>Mark Otway <a href="mailto:mark@otway.com" class="email">mark@otway.com</a></li> 21209 <li>William Cocker <a href="mailto:37018962+WilliamCocker@users.noreply.github.com" class="email">37018962+WilliamCocker@users.noreply.github.com</a></li> 21210 <li>François Leurent <a href="mailto:131.js@cloudyks.org" class="email">131.js@cloudyks.org</a></li> 21211 <li>Arkadius Stefanski <a href="mailto:arkste@gmail.com" class="email">arkste@gmail.com</a></li> 21212 <li>Jay <a href="mailto:dev@jaygoel.com" class="email">dev@jaygoel.com</a></li> 21213 <li>andrea rota <a href="mailto:a@xelera.eu" class="email">a@xelera.eu</a></li> 21214 <li>nicolov <a href="mailto:nicolov@users.noreply.github.com" class="email">nicolov@users.noreply.github.com</a></li> 21215 <li>Dario Guzik <a href="mailto:dario@guzik.com.ar" class="email">dario@guzik.com.ar</a></li> 21216 <li>qip <a href="mailto:qip@users.noreply.github.com" class="email">qip@users.noreply.github.com</a></li> 21217 <li>yair@unicorn <a href="mailto:yair@unicorn" class="email">yair@unicorn</a></li> 21218 <li>Matt Robinson <a href="mailto:brimstone@the.narro.ws" class="email">brimstone@the.narro.ws</a></li> 21219 <li>kayrus <a href="mailto:kay.diam@gmail.com" class="email">kay.diam@gmail.com</a></li> 21220 <li>Rémy Léone <a href="mailto:remy.leone@gmail.com" class="email">remy.leone@gmail.com</a></li> 21221 <li>Wojciech Smigielski <a href="mailto:wojciech.hieronim.smigielski@gmail.com" class="email">wojciech.hieronim.smigielski@gmail.com</a></li> 21222 <li>weetmuts <a href="mailto:oehrstroem@gmail.com" class="email">oehrstroem@gmail.com</a></li> 21223 <li>Jonathan <a href="mailto:vanillajonathan@users.noreply.github.com" class="email">vanillajonathan@users.noreply.github.com</a></li> 21224 <li>James Carpenter <a href="mailto:orbsmiv@users.noreply.github.com" class="email">orbsmiv@users.noreply.github.com</a></li> 21225 <li>Vince <a href="mailto:vince0villamora@gmail.com" class="email">vince0villamora@gmail.com</a></li> 21226 <li>Nestar47 <a href="mailto:47841759+Nestar47@users.noreply.github.com" class="email">47841759+Nestar47@users.noreply.github.com</a></li> 21227 <li>Six <a href="mailto:brbsix@gmail.com" class="email">brbsix@gmail.com</a></li> 21228 <li>Alexandru Bumbacea <a href="mailto:alexandru.bumbacea@booking.com" class="email">alexandru.bumbacea@booking.com</a></li> 21229 <li>calisro <a href="mailto:robert.calistri@gmail.com" class="email">robert.calistri@gmail.com</a></li> 21230 <li>Dr.Rx <a href="mailto:david.rey@nventive.com" class="email">david.rey@nventive.com</a></li> 21231 <li>marcintustin <a href="mailto:marcintustin@users.noreply.github.com" class="email">marcintustin@users.noreply.github.com</a></li> 21232 <li>jaKa Močnik <a href="mailto:jaka@koofr.net" class="email">jaka@koofr.net</a></li> 21233 <li>Fionera <a href="mailto:fionera@fionera.de" class="email">fionera@fionera.de</a></li> 21234 <li>Dan Walters <a href="mailto:dan@walters.io" class="email">dan@walters.io</a></li> 21235 <li>Danil Semelenov <a href="mailto:sgtpep@users.noreply.github.com" class="email">sgtpep@users.noreply.github.com</a></li> 21236 <li>xopez <a href="mailto:28950736+xopez@users.noreply.github.com" class="email">28950736+xopez@users.noreply.github.com</a></li> 21237 <li>Ben Boeckel <a href="mailto:mathstuf@gmail.com" class="email">mathstuf@gmail.com</a></li> 21238 <li>Manu <a href="mailto:manu@snapdragon.cc" class="email">manu@snapdragon.cc</a></li> 21239 <li>Kyle E. Mitchell <a href="mailto:kyle@kemitchell.com" class="email">kyle@kemitchell.com</a></li> 21240 <li>Gary Kim <a href="mailto:gary@garykim.dev" class="email">gary@garykim.dev</a></li> 21241 <li>Jon <a href="mailto:jonathn@github.com" class="email">jonathn@github.com</a></li> 21242 <li>Jeff Quinn <a href="mailto:jeffrey.quinn@bluevoyant.com" class="email">jeffrey.quinn@bluevoyant.com</a></li> 21243 <li>Peter Berbec <a href="mailto:peter@berbec.com" class="email">peter@berbec.com</a></li> 21244 <li>didil <a href="mailto:1284255+didil@users.noreply.github.com" class="email">1284255+didil@users.noreply.github.com</a></li> 21245 <li>id01 <a href="mailto:gaviniboom@gmail.com" class="email">gaviniboom@gmail.com</a></li> 21246 <li>Robert Marko <a href="mailto:robimarko@gmail.com" class="email">robimarko@gmail.com</a></li> 21247 <li>Philip Harvey <a href="mailto:32467456+pharveybattelle@users.noreply.github.com" class="email">32467456+pharveybattelle@users.noreply.github.com</a></li> 21248 <li>JorisE <a href="mailto:JorisE@users.noreply.github.com" class="email">JorisE@users.noreply.github.com</a></li> 21249 <li>garry415 <a href="mailto:garry.415@gmail.com" class="email">garry.415@gmail.com</a></li> 21250 <li>forgems <a href="mailto:forgems@gmail.com" class="email">forgems@gmail.com</a></li> 21251 <li>Florian Apolloner <a href="mailto:florian@apolloner.eu" class="email">florian@apolloner.eu</a></li> 21252 <li>Aleksandar Janković <a href="mailto:office@ajankovic.com" class="email">office@ajankovic.com</a> <a href="mailto:ajankovic@users.noreply.github.com" class="email">ajankovic@users.noreply.github.com</a></li> 21253 <li>Maran <a href="mailto:maran@protonmail.com" class="email">maran@protonmail.com</a></li> 21254 <li>nguyenhuuluan434 <a href="mailto:nguyenhuuluan434@gmail.com" class="email">nguyenhuuluan434@gmail.com</a></li> 21255 <li>Laura Hausmann <a href="mailto:zotan@zotan.pw" class="email">zotan@zotan.pw</a> <a href="mailto:laura@hausmann.dev" class="email">laura@hausmann.dev</a></li> 21256 <li>yparitcher <a href="mailto:y@paritcher.com" class="email">y@paritcher.com</a></li> 21257 <li>AbelThar <a href="mailto:abela.tharen@gmail.com" class="email">abela.tharen@gmail.com</a></li> 21258 <li>Matti Niemenmaa <a href="mailto:matti.niemenmaa+git@iki.fi" class="email">matti.niemenmaa+git@iki.fi</a></li> 21259 <li>Russell Davis <a href="mailto:russelldavis@users.noreply.github.com" class="email">russelldavis@users.noreply.github.com</a></li> 21260 <li>Yi FU <a href="mailto:yi.fu@tink.se" class="email">yi.fu@tink.se</a></li> 21261 <li>Paul Millar <a href="mailto:paul.millar@desy.de" class="email">paul.millar@desy.de</a></li> 21262 <li>justinalin <a href="mailto:justinalin@qnap.com" class="email">justinalin@qnap.com</a></li> 21263 <li>EliEron <a href="mailto:subanimehd@gmail.com" class="email">subanimehd@gmail.com</a></li> 21264 <li>justina777 <a href="mailto:chiahuei.lin@gmail.com" class="email">chiahuei.lin@gmail.com</a></li> 21265 <li>Chaitanya Bankanhal <a href="mailto:bchaitanya15@gmail.com" class="email">bchaitanya15@gmail.com</a></li> 21266 <li>Michał Matczuk <a href="mailto:michal@scylladb.com" class="email">michal@scylladb.com</a></li> 21267 <li>Macavirus <a href="mailto:macavirus@zoho.com" class="email">macavirus@zoho.com</a></li> 21268 <li>Abhinav Sharma <a href="mailto:abhi18av@users.noreply.github.com" class="email">abhi18av@users.noreply.github.com</a></li> 21269 <li>ginvine <a href="mailto:34869051+ginvine@users.noreply.github.com" class="email">34869051+ginvine@users.noreply.github.com</a></li> 21270 <li>Patrick Wang <a href="mailto:mail6543210@yahoo.com.tw" class="email">mail6543210@yahoo.com.tw</a></li> 21271 <li>Cenk Alti <a href="mailto:cenkalti@gmail.com" class="email">cenkalti@gmail.com</a></li> 21272 <li>Andreas Chlupka <a href="mailto:andy@chlupka.com" class="email">andy@chlupka.com</a></li> 21273 <li>Alfonso Montero <a href="mailto:amontero@tinet.org" class="email">amontero@tinet.org</a></li> 21274 <li>Ivan Andreev <a href="mailto:ivandeex@gmail.com" class="email">ivandeex@gmail.com</a></li> 21275 <li>David Baumgold <a href="mailto:david@davidbaumgold.com" class="email">david@davidbaumgold.com</a></li> 21276 <li>Lars Lehtonen <a href="mailto:lars.lehtonen@gmail.com" class="email">lars.lehtonen@gmail.com</a></li> 21277 <li>Matei David <a href="mailto:matei.david@gmail.com" class="email">matei.david@gmail.com</a></li> 21278 <li>David <a href="mailto:david.bramwell@endemolshine.com" class="email">david.bramwell@endemolshine.com</a></li> 21279 <li>Anthony Rusdi <a href="mailto:33247310+antrusd@users.noreply.github.com" class="email">33247310+antrusd@users.noreply.github.com</a></li> 21280 <li>Richard Patel <a href="mailto:me@terorie.dev" class="email">me@terorie.dev</a></li> 21281 <li>庄天翼 <a href="mailto:zty0826@gmail.com" class="email">zty0826@gmail.com</a></li> 21282 <li>SwitchJS <a href="mailto:dev@switchjs.com" class="email">dev@switchjs.com</a></li> 21283 <li>Raphael <a href="mailto:PowershellNinja@users.noreply.github.com" class="email">PowershellNinja@users.noreply.github.com</a></li> 21284 <li>Sezal Agrawal <a href="mailto:sezalagrawal@gmail.com" class="email">sezalagrawal@gmail.com</a></li> 21285 <li>Tyler <a href="mailto:TylerNakamura@users.noreply.github.com" class="email">TylerNakamura@users.noreply.github.com</a></li> 21286 <li>Brett Dutro <a href="mailto:brett.dutro@gmail.com" class="email">brett.dutro@gmail.com</a></li> 21287 <li>Vighnesh SK <a href="mailto:booterror99@gmail.com" class="email">booterror99@gmail.com</a></li> 21288 <li>Arijit Biswas <a href="mailto:dibbyo456@gmail.com" class="email">dibbyo456@gmail.com</a></li> 21289 <li>Michele Caci <a href="mailto:michele.caci@gmail.com" class="email">michele.caci@gmail.com</a></li> 21290 <li>AlexandrBoltris <a href="mailto:ua2fgb@gmail.com" class="email">ua2fgb@gmail.com</a></li> 21291 <li>Bryce Larson <a href="mailto:blarson@saltstack.com" class="email">blarson@saltstack.com</a></li> 21292 <li>Carlos Ferreyra <a href="mailto:crypticmind@gmail.com" class="email">crypticmind@gmail.com</a></li> 21293 <li>Saksham Khanna <a href="mailto:sakshamkhanna@outlook.com" class="email">sakshamkhanna@outlook.com</a></li> 21294 <li>dausruddin <a href="mailto:5763466+dausruddin@users.noreply.github.com" class="email">5763466+dausruddin@users.noreply.github.com</a></li> 21295 <li>zero-24 <a href="mailto:zero-24@users.noreply.github.com" class="email">zero-24@users.noreply.github.com</a></li> 21296 <li>Xiaoxing Ye <a href="mailto:ye@xiaoxing.us" class="email">ye@xiaoxing.us</a></li> 21297 <li>Barry Muldrey <a href="mailto:barry@muldrey.net" class="email">barry@muldrey.net</a></li> 21298 <li>Sebastian Brandt <a href="mailto:sebastian.brandt@friday.de" class="email">sebastian.brandt@friday.de</a></li> 21299 <li>Marco Molteni <a href="mailto:marco.molteni@mailbox.org" class="email">marco.molteni@mailbox.org</a></li> 21300 <li>Ankur Gupta <a href="mailto:ankur0493@gmail.com" class="email">ankur0493@gmail.com</a> <a href="mailto:7876747+ankur0493@users.noreply.github.com" class="email">7876747+ankur0493@users.noreply.github.com</a></li> 21301 <li>Maciej Zimnoch <a href="mailto:maciej@scylladb.com" class="email">maciej@scylladb.com</a></li> 21302 <li>anuar45 <a href="mailto:serdaliyev.anuar@gmail.com" class="email">serdaliyev.anuar@gmail.com</a></li> 21303 <li>Fernando <a href="mailto:ferferga@users.noreply.github.com" class="email">ferferga@users.noreply.github.com</a></li> 21304 <li>David Cole <a href="mailto:david.cole@sohonet.com" class="email">david.cole@sohonet.com</a></li> 21305 <li>Wei He <a href="mailto:git@weispot.com" class="email">git@weispot.com</a></li> 21306 <li>Outvi V <a href="mailto:19144373+outloudvi@users.noreply.github.com" class="email">19144373+outloudvi@users.noreply.github.com</a></li> 21307 <li>Thomas Kriechbaumer <a href="mailto:thomas@kriechbaumer.name" class="email">thomas@kriechbaumer.name</a></li> 21308 <li>Tennix <a href="mailto:tennix@users.noreply.github.com" class="email">tennix@users.noreply.github.com</a></li> 21309 <li>Ole Schütt <a href="mailto:ole@schuett.name" class="email">ole@schuett.name</a></li> 21310 <li>Kuang-che Wu <a href="mailto:kcwu@csie.org" class="email">kcwu@csie.org</a></li> 21311 <li>Thomas Eales <a href="mailto:wingsuit@users.noreply.github.com" class="email">wingsuit@users.noreply.github.com</a></li> 21312 <li>Paul Tinsley <a href="mailto:paul.tinsley@vitalsource.com" class="email">paul.tinsley@vitalsource.com</a></li> 21313 <li>Felix Hungenberg <a href="mailto:git@shiftgeist.com" class="email">git@shiftgeist.com</a></li> 21314 <li>Benjamin Richter <a href="mailto:github@dev.telepath.de" class="email">github@dev.telepath.de</a></li> 21315 <li>landall <a href="mailto:cst_zf@qq.com" class="email">cst_zf@qq.com</a></li> 21316 <li>thestigma <a href="mailto:thestigma@gmail.com" class="email">thestigma@gmail.com</a></li> 21317 <li>jtagcat <a href="mailto:38327267+jtagcat@users.noreply.github.com" class="email">38327267+jtagcat@users.noreply.github.com</a></li> 21318 <li>Damon Permezel <a href="mailto:permezel@me.com" class="email">permezel@me.com</a></li> 21319 <li>boosh <a href="mailto:boosh@users.noreply.github.com" class="email">boosh@users.noreply.github.com</a></li> 21320 <li>unbelauscht <a href="mailto:58393353+unbelauscht@users.noreply.github.com" class="email">58393353+unbelauscht@users.noreply.github.com</a></li> 21321 <li>Motonori IWAMURO <a href="mailto:vmi@nifty.com" class="email">vmi@nifty.com</a></li> 21322 <li>Benjapol Worakan <a href="mailto:benwrk@live.com" class="email">benwrk@live.com</a></li> 21323 <li>Dave Koston <a href="mailto:dave.koston@stackpath.com" class="email">dave.koston@stackpath.com</a></li> 21324 <li>Durval Menezes <a href="mailto:DurvalMenezes@users.noreply.github.com" class="email">DurvalMenezes@users.noreply.github.com</a></li> 21325 <li>Tim Gallant <a href="mailto:me@timgallant.us" class="email">me@timgallant.us</a></li> 21326 <li>Frederick Zhang <a href="mailto:frederick888@tsundere.moe" class="email">frederick888@tsundere.moe</a></li> 21327 <li>valery1707 <a href="mailto:valery1707@gmail.com" class="email">valery1707@gmail.com</a></li> 21328 <li>Yves G <a href="mailto:theYinYeti@yalis.fr" class="email">theYinYeti@yalis.fr</a></li> 21329 <li>Shing Kit Chan <a href="mailto:chanshingkit@gmail.com" class="email">chanshingkit@gmail.com</a></li> 21330 <li>Franklyn Tackitt <a href="mailto:franklyn@tackitt.net" class="email">franklyn@tackitt.net</a></li> 21331 <li>Robert-André Mauchin <a href="mailto:zebob.m@gmail.com" class="email">zebob.m@gmail.com</a></li> 21332 <li>evileye <a href="mailto:48332831+ibiruai@users.noreply.github.com" class="email">48332831+ibiruai@users.noreply.github.com</a></li> 21333 <li>Joachim Brandon LeBlanc <a href="mailto:brandon@leblanc.codes" class="email">brandon@leblanc.codes</a></li> 21334 <li>Patryk Jakuszew <a href="mailto:patryk.jakuszew@gmail.com" class="email">patryk.jakuszew@gmail.com</a></li> 21335 <li>fishbullet <a href="mailto:shindu666@gmail.com" class="email">shindu666@gmail.com</a></li> 21336 <li>greatroar <@></li> 21337 <li>Bernd Schoolmann <a href="mailto:mail@quexten.com" class="email">mail@quexten.com</a></li> 21338 <li>Elan Ruusamäe <a href="mailto:glen@pld-linux.org" class="email">glen@pld-linux.org</a></li> 21339 <li>Max Sum <a href="mailto:max@lolyculture.com" class="email">max@lolyculture.com</a></li> 21340 <li>Mark Spieth <a href="mailto:mspieth@users.noreply.github.com" class="email">mspieth@users.noreply.github.com</a></li> 21341 <li>harry <a href="mailto:me@harry.plus" class="email">me@harry.plus</a></li> 21342 <li>Samantha McVey <a href="mailto:samantham@posteo.net" class="email">samantham@posteo.net</a></li> 21343 <li>Jack Anderson <a href="mailto:jack.anderson@metaswitch.com" class="email">jack.anderson@metaswitch.com</a></li> 21344 <li>Michael G <a href="mailto:draget@speciesm.net" class="email">draget@speciesm.net</a></li> 21345 <li>Brandon Philips <a href="mailto:brandon@ifup.org" class="email">brandon@ifup.org</a></li> 21346 <li>Daven <a href="mailto:dooven@users.noreply.github.com" class="email">dooven@users.noreply.github.com</a></li> 21347 <li>Martin Stone <a href="mailto:martin@d7415.co.uk" class="email">martin@d7415.co.uk</a></li> 21348 <li>David Bramwell <a href="mailto:13053834+dbramwell@users.noreply.github.com" class="email">13053834+dbramwell@users.noreply.github.com</a></li> 21349 <li>Sunil Patra <a href="mailto:snl_su@live.com" class="email">snl_su@live.com</a></li> 21350 <li>Adam Stroud <a href="mailto:adam.stroud@gmail.com" class="email">adam.stroud@gmail.com</a></li> 21351 <li>Kush <a href="mailto:kushsharma@users.noreply.github.com" class="email">kushsharma@users.noreply.github.com</a></li> 21352 <li>Matan Rosenberg <a href="mailto:matan129@gmail.com" class="email">matan129@gmail.com</a></li> 21353 <li>gitch1 <a href="mailto:63495046+gitch1@users.noreply.github.com" class="email">63495046+gitch1@users.noreply.github.com</a></li> 21354 <li>ElonH <a href="mailto:elonhhuang@gmail.com" class="email">elonhhuang@gmail.com</a></li> 21355 <li>Fred <a href="mailto:fred@creativeprojects.tech" class="email">fred@creativeprojects.tech</a></li> 21356 <li>Sébastien Gross <a href="mailto:renard@users.noreply.github.com" class="email">renard@users.noreply.github.com</a></li> 21357 <li>Maxime Suret <a href="mailto:11944422+msuret@users.noreply.github.com" class="email">11944422+msuret@users.noreply.github.com</a></li> 21358 <li>Caleb Case <a href="mailto:caleb@storj.io" class="email">caleb@storj.io</a></li> 21359 <li>Ben Zenker <a href="mailto:imbenzenker@gmail.com" class="email">imbenzenker@gmail.com</a></li> 21360 <li>Martin Michlmayr <a href="mailto:tbm@cyrius.com" class="email">tbm@cyrius.com</a></li> 21361 <li>Brandon McNama <a href="mailto:bmcnama@pagerduty.com" class="email">bmcnama@pagerduty.com</a></li> 21362 <li>Daniel Slyman <a href="mailto:github@skylayer.eu" class="email">github@skylayer.eu</a></li> 21363 </ul> 21364 <h1 id="contact-the-rclone-project">Contact the rclone project</h1> 21365 <h2 id="forum">Forum</h2> 21366 <p>Forum for questions and general discussion:</p> 21367 <ul> 21368 <li>https://forum.rclone.org</li> 21369 </ul> 21370 <h2 id="github-repository">GitHub repository</h2> 21371 <p>The project’s repository is located at:</p> 21372 <ul> 21373 <li>https://github.com/rclone/rclone</li> 21374 </ul> 21375 <p>There you can file bug reports or contribute with pull requests.</p> 21376 <h2 id="twitter">Twitter</h2> 21377 <p>You can also follow me on twitter for rclone announcements:</p> 21378 <ul> 21379 <li><span class="citation" data-cites="njcw">[@njcw]</span>(https://twitter.com/njcw)</li> 21380 </ul> 21381 <h2 id="email">Email</h2> 21382 <p>Or if all else fails or you want to ask something private or confidential email <a href="mailto:nick@craig-wood.com">Nick Craig-Wood</a>. Please don’t email me requests for help - those are better directed to the forum. Thanks!</p> 21383 </body> 21384 </html>