github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/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> 18 <h1 class="title">rclone(1) User Manual</h1> 19 <p class="author">Nick Craig-Wood</p> 20 <p class="date">Jun 15, 2019</p> 21 </header> 22 <h1 id="rclone">Rclone</h1> 23 <p><a href="https://rclone.org/"><img src="https://rclone.org/img/rclone-120x120.png" alt="Logo" /></a></p> 24 <p>Rclone is a command line program to sync files and directories to and from:</p> 25 <ul> 26 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 27 <li>Amazon Drive (<a href="/amazonclouddrive/#status">See note</a>)</li> 28 <li>Amazon S3</li> 29 <li>Backblaze B2</li> 30 <li>Box</li> 31 <li>Ceph</li> 32 <li>DigitalOcean Spaces</li> 33 <li>Dreamhost</li> 34 <li>Dropbox</li> 35 <li>FTP</li> 36 <li>Google Cloud Storage</li> 37 <li>Google Drive</li> 38 <li>HTTP</li> 39 <li>Hubic</li> 40 <li>Jottacloud</li> 41 <li>IBM COS S3</li> 42 <li>Koofr</li> 43 <li>Memset Memstore</li> 44 <li>Mega</li> 45 <li>Microsoft Azure Blob Storage</li> 46 <li>Microsoft OneDrive</li> 47 <li>Minio</li> 48 <li>Nextcloud</li> 49 <li>OVH</li> 50 <li>OpenDrive</li> 51 <li>Openstack Swift</li> 52 <li>Oracle Cloud Storage</li> 53 <li>ownCloud</li> 54 <li>pCloud</li> 55 <li>put.io</li> 56 <li>QingStor</li> 57 <li>Rackspace Cloud Files</li> 58 <li>rsync.net</li> 59 <li>Scaleway</li> 60 <li>SFTP</li> 61 <li>Wasabi</li> 62 <li>WebDAV</li> 63 <li>Yandex Disk</li> 64 <li>The local filesystem</li> 65 </ul> 66 <p>Features</p> 67 <ul> 68 <li>MD5/SHA1 hashes checked at all times for file integrity</li> 69 <li>Timestamps preserved on files</li> 70 <li>Partial syncs supported on a whole file basis</li> 71 <li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> mode to just copy new/changed files</li> 72 <li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one way) mode to make a directory identical</li> 73 <li><a href="https://rclone.org/commands/rclone_check/">Check</a> mode to check for file hash equality</li> 74 <li>Can sync to and from network, eg two different cloud accounts</li> 75 <li><a href="https://rclone.org/crypt/">Encryption</a> backend</li> 76 <li><a href="https://rclone.org/cache/">Cache</a> backend</li> 77 <li><a href="https://rclone.org/union/">Union</a> backend</li> 78 <li>Optional FUSE mount (<a href="https://rclone.org/commands/rclone_mount/">rclone mount</a>)</li> 79 <li>Multi-threaded downloads to local disk</li> 80 <li>Can <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> 81 </ul> 82 <p>Links</p> 83 <ul> 84 <li><a href="https://rclone.org/">Home page</a></li> 85 <li><a href="https://github.com/ncw/rclone">GitHub project page for source and bug tracker</a></li> 86 <li><a href="https://forum.rclone.org">Rclone Forum</a></li> 87 <li><a href="https://rclone.org/downloads/">Downloads</a></li> 88 </ul> 89 <h1 id="install">Install</h1> 90 <p>Rclone is a Go program and comes as a single binary file.</p> 91 <h2 id="quickstart">Quickstart</h2> 92 <ul> 93 <li><a href="https://rclone.org/downloads/">Download</a> the relevant binary.</li> 94 <li>Extract the <code>rclone</code> or <code>rclone.exe</code> binary from the archive</li> 95 <li>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</li> 96 </ul> 97 <p>See below for some expanded Linux / macOS instructions.</p> 98 <p>See the <a href="https://rclone.org/docs/">Usage section</a> of the docs for how to use rclone, or run <code>rclone -h</code>.</p> 99 <h2 id="script-installation">Script installation</h2> 100 <p>To install rclone on Linux/macOS/BSD systems, run:</p> 101 <pre><code>curl https://rclone.org/install.sh | sudo bash</code></pre> 102 <p>For beta installation, run:</p> 103 <pre><code>curl https://rclone.org/install.sh | sudo bash -s beta</code></pre> 104 <p>Note that this script checks the version of rclone installed first and won’t re-download if not needed.</p> 105 <h2 id="linux-installation-from-precompiled-binary">Linux installation from precompiled binary</h2> 106 <p>Fetch and unpack</p> 107 <pre><code>curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip 108 unzip rclone-current-linux-amd64.zip 109 cd rclone-*-linux-amd64</code></pre> 110 <p>Copy binary file</p> 111 <pre><code>sudo cp rclone /usr/bin/ 112 sudo chown root:root /usr/bin/rclone 113 sudo chmod 755 /usr/bin/rclone</code></pre> 114 <p>Install manpage</p> 115 <pre><code>sudo mkdir -p /usr/local/share/man/man1 116 sudo cp rclone.1 /usr/local/share/man/man1/ 117 sudo mandb </code></pre> 118 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 119 <pre><code>rclone config</code></pre> 120 <h2 id="macos-installation-from-precompiled-binary">macOS installation from precompiled binary</h2> 121 <p>Download the latest version of rclone.</p> 122 <pre><code>cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip</code></pre> 123 <p>Unzip the download and cd to the extracted folder.</p> 124 <pre><code>unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64</code></pre> 125 <p>Move rclone to your $PATH. You will be prompted for your password.</p> 126 <pre><code>sudo mkdir -p /usr/local/bin 127 sudo mv rclone /usr/local/bin/</code></pre> 128 <p>(the <code>mkdir</code> command is safe to run, even if the directory already exists).</p> 129 <p>Remove the leftover files.</p> 130 <pre><code>cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip</code></pre> 131 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 132 <pre><code>rclone config</code></pre> 133 <h2 id="install-from-source">Install from source</h2> 134 <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> 135 <pre><code>git clone https://github.com/ncw/rclone.git 136 cd rclone 137 go build 138 ./rclone version</code></pre> 139 <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> 140 <pre><code>go get -u -v github.com/ncw/rclone</code></pre> 141 <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/ncw/rclone</code> (<code>~/go/src/github.com/ncw/rclone</code> by default).</p> 142 <h2 id="installation-with-ansible">Installation with Ansible</h2> 143 <p>This can be done with <a href="https://github.com/stefangweichinger/ansible-rclone">Stefan Weichinger’s ansible role</a>.</p> 144 <p>Instructions</p> 145 <ol type="1"> 146 <li><code>git clone https://github.com/stefangweichinger/ansible-rclone.git</code> into your local roles-directory</li> 147 <li>add the role to the hosts you want rclone installed to:</li> 148 </ol> 149 <pre><code> - hosts: rclone-hosts 150 roles: 151 - rclone</code></pre> 152 <h2 id="configure">Configure</h2> 153 <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> 154 <p>The easiest way to make the config is to run rclone with the config option:</p> 155 <pre><code>rclone config</code></pre> 156 <p>See the following for detailed instructions for</p> 157 <ul> 158 <li><a href="https://rclone.org/alias/">Alias</a></li> 159 <li><a href="https://rclone.org/amazonclouddrive/">Amazon Drive</a></li> 160 <li><a href="https://rclone.org/s3/">Amazon S3</a></li> 161 <li><a href="https://rclone.org/b2/">Backblaze B2</a></li> 162 <li><a href="https://rclone.org/box/">Box</a></li> 163 <li><a href="https://rclone.org/cache/">Cache</a></li> 164 <li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other remotes</li> 165 <li><a href="/s3/#digitalocean-spaces">DigitalOcean Spaces</a></li> 166 <li><a href="https://rclone.org/dropbox/">Dropbox</a></li> 167 <li><a href="https://rclone.org/ftp/">FTP</a></li> 168 <li><a href="https://rclone.org/googlecloudstorage/">Google Cloud Storage</a></li> 169 <li><a href="https://rclone.org/drive/">Google Drive</a></li> 170 <li><a href="https://rclone.org/http/">HTTP</a></li> 171 <li><a href="https://rclone.org/hubic/">Hubic</a></li> 172 <li><a href="https://rclone.org/jottacloud/">Jottacloud</a></li> 173 <li><a href="https://rclone.org/koofr/">Koofr</a></li> 174 <li><a href="https://rclone.org/mega/">Mega</a></li> 175 <li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob Storage</a></li> 176 <li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li> 177 <li><a href="https://rclone.org/swift/">Openstack Swift / Rackspace Cloudfiles / Memset Memstore</a></li> 178 <li><a href="https://rclone.org/opendrive/">OpenDrive</a></li> 179 <li><a href="https://rclone.org/pcloud/">Pcloud</a></li> 180 <li><a href="https://rclone.org/qingstor/">QingStor</a></li> 181 <li><a href="https://rclone.org/sftp/">SFTP</a></li> 182 <li><a href="https://rclone.org/union/">Union</a></li> 183 <li><a href="https://rclone.org/webdav/">WebDAV</a></li> 184 <li><a href="https://rclone.org/yandex/">Yandex Disk</a></li> 185 <li><a href="https://rclone.org/local/">The local filesystem</a></li> 186 </ul> 187 <h2 id="usage">Usage</h2> 188 <p>Rclone syncs a directory tree from one storage system to another.</p> 189 <p>Its syntax is like this</p> 190 <pre><code>Syntax: [options] subcommand <parameters> <parameters...></code></pre> 191 <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> 192 <p>You can define as many storage paths as you like in the config file.</p> 193 <h2 id="subcommands">Subcommands</h2> 194 <p>rclone uses a system of subcommands. For example</p> 195 <pre><code>rclone ls remote:path # lists a remote 196 rclone copy /local/path remote:path # copies /local/path to the remote 197 rclone sync /local/path remote:path # syncs /local/path to the remote</code></pre> 198 <h2 id="rclone-config">rclone config</h2> 199 <p>Enter an interactive configuration session.</p> 200 <h3 id="synopsis">Synopsis</h3> 201 <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> 202 <pre><code>rclone config [flags]</code></pre> 203 <h3 id="options">Options</h3> 204 <pre><code> -h, --help help for config</code></pre> 205 <h3 id="see-also">SEE ALSO</h3> 206 <ul> 207 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 208 <li><a href="https://rclone.org/commands/rclone_config_create/">rclone config create</a> - Create a new remote with name, type and options.</li> 209 <li><a href="https://rclone.org/commands/rclone_config_delete/">rclone config delete</a> - Delete an existing remote <name>.</li> 210 <li><a href="https://rclone.org/commands/rclone_config_dump/">rclone config dump</a> - Dump the config file as JSON.</li> 211 <li><a href="https://rclone.org/commands/rclone_config_edit/">rclone config edit</a> - Enter an interactive configuration session.</li> 212 <li><a href="https://rclone.org/commands/rclone_config_file/">rclone config file</a> - Show path of configuration file in use.</li> 213 <li><a href="https://rclone.org/commands/rclone_config_password/">rclone config password</a> - Update password in an existing remote.</li> 214 <li><a href="https://rclone.org/commands/rclone_config_providers/">rclone config providers</a> - List in JSON format all the providers and options.</li> 215 <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> 216 <li><a href="https://rclone.org/commands/rclone_config_update/">rclone config update</a> - Update options in an existing remote.</li> 217 </ul> 218 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019">Auto generated by spf13/cobra on 15-Jun-2019</h6> 219 <h2 id="rclone-copy">rclone copy</h2> 220 <p>Copy files from source to dest, skipping already copied</p> 221 <h3 id="synopsis-1">Synopsis</h3> 222 <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> 223 <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> 224 <p>If dest:path doesn’t exist, it is created and the source:path contents go there.</p> 225 <p>For example</p> 226 <pre><code>rclone copy source:sourcepath dest:destpath</code></pre> 227 <p>Let’s say there are two files in sourcepath</p> 228 <pre><code>sourcepath/one.txt 229 sourcepath/two.txt</code></pre> 230 <p>This copies them to</p> 231 <pre><code>destpath/one.txt 232 destpath/two.txt</code></pre> 233 <p>Not to</p> 234 <pre><code>destpath/sourcepath/one.txt 235 destpath/sourcepath/two.txt</code></pre> 236 <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> 237 <p>See the <a href="/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> 238 <p>For example, if you have many files in /path/to/src but only a few of them change every day, you can to copy all the files which have changed recently very efficiently like this:</p> 239 <pre><code>rclone copy --max-age 24h --no-traverse /path/to/src remote:</code></pre> 240 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 241 <pre><code>rclone copy source:path dest:path [flags]</code></pre> 242 <h3 id="options-1">Options</h3> 243 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after copy 244 -h, --help help for copy</code></pre> 245 <h3 id="see-also-1">SEE ALSO</h3> 246 <ul> 247 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 248 </ul> 249 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-1">Auto generated by spf13/cobra on 15-Jun-2019</h6> 250 <h2 id="rclone-sync">rclone sync</h2> 251 <p>Make source and dest identical, modifying destination only.</p> 252 <h3 id="synopsis-2">Synopsis</h3> 253 <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> 254 <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> 255 <p>Note that files in the destination won’t be deleted if there were any errors at any point.</p> 256 <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> 257 <p>If dest:path doesn’t exist, it is created and the source:path contents go there.</p> 258 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 259 <pre><code>rclone sync source:path dest:path [flags]</code></pre> 260 <h3 id="options-2">Options</h3> 261 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after sync 262 -h, --help help for sync</code></pre> 263 <h3 id="see-also-2">SEE ALSO</h3> 264 <ul> 265 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 266 </ul> 267 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-2">Auto generated by spf13/cobra on 15-Jun-2019</h6> 268 <h2 id="rclone-move">rclone move</h2> 269 <p>Move files from source to dest.</p> 270 <h3 id="synopsis-3">Synopsis</h3> 271 <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> 272 <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 longer exist.</p> 273 <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> 274 <p>If you want to delete empty source directories after move, use the –delete-empty-src-dirs flag.</p> 275 <p>See the <a href="/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> 276 <p><strong>Important</strong>: Since this can cause data loss, test first with the –dry-run flag.</p> 277 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 278 <pre><code>rclone move source:path dest:path [flags]</code></pre> 279 <h3 id="options-3">Options</h3> 280 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after move 281 --delete-empty-src-dirs Delete empty source dirs after move 282 -h, --help help for move</code></pre> 283 <h3 id="see-also-3">SEE ALSO</h3> 284 <ul> 285 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 286 </ul> 287 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-3">Auto generated by spf13/cobra on 15-Jun-2019</h6> 288 <h2 id="rclone-delete">rclone delete</h2> 289 <p>Remove the contents of path.</p> 290 <h3 id="synopsis-4">Synopsis</h3> 291 <p>Remove the files in path. Unlike <code>purge</code> it obeys include/exclude filters so can be used to selectively delete files.</p> 292 <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> 293 <p>Eg delete all files bigger than 100MBytes</p> 294 <p>Check what would be deleted first (use either)</p> 295 <pre><code>rclone --min-size 100M lsl remote:path 296 rclone --dry-run --min-size 100M delete remote:path</code></pre> 297 <p>Then delete</p> 298 <pre><code>rclone --min-size 100M delete remote:path</code></pre> 299 <p>That reads “delete everything with a minimum size of 100 MB”, hence delete all files bigger than 100MBytes.</p> 300 <pre><code>rclone delete remote:path [flags]</code></pre> 301 <h3 id="options-4">Options</h3> 302 <pre><code> -h, --help help for delete</code></pre> 303 <h3 id="see-also-4">SEE ALSO</h3> 304 <ul> 305 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 306 </ul> 307 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-4">Auto generated by spf13/cobra on 15-Jun-2019</h6> 308 <h2 id="rclone-purge">rclone purge</h2> 309 <p>Remove the path and all of its contents.</p> 310 <h3 id="synopsis-5">Synopsis</h3> 311 <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> 312 <pre><code>rclone purge remote:path [flags]</code></pre> 313 <h3 id="options-5">Options</h3> 314 <pre><code> -h, --help help for purge</code></pre> 315 <h3 id="see-also-5">SEE ALSO</h3> 316 <ul> 317 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 318 </ul> 319 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-5">Auto generated by spf13/cobra on 15-Jun-2019</h6> 320 <h2 id="rclone-mkdir">rclone mkdir</h2> 321 <p>Make the path if it doesn’t already exist.</p> 322 <h3 id="synopsis-6">Synopsis</h3> 323 <p>Make the path if it doesn’t already exist.</p> 324 <pre><code>rclone mkdir remote:path [flags]</code></pre> 325 <h3 id="options-6">Options</h3> 326 <pre><code> -h, --help help for mkdir</code></pre> 327 <h3 id="see-also-6">SEE ALSO</h3> 328 <ul> 329 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 330 </ul> 331 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-6">Auto generated by spf13/cobra on 15-Jun-2019</h6> 332 <h2 id="rclone-rmdir">rclone rmdir</h2> 333 <p>Remove the path if empty.</p> 334 <h3 id="synopsis-7">Synopsis</h3> 335 <p>Remove the path. Note that you can’t remove a path with objects in it, use purge for that.</p> 336 <pre><code>rclone rmdir remote:path [flags]</code></pre> 337 <h3 id="options-7">Options</h3> 338 <pre><code> -h, --help help for rmdir</code></pre> 339 <h3 id="see-also-7">SEE ALSO</h3> 340 <ul> 341 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 342 </ul> 343 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-7">Auto generated by spf13/cobra on 15-Jun-2019</h6> 344 <h2 id="rclone-check">rclone check</h2> 345 <p>Checks the files in the source and destination match.</p> 346 <h3 id="synopsis-8">Synopsis</h3> 347 <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> 348 <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> 349 <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> 350 <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> 351 <pre><code>rclone check source:path dest:path [flags]</code></pre> 352 <h3 id="options-8">Options</h3> 353 <pre><code> --download Check by downloading rather than with hash. 354 -h, --help help for check 355 --one-way Check one way only, source files must exist on remote</code></pre> 356 <h3 id="see-also-8">SEE ALSO</h3> 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 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-8">Auto generated by spf13/cobra on 15-Jun-2019</h6> 361 <h2 id="rclone-ls">rclone ls</h2> 362 <p>List the objects in the path with size and path.</p> 363 <h3 id="synopsis-9">Synopsis</h3> 364 <p>Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default.</p> 365 <p>Eg</p> 366 <pre><code>$ rclone ls swift:bucket 367 60295 bevajer5jef 368 90613 canole 369 94467 diwogej7 370 37600 fubuwic</code></pre> 371 <p>Any of the filtering options can be applied to this command.</p> 372 <p>There are several related list commands</p> 373 <ul> 374 <li><code>ls</code> to list size and path of objects only</li> 375 <li><code>lsl</code> to list modification time, size and path of objects only</li> 376 <li><code>lsd</code> to list directories only</li> 377 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 378 <li><code>lsjson</code> to list objects and directories in JSON format</li> 379 </ul> 380 <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> 381 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 382 <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> 383 <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> 384 <pre><code>rclone ls remote:path [flags]</code></pre> 385 <h3 id="options-9">Options</h3> 386 <pre><code> -h, --help help for ls</code></pre> 387 <h3 id="see-also-9">SEE ALSO</h3> 388 <ul> 389 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 390 </ul> 391 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-9">Auto generated by spf13/cobra on 15-Jun-2019</h6> 392 <h2 id="rclone-lsd">rclone lsd</h2> 393 <p>List all directories/containers/buckets in the path.</p> 394 <h3 id="synopsis-10">Synopsis</h3> 395 <p>Lists the directories in the source path to standard output. Does not recurse by default. Use the -R flag to recurse.</p> 396 <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> 397 <pre><code>$ rclone lsd swift: 398 494000 2018-04-26 08:43:20 10000 10000files 399 65 2018-04-26 08:43:20 1 1File</code></pre> 400 <p>Or</p> 401 <pre><code>$ rclone lsd drive:test 402 -1 2016-10-17 17:41:53 -1 1000files 403 -1 2017-01-03 14:40:54 -1 2500files 404 -1 2017-07-08 14:39:28 -1 4000files</code></pre> 405 <p>If you just want the directory names use “rclone lsf –dirs-only”.</p> 406 <p>Any of the filtering options can be applied to this command.</p> 407 <p>There are several related list commands</p> 408 <ul> 409 <li><code>ls</code> to list size and path of objects only</li> 410 <li><code>lsl</code> to list modification time, size and path of objects only</li> 411 <li><code>lsd</code> to list directories only</li> 412 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 413 <li><code>lsjson</code> to list objects and directories in JSON format</li> 414 </ul> 415 <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> 416 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 417 <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> 418 <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> 419 <pre><code>rclone lsd remote:path [flags]</code></pre> 420 <h3 id="options-10">Options</h3> 421 <pre><code> -h, --help help for lsd 422 -R, --recursive Recurse into the listing.</code></pre> 423 <h3 id="see-also-10">SEE ALSO</h3> 424 <ul> 425 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 426 </ul> 427 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-10">Auto generated by spf13/cobra on 15-Jun-2019</h6> 428 <h2 id="rclone-lsl">rclone lsl</h2> 429 <p>List the objects in path with modification time, size and path.</p> 430 <h3 id="synopsis-11">Synopsis</h3> 431 <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> 432 <p>Eg</p> 433 <pre><code>$ rclone lsl swift:bucket 434 60295 2016-06-25 18:55:41.062626927 bevajer5jef 435 90613 2016-06-25 18:55:43.302607074 canole 436 94467 2016-06-25 18:55:43.046609333 diwogej7 437 37600 2016-06-25 18:55:40.814629136 fubuwic</code></pre> 438 <p>Any of the filtering options can be applied to this command.</p> 439 <p>There are several related list commands</p> 440 <ul> 441 <li><code>ls</code> to list size and path of objects only</li> 442 <li><code>lsl</code> to list modification time, size and path of objects only</li> 443 <li><code>lsd</code> to list directories only</li> 444 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 445 <li><code>lsjson</code> to list objects and directories in JSON format</li> 446 </ul> 447 <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> 448 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 449 <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> 450 <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> 451 <pre><code>rclone lsl remote:path [flags]</code></pre> 452 <h3 id="options-11">Options</h3> 453 <pre><code> -h, --help help for lsl</code></pre> 454 <h3 id="see-also-11">SEE ALSO</h3> 455 <ul> 456 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 457 </ul> 458 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-11">Auto generated by spf13/cobra on 15-Jun-2019</h6> 459 <h2 id="rclone-md5sum">rclone md5sum</h2> 460 <p>Produces an md5sum file for all the objects in the path.</p> 461 <h3 id="synopsis-12">Synopsis</h3> 462 <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> 463 <pre><code>rclone md5sum remote:path [flags]</code></pre> 464 <h3 id="options-12">Options</h3> 465 <pre><code> -h, --help help for md5sum</code></pre> 466 <h3 id="see-also-12">SEE ALSO</h3> 467 <ul> 468 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 469 </ul> 470 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-12">Auto generated by spf13/cobra on 15-Jun-2019</h6> 471 <h2 id="rclone-sha1sum">rclone sha1sum</h2> 472 <p>Produces an sha1sum file for all the objects in the path.</p> 473 <h3 id="synopsis-13">Synopsis</h3> 474 <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> 475 <pre><code>rclone sha1sum remote:path [flags]</code></pre> 476 <h3 id="options-13">Options</h3> 477 <pre><code> -h, --help help for sha1sum</code></pre> 478 <h3 id="see-also-13">SEE ALSO</h3> 479 <ul> 480 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 481 </ul> 482 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-13">Auto generated by spf13/cobra on 15-Jun-2019</h6> 483 <h2 id="rclone-size">rclone size</h2> 484 <p>Prints the total size and number of objects in remote:path.</p> 485 <h3 id="synopsis-14">Synopsis</h3> 486 <p>Prints the total size and number of objects in remote:path.</p> 487 <pre><code>rclone size remote:path [flags]</code></pre> 488 <h3 id="options-14">Options</h3> 489 <pre><code> -h, --help help for size 490 --json format output as JSON</code></pre> 491 <h3 id="see-also-14">SEE ALSO</h3> 492 <ul> 493 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 494 </ul> 495 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-14">Auto generated by spf13/cobra on 15-Jun-2019</h6> 496 <h2 id="rclone-version">rclone version</h2> 497 <p>Show the version number.</p> 498 <h3 id="synopsis-15">Synopsis</h3> 499 <p>Show the version number, the go version and the architecture.</p> 500 <p>Eg</p> 501 <pre><code>$ rclone version 502 rclone v1.41 503 - os/arch: linux/amd64 504 - go version: go1.10</code></pre> 505 <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> 506 <pre><code>$ rclone version --check 507 yours: 1.42.0.6 508 latest: 1.42 (released 2018-06-16) 509 beta: 1.42.0.5 (released 2018-06-17)</code></pre> 510 <p>Or</p> 511 <pre><code>$ rclone version --check 512 yours: 1.41 513 latest: 1.42 (released 2018-06-16) 514 upgrade: https://downloads.rclone.org/v1.42 515 beta: 1.42.0.5 (released 2018-06-17) 516 upgrade: https://beta.rclone.org/v1.42-005-g56e1e820</code></pre> 517 <pre><code>rclone version [flags]</code></pre> 518 <h3 id="options-15">Options</h3> 519 <pre><code> --check Check for new version. 520 -h, --help help for version</code></pre> 521 <h3 id="see-also-15">SEE ALSO</h3> 522 <ul> 523 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 524 </ul> 525 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-15">Auto generated by spf13/cobra on 15-Jun-2019</h6> 526 <h2 id="rclone-cleanup">rclone cleanup</h2> 527 <p>Clean up the remote if possible</p> 528 <h3 id="synopsis-16">Synopsis</h3> 529 <p>Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.</p> 530 <pre><code>rclone cleanup remote:path [flags]</code></pre> 531 <h3 id="options-16">Options</h3> 532 <pre><code> -h, --help help for cleanup</code></pre> 533 <h3 id="see-also-16">SEE ALSO</h3> 534 <ul> 535 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 536 </ul> 537 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-16">Auto generated by spf13/cobra on 15-Jun-2019</h6> 538 <h2 id="rclone-dedupe">rclone dedupe</h2> 539 <p>Interactively find duplicate files and delete/rename them.</p> 540 <h3 id="synopsis-17">Synopsis</h3> 541 <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> 542 <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> 543 <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> 544 <p>Here is an example run.</p> 545 <p>Before - with duplicates</p> 546 <pre><code>$ rclone lsl drive:dupes 547 6048320 2016-03-05 16:23:16.798000000 one.txt 548 6048320 2016-03-05 16:23:11.775000000 one.txt 549 564374 2016-03-05 16:23:06.731000000 one.txt 550 6048320 2016-03-05 16:18:26.092000000 one.txt 551 6048320 2016-03-05 16:22:46.185000000 two.txt 552 1744073 2016-03-05 16:22:38.104000000 two.txt 553 564374 2016-03-05 16:22:52.118000000 two.txt</code></pre> 554 <p>Now the <code>dedupe</code> session</p> 555 <pre><code>$ rclone dedupe drive:dupes 556 2016/03/05 16:24:37 Google drive root 'dupes': Looking for duplicates using interactive mode. 557 one.txt: Found 4 duplicates - deleting identical copies 558 one.txt: Deleting 2/3 identical duplicates (md5sum "1eedaa9fe86fd4b8632e2ac549403b36") 559 one.txt: 2 duplicates remain 560 1: 6048320 bytes, 2016-03-05 16:23:16.798000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 561 2: 564374 bytes, 2016-03-05 16:23:06.731000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 562 s) Skip and do nothing 563 k) Keep just one (choose which in next step) 564 r) Rename all to be different (by changing file.jpg to file-1.jpg) 565 s/k/r> k 566 Enter the number of the file to keep> 1 567 one.txt: Deleted 1 extra copies 568 two.txt: Found 3 duplicates - deleting identical copies 569 two.txt: 3 duplicates remain 570 1: 564374 bytes, 2016-03-05 16:22:52.118000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 571 2: 6048320 bytes, 2016-03-05 16:22:46.185000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 572 3: 1744073 bytes, 2016-03-05 16:22:38.104000000, md5sum 851957f7fb6f0bc4ce76be966d336802 573 s) Skip and do nothing 574 k) Keep just one (choose which in next step) 575 r) Rename all to be different (by changing file.jpg to file-1.jpg) 576 s/k/r> r 577 two-1.txt: renamed from: two.txt 578 two-2.txt: renamed from: two.txt 579 two-3.txt: renamed from: two.txt</code></pre> 580 <p>The result being</p> 581 <pre><code>$ rclone lsl drive:dupes 582 6048320 2016-03-05 16:23:16.798000000 one.txt 583 564374 2016-03-05 16:22:52.118000000 two-1.txt 584 6048320 2016-03-05 16:22:46.185000000 two-2.txt 585 1744073 2016-03-05 16:22:38.104000000 two-3.txt</code></pre> 586 <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> 587 <ul> 588 <li><code>--dedupe-mode interactive</code> - interactive as above.</li> 589 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 590 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 591 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 592 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 593 <li><code>--dedupe-mode largest</code> - removes identical files then keeps the largest one.</li> 594 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 595 </ul> 596 <p>For example to rename all the identically named photos in your Google Photos directory, do</p> 597 <pre><code>rclone dedupe --dedupe-mode rename "drive:Google Photos"</code></pre> 598 <p>Or</p> 599 <pre><code>rclone dedupe rename "drive:Google Photos"</code></pre> 600 <pre><code>rclone dedupe [mode] remote:path [flags]</code></pre> 601 <h3 id="options-17">Options</h3> 602 <pre><code> --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") 603 -h, --help help for dedupe</code></pre> 604 <h3 id="see-also-17">SEE ALSO</h3> 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 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-17">Auto generated by spf13/cobra on 15-Jun-2019</h6> 609 <h2 id="rclone-about">rclone about</h2> 610 <p>Get quota information from the remote.</p> 611 <h3 id="synopsis-18">Synopsis</h3> 612 <p>Get quota information from the remote, like bytes used/free/quota and bytes used in the trash. Not supported by all remotes.</p> 613 <p>This will print to stdout something like this:</p> 614 <pre><code>Total: 17G 615 Used: 7.444G 616 Free: 1.315G 617 Trashed: 100.000M 618 Other: 8.241G</code></pre> 619 <p>Where the fields are:</p> 620 <ul> 621 <li>Total: total size available.</li> 622 <li>Used: total size used</li> 623 <li>Free: total amount this user could upload.</li> 624 <li>Trashed: total amount in the trash</li> 625 <li>Other: total amount in other storage (eg Gmail, Google Photos)</li> 626 <li>Objects: total number of objects in the storage</li> 627 </ul> 628 <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> 629 <p>Use the –full flag to see the numbers written out in full, eg</p> 630 <pre><code>Total: 18253611008 631 Used: 7993453766 632 Free: 1411001220 633 Trashed: 104857602 634 Other: 8849156022</code></pre> 635 <p>Use the –json flag for a computer readable output, eg</p> 636 <pre><code>{ 637 "total": 18253611008, 638 "used": 7993453766, 639 "trashed": 104857602, 640 "other": 8849156022, 641 "free": 1411001220 642 }</code></pre> 643 <pre><code>rclone about remote: [flags]</code></pre> 644 <h3 id="options-18">Options</h3> 645 <pre><code> --full Full numbers instead of SI units 646 -h, --help help for about 647 --json Format output as JSON</code></pre> 648 <h3 id="see-also-18">SEE ALSO</h3> 649 <ul> 650 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 651 </ul> 652 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-18">Auto generated by spf13/cobra on 15-Jun-2019</h6> 653 <h2 id="rclone-authorize">rclone authorize</h2> 654 <p>Remote authorization.</p> 655 <h3 id="synopsis-19">Synopsis</h3> 656 <p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p> 657 <pre><code>rclone authorize [flags]</code></pre> 658 <h3 id="options-19">Options</h3> 659 <pre><code> -h, --help help for authorize</code></pre> 660 <h3 id="see-also-19">SEE ALSO</h3> 661 <ul> 662 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 663 </ul> 664 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-19">Auto generated by spf13/cobra on 15-Jun-2019</h6> 665 <h2 id="rclone-cachestats">rclone cachestats</h2> 666 <p>Print cache stats for a remote</p> 667 <h3 id="synopsis-20">Synopsis</h3> 668 <p>Print cache stats for a remote in JSON format</p> 669 <pre><code>rclone cachestats source: [flags]</code></pre> 670 <h3 id="options-20">Options</h3> 671 <pre><code> -h, --help help for cachestats</code></pre> 672 <h3 id="see-also-20">SEE ALSO</h3> 673 <ul> 674 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 675 </ul> 676 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-20">Auto generated by spf13/cobra on 15-Jun-2019</h6> 677 <h2 id="rclone-cat">rclone cat</h2> 678 <p>Concatenates any files and sends them to stdout.</p> 679 <h3 id="synopsis-21">Synopsis</h3> 680 <p>rclone cat sends any files to standard output.</p> 681 <p>You can use it like this to output a single file</p> 682 <pre><code>rclone cat remote:path/to/file</code></pre> 683 <p>Or like this to output any file in dir or subdirectories.</p> 684 <pre><code>rclone cat remote:path/to/dir</code></pre> 685 <p>Or like this to output any .txt files in dir or subdirectories.</p> 686 <pre><code>rclone --include "*.txt" cat remote:path/to/dir</code></pre> 687 <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> 688 <pre><code>rclone cat remote:path [flags]</code></pre> 689 <h3 id="options-21">Options</h3> 690 <pre><code> --count int Only print N characters. (default -1) 691 --discard Discard the output instead of printing. 692 --head int Only print the first N characters. 693 -h, --help help for cat 694 --offset int Start printing at offset N (or from end if -ve). 695 --tail int Only print the last N characters.</code></pre> 696 <h3 id="see-also-21">SEE ALSO</h3> 697 <ul> 698 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 699 </ul> 700 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-21">Auto generated by spf13/cobra on 15-Jun-2019</h6> 701 <h2 id="rclone-config-create">rclone config create</h2> 702 <p>Create a new remote with name, type and options.</p> 703 <h3 id="synopsis-22">Synopsis</h3> 704 <p>Create a new remote of <name> with <type> and options. The options should be passed in in pairs of <key> <value>.</p> 705 <p>For example to make a swift remote of name myremote using auto config you would do:</p> 706 <pre><code>rclone config create myremote swift env_auth true</code></pre> 707 <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> 708 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them before putting them in the config file.</p> 709 <p>So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this:</p> 710 <pre><code>rclone config create mydrive drive config_is_local false</code></pre> 711 <pre><code>rclone config create <name> <type> [<key> <value>]* [flags]</code></pre> 712 <h3 id="options-22">Options</h3> 713 <pre><code> -h, --help help for create</code></pre> 714 <h3 id="see-also-22">SEE ALSO</h3> 715 <ul> 716 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 717 </ul> 718 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-22">Auto generated by spf13/cobra on 15-Jun-2019</h6> 719 <h2 id="rclone-config-delete">rclone config delete</h2> 720 <p>Delete an existing remote <name>.</p> 721 <h3 id="synopsis-23">Synopsis</h3> 722 <p>Delete an existing remote <name>.</p> 723 <pre><code>rclone config delete <name> [flags]</code></pre> 724 <h3 id="options-23">Options</h3> 725 <pre><code> -h, --help help for delete</code></pre> 726 <h3 id="see-also-23">SEE ALSO</h3> 727 <ul> 728 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 729 </ul> 730 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-23">Auto generated by spf13/cobra on 15-Jun-2019</h6> 731 <h2 id="rclone-config-dump">rclone config dump</h2> 732 <p>Dump the config file as JSON.</p> 733 <h3 id="synopsis-24">Synopsis</h3> 734 <p>Dump the config file as JSON.</p> 735 <pre><code>rclone config dump [flags]</code></pre> 736 <h3 id="options-24">Options</h3> 737 <pre><code> -h, --help help for dump</code></pre> 738 <h3 id="see-also-24">SEE ALSO</h3> 739 <ul> 740 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 741 </ul> 742 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-24">Auto generated by spf13/cobra on 15-Jun-2019</h6> 743 <h2 id="rclone-config-edit">rclone config edit</h2> 744 <p>Enter an interactive configuration session.</p> 745 <h3 id="synopsis-25">Synopsis</h3> 746 <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> 747 <pre><code>rclone config edit [flags]</code></pre> 748 <h3 id="options-25">Options</h3> 749 <pre><code> -h, --help help for edit</code></pre> 750 <h3 id="see-also-25">SEE ALSO</h3> 751 <ul> 752 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 753 </ul> 754 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-25">Auto generated by spf13/cobra on 15-Jun-2019</h6> 755 <h2 id="rclone-config-file">rclone config file</h2> 756 <p>Show path of configuration file in use.</p> 757 <h3 id="synopsis-26">Synopsis</h3> 758 <p>Show path of configuration file in use.</p> 759 <pre><code>rclone config file [flags]</code></pre> 760 <h3 id="options-26">Options</h3> 761 <pre><code> -h, --help help for file</code></pre> 762 <h3 id="see-also-26">SEE ALSO</h3> 763 <ul> 764 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 765 </ul> 766 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-26">Auto generated by spf13/cobra on 15-Jun-2019</h6> 767 <h2 id="rclone-config-password">rclone config password</h2> 768 <p>Update password in an existing remote.</p> 769 <h3 id="synopsis-27">Synopsis</h3> 770 <p>Update an existing remote’s password. The password should be passed in in pairs of <key> <value>.</p> 771 <p>For example to set password of a remote of name myremote you would do:</p> 772 <pre><code>rclone config password myremote fieldname mypassword</code></pre> 773 <p>This command is obsolete now that “config update” and “config create” both support obscuring passwords directly.</p> 774 <pre><code>rclone config password <name> [<key> <value>]+ [flags]</code></pre> 775 <h3 id="options-27">Options</h3> 776 <pre><code> -h, --help help for password</code></pre> 777 <h3 id="see-also-27">SEE ALSO</h3> 778 <ul> 779 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 780 </ul> 781 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-27">Auto generated by spf13/cobra on 15-Jun-2019</h6> 782 <h2 id="rclone-config-providers">rclone config providers</h2> 783 <p>List in JSON format all the providers and options.</p> 784 <h3 id="synopsis-28">Synopsis</h3> 785 <p>List in JSON format all the providers and options.</p> 786 <pre><code>rclone config providers [flags]</code></pre> 787 <h3 id="options-28">Options</h3> 788 <pre><code> -h, --help help for providers</code></pre> 789 <h3 id="see-also-28">SEE ALSO</h3> 790 <ul> 791 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 792 </ul> 793 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-28">Auto generated by spf13/cobra on 15-Jun-2019</h6> 794 <h2 id="rclone-config-show">rclone config show</h2> 795 <p>Print (decrypted) config file, or the config for a single remote.</p> 796 <h3 id="synopsis-29">Synopsis</h3> 797 <p>Print (decrypted) config file, or the config for a single remote.</p> 798 <pre><code>rclone config show [<remote>] [flags]</code></pre> 799 <h3 id="options-29">Options</h3> 800 <pre><code> -h, --help help for show</code></pre> 801 <h3 id="see-also-29">SEE ALSO</h3> 802 <ul> 803 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 804 </ul> 805 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-29">Auto generated by spf13/cobra on 15-Jun-2019</h6> 806 <h2 id="rclone-config-update">rclone config update</h2> 807 <p>Update options in an existing remote.</p> 808 <h3 id="synopsis-30">Synopsis</h3> 809 <p>Update an existing remote’s options. The options should be passed in in pairs of <key> <value>.</p> 810 <p>For example to update the env_auth field of a remote of name myremote you would do:</p> 811 <pre><code>rclone config update myremote swift env_auth true</code></pre> 812 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them before putting them in the config file.</p> 813 <p>If the remote uses oauth the token will be updated, if you don’t require this add an extra parameter thus:</p> 814 <pre><code>rclone config update myremote swift env_auth true config_refresh_token false</code></pre> 815 <pre><code>rclone config update <name> [<key> <value>]+ [flags]</code></pre> 816 <h3 id="options-30">Options</h3> 817 <pre><code> -h, --help help for update</code></pre> 818 <h3 id="see-also-30">SEE ALSO</h3> 819 <ul> 820 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 821 </ul> 822 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-30">Auto generated by spf13/cobra on 15-Jun-2019</h6> 823 <h2 id="rclone-copyto">rclone copyto</h2> 824 <p>Copy files from source to dest, skipping already copied</p> 825 <h3 id="synopsis-31">Synopsis</h3> 826 <p>If source:path is a file or directory then it copies it to a file or directory named dest:path.</p> 827 <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> 828 <p>So</p> 829 <pre><code>rclone copyto src dst</code></pre> 830 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 831 <p>This will:</p> 832 <pre><code>if src is file 833 copy it to dst, overwriting an existing file if it exists 834 if src is directory 835 copy it to dst, overwriting existing files if they exist 836 see copy command for full details</code></pre> 837 <p>This doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. It doesn’t delete files from the destination.</p> 838 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 839 <pre><code>rclone copyto source:path dest:path [flags]</code></pre> 840 <h3 id="options-31">Options</h3> 841 <pre><code> -h, --help help for copyto</code></pre> 842 <h3 id="see-also-31">SEE ALSO</h3> 843 <ul> 844 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 845 </ul> 846 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-31">Auto generated by spf13/cobra on 15-Jun-2019</h6> 847 <h2 id="rclone-copyurl">rclone copyurl</h2> 848 <p>Copy url content to dest.</p> 849 <h3 id="synopsis-32">Synopsis</h3> 850 <p>Download urls content and copy it to destination without saving it in tmp storage.</p> 851 <pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre> 852 <h3 id="options-32">Options</h3> 853 <pre><code> -h, --help help for copyurl</code></pre> 854 <h3 id="see-also-32">SEE ALSO</h3> 855 <ul> 856 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 857 </ul> 858 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-32">Auto generated by spf13/cobra on 15-Jun-2019</h6> 859 <h2 id="rclone-cryptcheck">rclone cryptcheck</h2> 860 <p>Cryptcheck checks the integrity of a crypted remote.</p> 861 <h3 id="synopsis-33">Synopsis</h3> 862 <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> 863 <p>For it to work the underlying remote of the cryptedremote must support some kind of checksum.</p> 864 <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> 865 <p>Use it like this</p> 866 <pre><code>rclone cryptcheck /path/to/files encryptedremote:path</code></pre> 867 <p>You can use it like this also, but that will involve downloading all the files in remote:path.</p> 868 <pre><code>rclone cryptcheck remote:path encryptedremote:path</code></pre> 869 <p>After it has run it will log the status of the encryptedremote:.</p> 870 <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> 871 <pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre> 872 <h3 id="options-33">Options</h3> 873 <pre><code> -h, --help help for cryptcheck 874 --one-way Check one way only, source files must exist on destination</code></pre> 875 <h3 id="see-also-33">SEE ALSO</h3> 876 <ul> 877 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 878 </ul> 879 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-33">Auto generated by spf13/cobra on 15-Jun-2019</h6> 880 <h2 id="rclone-cryptdecode">rclone cryptdecode</h2> 881 <p>Cryptdecode returns unencrypted file names.</p> 882 <h3 id="synopsis-34">Synopsis</h3> 883 <p>rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items.</p> 884 <p>If you supply the –reverse flag, it will return encrypted file names.</p> 885 <p>use it like this</p> 886 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 887 888 rclone cryptdecode --reverse encryptedremote: filename1 filename2</code></pre> 889 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre> 890 <h3 id="options-34">Options</h3> 891 <pre><code> -h, --help help for cryptdecode 892 --reverse Reverse cryptdecode, encrypts filenames</code></pre> 893 <h3 id="see-also-34">SEE ALSO</h3> 894 <ul> 895 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 896 </ul> 897 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-34">Auto generated by spf13/cobra on 15-Jun-2019</h6> 898 <h2 id="rclone-dbhashsum">rclone dbhashsum</h2> 899 <p>Produces a Dropbox hash file for all the objects in the path.</p> 900 <h3 id="synopsis-35">Synopsis</h3> 901 <p>Produces a Dropbox hash file for all the objects in the path. The hashes are calculated according to <a href="https://www.dropbox.com/developers/reference/content-hash">Dropbox content hash rules</a>. The output is in the same format as md5sum and sha1sum.</p> 902 <pre><code>rclone dbhashsum remote:path [flags]</code></pre> 903 <h3 id="options-35">Options</h3> 904 <pre><code> -h, --help help for dbhashsum</code></pre> 905 <h3 id="see-also-35">SEE ALSO</h3> 906 <ul> 907 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 908 </ul> 909 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-35">Auto generated by spf13/cobra on 15-Jun-2019</h6> 910 <h2 id="rclone-deletefile">rclone deletefile</h2> 911 <p>Remove a single file from remote.</p> 912 <h3 id="synopsis-36">Synopsis</h3> 913 <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> 914 <pre><code>rclone deletefile remote:path [flags]</code></pre> 915 <h3 id="options-36">Options</h3> 916 <pre><code> -h, --help help for deletefile</code></pre> 917 <h3 id="see-also-36">SEE ALSO</h3> 918 <ul> 919 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 920 </ul> 921 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-36">Auto generated by spf13/cobra on 15-Jun-2019</h6> 922 <h2 id="rclone-genautocomplete">rclone genautocomplete</h2> 923 <p>Output completion script for a given shell.</p> 924 <h3 id="synopsis-37">Synopsis</h3> 925 <p>Generates a shell completion script for rclone. Run with –help to list the supported shells.</p> 926 <h3 id="options-37">Options</h3> 927 <pre><code> -h, --help help for genautocomplete</code></pre> 928 <h3 id="see-also-37">SEE ALSO</h3> 929 <ul> 930 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 931 <li><a href="https://rclone.org/commands/rclone_genautocomplete_bash/">rclone genautocomplete bash</a> - Output bash completion script for rclone.</li> 932 <li><a href="https://rclone.org/commands/rclone_genautocomplete_zsh/">rclone genautocomplete zsh</a> - Output zsh completion script for rclone.</li> 933 </ul> 934 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-37">Auto generated by spf13/cobra on 15-Jun-2019</h6> 935 <h2 id="rclone-genautocomplete-bash">rclone genautocomplete bash</h2> 936 <p>Output bash completion script for rclone.</p> 937 <h3 id="synopsis-38">Synopsis</h3> 938 <p>Generates a bash shell autocompletion script for rclone.</p> 939 <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> 940 <pre><code>sudo rclone genautocomplete bash</code></pre> 941 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 942 <pre><code>. /etc/bash_completion</code></pre> 943 <p>If you supply a command line argument the script will be written there.</p> 944 <pre><code>rclone genautocomplete bash [output_file] [flags]</code></pre> 945 <h3 id="options-38">Options</h3> 946 <pre><code> -h, --help help for bash</code></pre> 947 <h3 id="see-also-38">SEE ALSO</h3> 948 <ul> 949 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 950 </ul> 951 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-38">Auto generated by spf13/cobra on 15-Jun-2019</h6> 952 <h2 id="rclone-genautocomplete-zsh">rclone genautocomplete zsh</h2> 953 <p>Output zsh completion script for rclone.</p> 954 <h3 id="synopsis-39">Synopsis</h3> 955 <p>Generates a zsh autocompletion script for rclone.</p> 956 <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> 957 <pre><code>sudo rclone genautocomplete zsh</code></pre> 958 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 959 <pre><code>autoload -U compinit && compinit</code></pre> 960 <p>If you supply a command line argument the script will be written there.</p> 961 <pre><code>rclone genautocomplete zsh [output_file] [flags]</code></pre> 962 <h3 id="options-39">Options</h3> 963 <pre><code> -h, --help help for zsh</code></pre> 964 <h3 id="see-also-39">SEE ALSO</h3> 965 <ul> 966 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 967 </ul> 968 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-39">Auto generated by spf13/cobra on 15-Jun-2019</h6> 969 <h2 id="rclone-gendocs">rclone gendocs</h2> 970 <p>Output markdown docs for rclone to the directory supplied.</p> 971 <h3 id="synopsis-40">Synopsis</h3> 972 <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> 973 <pre><code>rclone gendocs output_directory [flags]</code></pre> 974 <h3 id="options-40">Options</h3> 975 <pre><code> -h, --help help for gendocs</code></pre> 976 <h3 id="see-also-40">SEE ALSO</h3> 977 <ul> 978 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 979 </ul> 980 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-40">Auto generated by spf13/cobra on 15-Jun-2019</h6> 981 <h2 id="rclone-hashsum">rclone hashsum</h2> 982 <p>Produces an hashsum file for all the objects in the path.</p> 983 <h3 id="synopsis-41">Synopsis</h3> 984 <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> 985 <p>Run without a hash to see the list of supported hashes, eg</p> 986 <pre><code>$ rclone hashsum 987 Supported hashes are: 988 * MD5 989 * SHA-1 990 * DropboxHash 991 * QuickXorHash</code></pre> 992 <p>Then</p> 993 <pre><code>$ rclone hashsum MD5 remote:path</code></pre> 994 <pre><code>rclone hashsum <hash> remote:path [flags]</code></pre> 995 <h3 id="options-41">Options</h3> 996 <pre><code> -h, --help help for hashsum</code></pre> 997 <h3 id="see-also-41">SEE ALSO</h3> 998 <ul> 999 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1000 </ul> 1001 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-41">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1002 <h2 id="rclone-link">rclone link</h2> 1003 <p>Generate public link to file/folder.</p> 1004 <h3 id="synopsis-42">Synopsis</h3> 1005 <p>rclone link will create or retrieve a public link to the given file or folder.</p> 1006 <pre><code>rclone link remote:path/to/file 1007 rclone link remote:path/to/folder/</code></pre> 1008 <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> 1009 <pre><code>rclone link remote:path [flags]</code></pre> 1010 <h3 id="options-42">Options</h3> 1011 <pre><code> -h, --help help for link</code></pre> 1012 <h3 id="see-also-42">SEE ALSO</h3> 1013 <ul> 1014 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1015 </ul> 1016 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-42">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1017 <h2 id="rclone-listremotes">rclone listremotes</h2> 1018 <p>List all the remotes in the config file.</p> 1019 <h3 id="synopsis-43">Synopsis</h3> 1020 <p>rclone listremotes lists all the available remotes from the config file.</p> 1021 <p>When uses with the -l flag it lists the types too.</p> 1022 <pre><code>rclone listremotes [flags]</code></pre> 1023 <h3 id="options-43">Options</h3> 1024 <pre><code> -h, --help help for listremotes 1025 --long Show the type as well as names.</code></pre> 1026 <h3 id="see-also-43">SEE ALSO</h3> 1027 <ul> 1028 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1029 </ul> 1030 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-43">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1031 <h2 id="rclone-lsf">rclone lsf</h2> 1032 <p>List directories and objects in remote:path formatted for parsing</p> 1033 <h3 id="synopsis-44">Synopsis</h3> 1034 <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> 1035 <p>Eg</p> 1036 <pre><code>$ rclone lsf swift:bucket 1037 bevajer5jef 1038 canole 1039 diwogej7 1040 ferejej3gux/ 1041 fubuwic</code></pre> 1042 <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> 1043 <pre><code>p - path 1044 s - size 1045 t - modification time 1046 h - hash 1047 i - ID of object 1048 o - Original ID of underlying object 1049 m - MimeType of object if known 1050 e - encrypted name 1051 T - tier of storage if known, eg "Hot" or "Cool"</code></pre> 1052 <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> 1053 <p>Eg</p> 1054 <pre><code>$ rclone lsf --format "tsp" swift:bucket 1055 2016-06-25 18:55:41;60295;bevajer5jef 1056 2016-06-25 18:55:43;90613;canole 1057 2016-06-25 18:55:43;94467;diwogej7 1058 2018-04-26 08:50:45;0;ferejej3gux/ 1059 2016-06-25 18:55:40;37600;fubuwic</code></pre> 1060 <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> 1061 <p>For example to emulate the md5sum command you can use</p> 1062 <pre><code>rclone lsf -R --hash MD5 --format hp --separator " " --files-only .</code></pre> 1063 <p>Eg</p> 1064 <pre><code>$ rclone lsf -R --hash MD5 --format hp --separator " " --files-only swift:bucket 1065 7908e352297f0f530b84a756f188baa3 bevajer5jef 1066 cd65ac234e6fea5925974a51cdd865cc canole 1067 03b5341b4f234b9d984d03ad076bae91 diwogej7 1068 8fd37c3810dd660778137ac3a66cc06d fubuwic 1069 99713e14a4c4ff553acaf1930fad985b gixacuh7ku</code></pre> 1070 <p>(Though “rclone md5sum .” is an easier way of typing this.)</p> 1071 <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> 1072 <p>Eg</p> 1073 <pre><code>$ rclone lsf --separator "," --format "tshp" swift:bucket 1074 2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef 1075 2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole 1076 2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 1077 2018-04-26 08:52:53,0,,ferejej3gux/ 1078 2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</code></pre> 1079 <p>You can output in CSV standard format. This will escape things in " if they contain ,</p> 1080 <p>Eg</p> 1081 <pre><code>$ rclone lsf --csv --files-only --format ps remote:path 1082 test.log,22355 1083 test.sh,449 1084 "this file contains a comma, in the file name.txt",6</code></pre> 1085 <p>Note that the –absolute parameter is useful for making lists of files to pass to an rclone copy with the –files-from flag.</p> 1086 <p>For example to find all the files modified within one day and copy those only (without traversing the whole directory structure):</p> 1087 <pre><code>rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files 1088 rclone copy --files-from new_files /path/to/local remote:path</code></pre> 1089 <p>Any of the filtering options can be applied to this command.</p> 1090 <p>There are several related list commands</p> 1091 <ul> 1092 <li><code>ls</code> to list size and path of objects only</li> 1093 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1094 <li><code>lsd</code> to list directories only</li> 1095 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1096 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1097 </ul> 1098 <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> 1099 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 1100 <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> 1101 <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> 1102 <pre><code>rclone lsf remote:path [flags]</code></pre> 1103 <h3 id="options-44">Options</h3> 1104 <pre><code> --absolute Put a leading / in front of path names. 1105 --csv Output in CSV format. 1106 -d, --dir-slash Append a slash to directory names. (default true) 1107 --dirs-only Only list directories. 1108 --files-only Only list files. 1109 -F, --format string Output format - see help for details (default "p") 1110 --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "MD5") 1111 -h, --help help for lsf 1112 -R, --recursive Recurse into the listing. 1113 -s, --separator string Separator for the items in the format. (default ";")</code></pre> 1114 <h3 id="see-also-44">SEE ALSO</h3> 1115 <ul> 1116 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1117 </ul> 1118 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-44">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1119 <h2 id="rclone-lsjson">rclone lsjson</h2> 1120 <p>List directories and objects in the path in JSON format.</p> 1121 <h3 id="synopsis-45">Synopsis</h3> 1122 <p>List directories and objects in the path in JSON format.</p> 1123 <p>The output is an array of Items, where each Item looks like this</p> 1124 <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> 1125 <p>If –hash is not specified the Hashes property won’t be emitted.</p> 1126 <p>If –no-modtime is specified then ModTime will be blank.</p> 1127 <p>If –encrypted is not specified the Encrypted won’t be emitted.</p> 1128 <p>If –dirs-only is not specified files in addition to directories are returned</p> 1129 <p>If –files-only is not specified directories in addition to the files will be returned.</p> 1130 <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> 1131 <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> 1132 <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> 1133 <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> 1134 <p>Any of the filtering options can be applied to this command.</p> 1135 <p>There are several related list commands</p> 1136 <ul> 1137 <li><code>ls</code> to list size and path of objects only</li> 1138 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1139 <li><code>lsd</code> to list directories only</li> 1140 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1141 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1142 </ul> 1143 <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> 1144 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use “–max-depth 1” to stop the recursion.</p> 1145 <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> 1146 <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> 1147 <pre><code>rclone lsjson remote:path [flags]</code></pre> 1148 <h3 id="options-45">Options</h3> 1149 <pre><code> --dirs-only Show only directories in the listing. 1150 -M, --encrypted Show the encrypted names. 1151 --files-only Show only files in the listing. 1152 --hash Include hashes in the output (may take longer). 1153 -h, --help help for lsjson 1154 --no-modtime Don't read the modification time (can speed things up). 1155 --original Show the ID of the underlying Object. 1156 -R, --recursive Recurse into the listing.</code></pre> 1157 <h3 id="see-also-45">SEE ALSO</h3> 1158 <ul> 1159 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1160 </ul> 1161 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-45">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1162 <h2 id="rclone-mount">rclone mount</h2> 1163 <p>Mount the remote as file system on a mountpoint.</p> 1164 <h3 id="synopsis-46">Synopsis</h3> 1165 <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> 1166 <p>First set up your remote using <code>rclone config</code>. Check it works with <code>rclone ls</code> etc.</p> 1167 <p>Start the mount like this</p> 1168 <pre><code>rclone mount remote:path/to/files /path/to/local/mount</code></pre> 1169 <p>Or on Windows like this where X: is an unused drive letter</p> 1170 <pre><code>rclone mount remote:path/to/files X:</code></pre> 1171 <p>When the program ends, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped.</p> 1172 <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 with</p> 1173 <pre><code># Linux 1174 fusermount -u /path/to/local/mount 1175 # OS X 1176 umount /path/to/local/mount</code></pre> 1177 <h3 id="installing-on-windows">Installing on Windows</h3> 1178 <p>To run rclone mount on Windows, you will need to download and install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p> 1179 <p>WinFsp is an <a href="https://github.com/billziss-gh/winfsp">open source</a> 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> 1180 <h4 id="windows-caveats">Windows caveats</h4> 1181 <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> 1182 <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> 1183 <h3 id="limitations">Limitations</h3> 1184 <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> 1185 <p>The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, Hubic) won’t work from the root - you will need to specify a bucket, or a path within the bucket. So <code>swift:</code> won’t work whereas <code>swift:bucket</code> will as will <code>swift:bucket/path</code>. None of these support the concept of directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.</p> 1186 <p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p> 1187 <h3 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone sync/copy</h3> 1188 <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> 1189 <h3 id="attribute-caching">Attribute caching</h3> 1190 <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> 1191 <p>The default is “1s” which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p> 1192 <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/ncw/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/ncw/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p> 1193 <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> 1194 <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> 1195 <p>If files don’t change on the remote outside of the control of rclone then there is no chance of corruption.</p> 1196 <p>This is the same as setting the attr_timeout option in mount.fuse.</p> 1197 <h3 id="filters">Filters</h3> 1198 <p>Note that all the rclone filters can be used to select a subset of the files to be visible in the mount.</p> 1199 <h3 id="systemd">systemd</h3> 1200 <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> 1201 <h3 id="chunked-reading">chunked reading</h3> 1202 <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> 1203 <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> 1204 <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> 1205 <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> 1206 <h3 id="directory-cache">Directory Cache</h3> 1207 <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.</p> 1208 <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> 1209 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1210 <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> 1211 <pre><code>rclone rc vfs/forget</code></pre> 1212 <p>Or individual files or directories:</p> 1213 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1214 <h3 id="file-buffering">File Buffering</h3> 1215 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1216 <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> 1217 <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> 1218 <h3 id="file-caching">File Caching</h3> 1219 <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> 1220 <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> 1221 <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> 1222 <pre><code>--cache-dir string Directory rclone will use for caching. 1223 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1224 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1225 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1226 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1227 <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> 1228 <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> 1229 <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> 1230 <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> 1231 <h4 id="vfs-cache-mode-off">–vfs-cache-mode off</h4> 1232 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1233 <p>This will mean some operations are not possible</p> 1234 <ul> 1235 <li>Files can’t be opened for both read AND write</li> 1236 <li>Files opened for write can’t be seeked</li> 1237 <li>Existing files opened for write must have O_TRUNC set</li> 1238 <li>Files open for read with O_TRUNC will be opened write only</li> 1239 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1240 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1241 <li>If an upload fails it can’t be retried</li> 1242 </ul> 1243 <h4 id="vfs-cache-mode-minimal">–vfs-cache-mode minimal</h4> 1244 <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> 1245 <p>These operations are not possible</p> 1246 <ul> 1247 <li>Files opened for write only can’t be seeked</li> 1248 <li>Existing files opened for write must have O_TRUNC set</li> 1249 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1250 <li>If an upload fails it can’t be retried</li> 1251 </ul> 1252 <h4 id="vfs-cache-mode-writes">–vfs-cache-mode writes</h4> 1253 <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> 1254 <p>This mode should support all normal file system operations.</p> 1255 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1256 <h4 id="vfs-cache-mode-full">–vfs-cache-mode full</h4> 1257 <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> 1258 <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> 1259 <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> 1260 <p>This mode should support all normal file system operations.</p> 1261 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1262 <pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre> 1263 <h3 id="options-46">Options</h3> 1264 <pre><code> --allow-non-empty Allow mounting over a non-empty directory. 1265 --allow-other Allow access to other users. 1266 --allow-root Allow access to root user. 1267 --attr-timeout duration Time for which file/directory attributes are cached. (default 1s) 1268 --daemon Run mount as a daemon (background mode). 1269 --daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). 1270 --debug-fuse Debug the FUSE internals - needs -v. 1271 --default-permissions Makes kernel enforce access control based on the file mode. 1272 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1273 --dir-perms FileMode Directory permissions (default 0777) 1274 --file-perms FileMode File permissions (default 0666) 1275 --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. 1276 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1277 -h, --help help for mount 1278 --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) 1279 --no-checksum Don't compare checksums on up/download. 1280 --no-modtime Don't read/write the modification time (can speed things up). 1281 --no-seek Don't allow seeking in files. 1282 -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. 1283 --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) 1284 --read-only Mount read-only. 1285 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1286 --umask int Override the permission bits set by the filesystem. 1287 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1288 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1289 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1290 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1291 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1292 --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) 1293 --volname string Set the volume name (not supported by all OSes). 1294 --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used.</code></pre> 1295 <h3 id="see-also-46">SEE ALSO</h3> 1296 <ul> 1297 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1298 </ul> 1299 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-46">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1300 <h2 id="rclone-moveto">rclone moveto</h2> 1301 <p>Move file or directory from source to dest.</p> 1302 <h3 id="synopsis-47">Synopsis</h3> 1303 <p>If source:path is a file or directory then it moves it to a file or directory named dest:path.</p> 1304 <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> 1305 <p>So</p> 1306 <pre><code>rclone moveto src dst</code></pre> 1307 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 1308 <p>This will:</p> 1309 <pre><code>if src is file 1310 move it to dst, overwriting an existing file if it exists 1311 if src is directory 1312 move it to dst, overwriting existing files if they exist 1313 see move command for full details</code></pre> 1314 <p>This doesn’t transfer unchanged files, testing by size and modification time or MD5SUM. src will be deleted on successful transfer.</p> 1315 <p><strong>Important</strong>: Since this can cause data loss, test first with the –dry-run flag.</p> 1316 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 1317 <pre><code>rclone moveto source:path dest:path [flags]</code></pre> 1318 <h3 id="options-47">Options</h3> 1319 <pre><code> -h, --help help for moveto</code></pre> 1320 <h3 id="see-also-47">SEE ALSO</h3> 1321 <ul> 1322 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1323 </ul> 1324 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-47">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1325 <h2 id="rclone-ncdu">rclone ncdu</h2> 1326 <p>Explore a remote with a text based user interface.</p> 1327 <h3 id="synopsis-48">Synopsis</h3> 1328 <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> 1329 <script src="https://asciinema.org/a/157793.js" id="asciicast-157793" async></script> 1330 <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> 1331 <p>Here are the keys - press ‘?’ to toggle the help on and off</p> 1332 <pre><code> ↑,↓ or k,j to Move 1333 →,l to enter 1334 ←,h to return 1335 c toggle counts 1336 g toggle graph 1337 n,s,C sort by name,size,count 1338 d delete file/directory 1339 ^L refresh screen 1340 ? to toggle help on and off 1341 q/ESC/c-C to quit</code></pre> 1342 <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> 1343 <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> 1344 <pre><code>rclone ncdu remote:path [flags]</code></pre> 1345 <h3 id="options-48">Options</h3> 1346 <pre><code> -h, --help help for ncdu</code></pre> 1347 <h3 id="see-also-48">SEE ALSO</h3> 1348 <ul> 1349 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1350 </ul> 1351 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-48">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1352 <h2 id="rclone-obscure">rclone obscure</h2> 1353 <p>Obscure password for use in the rclone.conf</p> 1354 <h3 id="synopsis-49">Synopsis</h3> 1355 <p>Obscure password for use in the rclone.conf</p> 1356 <pre><code>rclone obscure password [flags]</code></pre> 1357 <h3 id="options-49">Options</h3> 1358 <pre><code> -h, --help help for obscure</code></pre> 1359 <h3 id="see-also-49">SEE ALSO</h3> 1360 <ul> 1361 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1362 </ul> 1363 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-49">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1364 <h2 id="rclone-rc">rclone rc</h2> 1365 <p>Run a command against a running rclone.</p> 1366 <h3 id="synopsis-50">Synopsis</h3> 1367 <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> 1368 <p>A username and password can be passed in with –user and –pass.</p> 1369 <p>Note that –rc-addr, –rc-user, –rc-pass will be read also for –url, –user, –pass.</p> 1370 <p>Arguments should be passed in as parameter=value.</p> 1371 <p>The result will be returned as a JSON object by default.</p> 1372 <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> 1373 <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> 1374 <pre><code>rclone rc --loopback operations/about fs=/</code></pre> 1375 <p>Use “rclone rc” to see a list of all possible commands.</p> 1376 <pre><code>rclone rc commands parameter [flags]</code></pre> 1377 <h3 id="options-50">Options</h3> 1378 <pre><code> -h, --help help for rc 1379 --json string Input JSON - use instead of key=value args. 1380 --loopback If set connect to this rclone instance not via HTTP. 1381 --no-output If set don't output the JSON result. 1382 --pass string Password to use to connect to rclone remote control. 1383 --url string URL to connect to rclone remote control. (default "http://localhost:5572/") 1384 --user string Username to use to rclone remote control.</code></pre> 1385 <h3 id="see-also-50">SEE ALSO</h3> 1386 <ul> 1387 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1388 </ul> 1389 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-50">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1390 <h2 id="rclone-rcat">rclone rcat</h2> 1391 <p>Copies standard input to file on remote.</p> 1392 <h3 id="synopsis-51">Synopsis</h3> 1393 <p>rclone rcat reads from standard input (stdin) and copies it to a single remote file.</p> 1394 <pre><code>echo "hello world" | rclone rcat remote:path/to/file 1395 ffmpeg - | rclone rcat remote:path/to/file</code></pre> 1396 <p>If the remote file already exists, it will be overwritten.</p> 1397 <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> 1398 <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> 1399 <pre><code>rclone rcat remote:path [flags]</code></pre> 1400 <h3 id="options-51">Options</h3> 1401 <pre><code> -h, --help help for rcat</code></pre> 1402 <h3 id="see-also-51">SEE ALSO</h3> 1403 <ul> 1404 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1405 </ul> 1406 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-51">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1407 <h2 id="rclone-rcd">rclone rcd</h2> 1408 <p>Run rclone listening to remote control commands only.</p> 1409 <h3 id="synopsis-52">Synopsis</h3> 1410 <p>This runs rclone so that it only listens to remote control commands.</p> 1411 <p>This is useful if you are controlling rclone via the rc API.</p> 1412 <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> 1413 <p>See the <a href="https://rclone.org/rc/">rc documentation</a> for more info on the rc flags.</p> 1414 <pre><code>rclone rcd <path to files to serve>* [flags]</code></pre> 1415 <h3 id="options-52">Options</h3> 1416 <pre><code> -h, --help help for rcd</code></pre> 1417 <h3 id="see-also-52">SEE ALSO</h3> 1418 <ul> 1419 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1420 </ul> 1421 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-52">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1422 <h2 id="rclone-rmdirs">rclone rmdirs</h2> 1423 <p>Remove empty directories under the path.</p> 1424 <h3 id="synopsis-53">Synopsis</h3> 1425 <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> 1426 <p>If you supply the –leave-root flag, it will not remove the root directory.</p> 1427 <p>This is useful for tidying up remotes that rclone has left a lot of empty directories in.</p> 1428 <pre><code>rclone rmdirs remote:path [flags]</code></pre> 1429 <h3 id="options-53">Options</h3> 1430 <pre><code> -h, --help help for rmdirs 1431 --leave-root Do not remove root directory if empty</code></pre> 1432 <h3 id="see-also-53">SEE ALSO</h3> 1433 <ul> 1434 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1435 </ul> 1436 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-53">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1437 <h2 id="rclone-serve">rclone serve</h2> 1438 <p>Serve a remote over a protocol.</p> 1439 <h3 id="synopsis-54">Synopsis</h3> 1440 <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> 1441 <pre><code>rclone serve http remote:</code></pre> 1442 <p>Each subcommand has its own options which you can see in their help.</p> 1443 <pre><code>rclone serve <protocol> [opts] <remote> [flags]</code></pre> 1444 <h3 id="options-54">Options</h3> 1445 <pre><code> -h, --help help for serve</code></pre> 1446 <h3 id="see-also-54">SEE ALSO</h3> 1447 <ul> 1448 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1449 <li><a href="https://rclone.org/commands/rclone_serve_dlna/">rclone serve dlna</a> - Serve remote:path over DLNA</li> 1450 <li><a href="https://rclone.org/commands/rclone_serve_ftp/">rclone serve ftp</a> - Serve remote:path over FTP.</li> 1451 <li><a href="https://rclone.org/commands/rclone_serve_http/">rclone serve http</a> - Serve the remote over HTTP.</li> 1452 <li><a href="https://rclone.org/commands/rclone_serve_restic/">rclone serve restic</a> - Serve the remote for restic’s REST API.</li> 1453 <li><a href="https://rclone.org/commands/rclone_serve_sftp/">rclone serve sftp</a> - Serve the remote over SFTP.</li> 1454 <li><a href="https://rclone.org/commands/rclone_serve_webdav/">rclone serve webdav</a> - Serve remote:path over webdav.</li> 1455 </ul> 1456 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-54">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1457 <h2 id="rclone-serve-dlna">rclone serve dlna</h2> 1458 <p>Serve remote:path over DLNA</p> 1459 <h3 id="synopsis-55">Synopsis</h3> 1460 <p>rclone serve dlna is a DLNA media server for media stored in a 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> 1461 <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> 1462 <h3 id="server-options">Server options</h3> 1463 <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> 1464 <p>Use –name to choose the friendly server name, which is by default “rclone (hostname)”.</p> 1465 <p>Use –log-trace in conjunction with -vv to enable additional debug logging of all UPNP traffic.</p> 1466 <h3 id="directory-cache-1">Directory Cache</h3> 1467 <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.</p> 1468 <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> 1469 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1470 <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> 1471 <pre><code>rclone rc vfs/forget</code></pre> 1472 <p>Or individual files or directories:</p> 1473 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1474 <h3 id="file-buffering-1">File Buffering</h3> 1475 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1476 <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> 1477 <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> 1478 <h3 id="file-caching-1">File Caching</h3> 1479 <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> 1480 <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> 1481 <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> 1482 <pre><code>--cache-dir string Directory rclone will use for caching. 1483 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1484 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1485 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1486 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1487 <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> 1488 <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> 1489 <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> 1490 <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> 1491 <h4 id="vfs-cache-mode-off-1">–vfs-cache-mode off</h4> 1492 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1493 <p>This will mean some operations are not possible</p> 1494 <ul> 1495 <li>Files can’t be opened for both read AND write</li> 1496 <li>Files opened for write can’t be seeked</li> 1497 <li>Existing files opened for write must have O_TRUNC set</li> 1498 <li>Files open for read with O_TRUNC will be opened write only</li> 1499 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1500 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1501 <li>If an upload fails it can’t be retried</li> 1502 </ul> 1503 <h4 id="vfs-cache-mode-minimal-1">–vfs-cache-mode minimal</h4> 1504 <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> 1505 <p>These operations are not possible</p> 1506 <ul> 1507 <li>Files opened for write only can’t be seeked</li> 1508 <li>Existing files opened for write must have O_TRUNC set</li> 1509 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1510 <li>If an upload fails it can’t be retried</li> 1511 </ul> 1512 <h4 id="vfs-cache-mode-writes-1">–vfs-cache-mode writes</h4> 1513 <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> 1514 <p>This mode should support all normal file system operations.</p> 1515 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1516 <h4 id="vfs-cache-mode-full-1">–vfs-cache-mode full</h4> 1517 <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> 1518 <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> 1519 <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> 1520 <p>This mode should support all normal file system operations.</p> 1521 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1522 <pre><code>rclone serve dlna remote:path [flags]</code></pre> 1523 <h3 id="options-55">Options</h3> 1524 <pre><code> --addr string ip:port or :port to bind the DLNA http server to. (default ":7879") 1525 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1526 --dir-perms FileMode Directory permissions (default 0777) 1527 --file-perms FileMode File permissions (default 0666) 1528 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1529 -h, --help help for dlna 1530 --log-trace enable trace logging of SOAP traffic 1531 --name string name of DLNA server 1532 --no-checksum Don't compare checksums on up/download. 1533 --no-modtime Don't read/write the modification time (can speed things up). 1534 --no-seek Don't allow seeking in files. 1535 --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) 1536 --read-only Mount read-only. 1537 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1538 --umask int Override the permission bits set by the filesystem. (default 2) 1539 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1540 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1541 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1542 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1543 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1544 --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)</code></pre> 1545 <h3 id="see-also-55">SEE ALSO</h3> 1546 <ul> 1547 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1548 </ul> 1549 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-55">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1550 <h2 id="rclone-serve-ftp">rclone serve ftp</h2> 1551 <p>Serve remote:path over FTP.</p> 1552 <h3 id="synopsis-56">Synopsis</h3> 1553 <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> 1554 <h3 id="server-options-1">Server options</h3> 1555 <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> 1556 <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> 1557 <h4 id="authentication">Authentication</h4> 1558 <p>By default this will serve files without needing a login.</p> 1559 <p>You can set a single username and password with the –user and –pass flags.</p> 1560 <h3 id="directory-cache-2">Directory Cache</h3> 1561 <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.</p> 1562 <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> 1563 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1564 <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> 1565 <pre><code>rclone rc vfs/forget</code></pre> 1566 <p>Or individual files or directories:</p> 1567 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1568 <h3 id="file-buffering-2">File Buffering</h3> 1569 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1570 <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> 1571 <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> 1572 <h3 id="file-caching-2">File Caching</h3> 1573 <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> 1574 <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> 1575 <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> 1576 <pre><code>--cache-dir string Directory rclone will use for caching. 1577 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1578 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1579 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1580 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1581 <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> 1582 <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> 1583 <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> 1584 <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> 1585 <h4 id="vfs-cache-mode-off-2">–vfs-cache-mode off</h4> 1586 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1587 <p>This will mean some operations are not possible</p> 1588 <ul> 1589 <li>Files can’t be opened for both read AND write</li> 1590 <li>Files opened for write can’t be seeked</li> 1591 <li>Existing files opened for write must have O_TRUNC set</li> 1592 <li>Files open for read with O_TRUNC will be opened write only</li> 1593 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1594 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1595 <li>If an upload fails it can’t be retried</li> 1596 </ul> 1597 <h4 id="vfs-cache-mode-minimal-2">–vfs-cache-mode minimal</h4> 1598 <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> 1599 <p>These operations are not possible</p> 1600 <ul> 1601 <li>Files opened for write only can’t be seeked</li> 1602 <li>Existing files opened for write must have O_TRUNC set</li> 1603 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1604 <li>If an upload fails it can’t be retried</li> 1605 </ul> 1606 <h4 id="vfs-cache-mode-writes-2">–vfs-cache-mode writes</h4> 1607 <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> 1608 <p>This mode should support all normal file system operations.</p> 1609 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1610 <h4 id="vfs-cache-mode-full-2">–vfs-cache-mode full</h4> 1611 <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> 1612 <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> 1613 <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> 1614 <p>This mode should support all normal file system operations.</p> 1615 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1616 <pre><code>rclone serve ftp remote:path [flags]</code></pre> 1617 <h3 id="options-56">Options</h3> 1618 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") 1619 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1620 --dir-perms FileMode Directory permissions (default 0777) 1621 --file-perms FileMode File permissions (default 0666) 1622 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1623 -h, --help help for ftp 1624 --no-checksum Don't compare checksums on up/download. 1625 --no-modtime Don't read/write the modification time (can speed things up). 1626 --no-seek Don't allow seeking in files. 1627 --pass string Password for authentication. (empty value allow every password) 1628 --passive-port string Passive port range to use. (default "30000-32000") 1629 --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) 1630 --public-ip string Public IP address to advertise for passive connections. 1631 --read-only Mount read-only. 1632 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1633 --umask int Override the permission bits set by the filesystem. (default 2) 1634 --user string User name for authentication. (default "anonymous") 1635 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1636 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1637 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1638 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1639 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1640 --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)</code></pre> 1641 <h3 id="see-also-56">SEE ALSO</h3> 1642 <ul> 1643 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1644 </ul> 1645 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-56">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1646 <h2 id="rclone-serve-http">rclone serve http</h2> 1647 <p>Serve the remote over HTTP.</p> 1648 <h3 id="synopsis-57">Synopsis</h3> 1649 <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> 1650 <p>You can use the filter flags (eg –include, –exclude) to control what is served.</p> 1651 <p>The server will log errors. Use -v to see access logs.</p> 1652 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 1653 <h3 id="server-options-2">Server options</h3> 1654 <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> 1655 <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> 1656 <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> 1657 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 1658 <h4 id="authentication-1">Authentication</h4> 1659 <p>By default this will serve files without needing a login.</p> 1660 <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> 1661 <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> 1662 <p>To create an htpasswd file:</p> 1663 <pre><code>touch htpasswd 1664 htpasswd -B htpasswd user 1665 htpasswd -B htpasswd anotherUser</code></pre> 1666 <p>The password file can be updated while rclone is running.</p> 1667 <p>Use –realm to set the authentication realm.</p> 1668 <h4 id="ssltls">SSL/TLS</h4> 1669 <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> 1670 <p>–cert should be a 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> 1671 <h3 id="directory-cache-3">Directory Cache</h3> 1672 <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.</p> 1673 <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> 1674 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1675 <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> 1676 <pre><code>rclone rc vfs/forget</code></pre> 1677 <p>Or individual files or directories:</p> 1678 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1679 <h3 id="file-buffering-3">File Buffering</h3> 1680 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1681 <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> 1682 <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> 1683 <h3 id="file-caching-3">File Caching</h3> 1684 <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> 1685 <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> 1686 <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> 1687 <pre><code>--cache-dir string Directory rclone will use for caching. 1688 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1689 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1690 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1691 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1692 <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> 1693 <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> 1694 <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> 1695 <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> 1696 <h4 id="vfs-cache-mode-off-3">–vfs-cache-mode off</h4> 1697 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1698 <p>This will mean some operations are not possible</p> 1699 <ul> 1700 <li>Files can’t be opened for both read AND write</li> 1701 <li>Files opened for write can’t be seeked</li> 1702 <li>Existing files opened for write must have O_TRUNC set</li> 1703 <li>Files open for read with O_TRUNC will be opened write only</li> 1704 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1705 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1706 <li>If an upload fails it can’t be retried</li> 1707 </ul> 1708 <h4 id="vfs-cache-mode-minimal-3">–vfs-cache-mode minimal</h4> 1709 <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> 1710 <p>These operations are not possible</p> 1711 <ul> 1712 <li>Files opened for write only can’t be seeked</li> 1713 <li>Existing files opened for write must have O_TRUNC set</li> 1714 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1715 <li>If an upload fails it can’t be retried</li> 1716 </ul> 1717 <h4 id="vfs-cache-mode-writes-3">–vfs-cache-mode writes</h4> 1718 <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> 1719 <p>This mode should support all normal file system operations.</p> 1720 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1721 <h4 id="vfs-cache-mode-full-3">–vfs-cache-mode full</h4> 1722 <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> 1723 <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> 1724 <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> 1725 <p>This mode should support all normal file system operations.</p> 1726 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1727 <pre><code>rclone serve http remote:path [flags]</code></pre> 1728 <h3 id="options-57">Options</h3> 1729 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 1730 --cert string SSL PEM key (concatenation of certificate and CA certificate) 1731 --client-ca string Client certificate authority to verify clients with 1732 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1733 --dir-perms FileMode Directory permissions (default 0777) 1734 --file-perms FileMode File permissions (default 0666) 1735 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1736 -h, --help help for http 1737 --htpasswd string htpasswd file - if not provided no authentication is done 1738 --key string SSL PEM Private key 1739 --max-header-bytes int Maximum size of request header (default 4096) 1740 --no-checksum Don't compare checksums on up/download. 1741 --no-modtime Don't read/write the modification time (can speed things up). 1742 --no-seek Don't allow seeking in files. 1743 --pass string Password for authentication. 1744 --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) 1745 --read-only Mount read-only. 1746 --realm string realm for authentication (default "rclone") 1747 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 1748 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 1749 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1750 --umask int Override the permission bits set by the filesystem. (default 2) 1751 --user string User name for authentication. 1752 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1753 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1754 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1755 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1756 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1757 --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)</code></pre> 1758 <h3 id="see-also-57">SEE ALSO</h3> 1759 <ul> 1760 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1761 </ul> 1762 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-57">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1763 <h2 id="rclone-serve-restic">rclone serve restic</h2> 1764 <p>Serve the remote for restic’s REST API.</p> 1765 <h3 id="synopsis-58">Synopsis</h3> 1766 <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> 1767 <p><a href="https://restic.net/">Restic</a> is a command line program for doing backups.</p> 1768 <p>The server will log errors. Use -v to see access logs.</p> 1769 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 1770 <h3 id="setting-up-rclone-for-use-by-restic">Setting up rclone for use by restic</h3> 1771 <p>First <a href="/docs/#configure">set up a remote for your chosen cloud provider</a>.</p> 1772 <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> 1773 <p>Now start the rclone restic server</p> 1774 <pre><code>rclone serve restic -v remote:backup</code></pre> 1775 <p>Where you can replace “backup” in the above by whatever path in the remote you wish to use.</p> 1776 <p>By default this will serve on “localhost:8080” you can change this with use of the “–addr” flag.</p> 1777 <p>You might wish to start this server on boot.</p> 1778 <h3 id="setting-up-restic-to-use-rclone">Setting up restic to use rclone</h3> 1779 <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> 1780 <p>Note that you will need restic 0.8.2 or later to interoperate with rclone.</p> 1781 <p>For the example above you will want to use “http://localhost:8080/” as the URL for the REST server.</p> 1782 <p>For example:</p> 1783 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/ 1784 $ export RESTIC_PASSWORD=yourpassword 1785 $ restic init 1786 created restic backend 8b1a4b56ae at rest:http://localhost:8080/ 1787 1788 Please note that knowledge of your password is required to access 1789 the repository. Losing your password means that your data is 1790 irrecoverably lost. 1791 $ restic backup /path/to/files/to/backup 1792 scan [/path/to/files/to/backup] 1793 scanned 189 directories, 312 files in 0:00 1794 [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 1795 duration: 0:00 1796 snapshot 45c8fdd8 saved</code></pre> 1797 <h4 id="multiple-repositories">Multiple repositories</h4> 1798 <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> 1799 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ 1800 # backup user1 stuff 1801 $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ 1802 # backup user2 stuff</code></pre> 1803 <h4 id="private-repositories">Private repositories</h4> 1804 <p>The “–private-repos” flag can be used to limit users to repositories starting with a path of “/<username>/”.</p> 1805 <h3 id="server-options-3">Server options</h3> 1806 <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> 1807 <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> 1808 <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> 1809 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 1810 <h4 id="authentication-2">Authentication</h4> 1811 <p>By default this will serve files without needing a login.</p> 1812 <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> 1813 <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> 1814 <p>To create an htpasswd file:</p> 1815 <pre><code>touch htpasswd 1816 htpasswd -B htpasswd user 1817 htpasswd -B htpasswd anotherUser</code></pre> 1818 <p>The password file can be updated while rclone is running.</p> 1819 <p>Use –realm to set the authentication realm.</p> 1820 <h4 id="ssltls-1">SSL/TLS</h4> 1821 <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> 1822 <p>–cert should be a 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> 1823 <pre><code>rclone serve restic remote:path [flags]</code></pre> 1824 <h3 id="options-58">Options</h3> 1825 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 1826 --append-only disallow deletion of repository data 1827 --cert string SSL PEM key (concatenation of certificate and CA certificate) 1828 --client-ca string Client certificate authority to verify clients with 1829 -h, --help help for restic 1830 --htpasswd string htpasswd file - if not provided no authentication is done 1831 --key string SSL PEM Private key 1832 --max-header-bytes int Maximum size of request header (default 4096) 1833 --pass string Password for authentication. 1834 --private-repos users can only access their private repo 1835 --realm string realm for authentication (default "rclone") 1836 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 1837 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 1838 --stdio run an HTTP2 server on stdin/stdout 1839 --user string User name for authentication.</code></pre> 1840 <h3 id="see-also-58">SEE ALSO</h3> 1841 <ul> 1842 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1843 </ul> 1844 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-58">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1845 <h2 id="rclone-serve-sftp">rclone serve sftp</h2> 1846 <p>Serve the remote over SFTP.</p> 1847 <h3 id="synopsis-59">Synopsis</h3> 1848 <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> 1849 <p>You can use the filter flags (eg –include, –exclude) to control what is served.</p> 1850 <p>The server will log errors. Use -v to see access logs.</p> 1851 <p>–bwlimit will be respected for file transfers. Use –stats to control the stats printing.</p> 1852 <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) or set the –no-auth flag for no authentication when logging in.</p> 1853 <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> 1854 <p>If you don’t supply a –key then rclone will generate one and cache it for later use.</p> 1855 <p>By default the server binds to localhost:2022 - if you want it to be reachable externally then supply “–addr :2022” for example.</p> 1856 <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> 1857 <h3 id="directory-cache-4">Directory Cache</h3> 1858 <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.</p> 1859 <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> 1860 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1861 <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> 1862 <pre><code>rclone rc vfs/forget</code></pre> 1863 <p>Or individual files or directories:</p> 1864 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1865 <h3 id="file-buffering-4">File Buffering</h3> 1866 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1867 <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> 1868 <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> 1869 <h3 id="file-caching-4">File Caching</h3> 1870 <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> 1871 <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> 1872 <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> 1873 <pre><code>--cache-dir string Directory rclone will use for caching. 1874 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1875 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1876 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1877 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1878 <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> 1879 <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> 1880 <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> 1881 <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> 1882 <h4 id="vfs-cache-mode-off-4">–vfs-cache-mode off</h4> 1883 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1884 <p>This will mean some operations are not possible</p> 1885 <ul> 1886 <li>Files can’t be opened for both read AND write</li> 1887 <li>Files opened for write can’t be seeked</li> 1888 <li>Existing files opened for write must have O_TRUNC set</li> 1889 <li>Files open for read with O_TRUNC will be opened write only</li> 1890 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 1891 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 1892 <li>If an upload fails it can’t be retried</li> 1893 </ul> 1894 <h4 id="vfs-cache-mode-minimal-4">–vfs-cache-mode minimal</h4> 1895 <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> 1896 <p>These operations are not possible</p> 1897 <ul> 1898 <li>Files opened for write only can’t be seeked</li> 1899 <li>Existing files opened for write must have O_TRUNC set</li> 1900 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 1901 <li>If an upload fails it can’t be retried</li> 1902 </ul> 1903 <h4 id="vfs-cache-mode-writes-4">–vfs-cache-mode writes</h4> 1904 <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> 1905 <p>This mode should support all normal file system operations.</p> 1906 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 1907 <h4 id="vfs-cache-mode-full-4">–vfs-cache-mode full</h4> 1908 <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> 1909 <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> 1910 <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> 1911 <p>This mode should support all normal file system operations.</p> 1912 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 1913 <pre><code>rclone serve sftp remote:path [flags]</code></pre> 1914 <h3 id="options-59">Options</h3> 1915 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022") 1916 --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") 1917 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 1918 --dir-perms FileMode Directory permissions (default 0777) 1919 --file-perms FileMode File permissions (default 0666) 1920 --gid uint32 Override the gid field set by the filesystem. (default 1000) 1921 -h, --help help for sftp 1922 --key string SSH private key file (leave blank to auto generate) 1923 --no-auth Allow connections with no authentication if set. 1924 --no-checksum Don't compare checksums on up/download. 1925 --no-modtime Don't read/write the modification time (can speed things up). 1926 --no-seek Don't allow seeking in files. 1927 --pass string Password for authentication. 1928 --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) 1929 --read-only Mount read-only. 1930 --uid uint32 Override the uid field set by the filesystem. (default 1000) 1931 --umask int Override the permission bits set by the filesystem. (default 2) 1932 --user string User name for authentication. 1933 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1934 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 1935 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 1936 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1937 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 1938 --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)</code></pre> 1939 <h3 id="see-also-59">SEE ALSO</h3> 1940 <ul> 1941 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 1942 </ul> 1943 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-59">Auto generated by spf13/cobra on 15-Jun-2019</h6> 1944 <h2 id="rclone-serve-webdav">rclone serve webdav</h2> 1945 <p>Serve remote:path over webdav.</p> 1946 <h3 id="synopsis-60">Synopsis</h3> 1947 <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> 1948 <h3 id="webdav-options">Webdav options</h3> 1949 <h4 id="etag-hash">–etag-hash</h4> 1950 <p>This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object.</p> 1951 <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> 1952 <p>Use “rclone hashsum” to see the full list.</p> 1953 <h3 id="server-options-4">Server options</h3> 1954 <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> 1955 <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> 1956 <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> 1957 <p>–max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p> 1958 <h4 id="authentication-3">Authentication</h4> 1959 <p>By default this will serve files without needing a login.</p> 1960 <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> 1961 <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> 1962 <p>To create an htpasswd file:</p> 1963 <pre><code>touch htpasswd 1964 htpasswd -B htpasswd user 1965 htpasswd -B htpasswd anotherUser</code></pre> 1966 <p>The password file can be updated while rclone is running.</p> 1967 <p>Use –realm to set the authentication realm.</p> 1968 <h4 id="ssltls-2">SSL/TLS</h4> 1969 <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> 1970 <p>–cert should be a 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> 1971 <h3 id="directory-cache-5">Directory Cache</h3> 1972 <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.</p> 1973 <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> 1974 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 1975 <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> 1976 <pre><code>rclone rc vfs/forget</code></pre> 1977 <p>Or individual files or directories:</p> 1978 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 1979 <h3 id="file-buffering-5">File Buffering</h3> 1980 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 1981 <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> 1982 <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> 1983 <h3 id="file-caching-5">File Caching</h3> 1984 <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> 1985 <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> 1986 <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> 1987 <pre><code>--cache-dir string Directory rclone will use for caching. 1988 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 1989 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") 1990 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 1991 --vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre> 1992 <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> 1993 <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> 1994 <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> 1995 <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> 1996 <h4 id="vfs-cache-mode-off-5">–vfs-cache-mode off</h4> 1997 <p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 1998 <p>This will mean some operations are not possible</p> 1999 <ul> 2000 <li>Files can’t be opened for both read AND write</li> 2001 <li>Files opened for write can’t be seeked</li> 2002 <li>Existing files opened for write must have O_TRUNC set</li> 2003 <li>Files open for read with O_TRUNC will be opened write only</li> 2004 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 2005 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 2006 <li>If an upload fails it can’t be retried</li> 2007 </ul> 2008 <h4 id="vfs-cache-mode-minimal-5">–vfs-cache-mode minimal</h4> 2009 <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> 2010 <p>These operations are not possible</p> 2011 <ul> 2012 <li>Files opened for write only can’t be seeked</li> 2013 <li>Existing files opened for write must have O_TRUNC set</li> 2014 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 2015 <li>If an upload fails it can’t be retried</li> 2016 </ul> 2017 <h4 id="vfs-cache-mode-writes-5">–vfs-cache-mode writes</h4> 2018 <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> 2019 <p>This mode should support all normal file system operations.</p> 2020 <p>If an upload fails it will be retried up to –low-level-retries times.</p> 2021 <h4 id="vfs-cache-mode-full-5">–vfs-cache-mode full</h4> 2022 <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> 2023 <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> 2024 <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> 2025 <p>This mode should support all normal file system operations.</p> 2026 <p>If an upload or download fails it will be retried up to –low-level-retries times.</p> 2027 <pre><code>rclone serve webdav remote:path [flags]</code></pre> 2028 <h3 id="options-60">Options</h3> 2029 <pre><code> --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") 2030 --cert string SSL PEM key (concatenation of certificate and CA certificate) 2031 --client-ca string Client certificate authority to verify clients with 2032 --dir-cache-time duration Time to cache directory entries for. (default 5m0s) 2033 --dir-perms FileMode Directory permissions (default 0777) 2034 --disable-dir-list Disable HTML directory list on GET request for a directory 2035 --etag-hash string Which hash to use for the ETag, or auto or blank for off 2036 --file-perms FileMode File permissions (default 0666) 2037 --gid uint32 Override the gid field set by the filesystem. (default 1000) 2038 -h, --help help for webdav 2039 --htpasswd string htpasswd file - if not provided no authentication is done 2040 --key string SSL PEM Private key 2041 --max-header-bytes int Maximum size of request header (default 4096) 2042 --no-checksum Don't compare checksums on up/download. 2043 --no-modtime Don't read/write the modification time (can speed things up). 2044 --no-seek Don't allow seeking in files. 2045 --pass string Password for authentication. 2046 --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) 2047 --read-only Mount read-only. 2048 --realm string realm for authentication (default "rclone") 2049 --server-read-timeout duration Timeout for server reading data (default 1h0m0s) 2050 --server-write-timeout duration Timeout for server writing data (default 1h0m0s) 2051 --uid uint32 Override the uid field set by the filesystem. (default 1000) 2052 --umask int Override the permission bits set by the filesystem. (default 2) 2053 --user string User name for authentication. 2054 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) 2055 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) 2056 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 2057 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) 2058 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) 2059 --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)</code></pre> 2060 <h3 id="see-also-60">SEE ALSO</h3> 2061 <ul> 2062 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 2063 </ul> 2064 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-60">Auto generated by spf13/cobra on 15-Jun-2019</h6> 2065 <h2 id="rclone-settier">rclone settier</h2> 2066 <p>Changes storage class/tier of objects in remote.</p> 2067 <h3 id="synopsis-61">Synopsis</h3> 2068 <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> 2069 <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> 2070 <p>You can use it to tier single object</p> 2071 <pre><code>rclone settier Cool remote:path/file</code></pre> 2072 <p>Or use rclone filters to set tier on only specific files</p> 2073 <pre><code>rclone --include "*.txt" settier Hot remote:path/dir</code></pre> 2074 <p>Or just provide remote directory and all files in directory will be tiered</p> 2075 <pre><code>rclone settier tier remote:path/dir</code></pre> 2076 <pre><code>rclone settier tier remote:path [flags]</code></pre> 2077 <h3 id="options-61">Options</h3> 2078 <pre><code> -h, --help help for settier</code></pre> 2079 <h3 id="see-also-61">SEE ALSO</h3> 2080 <ul> 2081 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2082 </ul> 2083 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-61">Auto generated by spf13/cobra on 15-Jun-2019</h6> 2084 <h2 id="rclone-touch">rclone touch</h2> 2085 <p>Create new file or change file modification time.</p> 2086 <h3 id="synopsis-62">Synopsis</h3> 2087 <p>Create new file or change file modification time.</p> 2088 <pre><code>rclone touch remote:path [flags]</code></pre> 2089 <h3 id="options-62">Options</h3> 2090 <pre><code> -h, --help help for touch 2091 -C, --no-create Do not create the file if it does not exist. 2092 -t, --timestamp string Change the modification times to the specified time instead of the current time of day. The argument is of the form 'YYMMDD' (ex. 17.10.30) or 'YYYY-MM-DDTHH:MM:SS' (ex. 2006-01-02T15:04:05)</code></pre> 2093 <h3 id="see-also-62">SEE ALSO</h3> 2094 <ul> 2095 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2096 </ul> 2097 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-62">Auto generated by spf13/cobra on 15-Jun-2019</h6> 2098 <h2 id="rclone-tree">rclone tree</h2> 2099 <p>List the contents of the remote in a tree like fashion.</p> 2100 <h3 id="synopsis-63">Synopsis</h3> 2101 <p>rclone tree lists the contents of a remote in a similar way to the unix tree command.</p> 2102 <p>For example</p> 2103 <pre><code>$ rclone tree remote:path 2104 / 2105 ├── file1 2106 ├── file2 2107 ├── file3 2108 └── subdir 2109 ├── file4 2110 └── file5 2111 2112 1 directories, 5 files</code></pre> 2113 <p>You can use any of the filtering options with the tree command (eg –include and –exclude). You can also use –fast-list.</p> 2114 <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> 2115 <pre><code>rclone tree remote:path [flags]</code></pre> 2116 <h3 id="options-63">Options</h3> 2117 <pre><code> -a, --all All files are listed (list . files too). 2118 -C, --color Turn colorization on always. 2119 -d, --dirs-only List directories only. 2120 --dirsfirst List directories before files (-U disables). 2121 --full-path Print the full path prefix for each file. 2122 -h, --help help for tree 2123 --human Print the size in a more human readable way. 2124 --level int Descend only level directories deep. 2125 -D, --modtime Print the date of last modification. 2126 -i, --noindent Don't print indentation lines. 2127 --noreport Turn off file/directory count at end of tree listing. 2128 -o, --output string Output to file instead of stdout. 2129 -p, --protections Print the protections for each file. 2130 -Q, --quote Quote filenames with double quotes. 2131 -s, --size Print the size in bytes of each file. 2132 --sort string Select sort: name,version,size,mtime,ctime. 2133 --sort-ctime Sort files by last status change time. 2134 -t, --sort-modtime Sort files by last modification time. 2135 -r, --sort-reverse Reverse the order of the sort. 2136 -U, --unsorted Leave files unsorted. 2137 --version Sort files alphanumerically by version.</code></pre> 2138 <h3 id="see-also-63">SEE ALSO</h3> 2139 <ul> 2140 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2141 </ul> 2142 <h6 id="auto-generated-by-spf13cobra-on-15-jun-2019-63">Auto generated by spf13/cobra on 15-Jun-2019</h6> 2143 <h2 id="copying-single-files">Copying single files</h2> 2144 <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> 2145 <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> 2146 <pre><code>rclone copy remote:test.jpg /tmp/download</code></pre> 2147 <p>The file <code>test.jpg</code> will be placed inside <code>/tmp/download</code>.</p> 2148 <p>This is equivalent to specifying</p> 2149 <pre><code>rclone copy --files-from /tmp/files remote: /tmp/download</code></pre> 2150 <p>Where <code>/tmp/files</code> contains the single line</p> 2151 <pre><code>test.jpg</code></pre> 2152 <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> 2153 <h2 id="syntax-of-remote-paths">Syntax of remote paths</h2> 2154 <p>The syntax of the paths passed to the rclone command are as follows.</p> 2155 <h3 id="pathtodir">/path/to/dir</h3> 2156 <p>This refers to the local file system.</p> 2157 <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> 2158 <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> 2159 <h3 id="remotepathtodir">remote:path/to/dir</h3> 2160 <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> 2161 <h3 id="remotepathtodir-1">remote:/path/to/dir</h3> 2162 <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> 2163 <h3 id="backendpathtodir">:backend:path/to/dir</h3> 2164 <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> 2165 <p>Here are some examples:</p> 2166 <pre><code>rclone lsd --http-url https://pub.rclone.org :http:</code></pre> 2167 <p>To list all the directories in the root of <code>https://pub.rclone.org/</code>.</p> 2168 <pre><code>rclone lsf --http-url https://example.com :http:path/to/dir</code></pre> 2169 <p>To list files and directories in <code>https://example.com/path/to/dir/</code></p> 2170 <pre><code>rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir</code></pre> 2171 <p>To copy files and directories in <code>https://example.com/path/to/dir</code> to <code>/tmp/dir</code>.</p> 2172 <pre><code>rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir</code></pre> 2173 <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> 2174 <h2 id="quoting-and-the-shell">Quoting and the shell</h2> 2175 <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> 2176 <p>Here are some gotchas which may help users unfamiliar with the shell rules</p> 2177 <h3 id="linux-osx">Linux / OSX</h3> 2178 <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> 2179 <pre><code>rclone copy 'Important files?' remote:backup</code></pre> 2180 <p>If you want to send a <code>'</code> you will need to use <code>"</code>, eg</p> 2181 <pre><code>rclone copy "O'Reilly Reviews" remote:backup</code></pre> 2182 <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> 2183 <h3 id="windows">Windows</h3> 2184 <p>If your names have spaces in you need to put them in <code>"</code>, eg</p> 2185 <pre><code>rclone copy "E:\folder name\folder name\folder name" remote:backup</code></pre> 2186 <p>If you are using the root directory on its own then don’t quote it (see <a href="https://github.com/ncw/rclone/issues/464">#464</a> for why), eg</p> 2187 <pre><code>rclone copy E:\ remote:backup</code></pre> 2188 <h2 id="copying-files-or-directories-with-in-the-names">Copying files or directories with <code>:</code> in the names</h2> 2189 <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> 2190 <p>So to sync a directory called <code>sync:me</code> to a remote called <code>remote:</code> use</p> 2191 <pre><code>rclone sync ./sync:me remote:path</code></pre> 2192 <p>or</p> 2193 <pre><code>rclone sync /full/path/to/sync:me remote:path</code></pre> 2194 <h2 id="server-side-copy">Server Side Copy</h2> 2195 <p>Most remotes (but not all - see <a href="/overview/#optional-features">the overview</a>) support server side copy.</p> 2196 <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> 2197 <p>Eg</p> 2198 <pre><code>rclone copy s3:oldbucket s3:newbucket</code></pre> 2199 <p>Will copy the contents of <code>oldbucket</code> to <code>newbucket</code> without downloading and re-uploading.</p> 2200 <p>Remotes which don’t support server side copy <strong>will</strong> download and re-upload in this case.</p> 2201 <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> 2202 <p>Server side copies will only be attempted if the remote names are the same.</p> 2203 <p>This can be used when scripting to make aged backups efficiently, eg</p> 2204 <pre><code>rclone sync remote:current-backup remote:previous-backup 2205 rclone sync /path/to/files remote:current-backup</code></pre> 2206 <h2 id="options-64">Options</h2> 2207 <p>Rclone has a number of options to control its behaviour.</p> 2208 <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> 2209 <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> 2210 <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> 2211 <h3 id="backup-dirdir">–backup-dir=DIR</h3> 2212 <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> 2213 <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> 2214 <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> 2215 <p>For example</p> 2216 <pre><code>rclone sync /path/to/local remote:current --backup-dir remote:old</code></pre> 2217 <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> 2218 <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> 2219 <h3 id="bind-string">–bind string</h3> 2220 <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> 2221 <h3 id="bwlimitbandwidth_spec">–bwlimit=BANDWIDTH_SPEC</h3> 2222 <p>This option controls the bandwidth limit. Limits can be specified in two ways: As a single limit, or as a timetable.</p> 2223 <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> 2224 <p>For example, to limit bandwidth usage to 10 MBytes/s use <code>--bwlimit 10M</code></p> 2225 <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 “WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH…” where: WEEKDAY is optional element. It could be written as whole world or only using 3 first characters. HH:MM is an hour from 00:00 to 23:59.</p> 2226 <p>An example of a typical timetable to avoid link saturation during daytime working hours could be:</p> 2227 <p><code>--bwlimit "08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off"</code></p> 2228 <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> 2229 <p>An example of timetable with WEEKDAY could be:</p> 2230 <p><code>--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"</code></p> 2231 <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> 2232 <p>Timeslots without weekday are extended to whole week. So this one example:</p> 2233 <p><code>--bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"</code></p> 2234 <p>Is equal to this:</p> 2235 <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> 2236 <p>Bandwidth limits only apply to the data transfer. They don’t apply to the bandwidth of the directory listings etc.</p> 2237 <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> 2238 <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> 2239 <pre><code>kill -SIGUSR2 $(pidof rclone)</code></pre> 2240 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use change the bwlimit dynamically:</p> 2241 <pre><code>rclone rc core/bwlimit rate=1M</code></pre> 2242 <h3 id="buffer-sizesize">–buffer-size=SIZE</h3> 2243 <p>Use this sized buffer to speed up file transfers. Each <code>--transfer</code> will use this much memory for buffering.</p> 2244 <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="/commands/rclone_mount/#file-buffering">mount</a> documentation for more details.</p> 2245 <p>Set to 0 to disable the buffering for the minimum memory usage.</p> 2246 <p>Note that the memory allocation of the buffers is influenced by the <a href="#use-mmap">–use-mmap</a> flag.</p> 2247 <h3 id="checkersn">–checkers=N</h3> 2248 <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> 2249 <p>The default is to run 8 checkers in parallel.</p> 2250 <h3 id="c-checksum">-c, –checksum</h3> 2251 <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> 2252 <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> 2253 <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> 2254 <p>Eg <code>rclone --checksum sync s3:/bucket swift:/bucket</code> would run much quicker than without the <code>--checksum</code> flag.</p> 2255 <p>When using this flag, rclone won’t update mtimes of remote files if they are incorrect as it would normally.</p> 2256 <h3 id="configconfig_file">–config=CONFIG_FILE</h3> 2257 <p>Specify the location of the rclone config file.</p> 2258 <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> 2259 <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> 2260 <p>If you run <code>rclone config file</code> you will see where the default location is for you.</p> 2261 <p>Use this flag to override the config location, eg <code>rclone --config=".myconfig" .config</code>.</p> 2262 <h3 id="contimeouttime">–contimeout=TIME</h3> 2263 <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> 2264 <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> 2265 <h3 id="dedupe-mode-mode">–dedupe-mode MODE</h3> 2266 <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> 2267 <h3 id="disable-featurefeature">–disable FEATURE,FEATURE,…</h3> 2268 <p>This disables a comma separated list of optional features. For example to disable server side move and server side copy use:</p> 2269 <pre><code>--disable move,copy</code></pre> 2270 <p>The features can be put in in any case.</p> 2271 <p>To see a list of which features can be disabled use:</p> 2272 <pre><code>--disable help</code></pre> 2273 <p>See the overview <a href="/overview/#features">features</a> and <a href="/overview/#optional-features">optional features</a> to get an idea of which feature does what.</p> 2274 <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> 2275 <h3 id="n-dry-run">-n, –dry-run</h3> 2276 <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> 2277 <h3 id="ignore-case-sync">–ignore-case-sync</h3> 2278 <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> 2279 <h3 id="ignore-checksum">–ignore-checksum</h3> 2280 <p>Normally rclone will check that the checksums of transferred files match, and give an error “corrupted on transfer” if they don’t.</p> 2281 <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> 2282 <h3 id="ignore-existing">–ignore-existing</h3> 2283 <p>Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files.</p> 2284 <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> 2285 <h3 id="ignore-size">–ignore-size</h3> 2286 <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> 2287 <p>It will also cause rclone to skip verifying the sizes are the same after transfer.</p> 2288 <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/ncw/rclone/issues/399">#399</a> for more info).</p> 2289 <h3 id="i-ignore-times">-I, –ignore-times</h3> 2290 <p>Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination.</p> 2291 <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> 2292 <h3 id="immutable">–immutable</h3> 2293 <p>Treat source and destination files as immutable and disallow modification.</p> 2294 <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> 2295 <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> 2296 <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> 2297 <h2 id="leave-root">–leave-root</h2> 2298 <p>During rmdirs it will not remove root directory, even if it’s empty.</p> 2299 <h3 id="log-filefile">–log-file=FILE</h3> 2300 <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> 2301 <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> 2302 <h3 id="log-format-list">–log-format LIST</h3> 2303 <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> 2304 <h3 id="log-level-level">–log-level LEVEL</h3> 2305 <p>This sets the log level for rclone. The default log level is <code>NOTICE</code>.</p> 2306 <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> 2307 <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> 2308 <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> 2309 <p><code>ERROR</code> is equivalent to <code>-q</code>. It only outputs error messages.</p> 2310 <h3 id="low-level-retries-number">–low-level-retries NUMBER</h3> 2311 <p>This controls the number of low level retries rclone does.</p> 2312 <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> 2313 <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> 2314 <p>Disable low level retries with <code>--low-level-retries 1</code>.</p> 2315 <h3 id="max-backlogn">–max-backlog=N</h3> 2316 <p>This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred.</p> 2317 <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> 2318 <p>Setting this large allows rclone to calculate how many files are pending more accurately and give a more accurate estimated finish time.</p> 2319 <p>Setting this small will make rclone more synchronous to the listings of the remote which may be desirable.</p> 2320 <h3 id="max-deleten">–max-delete=N</h3> 2321 <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> 2322 <h3 id="max-depthn">–max-depth=N</h3> 2323 <p>This modifies the recursion depth for all the commands except purge.</p> 2324 <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> 2325 <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> 2326 <p>You can use this command to disable recursion (with <code>--max-depth 1</code>).</p> 2327 <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> 2328 <h3 id="max-transfersize">–max-transfer=SIZE</h3> 2329 <p>Rclone will stop transferring when it has reached the size specified. Defaults to off.</p> 2330 <p>When the limit is reached all transfers will stop immediately.</p> 2331 <p>Rclone will exit with exit code 8 if the transfer limit is reached.</p> 2332 <h3 id="modify-windowtime">–modify-window=TIME</h3> 2333 <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> 2334 <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> 2335 <p>This command line flag allows you to override that computed default.</p> 2336 <h3 id="multi-thread-cutoffsize">–multi-thread-cutoff=SIZE</h3> 2337 <p>When downloading files to the local backend above this size, rclone will use multiple threads to download the file. (default 250M)</p> 2338 <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> 2339 <p>The number of threads used to dowload is controlled by <code>--multi-thread-streams</code>.</p> 2340 <p>Use <code>-vv</code> if you wish to see info about the threads.</p> 2341 <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> 2342 <p><strong>NB</strong> that this <strong>only</strong> works for a local destination but will work with any source.</p> 2343 <h3 id="multi-thread-streamsn">–multi-thread-streams=N</h3> 2344 <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> 2345 <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> 2346 <p>So if <code>--multi-thread-cutoff 250MB</code> and <code>--multi-thread-streams 4</code> are in effect (the defaults):</p> 2347 <ul> 2348 <li>0MB.250MB files will be downloaded with 1 stream</li> 2349 <li>250MB..500MB files will be downloaded with 2 streams</li> 2350 <li>500MB..750MB files will be downloaded with 3 streams</li> 2351 <li>750MB+ files will be downloaded with 4 streams</li> 2352 </ul> 2353 <h3 id="no-gzip-encoding">–no-gzip-encoding</h3> 2354 <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> 2355 <p>There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone.</p> 2356 <h3 id="no-traverse">–no-traverse</h3> 2357 <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> 2358 <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> 2359 <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> 2360 <p>See <a href="https://rclone.org/commands/rclone_copy/">rclone copy</a> for an example of how to use it.</p> 2361 <h3 id="no-update-modtime">–no-update-modtime</h3> 2362 <p>When using this flag, rclone won’t update modification times of remote files if they are incorrect as it would normally.</p> 2363 <p>This can be used if the remote is being synced with another tool also (eg the Google Drive client).</p> 2364 <h3 id="p-progress">-P, –progress</h3> 2365 <p>This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer.</p> 2366 <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> 2367 <p>Normally this is updated every 500mS but this period can be overridden with the <code>--stats</code> flag.</p> 2368 <p>This can be used with the <code>--stats-one-line</code> flag for a simpler display.</p> 2369 <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> 2370 <h3 id="q-quiet">-q, –quiet</h3> 2371 <p>Normally rclone outputs stats and a completion message. If you set this flag it will make as little output as possible.</p> 2372 <h3 id="retries-int">–retries int</h3> 2373 <p>Retry the entire sync if it fails this many times it fails (default 3).</p> 2374 <p>Some remotes can be unreliable and a few retries help pick up the files which didn’t get transferred because of errors.</p> 2375 <p>Disable retries with <code>--retries 1</code>.</p> 2376 <h3 id="retries-sleeptime">–retries-sleep=TIME</h3> 2377 <p>This sets the interval between each retry specified by <code>--retries</code></p> 2378 <p>The default is 0. Use 0 to disable.</p> 2379 <h3 id="size-only">–size-only</h3> 2380 <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> 2381 <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> 2382 <h3 id="statstime">–stats=TIME</h3> 2383 <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> 2384 <p>This sets the interval.</p> 2385 <p>The default is <code>1m</code>. Use 0 to disable.</p> 2386 <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> 2387 <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> 2388 <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> 2389 <h3 id="stats-file-name-length-integer">–stats-file-name-length integer</h3> 2390 <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> 2391 <h3 id="stats-log-level-string">–stats-log-level string</h3> 2392 <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> 2393 <h3 id="stats-one-line">–stats-one-line</h3> 2394 <p>When this is specified, rclone condenses the stats into a single line showing the most important stats only.</p> 2395 <h3 id="stats-one-line-date">–stats-one-line-date</h3> 2396 <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> 2397 <h3 id="stats-one-line-date-format">–stats-one-line-date-format</h3> 2398 <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> 2399 <h3 id="stats-unitbitsbytes">–stats-unit=bits|bytes</h3> 2400 <p>By default, data transfer rates will be printed in bytes/second.</p> 2401 <p>This option allows the data rate to be printed in bits/second.</p> 2402 <p>Data transfer volume will still be reported in bytes.</p> 2403 <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> 2404 <p>The default is <code>bytes</code>.</p> 2405 <h3 id="suffixsuffix">–suffix=SUFFIX</h3> 2406 <p>This is for use with <code>--backup-dir</code> only. If this isn’t set then <code>--backup-dir</code> will move files with their original name. If it is set then the files will have SUFFIX added on to them.</p> 2407 <p>See <code>--backup-dir</code> for more info.</p> 2408 <h3 id="suffix-keep-extension">–suffix-keep-extension</h3> 2409 <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> 2410 <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> 2411 <h3 id="syslog">–syslog</h3> 2412 <p>On capable OSes (not Windows or Plan9) send all log output to syslog.</p> 2413 <p>This can be useful for running rclone in a script or <code>rclone mount</code>.</p> 2414 <h3 id="syslog-facility-string">–syslog-facility string</h3> 2415 <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> 2416 <h3 id="tpslimit-float">–tpslimit float</h3> 2417 <p>Limit HTTP transactions per second to this. Default is 0 which is used to mean unlimited transactions per second.</p> 2418 <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> 2419 <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> 2420 <p>This can be very useful for <code>rclone mount</code> to control the behaviour of applications using it.</p> 2421 <p>See also <code>--tpslimit-burst</code>.</p> 2422 <h3 id="tpslimit-burst-int">–tpslimit-burst int</h3> 2423 <p>Max burst of transactions for <code>--tpslimit</code>. (default 1)</p> 2424 <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> 2425 <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> 2426 <p>This may be used to increase performance of <code>--tpslimit</code> without changing the long term average number of transactions per second.</p> 2427 <h3 id="track-renames">–track-renames</h3> 2428 <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> 2429 <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> 2430 <p>Files will be matched by size and hash - if both match then a rename will be considered.</p> 2431 <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> 2432 <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> 2433 <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> 2434 <h3 id="delete-beforeduringafter">–delete-(before,during,after)</h3> 2435 <p>This option allows you to specify when files on your destination are deleted when you sync folders.</p> 2436 <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> 2437 <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> 2438 <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> 2439 <h3 id="fast-list">–fast-list</h3> 2440 <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> 2441 <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> 2442 <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> 2443 <ul> 2444 <li>It <strong>will</strong> use fewer transactions (important if you pay for them)</li> 2445 <li>It <strong>will</strong> use more memory. Rclone has to load the whole listing into memory.</li> 2446 <li>It <em>may</em> be faster because it uses fewer transactions</li> 2447 <li>It <em>may</em> be slower because it can’t be parallelized</li> 2448 </ul> 2449 <p>rclone should always give identical results with and without <code>--fast-list</code>.</p> 2450 <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> 2451 <p>If you use <code>--fast-list</code> on a remote which doesn’t support it, then rclone will just ignore it.</p> 2452 <h3 id="timeouttime">–timeout=TIME</h3> 2453 <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> 2454 <p>The default is <code>5m</code>. Set to 0 to disable.</p> 2455 <h3 id="transfersn">–transfers=N</h3> 2456 <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> 2457 <p>The default is to run 4 file transfers in parallel.</p> 2458 <h3 id="u-update">-u, –update</h3> 2459 <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> 2460 <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.</p> 2461 <p>On remotes which don’t support mod time directly 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> 2462 <p>This can be useful when transferring to a remote which doesn’t support mod times directly as it is more accurate than a <code>--size-only</code> check and faster than using <code>--checksum</code>.</p> 2463 <h3 id="use-mmap">–use-mmap</h3> 2464 <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> 2465 <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> 2466 <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> 2467 <h3 id="use-server-modtime">–use-server-modtime</h3> 2468 <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> 2469 <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, 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> 2470 <h3 id="v--vv-verbose">-v, -vv, –verbose</h3> 2471 <p>With <code>-v</code> rclone will tell you about each file that is transferred and a small number of significant events.</p> 2472 <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> 2473 <h3 id="v-version">-V, –version</h3> 2474 <p>Prints the version number</p> 2475 <h2 id="ssltls-options">SSL/TLS options</h2> 2476 <p>The outoing 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> 2477 <h3 id="ca-cert-string">–ca-cert string</h3> 2478 <p>This loads the PEM encoded certificate authority certificate and uses it to verify the certificates of the servers rclone connects to.</p> 2479 <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> 2480 <h3 id="client-cert-string">–client-cert string</h3> 2481 <p>This loads the PEM encoded client side certificate.</p> 2482 <p>This is used for <a href="https://en.wikipedia.org/wiki/Mutual_authentication">mutual TLS authentication</a>.</p> 2483 <p>The <code>--client-key</code> flag is required too when using this.</p> 2484 <h3 id="client-key-string">–client-key string</h3> 2485 <p>This loads the PEM encoded client side private key used for mutual TLS authentication. Used in conjunction with <code>--client-cert</code>.</p> 2486 <h3 id="no-check-certificatetruefalse">–no-check-certificate=true/false</h3> 2487 <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> 2488 <p>This option defaults to <code>false</code>.</p> 2489 <p><strong>This should be used only for testing.</strong></p> 2490 <h2 id="configuration-encryption">Configuration Encryption</h2> 2491 <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> 2492 <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 enter the password every time you start rclone.</p> 2493 <p>To add a password to your rclone configuration, execute <code>rclone config</code>.</p> 2494 <pre><code>>rclone config 2495 Current remotes: 2496 2497 e) Edit existing remote 2498 n) New remote 2499 d) Delete remote 2500 s) Set configuration password 2501 q) Quit config 2502 e/n/d/s/q></code></pre> 2503 <p>Go into <code>s</code>, Set configuration password:</p> 2504 <pre><code>e/n/d/s/q> s 2505 Your configuration is not encrypted. 2506 If you add a password, you will protect your login information to cloud services. 2507 a) Add Password 2508 q) Quit to main menu 2509 a/q> a 2510 Enter NEW configuration password: 2511 password: 2512 Confirm NEW password: 2513 password: 2514 Password set 2515 Your configuration is encrypted. 2516 c) Change Password 2517 u) Unencrypt configuration 2518 q) Quit to main menu 2519 c/u/q></code></pre> 2520 <p>Your configuration is now encrypted, and every time you start rclone you will now be asked for the password. In the same menu, you can change the password or completely remove encryption from your configuration.</p> 2521 <p>There is no way to recover the configuration if you lose your password.</p> 2522 <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> 2523 <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> 2524 <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> 2525 <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> 2526 <pre><code>#!/bin/echo Source this file don't run it 2527 2528 read -s RCLONE_CONFIG_PASS 2529 export RCLONE_CONFIG_PASS</code></pre> 2530 <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> 2531 <p>If you are running rclone inside a script, 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.</p> 2532 <h2 id="developer-options">Developer options</h2> 2533 <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> 2534 <h3 id="cpuprofilefile">–cpuprofile=FILE</h3> 2535 <p>Write CPU profile to file. This can be analysed with <code>go tool pprof</code>.</p> 2536 <h4 id="dump-flagflagflag">–dump flag,flag,flag</h4> 2537 <p>The <code>--dump</code> flag takes a comma separated list of flags to dump info about. These are:</p> 2538 <h4 id="dump-headers">–dump headers</h4> 2539 <p>Dump HTTP headers with <code>Authorization:</code> lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only.</p> 2540 <p>Use <code>--dump auth</code> if you do want the <code>Authorization:</code> headers.</p> 2541 <h4 id="dump-bodies">–dump bodies</h4> 2542 <p>Dump HTTP headers and bodies - may contain sensitive info. Can be very verbose. Useful for debugging only.</p> 2543 <p>Note that the bodies are buffered in memory so don’t use this for enormous files.</p> 2544 <h4 id="dump-requests">–dump requests</h4> 2545 <p>Like <code>--dump bodies</code> but dumps the request bodies and the response headers. Useful for debugging download problems.</p> 2546 <h4 id="dump-responses">–dump responses</h4> 2547 <p>Like <code>--dump bodies</code> but dumps the response bodies and the request headers. Useful for debugging upload problems.</p> 2548 <h4 id="dump-auth">–dump auth</h4> 2549 <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> 2550 <h4 id="dump-filters">–dump filters</h4> 2551 <p>Dump the filters to the output. Useful to see exactly what include and exclude options are filtering on.</p> 2552 <h4 id="dump-goroutines">–dump goroutines</h4> 2553 <p>This dumps a list of the running go-routines at the end of the command to standard output.</p> 2554 <h4 id="dump-openfiles">–dump openfiles</h4> 2555 <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> 2556 <h3 id="memprofilefile">–memprofile=FILE</h3> 2557 <p>Write memory profile to file. This can be analysed with <code>go tool pprof</code>.</p> 2558 <h2 id="filtering">Filtering</h2> 2559 <p>For the filtering options</p> 2560 <ul> 2561 <li><code>--delete-excluded</code></li> 2562 <li><code>--filter</code></li> 2563 <li><code>--filter-from</code></li> 2564 <li><code>--exclude</code></li> 2565 <li><code>--exclude-from</code></li> 2566 <li><code>--include</code></li> 2567 <li><code>--include-from</code></li> 2568 <li><code>--files-from</code></li> 2569 <li><code>--min-size</code></li> 2570 <li><code>--max-size</code></li> 2571 <li><code>--min-age</code></li> 2572 <li><code>--max-age</code></li> 2573 <li><code>--dump filters</code></li> 2574 </ul> 2575 <p>See the <a href="https://rclone.org/filtering/">filtering section</a>.</p> 2576 <h2 id="remote-control">Remote control</h2> 2577 <p>For the remote control options and for instructions on how to remote control rclone</p> 2578 <ul> 2579 <li><code>--rc</code></li> 2580 <li>and anything starting with <code>--rc-</code></li> 2581 </ul> 2582 <p>See <a href="https://rclone.org/rc/">the remote control section</a>.</p> 2583 <h2 id="logging">Logging</h2> 2584 <p>rclone has 4 levels of logging, <code>ERROR</code>, <code>NOTICE</code>, <code>INFO</code> and <code>DEBUG</code>.</p> 2585 <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> 2586 <p>By default, rclone will produce <code>Error</code> and <code>Notice</code> level messages.</p> 2587 <p>If you use the <code>-q</code> flag, rclone will only produce <code>Error</code> messages.</p> 2588 <p>If you use the <code>-v</code> flag, rclone will produce <code>Error</code>, <code>Notice</code> and <code>Info</code> messages.</p> 2589 <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> 2590 <p>You can also control the log levels with the <code>--log-level</code> flag.</p> 2591 <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> 2592 <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> 2593 <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> 2594 <h2 id="exit-code">Exit Code</h2> 2595 <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> 2596 <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> 2597 <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> 2598 <h3 id="list-of-exit-codes">List of exit codes</h3> 2599 <ul> 2600 <li><code>0</code> - success</li> 2601 <li><code>1</code> - Syntax or usage error</li> 2602 <li><code>2</code> - Error not otherwise categorised</li> 2603 <li><code>3</code> - Directory not found</li> 2604 <li><code>4</code> - File not found</li> 2605 <li><code>5</code> - Temporary error (one that more retries might fix) (Retry errors)</li> 2606 <li><code>6</code> - Less serious errors (like 461 errors from dropbox) (NoRetry errors)</li> 2607 <li><code>7</code> - Fatal error (one that more retries won’t fix, like account suspended) (Fatal errors)</li> 2608 <li><code>8</code> - Transfer exceeded - limit set by –max-transfer reached</li> 2609 </ul> 2610 <h2 id="environment-variables">Environment Variables</h2> 2611 <p>Rclone can be configured entirely using environment variables. These can be used to set defaults for options or config file entries.</p> 2612 <h3 id="options-65">Options</h3> 2613 <p>Every option in rclone can have its default set by environment variable.</p> 2614 <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> 2615 <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> 2616 <p>Or to always use the trash in drive <code>--drive-use-trash</code>, set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p> 2617 <p>The same parser is used for the options and the environment variables so they take exactly the same form.</p> 2618 <h3 id="config-file">Config file</h3> 2619 <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> 2620 <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> 2621 <p>For example, to configure an S3 remote named <code>mys3:</code> without a config file (using unix ways of setting environment variables):</p> 2622 <pre><code>$ export RCLONE_CONFIG_MYS3_TYPE=s3 2623 $ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX 2624 $ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX 2625 $ rclone lsd MYS3: 2626 -1 2016-09-21 12:54:21 -1 my-bucket 2627 $ rclone listremotes | grep mys3 2628 mys3:</code></pre> 2629 <p>Note that if you want to create a remote using environment variables you must create the <code>..._TYPE</code> variable as above.</p> 2630 <h3 id="other-environment-variables">Other environment variables</h3> 2631 <ul> 2632 <li>RCLONE_CONFIG_PASS` set to contain your config file password (see <a href="#configuration-encryption">Configuration Encryption</a> section)</li> 2633 <li>HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). 2634 <ul> 2635 <li>HTTPS_PROXY takes precedence over HTTP_PROXY for https requests.</li> 2636 <li>The environment values may be either a complete URL or a “host[:port]” for, in which case the “http” scheme is assumed.</li> 2637 </ul></li> 2638 </ul> 2639 <h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring rclone on a remote / headless machine</h1> 2640 <p>Some of the configurations (those involving oauth2) require an Internet connected web browser.</p> 2641 <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> 2642 <h2 id="configuring-using-rclone-authorize">Configuring using rclone authorize</h2> 2643 <p>On the headless box</p> 2644 <pre><code>... 2645 Remote config 2646 Use auto config? 2647 * Say Y if not sure 2648 * Say N if you are working on a remote or headless machine 2649 y) Yes 2650 n) No 2651 y/n> n 2652 For this to work, you will need rclone available on a machine that has a web browser available. 2653 Execute the following on your machine: 2654 rclone authorize "amazon cloud drive" 2655 Then paste the result below: 2656 result></code></pre> 2657 <p>Then on your main desktop machine</p> 2658 <pre><code>rclone authorize "amazon cloud drive" 2659 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 2660 Log in and authorize rclone for access 2661 Waiting for code... 2662 Got code 2663 Paste the following into your remote machine ---> 2664 SECRET_TOKEN 2665 <---End paste</code></pre> 2666 <p>Then back to the headless box, paste in the code</p> 2667 <pre><code>result> SECRET_TOKEN 2668 -------------------- 2669 [acd12] 2670 client_id = 2671 client_secret = 2672 token = SECRET_TOKEN 2673 -------------------- 2674 y) Yes this is OK 2675 e) Edit this remote 2676 d) Delete this remote 2677 y/e/d></code></pre> 2678 <h2 id="configuring-by-copying-the-config-file">Configuring by copying the config file</h2> 2679 <p>Rclone stores all of its config in a single configuration file. This can easily be copied to configure a remote rclone.</p> 2680 <p>So first configure rclone on your desktop machine</p> 2681 <pre><code>rclone config</code></pre> 2682 <p>to set up the config file.</p> 2683 <p>Find the config file by running <code>rclone config file</code>, for example</p> 2684 <pre><code>$ rclone config file 2685 Configuration file is stored at: 2686 /home/user/.rclone.conf</code></pre> 2687 <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> 2688 <h1 id="filtering-includes-and-excludes">Filtering, includes and excludes</h1> 2689 <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> 2690 <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> 2691 <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>.</p> 2692 <h2 id="patterns">Patterns</h2> 2693 <p>The patterns used to match files for inclusion or exclusion are based on “file globs” as used by the unix shell.</p> 2694 <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> 2695 <pre><code>file.jpg - matches "file.jpg" 2696 - matches "directory/file.jpg" 2697 - doesn't match "afile.jpg" 2698 - doesn't match "directory/afile.jpg" 2699 /file.jpg - matches "file.jpg" in the root directory of the remote 2700 - doesn't match "afile.jpg" 2701 - doesn't match "directory/file.jpg"</code></pre> 2702 <p><strong>Important</strong> Note that you must use <code>/</code> in patterns and not <code>\</code> even if running on Windows.</p> 2703 <p>A <code>*</code> matches anything but not a <code>/</code>.</p> 2704 <pre><code>*.jpg - matches "file.jpg" 2705 - matches "directory/file.jpg" 2706 - doesn't match "file.jpg/something"</code></pre> 2707 <p>Use <code>**</code> to match anything, including slashes (<code>/</code>).</p> 2708 <pre><code>dir/** - matches "dir/file.jpg" 2709 - matches "dir/dir1/dir2/file.jpg" 2710 - doesn't match "directory/file.jpg" 2711 - doesn't match "adir/file.jpg"</code></pre> 2712 <p>A <code>?</code> matches any character except a slash <code>/</code>.</p> 2713 <pre><code>l?ss - matches "less" 2714 - matches "lass" 2715 - doesn't match "floss"</code></pre> 2716 <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> 2717 <pre><code>h[ae]llo - matches "hello" 2718 - matches "hallo" 2719 - doesn't match "hullo"</code></pre> 2720 <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> 2721 <pre><code>{one,two}_potato - matches "one_potato" 2722 - matches "two_potato" 2723 - doesn't match "three_potato" 2724 - doesn't match "_potato"</code></pre> 2725 <p>Special characters can be escaped with a <code>\</code> before them.</p> 2726 <pre><code>\*.jpg - matches "*.jpg" 2727 \\.jpg - matches "\.jpg" 2728 \[one\].jpg - matches "[one].jpg"</code></pre> 2729 <p>Patterns are case sensitive unless the <code>--ignore-case</code> flag is used.</p> 2730 <p>Without <code>--ignore-case</code> (default)</p> 2731 <pre><code>potato - matches "potato" 2732 - doesn't match "POTATO"</code></pre> 2733 <p>With <code>--ignore-case</code></p> 2734 <pre><code>potato - matches "potato" 2735 - matches "POTATO"</code></pre> 2736 <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> 2737 <h3 id="directories">Directories</h3> 2738 <p>Rclone keeps track of directories that could match any file patterns.</p> 2739 <p>Eg if you add the include rule</p> 2740 <pre><code>/a/*.jpg</code></pre> 2741 <p>Rclone will synthesize the directory include rule</p> 2742 <pre><code>/a/</code></pre> 2743 <p>If you put any rules which end in <code>/</code> then it will only match directories.</p> 2744 <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> 2745 <h3 id="differences-between-rsync-and-rclone-patterns">Differences between rsync and rclone patterns</h3> 2746 <p>Rclone implements bash style <code>{a,b,c}</code> glob matching which rsync doesn’t.</p> 2747 <p>Rclone always does a wildcard match so <code>\</code> must always escape a <code>\</code>.</p> 2748 <h2 id="how-the-rules-are-used">How the rules are used</h2> 2749 <p>Rclone maintains a combined list of include rules and exclude rules.</p> 2750 <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> 2751 <p>If the matcher fails to find a match after testing against all the entries in the list then the path is included.</p> 2752 <p>For example given the following rules, <code>+</code> being include, <code>-</code> being exclude,</p> 2753 <pre><code>- secret*.jpg 2754 + *.jpg 2755 + *.png 2756 + file2.avi 2757 - *</code></pre> 2758 <p>This would include</p> 2759 <ul> 2760 <li><code>file1.jpg</code></li> 2761 <li><code>file3.png</code></li> 2762 <li><code>file2.avi</code></li> 2763 </ul> 2764 <p>This would exclude</p> 2765 <ul> 2766 <li><code>secret17.jpg</code></li> 2767 <li>non <code>*.jpg</code> and <code>*.png</code></li> 2768 </ul> 2769 <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> 2770 <h2 id="adding-filtering-rules">Adding filtering rules</h2> 2771 <p>Filtering rules are added with the following command line flags.</p> 2772 <h3 id="repeating-options">Repeating options</h3> 2773 <p>You can repeat the following options to add more than one rule of that type.</p> 2774 <ul> 2775 <li><code>--include</code></li> 2776 <li><code>--include-from</code></li> 2777 <li><code>--exclude</code></li> 2778 <li><code>--exclude-from</code></li> 2779 <li><code>--filter</code></li> 2780 <li><code>--filter-from</code></li> 2781 </ul> 2782 <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> 2783 <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> 2784 <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> 2785 <p>To mix up the order includes and excludes, the <code>--filter</code> flag can be used.</p> 2786 <h3 id="exclude---exclude-files-matching-pattern"><code>--exclude</code> - Exclude files matching pattern</h3> 2787 <p>Add a single exclude rule with <code>--exclude</code>.</p> 2788 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2789 <p>Eg <code>--exclude *.bak</code> to exclude all bak files from the sync.</p> 2790 <h3 id="exclude-from---read-exclude-patterns-from-file"><code>--exclude-from</code> - Read exclude patterns from file</h3> 2791 <p>Add exclude rules from a file.</p> 2792 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2793 <p>Prepare a file like this <code>exclude-file.txt</code></p> 2794 <pre><code># a sample exclude rule file 2795 *.bak 2796 file2.jpg</code></pre> 2797 <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> 2798 <p>This is useful if you have a lot of rules.</p> 2799 <h3 id="include---include-files-matching-pattern"><code>--include</code> - Include files matching pattern</h3> 2800 <p>Add a single include rule with <code>--include</code>.</p> 2801 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2802 <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> 2803 <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> 2804 <h3 id="include-from---read-include-patterns-from-file"><code>--include-from</code> - Read include patterns from file</h3> 2805 <p>Add include rules from a file.</p> 2806 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2807 <p>Prepare a file like this <code>include-file.txt</code></p> 2808 <pre><code># a sample include rule file 2809 *.jpg 2810 *.png 2811 file2.avi</code></pre> 2812 <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> 2813 <p>This is useful if you have a lot of rules.</p> 2814 <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> 2815 <h3 id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add a file-filtering rule</h3> 2816 <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> 2817 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2818 <p>Eg <code>--filter "- *.bak"</code> to exclude all bak files from the sync.</p> 2819 <h3 id="filter-from---read-filtering-patterns-from-a-file"><code>--filter-from</code> - Read filtering patterns from a file</h3> 2820 <p>Add include/exclude rules from a file.</p> 2821 <p>This flag can be repeated. See above for the order the flags are processed in.</p> 2822 <p>Prepare a file like this <code>filter-file.txt</code></p> 2823 <pre><code># a sample filter rule file 2824 - secret*.jpg 2825 + *.jpg 2826 + *.png 2827 + file2.avi 2828 - /dir/Trash/** 2829 + /dir/** 2830 # exclude everything else 2831 - *</code></pre> 2832 <p>Then use as <code>--filter-from filter-file.txt</code>. The rules are processed in the order that they are defined.</p> 2833 <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> 2834 <h3 id="files-from---read-list-of-source-file-names"><code>--files-from</code> - Read list of source-file names</h3> 2835 <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> 2836 <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> 2837 <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> 2838 <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> 2839 <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.</p> 2840 <p>For example, suppose you had <code>files-from.txt</code> with this content:</p> 2841 <pre><code># comment 2842 file1.jpg 2843 subdir/file2.jpg</code></pre> 2844 <p>You could then use it like this:</p> 2845 <pre><code>rclone copy --files-from files-from.txt /home/me/pics remote:pics</code></pre> 2846 <p>This will transfer these files only (if they exist)</p> 2847 <pre><code>/home/me/pics/file1.jpg → remote:pics/file1.jpg 2848 /home/me/pics/subdir/file2.jpg → remote:pics/subdirfile1.jpg</code></pre> 2849 <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> 2850 <pre><code>/home/user1/important 2851 /home/user1/dir/file 2852 /home/user2/stuff</code></pre> 2853 <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> 2854 <pre><code>user1/important 2855 user1/dir/file 2856 user2/stuff</code></pre> 2857 <p>You could then copy these to a remote like this</p> 2858 <pre><code>rclone copy --files-from files-from.txt /home remote:backup</code></pre> 2859 <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> 2860 <pre><code>/home/user1/important → remote:backup/user1/important 2861 /home/user1/dir/file → remote:backup/user1/dir/file 2862 /home/user2/stuff → remote:backup/stuff</code></pre> 2863 <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> 2864 <pre><code>/home/user1/important 2865 /home/user1/dir/file 2866 /home/user2/stuff</code></pre> 2867 <p>And you would transfer it like this</p> 2868 <pre><code>rclone copy --files-from files-from.txt / remote:backup</code></pre> 2869 <p>In this case there will be an extra <code>home</code> directory on the remote:</p> 2870 <pre><code>/home/user1/important → remote:home/backup/user1/important 2871 /home/user1/dir/file → remote:home/backup/user1/dir/file 2872 /home/user2/stuff → remote:home/backup/stuff</code></pre> 2873 <h3 id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code> - Don’t transfer any file smaller than this</h3> 2874 <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> 2875 <p>For example <code>--min-size 50k</code> means no files smaller than 50kByte will be transferred.</p> 2876 <h3 id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code> - Don’t transfer any file larger than this</h3> 2877 <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> 2878 <p>For example <code>--max-size 1G</code> means no files larger than 1GByte will be transferred.</p> 2879 <h3 id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code> - Don’t transfer any file older than this</h3> 2880 <p>This option controls the maximum age of files to transfer. Give in seconds or with a suffix of:</p> 2881 <ul> 2882 <li><code>ms</code> - Milliseconds</li> 2883 <li><code>s</code> - Seconds</li> 2884 <li><code>m</code> - Minutes</li> 2885 <li><code>h</code> - Hours</li> 2886 <li><code>d</code> - Days</li> 2887 <li><code>w</code> - Weeks</li> 2888 <li><code>M</code> - Months</li> 2889 <li><code>y</code> - Years</li> 2890 </ul> 2891 <p>For example <code>--max-age 2d</code> means no files older than 2 days will be transferred.</p> 2892 <h3 id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code> - Don’t transfer any file younger than this</h3> 2893 <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> 2894 <p>For example <code>--min-age 2d</code> means no files younger than 2 days will be transferred.</p> 2895 <h3 id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code> - Delete files on dest excluded from sync</h3> 2896 <p><strong>Important</strong> this flag is dangerous - use with <code>--dry-run</code> and <code>-v</code> first.</p> 2897 <p>When doing <code>rclone sync</code> this will delete any files which are excluded from the sync on the destination.</p> 2898 <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> 2899 <pre><code>rclone sync A: B:</code></pre> 2900 <p>Then you repeated it like this with the <code>--delete-excluded</code></p> 2901 <pre><code>rclone --min-size 50k --delete-excluded sync A: B:</code></pre> 2902 <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> 2903 <p>Always test first with <code>--dry-run</code> and <code>-v</code> before using this flag.</p> 2904 <h3 id="dump-filters---dump-the-filters-to-the-output"><code>--dump filters</code> - dump the filters to the output</h3> 2905 <p>This dumps the defined filters to the output as regular expressions.</p> 2906 <p>Useful for debugging.</p> 2907 <h3 id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code> - make searches case insensitive</h3> 2908 <p>Normally filter patterns are case sensitive. If this flag is supplied then filter patterns become case insensitive.</p> 2909 <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> 2910 <h2 id="quoting-shell-metacharacters">Quoting shell metacharacters</h2> 2911 <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> 2912 <p>Eg linux, OSX</p> 2913 <ul> 2914 <li><code>--include \*.jpg</code></li> 2915 <li><code>--include '*.jpg'</code></li> 2916 <li><code>--include='*.jpg'</code></li> 2917 </ul> 2918 <p>In Windows the expansion is done by the command not the shell so this should work fine</p> 2919 <ul> 2920 <li><code>--include *.jpg</code></li> 2921 </ul> 2922 <h2 id="exclude-directory-based-on-a-file">Exclude directory based on a file</h2> 2923 <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> 2924 <p>Imagine, you have the following directory structure:</p> 2925 <pre><code>dir1/file1 2926 dir1/dir2/file2 2927 dir1/dir2/dir3/file3 2928 dir1/dir2/dir3/.ignore</code></pre> 2929 <p>You can exclude <code>dir3</code> from sync by running the following command:</p> 2930 <pre><code>rclone sync --exclude-if-present .ignore dir1 remote:backup</code></pre> 2931 <p>Currently only one filename is supported, i.e. <code>--exclude-if-present</code> should not be used multiple times.</p> 2932 <h1 id="remote-controlling-rclone">Remote controlling rclone</h1> 2933 <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.</p> 2934 <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> 2935 <p><strong>NB</strong> this is experimental and everything here is subject to change!</p> 2936 <h2 id="supported-parameters">Supported parameters</h2> 2937 <h3 id="rc">–rc</h3> 2938 <p>Flag to start the http server listen on remote requests</p> 2939 <h3 id="rc-addrip">–rc-addr=IP</h3> 2940 <p>IPaddress:Port or :Port to bind server to. (default “localhost:5572”)</p> 2941 <h3 id="rc-certkey">–rc-cert=KEY</h3> 2942 <p>SSL PEM key (concatenation of certificate and CA certificate)</p> 2943 <h3 id="rc-client-capath">–rc-client-ca=PATH</h3> 2944 <p>Client certificate authority to verify clients with</p> 2945 <h3 id="rc-htpasswdpath">–rc-htpasswd=PATH</h3> 2946 <p>htpasswd file - if not provided no authentication is done</p> 2947 <h3 id="rc-keypath">–rc-key=PATH</h3> 2948 <p>SSL PEM Private key</p> 2949 <h3 id="rc-max-header-bytesvalue">–rc-max-header-bytes=VALUE</h3> 2950 <p>Maximum size of request header (default 4096)</p> 2951 <h3 id="rc-uservalue">–rc-user=VALUE</h3> 2952 <p>User name for authentication.</p> 2953 <h3 id="rc-passvalue">–rc-pass=VALUE</h3> 2954 <p>Password for authentication.</p> 2955 <h3 id="rc-realmvalue">–rc-realm=VALUE</h3> 2956 <p>Realm for authentication (default “rclone”)</p> 2957 <h3 id="rc-server-read-timeoutduration">–rc-server-read-timeout=DURATION</h3> 2958 <p>Timeout for server reading data (default 1h0m0s)</p> 2959 <h3 id="rc-server-write-timeoutduration">–rc-server-write-timeout=DURATION</h3> 2960 <p>Timeout for server writing data (default 1h0m0s)</p> 2961 <h3 id="rc-serve">–rc-serve</h3> 2962 <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> 2963 <p>Default Off.</p> 2964 <h3 id="rc-files-pathtodirectory">–rc-files /path/to/directory</h3> 2965 <p>Path to local files to serve on the HTTP server.</p> 2966 <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> 2967 <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> 2968 <p>Default Off.</p> 2969 <h3 id="rc-job-expire-durationduration">–rc-job-expire-duration=DURATION</h3> 2970 <p>Expire finished async jobs older than DURATION (default 60s).</p> 2971 <h3 id="rc-job-expire-intervalduration">–rc-job-expire-interval=DURATION</h3> 2972 <p>Interval duration to check for expired async jobs (default 10s).</p> 2973 <h3 id="rc-no-auth">–rc-no-auth</h3> 2974 <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> 2975 <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> 2976 <p>Default Off.</p> 2977 <h2 id="accessing-the-remote-control-via-the-rclone-rc-command">Accessing the remote control via the rclone rc command</h2> 2978 <p>Rclone itself implements the remote control protocol in its <code>rclone rc</code> command.</p> 2979 <p>You can use it like this</p> 2980 <pre><code>$ rclone rc rc/noop param1=one param2=two 2981 { 2982 "param1": "one", 2983 "param2": "two" 2984 }</code></pre> 2985 <p>Run <code>rclone rc</code> on its own to see the help for the installed remote control commands.</p> 2986 <p><code>rclone rc</code> also supports a <code>--json</code> flag which can be used to send more complicated input parameters.</p> 2987 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 } }' rc/noop 2988 { 2989 "p1": [ 2990 1, 2991 "2", 2992 null, 2993 4 2994 ], 2995 "p2": { 2996 "a": 1, 2997 "b": 2 2998 } 2999 }</code></pre> 3000 <h2 id="special-parameters">Special parameters</h2> 3001 <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> 3002 <h3 id="running-asynchronous-jobs-with-_async-true">Running asynchronous jobs with _async = true</h3> 3003 <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> 3004 <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> 3005 <p>Starting a job with the <code>_async</code> flag:</p> 3006 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 }, "_async": true }' rc/noop 3007 { 3008 "jobid": 2 3009 }</code></pre> 3010 <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> 3011 <pre><code>$ rclone rc --json '{ "jobid":2 }' job/status 3012 { 3013 "duration": 0.000124163, 3014 "endTime": "2018-10-27T11:38:07.911245881+01:00", 3015 "error": "", 3016 "finished": true, 3017 "id": 2, 3018 "output": { 3019 "_async": true, 3020 "p1": [ 3021 1, 3022 "2", 3023 null, 3024 4 3025 ], 3026 "p2": { 3027 "a": 1, 3028 "b": 2 3029 } 3030 }, 3031 "startTime": "2018-10-27T11:38:07.911121728+01:00", 3032 "success": true 3033 }</code></pre> 3034 <p><code>job/list</code> can be used to show the running or recently completed jobs</p> 3035 <pre><code>$ rclone rc job/list 3036 { 3037 "jobids": [ 3038 2 3039 ] 3040 }</code></pre> 3041 <h2 id="supported-commands">Supported commands</h2> 3042 <!--- autogenerated start - run make rcdocs - don't edit here --> 3043 <h3 id="cacheexpire-purge-a-remote-from-cache">cache/expire: Purge a remote from cache</h3> 3044 <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> 3045 <p>Eg</p> 3046 <pre><code>rclone rc cache/expire remote=path/to/sub/folder/ 3047 rclone rc cache/expire remote=/ withData=true</code></pre> 3048 <h3 id="cachefetch-fetch-file-chunks">cache/fetch: Fetch file chunks</h3> 3049 <p>Ensure the specified file chunks are cached on disk.</p> 3050 <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> 3051 <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> 3052 <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> 3053 <p>Any parameter with a key that starts with “file” can be used to specify files to fetch, eg</p> 3054 <pre><code>rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye</code></pre> 3055 <p>File names will automatically be encrypted when the a crypt remote is used on top of the cache.</p> 3056 <h3 id="cachestats-get-cache-stats">cache/stats: Get cache stats</h3> 3057 <p>Show statistics for the cache remote.</p> 3058 <h3 id="configcreate-create-the-config-for-a-remote.">config/create: create the config for a remote.</h3> 3059 <p>This takes the following parameters</p> 3060 <ul> 3061 <li>name - name of remote</li> 3062 <li>type - type of the new remote</li> 3063 </ul> 3064 <p>See the <a href="https://rclone.org/commands/rclone_config_create/">config create command</a> command for more information on the above.</p> 3065 <p>Authentication is required for this call.</p> 3066 <h3 id="configdelete-delete-a-remote-in-the-config-file.">config/delete: Delete a remote in the config file.</h3> 3067 <p>Parameters: - name - name of remote to delete</p> 3068 <p>See the <a href="https://rclone.org/commands/rclone_config_delete/">config delete command</a> command for more information on the above.</p> 3069 <p>Authentication is required for this call.</p> 3070 <h3 id="configdump-dumps-the-config-file.">config/dump: Dumps the config file.</h3> 3071 <p>Returns a JSON object: - key: value</p> 3072 <p>Where keys are remote names and values are the config parameters.</p> 3073 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p> 3074 <p>Authentication is required for this call.</p> 3075 <h3 id="configget-get-a-remote-in-the-config-file.">config/get: Get a remote in the config file.</h3> 3076 <p>Parameters: - name - name of remote to get</p> 3077 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p> 3078 <p>Authentication is required for this call.</p> 3079 <h3 id="configlistremotes-lists-the-remotes-in-the-config-file.">config/listremotes: Lists the remotes in the config file.</h3> 3080 <p>Returns - remotes - array of remote names</p> 3081 <p>See the <a href="https://rclone.org/commands/rclone_listremotes/">listremotes command</a> command for more information on the above.</p> 3082 <p>Authentication is required for this call.</p> 3083 <h3 id="configpassword-password-the-config-for-a-remote.">config/password: password the config for a remote.</h3> 3084 <p>This takes the following parameters</p> 3085 <ul> 3086 <li>name - name of remote</li> 3087 </ul> 3088 <p>See the <a href="https://rclone.org/commands/rclone_config_password/">config password command</a> command for more information on the above.</p> 3089 <p>Authentication is required for this call.</p> 3090 <h3 id="configproviders-shows-how-providers-are-configured-in-the-config-file.">config/providers: Shows how providers are configured in the config file.</h3> 3091 <p>Returns a JSON object: - providers - array of objects</p> 3092 <p>See the <a href="https://rclone.org/commands/rclone_config_providers/">config providers command</a> command for more information on the above.</p> 3093 <p>Authentication is required for this call.</p> 3094 <h3 id="configupdate-update-the-config-for-a-remote.">config/update: update the config for a remote.</h3> 3095 <p>This takes the following parameters</p> 3096 <ul> 3097 <li>name - name of remote</li> 3098 </ul> 3099 <p>See the <a href="https://rclone.org/commands/rclone_config_update/">config update command</a> command for more information on the above.</p> 3100 <p>Authentication is required for this call.</p> 3101 <h3 id="corebwlimit-set-the-bandwidth-limit.">core/bwlimit: Set the bandwidth limit.</h3> 3102 <p>This sets the bandwidth limit to that passed in.</p> 3103 <p>Eg</p> 3104 <pre><code>rclone rc core/bwlimit rate=1M 3105 rclone rc core/bwlimit rate=off</code></pre> 3106 <p>The format of the parameter is exactly the same as passed to –bwlimit except only one bandwidth may be specified.</p> 3107 <h3 id="coregc-runs-a-garbage-collection.">core/gc: Runs a garbage collection.</h3> 3108 <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> 3109 <h3 id="corememstats-returns-the-memory-statistics">core/memstats: Returns the memory statistics</h3> 3110 <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> 3111 <p>The most interesting values for most people are:</p> 3112 <ul> 3113 <li>HeapAlloc: This is the amount of memory rclone is actually using</li> 3114 <li>HeapSys: This is the amount of memory rclone has obtained from the OS</li> 3115 <li>Sys: this is the total amount of memory requested from the OS 3116 <ul> 3117 <li>It is virtual memory so may include unused memory</li> 3118 </ul></li> 3119 </ul> 3120 <h3 id="coreobscure-obscures-a-string-passed-in.">core/obscure: Obscures a string passed in.</h3> 3121 <p>Pass a clear string and rclone will obscure it for the config file: - clear - string</p> 3122 <p>Returns - obscured - string</p> 3123 <h3 id="corepid-return-pid-of-current-process">core/pid: Return PID of current process</h3> 3124 <p>This returns PID of current process. Useful for stopping rclone process.</p> 3125 <h3 id="corestats-returns-stats-about-current-transfers.">core/stats: Returns stats about current transfers.</h3> 3126 <p>This returns all available stats</p> 3127 <pre><code>rclone rc core/stats</code></pre> 3128 <p>Returns the following values:</p> 3129 <pre><code>{ 3130 "speed": average speed in bytes/sec since start of the process, 3131 "bytes": total transferred bytes since the start of the process, 3132 "errors": number of errors, 3133 "fatalError": whether there has been at least one FatalError, 3134 "retryError": whether there has been at least one non-NoRetryError, 3135 "checks": number of checked files, 3136 "transfers": number of transferred files, 3137 "deletes" : number of deleted files, 3138 "elapsedTime": time in seconds since the start of the process, 3139 "lastError": last occurred error, 3140 "transferring": an array of currently active file transfers: 3141 [ 3142 { 3143 "bytes": total transferred bytes for this file, 3144 "eta": estimated time in seconds until file transfer completion 3145 "name": name of the file, 3146 "percentage": progress of the file transfer in percent, 3147 "speed": speed in bytes/sec, 3148 "speedAvg": speed in bytes/sec as an exponentially weighted moving average, 3149 "size": size of the file in bytes 3150 } 3151 ], 3152 "checking": an array of names of currently active file checks 3153 [] 3154 }</code></pre> 3155 <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> 3156 <h3 id="coreversion-shows-the-current-version-of-rclone-and-the-go-runtime.">core/version: Shows the current version of rclone and the go runtime.</h3> 3157 <p>This shows the current version of go and the go runtime - version - rclone version, eg “v1.44” - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version - isGit - boolean - true if this was compiled from the git version - os - OS in use as according to Go - arch - cpu architecture in use according to Go - goVersion - version of Go runtime in use</p> 3158 <h3 id="joblist-lists-the-ids-of-the-running-jobs">job/list: Lists the IDs of the running jobs</h3> 3159 <p>Parameters - None</p> 3160 <p>Results - jobids - array of integer job ids</p> 3161 <h3 id="jobstatus-reads-the-status-of-the-job-id">job/status: Reads the status of the job ID</h3> 3162 <p>Parameters - jobid - id of the job (integer)</p> 3163 <p>Results - finished - boolean - duration - time in seconds that the job ran for - endTime - time the job finished (eg “2018-10-26T18:50:20.528746884+01:00”) - error - error from the job or empty string for no error - finished - boolean whether the job has finished or not - id - as passed in above - startTime - time the job started (eg “2018-10-26T18:50:20.528336039+01:00”) - success - boolean - true for success false otherwise - output - output of the job as would have been returned if called synchronously</p> 3164 <h3 id="operationsabout-return-the-space-used-on-the-remote">operations/about: Return the space used on the remote</h3> 3165 <p>This takes the following parameters</p> 3166 <ul> 3167 <li>fs - a remote name string eg “drive:”</li> 3168 </ul> 3169 <p>The result is as returned from rclone about –json</p> 3170 <p>See the <a href="https://rclone.org/commands/rclone_size/">about command</a> command for more information on the above.</p> 3171 <p>Authentication is required for this call.</p> 3172 <h3 id="operationscleanup-remove-trashed-files-in-the-remote-or-path">operations/cleanup: Remove trashed files in the remote or path</h3> 3173 <p>This takes the following parameters</p> 3174 <ul> 3175 <li>fs - a remote name string eg “drive:”</li> 3176 </ul> 3177 <p>See the <a href="https://rclone.org/commands/rclone_cleanup/">cleanup command</a> command for more information on the above.</p> 3178 <p>Authentication is required for this call.</p> 3179 <h3 id="operationscopyfile-copy-a-file-from-source-remote-to-destination-remote">operations/copyfile: Copy a file from source remote to destination remote</h3> 3180 <p>This takes the following parameters</p> 3181 <ul> 3182 <li>srcFs - a remote name string eg “drive:” for the source</li> 3183 <li>srcRemote - a path within that remote eg “file.txt” for the source</li> 3184 <li>dstFs - a remote name string eg “drive2:” for the destination</li> 3185 <li>dstRemote - a path within that remote eg “file2.txt” for the destination</li> 3186 </ul> 3187 <p>Authentication is required for this call.</p> 3188 <h3 id="operationscopyurl-copy-the-url-to-the-object">operations/copyurl: Copy the URL to the object</h3> 3189 <p>This takes the following parameters</p> 3190 <ul> 3191 <li>fs - a remote name string eg “drive:”</li> 3192 <li>remote - a path within that remote eg “dir”</li> 3193 <li>url - string, URL to read from</li> 3194 </ul> 3195 <p>See the <a href="https://rclone.org/commands/rclone_copyurl/">copyurl command</a> command for more information on the above.</p> 3196 <p>Authentication is required for this call.</p> 3197 <h3 id="operationsdelete-remove-files-in-the-path">operations/delete: Remove files in the path</h3> 3198 <p>This takes the following parameters</p> 3199 <ul> 3200 <li>fs - a remote name string eg “drive:”</li> 3201 </ul> 3202 <p>See the <a href="https://rclone.org/commands/rclone_delete/">delete command</a> command for more information on the above.</p> 3203 <p>Authentication is required for this call.</p> 3204 <h3 id="operationsdeletefile-remove-the-single-file-pointed-to">operations/deletefile: Remove the single file pointed to</h3> 3205 <p>This takes the following parameters</p> 3206 <ul> 3207 <li>fs - a remote name string eg “drive:”</li> 3208 <li>remote - a path within that remote eg “dir”</li> 3209 </ul> 3210 <p>See the <a href="https://rclone.org/commands/rclone_deletefile/">deletefile command</a> command for more information on the above.</p> 3211 <p>Authentication is required for this call.</p> 3212 <h3 id="operationsfsinfo-return-information-about-the-remote">operations/fsinfo: Return information about the remote</h3> 3213 <p>This takes the following parameters</p> 3214 <ul> 3215 <li>fs - a remote name string eg “drive:”</li> 3216 </ul> 3217 <p>This returns info about the remote passed in;</p> 3218 <pre><code>{ 3219 // optional features and whether they are available or not 3220 "Features": { 3221 "About": true, 3222 "BucketBased": false, 3223 "CanHaveEmptyDirectories": true, 3224 "CaseInsensitive": false, 3225 "ChangeNotify": false, 3226 "CleanUp": false, 3227 "Copy": false, 3228 "DirCacheFlush": false, 3229 "DirMove": true, 3230 "DuplicateFiles": false, 3231 "GetTier": false, 3232 "ListR": false, 3233 "MergeDirs": false, 3234 "Move": true, 3235 "OpenWriterAt": true, 3236 "PublicLink": false, 3237 "Purge": true, 3238 "PutStream": true, 3239 "PutUnchecked": false, 3240 "ReadMimeType": false, 3241 "ServerSideAcrossConfigs": false, 3242 "SetTier": false, 3243 "SetWrapper": false, 3244 "UnWrap": false, 3245 "WrapFs": false, 3246 "WriteMimeType": false 3247 }, 3248 // Names of hashes available 3249 "Hashes": [ 3250 "MD5", 3251 "SHA-1", 3252 "DropboxHash", 3253 "QuickXorHash" 3254 ], 3255 "Name": "local", // Name as created 3256 "Precision": 1, // Precision of timestamps in ns 3257 "Root": "/", // Path as created 3258 "String": "Local file system at /" // how the remote will appear in logs 3259 }</code></pre> 3260 <p>This command does not have a command line equivalent so use this instead:</p> 3261 <pre><code>rclone rc --loopback operations/fsinfo fs=remote:</code></pre> 3262 <h3 id="operationslist-list-the-given-remote-and-path-in-json-format">operations/list: List the given remote and path in JSON format</h3> 3263 <p>This takes the following parameters</p> 3264 <ul> 3265 <li>fs - a remote name string eg “drive:”</li> 3266 <li>remote - a path within that remote eg “dir”</li> 3267 <li>opt - a dictionary of options to control the listing (optional) 3268 <ul> 3269 <li>recurse - If set recurse directories</li> 3270 <li>noModTime - If set return modification time</li> 3271 <li>showEncrypted - If set show decrypted names</li> 3272 <li>showOrigIDs - If set show the IDs for each item if known</li> 3273 <li>showHash - If set return a dictionary of hashes</li> 3274 </ul></li> 3275 </ul> 3276 <p>The result is</p> 3277 <ul> 3278 <li>list 3279 <ul> 3280 <li>This is an array of objects as described in the lsjson command</li> 3281 </ul></li> 3282 </ul> 3283 <p>See the <a href="https://rclone.org/commands/rclone_lsjson/">lsjson command</a> for more information on the above and examples.</p> 3284 <p>Authentication is required for this call.</p> 3285 <h3 id="operationsmkdir-make-a-destination-directory-or-container">operations/mkdir: Make a destination directory or container</h3> 3286 <p>This takes the following parameters</p> 3287 <ul> 3288 <li>fs - a remote name string eg “drive:”</li> 3289 <li>remote - a path within that remote eg “dir”</li> 3290 </ul> 3291 <p>See the <a href="https://rclone.org/commands/rclone_mkdir/">mkdir command</a> command for more information on the above.</p> 3292 <p>Authentication is required for this call.</p> 3293 <h3 id="operationsmovefile-move-a-file-from-source-remote-to-destination-remote">operations/movefile: Move a file from source remote to destination remote</h3> 3294 <p>This takes the following parameters</p> 3295 <ul> 3296 <li>srcFs - a remote name string eg “drive:” for the source</li> 3297 <li>srcRemote - a path within that remote eg “file.txt” for the source</li> 3298 <li>dstFs - a remote name string eg “drive2:” for the destination</li> 3299 <li>dstRemote - a path within that remote eg “file2.txt” for the destination</li> 3300 </ul> 3301 <p>Authentication is required for this call.</p> 3302 <h3 id="operationspubliclink-create-or-retrieve-a-public-link-to-the-given-file-or-folder.">operations/publiclink: Create or retrieve a public link to the given file or folder.</h3> 3303 <p>This takes the following parameters</p> 3304 <ul> 3305 <li>fs - a remote name string eg “drive:”</li> 3306 <li>remote - a path within that remote eg “dir”</li> 3307 </ul> 3308 <p>Returns</p> 3309 <ul> 3310 <li>url - URL of the resource</li> 3311 </ul> 3312 <p>See the <a href="https://rclone.org/commands/rclone_link/">link command</a> command for more information on the above.</p> 3313 <p>Authentication is required for this call.</p> 3314 <h3 id="operationspurge-remove-a-directory-or-container-and-all-of-its-contents">operations/purge: Remove a directory or container and all of its contents</h3> 3315 <p>This takes the following parameters</p> 3316 <ul> 3317 <li>fs - a remote name string eg “drive:”</li> 3318 <li>remote - a path within that remote eg “dir”</li> 3319 </ul> 3320 <p>See the <a href="https://rclone.org/commands/rclone_purge/">purge command</a> command for more information on the above.</p> 3321 <p>Authentication is required for this call.</p> 3322 <h3 id="operationsrmdir-remove-an-empty-directory-or-container">operations/rmdir: Remove an empty directory or container</h3> 3323 <p>This takes the following parameters</p> 3324 <ul> 3325 <li>fs - a remote name string eg “drive:”</li> 3326 <li>remote - a path within that remote eg “dir”</li> 3327 </ul> 3328 <p>See the <a href="https://rclone.org/commands/rclone_rmdir/">rmdir command</a> command for more information on the above.</p> 3329 <p>Authentication is required for this call.</p> 3330 <h3 id="operationsrmdirs-remove-all-the-empty-directories-in-the-path">operations/rmdirs: Remove all the empty directories in the path</h3> 3331 <p>This takes the following parameters</p> 3332 <ul> 3333 <li>fs - a remote name string eg “drive:”</li> 3334 <li>remote - a path within that remote eg “dir”</li> 3335 <li>leaveRoot - boolean, set to true not to delete the root</li> 3336 </ul> 3337 <p>See the <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs command</a> command for more information on the above.</p> 3338 <p>Authentication is required for this call.</p> 3339 <h3 id="operationssize-count-the-number-of-bytes-and-files-in-remote">operations/size: Count the number of bytes and files in remote</h3> 3340 <p>This takes the following parameters</p> 3341 <ul> 3342 <li>fs - a remote name string eg “drive:path/to/dir”</li> 3343 </ul> 3344 <p>Returns</p> 3345 <ul> 3346 <li>count - number of files</li> 3347 <li>bytes - number of bytes in those files</li> 3348 </ul> 3349 <p>See the <a href="https://rclone.org/commands/rclone_size/">size command</a> command for more information on the above.</p> 3350 <p>Authentication is required for this call.</p> 3351 <h3 id="optionsblocks-list-all-the-option-blocks">options/blocks: List all the option blocks</h3> 3352 <p>Returns - options - a list of the options block names</p> 3353 <h3 id="optionsget-get-all-the-options">options/get: Get all the options</h3> 3354 <p>Returns an object where keys are option block names and values are an object with the current option values in.</p> 3355 <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> 3356 <h3 id="optionsset-set-an-option">options/set: Set an option</h3> 3357 <p>Parameters</p> 3358 <ul> 3359 <li>option block name containing an object with 3360 <ul> 3361 <li>key: value</li> 3362 </ul></li> 3363 </ul> 3364 <p>Repeated as often as required.</p> 3365 <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> 3366 <p>For example:</p> 3367 <p>This sets DEBUG level logs (-vv)</p> 3368 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 8}}'</code></pre> 3369 <p>And this sets INFO level logs (-v)</p> 3370 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 7}}'</code></pre> 3371 <p>And this sets NOTICE level logs (normal without -v)</p> 3372 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": 6}}'</code></pre> 3373 <h3 id="rcerror-this-returns-an-error">rc/error: This returns an error</h3> 3374 <p>This returns an error with the input as part of its error string. Useful for testing error handling.</p> 3375 <h3 id="rclist-list-all-the-registered-remote-control-commands">rc/list: List all the registered remote control commands</h3> 3376 <p>This lists all the registered remote control commands as a JSON map in the commands response.</p> 3377 <h3 id="rcnoop-echo-the-input-to-the-output-parameters">rc/noop: Echo the input to the output parameters</h3> 3378 <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> 3379 <h3 id="rcnoopauth-echo-the-input-to-the-output-parameters-requiring-auth">rc/noopauth: Echo the input to the output parameters requiring auth</h3> 3380 <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> 3381 <p>Authentication is required for this call.</p> 3382 <h3 id="synccopy-copy-a-directory-from-source-remote-to-destination-remote">sync/copy: copy a directory from source remote to destination remote</h3> 3383 <p>This takes the following parameters</p> 3384 <ul> 3385 <li>srcFs - a remote name string eg “drive:src” for the source</li> 3386 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 3387 </ul> 3388 <p>See the <a href="https://rclone.org/commands/rclone_copy/">copy command</a> command for more information on the above.</p> 3389 <p>Authentication is required for this call.</p> 3390 <h3 id="syncmove-move-a-directory-from-source-remote-to-destination-remote">sync/move: move a directory from source remote to destination remote</h3> 3391 <p>This takes the following parameters</p> 3392 <ul> 3393 <li>srcFs - a remote name string eg “drive:src” for the source</li> 3394 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 3395 <li>deleteEmptySrcDirs - delete empty src directories if set</li> 3396 </ul> 3397 <p>See the <a href="https://rclone.org/commands/rclone_move/">move command</a> command for more information on the above.</p> 3398 <p>Authentication is required for this call.</p> 3399 <h3 id="syncsync-sync-a-directory-from-source-remote-to-destination-remote">sync/sync: sync a directory from source remote to destination remote</h3> 3400 <p>This takes the following parameters</p> 3401 <ul> 3402 <li>srcFs - a remote name string eg “drive:src” for the source</li> 3403 <li>dstFs - a remote name string eg “drive:dst” for the destination</li> 3404 </ul> 3405 <p>See the <a href="https://rclone.org/commands/rclone_sync/">sync command</a> command for more information on the above.</p> 3406 <p>Authentication is required for this call.</p> 3407 <h3 id="vfsforget-forget-files-or-directories-in-the-directory-cache.">vfs/forget: Forget files or directories in the directory cache.</h3> 3408 <p>This forgets the paths in the directory cache causing them to be re-read from the remote when needed.</p> 3409 <p>If no paths are passed in then it will forget all the paths in the directory cache.</p> 3410 <pre><code>rclone rc vfs/forget</code></pre> 3411 <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> 3412 <pre><code>rclone rc vfs/forget file=hello file2=goodbye dir=home/junk</code></pre> 3413 <h3 id="vfspoll-interval-get-the-status-or-update-the-value-of-the-poll-interval-option.">vfs/poll-interval: Get the status or update the value of the poll-interval option.</h3> 3414 <p>Without any parameter given this returns the current status of the poll-interval setting.</p> 3415 <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> 3416 <pre><code>rclone rc vfs/poll-interval interval=5m</code></pre> 3417 <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> 3418 <p>The new poll-interval value will only be active when the timeout is not reached.</p> 3419 <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> 3420 <h3 id="vfsrefresh-refresh-the-directory-cache.">vfs/refresh: Refresh the directory cache.</h3> 3421 <p>This reads the directories for the specified paths and freshens the directory cache.</p> 3422 <p>If no paths are passed in then it will refresh the root directory.</p> 3423 <pre><code>rclone rc vfs/refresh</code></pre> 3424 <p>Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, eg</p> 3425 <pre><code>rclone rc vfs/refresh dir=home/junk dir2=data/misc</code></pre> 3426 <p>If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use –fast-list if enabled.</p> 3427 <!--- autogenerated stop --> 3428 <h2 id="accessing-the-remote-control-via-http">Accessing the remote control via HTTP</h2> 3429 <p>Rclone implements a simple HTTP based protocol.</p> 3430 <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> 3431 <p>All calls must made using POST.</p> 3432 <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> 3433 <p>The response will be a JSON blob in the body of the response. This is formatted to be reasonably human readable.</p> 3434 <h3 id="error-returns">Error returns</h3> 3435 <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> 3436 <pre><code>{ 3437 "error": "Expecting string value for key \"remote\" (was float64)", 3438 "input": { 3439 "fs": "/tmp", 3440 "remote": 3 3441 }, 3442 "status": 400 3443 "path": "operations/rmdir", 3444 }</code></pre> 3445 <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> 3446 <h3 id="cors">CORS</h3> 3447 <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> 3448 <h3 id="using-post-with-url-parameters-only">Using POST with URL parameters only</h3> 3449 <pre><code>curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'</code></pre> 3450 <p>Response</p> 3451 <pre><code>{ 3452 "potato": "1", 3453 "sausage": "2" 3454 }</code></pre> 3455 <p>Here is what an error response looks like:</p> 3456 <pre><code>curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'</code></pre> 3457 <pre><code>{ 3458 "error": "arbitrary error on input map[potato:1 sausage:2]", 3459 "input": { 3460 "potato": "1", 3461 "sausage": "2" 3462 } 3463 }</code></pre> 3464 <p>Note that curl doesn’t return errors to the shell unless you use the <code>-f</code> option</p> 3465 <pre><code>$ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' 3466 curl: (22) The requested URL returned error: 400 Bad Request 3467 $ echo $? 3468 22</code></pre> 3469 <h3 id="using-post-with-a-form">Using POST with a form</h3> 3470 <pre><code>curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop</code></pre> 3471 <p>Response</p> 3472 <pre><code>{ 3473 "potato": "1", 3474 "sausage": "2" 3475 }</code></pre> 3476 <p>Note that you can combine these with URL parameters too with the POST parameters taking precedence.</p> 3477 <pre><code>curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"</code></pre> 3478 <p>Response</p> 3479 <pre><code>{ 3480 "potato": "1", 3481 "rutabaga": "3", 3482 "sausage": "4" 3483 } 3484 </code></pre> 3485 <h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3> 3486 <pre><code>curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop</code></pre> 3487 <p>response</p> 3488 <pre><code>{ 3489 "password": "xyz", 3490 "username": "xyz" 3491 }</code></pre> 3492 <p>This can be combined with URL parameters too if required. The JSON blob takes precedence.</p> 3493 <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> 3494 <pre><code>{ 3495 "potato": 2, 3496 "rutabaga": "3", 3497 "sausage": 1 3498 }</code></pre> 3499 <h2 id="debugging-rclone-with-pprof">Debugging rclone with pprof</h2> 3500 <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> 3501 <p>To use these, first <a href="https://golang.org/doc/install">install go</a>.</p> 3502 <h3 id="debugging-memory-use">Debugging memory use</h3> 3503 <p>To profile rclone’s memory use you can run:</p> 3504 <pre><code>go tool pprof -web http://localhost:5572/debug/pprof/heap</code></pre> 3505 <p>This should open a page in your browser showing what is using what memory.</p> 3506 <p>You can also use the <code>-text</code> flag to produce a textual summary</p> 3507 <pre><code>$ go tool pprof -text http://localhost:5572/debug/pprof/heap 3508 Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total 3509 flat flat% sum% cum cum% 3510 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/ncw/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 3511 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 3512 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/cmd/all.init 3513 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/cmd/serve.init 3514 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/cmd/serve/restic.init 3515 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/vendor/golang.org/x/net/http2.init 3516 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/vendor/golang.org/x/net/http2/hpack.init 3517 0 0% 100% 1024.03kB 66.62% github.com/ncw/rclone/vendor/golang.org/x/net/http2/hpack.init.0 3518 0 0% 100% 1024.03kB 66.62% main.init 3519 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest 3520 0 0% 100% 513kB 33.38% net/http.(*conn).serve 3521 0 0% 100% 1024.03kB 66.62% runtime.main</code></pre> 3522 <h3 id="debugging-go-routine-leaks">Debugging go routine leaks</h3> 3523 <p>Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected.</p> 3524 <p>See all active go routines using</p> 3525 <pre><code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></pre> 3526 <p>Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.</p> 3527 <h3 id="other-profiles-to-look-at">Other profiles to look at</h3> 3528 <p>You can see a summary of profiles available at http://localhost:5572/debug/pprof/</p> 3529 <p>Here is how to use some of them:</p> 3530 <ul> 3531 <li>Memory: <code>go tool pprof http://localhost:5572/debug/pprof/heap</code></li> 3532 <li>Go routines: <code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></li> 3533 <li>30-second CPU profile: <code>go tool pprof http://localhost:5572/debug/pprof/profile</code></li> 3534 <li>5-second execution trace: <code>wget http://localhost:5572/debug/pprof/trace?seconds=5</code></li> 3535 </ul> 3536 <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> 3537 <p>The profiling hook is <a href="https://stackoverflow.com/q/26545159/164234">zero overhead unless it is used</a>.</p> 3538 <h1 id="overview-of-cloud-storage-systems">Overview of cloud storage systems</h1> 3539 <p>Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.</p> 3540 <h2 id="features">Features</h2> 3541 <p>Here is an overview of the major features of each cloud storage system.</p> 3542 <table> 3543 <thead> 3544 <tr class="header"> 3545 <th>Name</th> 3546 <th style="text-align: center;">Hash</th> 3547 <th style="text-align: center;">ModTime</th> 3548 <th style="text-align: center;">Case Insensitive</th> 3549 <th style="text-align: center;">Duplicate Files</th> 3550 <th style="text-align: center;">MIME Type</th> 3551 </tr> 3552 </thead> 3553 <tbody> 3554 <tr class="odd"> 3555 <td>Amazon Drive</td> 3556 <td style="text-align: center;">MD5</td> 3557 <td style="text-align: center;">No</td> 3558 <td style="text-align: center;">Yes</td> 3559 <td style="text-align: center;">No</td> 3560 <td style="text-align: center;">R</td> 3561 </tr> 3562 <tr class="even"> 3563 <td>Amazon S3</td> 3564 <td style="text-align: center;">MD5</td> 3565 <td style="text-align: center;">Yes</td> 3566 <td style="text-align: center;">No</td> 3567 <td style="text-align: center;">No</td> 3568 <td style="text-align: center;">R/W</td> 3569 </tr> 3570 <tr class="odd"> 3571 <td>Backblaze B2</td> 3572 <td style="text-align: center;">SHA1</td> 3573 <td style="text-align: center;">Yes</td> 3574 <td style="text-align: center;">No</td> 3575 <td style="text-align: center;">No</td> 3576 <td style="text-align: center;">R/W</td> 3577 </tr> 3578 <tr class="even"> 3579 <td>Box</td> 3580 <td style="text-align: center;">SHA1</td> 3581 <td style="text-align: center;">Yes</td> 3582 <td style="text-align: center;">Yes</td> 3583 <td style="text-align: center;">No</td> 3584 <td style="text-align: center;">-</td> 3585 </tr> 3586 <tr class="odd"> 3587 <td>Dropbox</td> 3588 <td style="text-align: center;">DBHASH †</td> 3589 <td style="text-align: center;">Yes</td> 3590 <td style="text-align: center;">Yes</td> 3591 <td style="text-align: center;">No</td> 3592 <td style="text-align: center;">-</td> 3593 </tr> 3594 <tr class="even"> 3595 <td>FTP</td> 3596 <td style="text-align: center;">-</td> 3597 <td style="text-align: center;">No</td> 3598 <td style="text-align: center;">No</td> 3599 <td style="text-align: center;">No</td> 3600 <td style="text-align: center;">-</td> 3601 </tr> 3602 <tr class="odd"> 3603 <td>Google Cloud Storage</td> 3604 <td style="text-align: center;">MD5</td> 3605 <td style="text-align: center;">Yes</td> 3606 <td style="text-align: center;">No</td> 3607 <td style="text-align: center;">No</td> 3608 <td style="text-align: center;">R/W</td> 3609 </tr> 3610 <tr class="even"> 3611 <td>Google Drive</td> 3612 <td style="text-align: center;">MD5</td> 3613 <td style="text-align: center;">Yes</td> 3614 <td style="text-align: center;">No</td> 3615 <td style="text-align: center;">Yes</td> 3616 <td style="text-align: center;">R/W</td> 3617 </tr> 3618 <tr class="odd"> 3619 <td>HTTP</td> 3620 <td style="text-align: center;">-</td> 3621 <td style="text-align: center;">No</td> 3622 <td style="text-align: center;">No</td> 3623 <td style="text-align: center;">No</td> 3624 <td style="text-align: center;">R</td> 3625 </tr> 3626 <tr class="even"> 3627 <td>Hubic</td> 3628 <td style="text-align: center;">MD5</td> 3629 <td style="text-align: center;">Yes</td> 3630 <td style="text-align: center;">No</td> 3631 <td style="text-align: center;">No</td> 3632 <td style="text-align: center;">R/W</td> 3633 </tr> 3634 <tr class="odd"> 3635 <td>Jottacloud</td> 3636 <td style="text-align: center;">MD5</td> 3637 <td style="text-align: center;">Yes</td> 3638 <td style="text-align: center;">Yes</td> 3639 <td style="text-align: center;">No</td> 3640 <td style="text-align: center;">R/W</td> 3641 </tr> 3642 <tr class="even"> 3643 <td>Koofr</td> 3644 <td style="text-align: center;">MD5</td> 3645 <td style="text-align: center;">No</td> 3646 <td style="text-align: center;">Yes</td> 3647 <td style="text-align: center;">No</td> 3648 <td style="text-align: center;">-</td> 3649 </tr> 3650 <tr class="odd"> 3651 <td>Mega</td> 3652 <td style="text-align: center;">-</td> 3653 <td style="text-align: center;">No</td> 3654 <td style="text-align: center;">No</td> 3655 <td style="text-align: center;">Yes</td> 3656 <td style="text-align: center;">-</td> 3657 </tr> 3658 <tr class="even"> 3659 <td>Microsoft Azure Blob Storage</td> 3660 <td style="text-align: center;">MD5</td> 3661 <td style="text-align: center;">Yes</td> 3662 <td style="text-align: center;">No</td> 3663 <td style="text-align: center;">No</td> 3664 <td style="text-align: center;">R/W</td> 3665 </tr> 3666 <tr class="odd"> 3667 <td>Microsoft OneDrive</td> 3668 <td style="text-align: center;">SHA1 ‡‡</td> 3669 <td style="text-align: center;">Yes</td> 3670 <td style="text-align: center;">Yes</td> 3671 <td style="text-align: center;">No</td> 3672 <td style="text-align: center;">R</td> 3673 </tr> 3674 <tr class="even"> 3675 <td>OpenDrive</td> 3676 <td style="text-align: center;">MD5</td> 3677 <td style="text-align: center;">Yes</td> 3678 <td style="text-align: center;">Yes</td> 3679 <td style="text-align: center;">No</td> 3680 <td style="text-align: center;">-</td> 3681 </tr> 3682 <tr class="odd"> 3683 <td>Openstack Swift</td> 3684 <td style="text-align: center;">MD5</td> 3685 <td style="text-align: center;">Yes</td> 3686 <td style="text-align: center;">No</td> 3687 <td style="text-align: center;">No</td> 3688 <td style="text-align: center;">R/W</td> 3689 </tr> 3690 <tr class="even"> 3691 <td>pCloud</td> 3692 <td style="text-align: center;">MD5, SHA1</td> 3693 <td style="text-align: center;">Yes</td> 3694 <td style="text-align: center;">No</td> 3695 <td style="text-align: center;">No</td> 3696 <td style="text-align: center;">W</td> 3697 </tr> 3698 <tr class="odd"> 3699 <td>QingStor</td> 3700 <td style="text-align: center;">MD5</td> 3701 <td style="text-align: center;">No</td> 3702 <td style="text-align: center;">No</td> 3703 <td style="text-align: center;">No</td> 3704 <td style="text-align: center;">R/W</td> 3705 </tr> 3706 <tr class="even"> 3707 <td>SFTP</td> 3708 <td style="text-align: center;">MD5, SHA1 ‡</td> 3709 <td style="text-align: center;">Yes</td> 3710 <td style="text-align: center;">Depends</td> 3711 <td style="text-align: center;">No</td> 3712 <td style="text-align: center;">-</td> 3713 </tr> 3714 <tr class="odd"> 3715 <td>WebDAV</td> 3716 <td style="text-align: center;">MD5, SHA1 ††</td> 3717 <td style="text-align: center;">Yes †††</td> 3718 <td style="text-align: center;">Depends</td> 3719 <td style="text-align: center;">No</td> 3720 <td style="text-align: center;">-</td> 3721 </tr> 3722 <tr class="even"> 3723 <td>Yandex Disk</td> 3724 <td style="text-align: center;">MD5</td> 3725 <td style="text-align: center;">Yes</td> 3726 <td style="text-align: center;">No</td> 3727 <td style="text-align: center;">No</td> 3728 <td style="text-align: center;">R/W</td> 3729 </tr> 3730 <tr class="odd"> 3731 <td>The local filesystem</td> 3732 <td style="text-align: center;">All</td> 3733 <td style="text-align: center;">Yes</td> 3734 <td style="text-align: center;">Depends</td> 3735 <td style="text-align: center;">No</td> 3736 <td style="text-align: center;">-</td> 3737 </tr> 3738 </tbody> 3739 </table> 3740 <h3 id="hash">Hash</h3> 3741 <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> 3742 <p>To use the verify checksums when transferring between cloud storage systems they must support a common hash type.</p> 3743 <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> 3744 <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> 3745 <p>†† WebDAV supports hashes when used with Owncloud and Nextcloud only.</p> 3746 <p>††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.</p> 3747 <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> 3748 <h3 id="modtime">ModTime</h3> 3749 <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> 3750 <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> 3751 <h3 id="case-insensitive">Case Insensitive</h3> 3752 <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> 3753 <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> 3754 <p>The local filesystem and SFTP may or may not be case sensitive depending on OS.</p> 3755 <ul> 3756 <li>Windows - usually case insensitive, though case is preserved</li> 3757 <li>OSX - usually case insensitive, though it is possible to format case sensitive</li> 3758 <li>Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys)</li> 3759 </ul> 3760 <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> 3761 <h3 id="duplicate-files">Duplicate files</h3> 3762 <p>If a cloud storage system allows duplicate files then it can have two objects with the same name.</p> 3763 <p>This confuses rclone greatly when syncing - use the <code>rclone dedupe</code> command to rename or remove duplicates.</p> 3764 <h3 id="mime-type">MIME Type</h3> 3765 <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> 3766 <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> 3767 <p>The MIME type can be important if you are serving files directly to HTTP from the storage system.</p> 3768 <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> 3769 <h2 id="optional-features">Optional Features</h2> 3770 <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> 3771 <table> 3772 <thead> 3773 <tr class="header"> 3774 <th>Name</th> 3775 <th style="text-align: center;">Purge</th> 3776 <th style="text-align: center;">Copy</th> 3777 <th style="text-align: center;">Move</th> 3778 <th style="text-align: center;">DirMove</th> 3779 <th style="text-align: center;">CleanUp</th> 3780 <th style="text-align: center;">ListR</th> 3781 <th style="text-align: center;">StreamUpload</th> 3782 <th style="text-align: center;">LinkSharing</th> 3783 <th style="text-align: center;">About</th> 3784 </tr> 3785 </thead> 3786 <tbody> 3787 <tr class="odd"> 3788 <td>Amazon Drive</td> 3789 <td style="text-align: center;">Yes</td> 3790 <td style="text-align: center;">No</td> 3791 <td style="text-align: center;">Yes</td> 3792 <td style="text-align: center;">Yes</td> 3793 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/575">#575</a></td> 3794 <td style="text-align: center;">No</td> 3795 <td style="text-align: center;">No</td> 3796 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3797 <td style="text-align: center;">No</td> 3798 </tr> 3799 <tr class="even"> 3800 <td>Amazon S3</td> 3801 <td style="text-align: center;">No</td> 3802 <td style="text-align: center;">Yes</td> 3803 <td style="text-align: center;">No</td> 3804 <td style="text-align: center;">No</td> 3805 <td style="text-align: center;">No</td> 3806 <td style="text-align: center;">Yes</td> 3807 <td style="text-align: center;">Yes</td> 3808 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3809 <td style="text-align: center;">No</td> 3810 </tr> 3811 <tr class="odd"> 3812 <td>Backblaze B2</td> 3813 <td style="text-align: center;">No</td> 3814 <td style="text-align: center;">Yes</td> 3815 <td style="text-align: center;">No</td> 3816 <td style="text-align: center;">No</td> 3817 <td style="text-align: center;">Yes</td> 3818 <td style="text-align: center;">Yes</td> 3819 <td style="text-align: center;">Yes</td> 3820 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3821 <td style="text-align: center;">No</td> 3822 </tr> 3823 <tr class="even"> 3824 <td>Box</td> 3825 <td style="text-align: center;">Yes</td> 3826 <td style="text-align: center;">Yes</td> 3827 <td style="text-align: center;">Yes</td> 3828 <td style="text-align: center;">Yes</td> 3829 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/575">#575</a></td> 3830 <td style="text-align: center;">No</td> 3831 <td style="text-align: center;">Yes</td> 3832 <td style="text-align: center;">Yes</td> 3833 <td style="text-align: center;">No</td> 3834 </tr> 3835 <tr class="odd"> 3836 <td>Dropbox</td> 3837 <td style="text-align: center;">Yes</td> 3838 <td style="text-align: center;">Yes</td> 3839 <td style="text-align: center;">Yes</td> 3840 <td style="text-align: center;">Yes</td> 3841 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/575">#575</a></td> 3842 <td style="text-align: center;">No</td> 3843 <td style="text-align: center;">Yes</td> 3844 <td style="text-align: center;">Yes</td> 3845 <td style="text-align: center;">Yes</td> 3846 </tr> 3847 <tr class="even"> 3848 <td>FTP</td> 3849 <td style="text-align: center;">No</td> 3850 <td style="text-align: center;">No</td> 3851 <td style="text-align: center;">Yes</td> 3852 <td style="text-align: center;">Yes</td> 3853 <td style="text-align: center;">No</td> 3854 <td style="text-align: center;">No</td> 3855 <td style="text-align: center;">Yes</td> 3856 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3857 <td style="text-align: center;">No</td> 3858 </tr> 3859 <tr class="odd"> 3860 <td>Google Cloud Storage</td> 3861 <td style="text-align: center;">Yes</td> 3862 <td style="text-align: center;">Yes</td> 3863 <td style="text-align: center;">No</td> 3864 <td style="text-align: center;">No</td> 3865 <td style="text-align: center;">No</td> 3866 <td style="text-align: center;">Yes</td> 3867 <td style="text-align: center;">Yes</td> 3868 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3869 <td style="text-align: center;">No</td> 3870 </tr> 3871 <tr class="even"> 3872 <td>Google Drive</td> 3873 <td style="text-align: center;">Yes</td> 3874 <td style="text-align: center;">Yes</td> 3875 <td style="text-align: center;">Yes</td> 3876 <td style="text-align: center;">Yes</td> 3877 <td style="text-align: center;">Yes</td> 3878 <td style="text-align: center;">Yes</td> 3879 <td style="text-align: center;">Yes</td> 3880 <td style="text-align: center;">Yes</td> 3881 <td style="text-align: center;">Yes</td> 3882 </tr> 3883 <tr class="odd"> 3884 <td>HTTP</td> 3885 <td style="text-align: center;">No</td> 3886 <td style="text-align: center;">No</td> 3887 <td style="text-align: center;">No</td> 3888 <td style="text-align: center;">No</td> 3889 <td style="text-align: center;">No</td> 3890 <td style="text-align: center;">No</td> 3891 <td style="text-align: center;">No</td> 3892 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3893 <td style="text-align: center;">No</td> 3894 </tr> 3895 <tr class="even"> 3896 <td>Hubic</td> 3897 <td style="text-align: center;">Yes †</td> 3898 <td style="text-align: center;">Yes</td> 3899 <td style="text-align: center;">No</td> 3900 <td style="text-align: center;">No</td> 3901 <td style="text-align: center;">No</td> 3902 <td style="text-align: center;">Yes</td> 3903 <td style="text-align: center;">Yes</td> 3904 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3905 <td style="text-align: center;">Yes</td> 3906 </tr> 3907 <tr class="odd"> 3908 <td>Jottacloud</td> 3909 <td style="text-align: center;">Yes</td> 3910 <td style="text-align: center;">Yes</td> 3911 <td style="text-align: center;">Yes</td> 3912 <td style="text-align: center;">Yes</td> 3913 <td style="text-align: center;">No</td> 3914 <td style="text-align: center;">Yes</td> 3915 <td style="text-align: center;">No</td> 3916 <td style="text-align: center;">Yes</td> 3917 <td style="text-align: center;">Yes</td> 3918 </tr> 3919 <tr class="even"> 3920 <td>Mega</td> 3921 <td style="text-align: center;">Yes</td> 3922 <td style="text-align: center;">No</td> 3923 <td style="text-align: center;">Yes</td> 3924 <td style="text-align: center;">Yes</td> 3925 <td style="text-align: center;">Yes</td> 3926 <td style="text-align: center;">No</td> 3927 <td style="text-align: center;">No</td> 3928 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3929 <td style="text-align: center;">Yes</td> 3930 </tr> 3931 <tr class="odd"> 3932 <td>Microsoft Azure Blob Storage</td> 3933 <td style="text-align: center;">Yes</td> 3934 <td style="text-align: center;">Yes</td> 3935 <td style="text-align: center;">No</td> 3936 <td style="text-align: center;">No</td> 3937 <td style="text-align: center;">No</td> 3938 <td style="text-align: center;">Yes</td> 3939 <td style="text-align: center;">No</td> 3940 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3941 <td style="text-align: center;">No</td> 3942 </tr> 3943 <tr class="even"> 3944 <td>Microsoft OneDrive</td> 3945 <td style="text-align: center;">Yes</td> 3946 <td style="text-align: center;">Yes</td> 3947 <td style="text-align: center;">Yes</td> 3948 <td style="text-align: center;">Yes</td> 3949 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/575">#575</a></td> 3950 <td style="text-align: center;">No</td> 3951 <td style="text-align: center;">No</td> 3952 <td style="text-align: center;">Yes</td> 3953 <td style="text-align: center;">Yes</td> 3954 </tr> 3955 <tr class="odd"> 3956 <td>OpenDrive</td> 3957 <td style="text-align: center;">Yes</td> 3958 <td style="text-align: center;">Yes</td> 3959 <td style="text-align: center;">Yes</td> 3960 <td style="text-align: center;">Yes</td> 3961 <td style="text-align: center;">No</td> 3962 <td style="text-align: center;">No</td> 3963 <td style="text-align: center;">No</td> 3964 <td style="text-align: center;">No</td> 3965 <td style="text-align: center;">No</td> 3966 </tr> 3967 <tr class="even"> 3968 <td>Openstack Swift</td> 3969 <td style="text-align: center;">Yes †</td> 3970 <td style="text-align: center;">Yes</td> 3971 <td style="text-align: center;">No</td> 3972 <td style="text-align: center;">No</td> 3973 <td style="text-align: center;">No</td> 3974 <td style="text-align: center;">Yes</td> 3975 <td style="text-align: center;">Yes</td> 3976 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3977 <td style="text-align: center;">Yes</td> 3978 </tr> 3979 <tr class="odd"> 3980 <td>pCloud</td> 3981 <td style="text-align: center;">Yes</td> 3982 <td style="text-align: center;">Yes</td> 3983 <td style="text-align: center;">Yes</td> 3984 <td style="text-align: center;">Yes</td> 3985 <td style="text-align: center;">Yes</td> 3986 <td style="text-align: center;">No</td> 3987 <td style="text-align: center;">No</td> 3988 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 3989 <td style="text-align: center;">Yes</td> 3990 </tr> 3991 <tr class="even"> 3992 <td>QingStor</td> 3993 <td style="text-align: center;">No</td> 3994 <td style="text-align: center;">Yes</td> 3995 <td style="text-align: center;">No</td> 3996 <td style="text-align: center;">No</td> 3997 <td style="text-align: center;">No</td> 3998 <td style="text-align: center;">Yes</td> 3999 <td style="text-align: center;">No</td> 4000 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 4001 <td style="text-align: center;">No</td> 4002 </tr> 4003 <tr class="odd"> 4004 <td>SFTP</td> 4005 <td style="text-align: center;">No</td> 4006 <td style="text-align: center;">No</td> 4007 <td style="text-align: center;">Yes</td> 4008 <td style="text-align: center;">Yes</td> 4009 <td style="text-align: center;">No</td> 4010 <td style="text-align: center;">No</td> 4011 <td style="text-align: center;">Yes</td> 4012 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 4013 <td style="text-align: center;">Yes</td> 4014 </tr> 4015 <tr class="even"> 4016 <td>WebDAV</td> 4017 <td style="text-align: center;">Yes</td> 4018 <td style="text-align: center;">Yes</td> 4019 <td style="text-align: center;">Yes</td> 4020 <td style="text-align: center;">Yes</td> 4021 <td style="text-align: center;">No</td> 4022 <td style="text-align: center;">No</td> 4023 <td style="text-align: center;">Yes ‡</td> 4024 <td style="text-align: center;">No <a href="https://github.com/ncw/rclone/issues/2178">#2178</a></td> 4025 <td style="text-align: center;">Yes</td> 4026 </tr> 4027 <tr class="odd"> 4028 <td>Yandex Disk</td> 4029 <td style="text-align: center;">Yes</td> 4030 <td style="text-align: center;">Yes</td> 4031 <td style="text-align: center;">Yes</td> 4032 <td style="text-align: center;">Yes</td> 4033 <td style="text-align: center;">Yes</td> 4034 <td style="text-align: center;">No</td> 4035 <td style="text-align: center;">Yes</td> 4036 <td style="text-align: center;">Yes</td> 4037 <td style="text-align: center;">Yes</td> 4038 </tr> 4039 <tr class="even"> 4040 <td>The local filesystem</td> 4041 <td style="text-align: center;">Yes</td> 4042 <td style="text-align: center;">No</td> 4043 <td style="text-align: center;">Yes</td> 4044 <td style="text-align: center;">Yes</td> 4045 <td style="text-align: center;">No</td> 4046 <td style="text-align: center;">No</td> 4047 <td style="text-align: center;">Yes</td> 4048 <td style="text-align: center;">No</td> 4049 <td style="text-align: center;">Yes</td> 4050 </tr> 4051 </tbody> 4052 </table> 4053 <h3 id="purge">Purge</h3> 4054 <p>This deletes a directory quicker than just deleting all the files in the directory.</p> 4055 <p>† Note Swift and Hubic 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> 4056 <p>‡ StreamUpload is not supported with Nextcloud</p> 4057 <h3 id="copy">Copy</h3> 4058 <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> 4059 <p>If the server doesn’t support <code>Copy</code> directly then for copy operations the file is downloaded then re-uploaded.</p> 4060 <h3 id="move">Move</h3> 4061 <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> 4062 <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> 4063 <h3 id="dirmove">DirMove</h3> 4064 <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> 4065 <h3 id="cleanup">CleanUp</h3> 4066 <p>This is used for emptying the trash for a remote by <code>rclone cleanup</code>.</p> 4067 <p>If the server can’t do <code>CleanUp</code> then <code>rclone cleanup</code> will return an error.</p> 4068 <h3 id="listr">ListR</h3> 4069 <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="/docs/#fast-list">rclone docs</a> for more details.</p> 4070 <h3 id="streamupload">StreamUpload</h3> 4071 <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> 4072 <h3 id="linksharing">LinkSharing</h3> 4073 <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> 4074 <h3 id="about">About</h3> 4075 <p>This is used to fetch quota information from the remote, like bytes used/free/quota and bytes used in the trash.</p> 4076 <p>This is also used to return the space used, available for <code>rclone mount</code>.</p> 4077 <p>If the server can’t do <code>About</code> then <code>rclone about</code> will return an error.</p> 4078 <h2 id="alias">Alias</h2> 4079 <p>The <code>alias</code> remote provides a new name for another remote.</p> 4080 <p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p> 4081 <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> 4082 <p>Subfolders can be used in target remote. Assume a 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> 4083 <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> 4084 <p>Here is an example of how to make a alias called <code>remote</code> for local folder. First run:</p> 4085 <pre><code> rclone config</code></pre> 4086 <p>This will guide you through an interactive setup process:</p> 4087 <pre><code>No remotes found - make a new one 4088 n) New remote 4089 s) Set configuration password 4090 q) Quit config 4091 n/s/q> n 4092 name> remote 4093 Type of storage to configure. 4094 Choose a number from below, or type in your own value 4095 1 / Alias for an existing remote 4096 \ "alias" 4097 2 / Amazon Drive 4098 \ "amazon cloud drive" 4099 3 / Amazon S3 (also Dreamhost, Ceph, Minio) 4100 \ "s3" 4101 4 / Backblaze B2 4102 \ "b2" 4103 5 / Box 4104 \ "box" 4105 6 / Cache a remote 4106 \ "cache" 4107 7 / Dropbox 4108 \ "dropbox" 4109 8 / Encrypt/Decrypt a remote 4110 \ "crypt" 4111 9 / FTP Connection 4112 \ "ftp" 4113 10 / Google Cloud Storage (this is not Google Drive) 4114 \ "google cloud storage" 4115 11 / Google Drive 4116 \ "drive" 4117 12 / Hubic 4118 \ "hubic" 4119 13 / Local Disk 4120 \ "local" 4121 14 / Microsoft Azure Blob Storage 4122 \ "azureblob" 4123 15 / Microsoft OneDrive 4124 \ "onedrive" 4125 16 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 4126 \ "swift" 4127 17 / Pcloud 4128 \ "pcloud" 4129 18 / QingCloud Object Storage 4130 \ "qingstor" 4131 19 / SSH/SFTP Connection 4132 \ "sftp" 4133 20 / Webdav 4134 \ "webdav" 4135 21 / Yandex Disk 4136 \ "yandex" 4137 22 / http Connection 4138 \ "http" 4139 Storage> 1 4140 Remote or path to alias. 4141 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". 4142 remote> /mnt/storage/backup 4143 Remote config 4144 -------------------- 4145 [remote] 4146 remote = /mnt/storage/backup 4147 -------------------- 4148 y) Yes this is OK 4149 e) Edit this remote 4150 d) Delete this remote 4151 y/e/d> y 4152 Current remotes: 4153 4154 Name Type 4155 ==== ==== 4156 remote alias 4157 4158 e) Edit existing remote 4159 n) New remote 4160 d) Delete remote 4161 r) Rename remote 4162 c) Copy remote 4163 s) Set configuration password 4164 q) Quit config 4165 e/n/d/r/c/s/q> q</code></pre> 4166 <p>Once configured you can then use <code>rclone</code> like this,</p> 4167 <p>List directories in top level in <code>/mnt/storage/backup</code></p> 4168 <pre><code>rclone lsd remote:</code></pre> 4169 <p>List all the files in <code>/mnt/storage/backup</code></p> 4170 <pre><code>rclone ls remote:</code></pre> 4171 <p>Copy another local directory to the alias directory called source</p> 4172 <pre><code>rclone copy /home/source remote:source</code></pre> 4173 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs --> 4174 <h3 id="standard-options">Standard Options</h3> 4175 <p>Here are the standard options specific to alias (Alias for an existing remote).</p> 4176 <h4 id="alias-remote">–alias-remote</h4> 4177 <p>Remote or path to alias. Can be “myremote:path/to/dir”, “myremote:bucket”, “myremote:” or “/local/path”.</p> 4178 <ul> 4179 <li>Config: remote</li> 4180 <li>Env Var: RCLONE_ALIAS_REMOTE</li> 4181 <li>Type: string</li> 4182 <li>Default: ""</li> 4183 </ul> 4184 <!--- autogenerated options stop --> 4185 <h2 id="amazon-drive">Amazon Drive</h2> 4186 <p>Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers.</p> 4187 <h2 id="status">Status</h2> 4188 <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> 4189 <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> 4190 <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> 4191 <h2 id="setup">Setup</h2> 4192 <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> 4193 <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> 4194 <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 a third party ouath 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> 4195 <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> 4196 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 4197 <pre><code> rclone config</code></pre> 4198 <p>This will guide you through an interactive setup process:</p> 4199 <pre><code>No remotes found - make a new one 4200 n) New remote 4201 r) Rename remote 4202 c) Copy remote 4203 s) Set configuration password 4204 q) Quit config 4205 n/r/c/s/q> n 4206 name> remote 4207 Type of storage to configure. 4208 Choose a number from below, or type in your own value 4209 1 / Amazon Drive 4210 \ "amazon cloud drive" 4211 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 4212 \ "s3" 4213 3 / Backblaze B2 4214 \ "b2" 4215 4 / Dropbox 4216 \ "dropbox" 4217 5 / Encrypt/Decrypt a remote 4218 \ "crypt" 4219 6 / FTP Connection 4220 \ "ftp" 4221 7 / Google Cloud Storage (this is not Google Drive) 4222 \ "google cloud storage" 4223 8 / Google Drive 4224 \ "drive" 4225 9 / Hubic 4226 \ "hubic" 4227 10 / Local Disk 4228 \ "local" 4229 11 / Microsoft OneDrive 4230 \ "onedrive" 4231 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 4232 \ "swift" 4233 13 / SSH/SFTP Connection 4234 \ "sftp" 4235 14 / Yandex Disk 4236 \ "yandex" 4237 Storage> 1 4238 Amazon Application Client Id - required. 4239 client_id> your client ID goes here 4240 Amazon Application Client Secret - required. 4241 client_secret> your client secret goes here 4242 Auth server URL - leave blank to use Amazon's. 4243 auth_url> Optional auth URL 4244 Token server url - leave blank to use Amazon's. 4245 token_url> Optional token URL 4246 Remote config 4247 Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. 4248 Use auto config? 4249 * Say Y if not sure 4250 * Say N if you are working on a remote or headless machine 4251 y) Yes 4252 n) No 4253 y/n> y 4254 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 4255 Log in and authorize rclone for access 4256 Waiting for code... 4257 Got code 4258 -------------------- 4259 [remote] 4260 client_id = your client ID goes here 4261 client_secret = your client secret goes here 4262 auth_url = Optional auth URL 4263 token_url = Optional token URL 4264 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} 4265 -------------------- 4266 y) Yes this is OK 4267 e) Edit this remote 4268 d) Delete this remote 4269 y/e/d> y</code></pre> 4270 <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> 4271 <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> 4272 <p>Once configured you can then use <code>rclone</code> like this,</p> 4273 <p>List directories in top level of your Amazon Drive</p> 4274 <pre><code>rclone lsd remote:</code></pre> 4275 <p>List all the files in your Amazon Drive</p> 4276 <pre><code>rclone ls remote:</code></pre> 4277 <p>To copy a local directory to an Amazon Drive directory called backup</p> 4278 <pre><code>rclone copy /home/source remote:backup</code></pre> 4279 <h3 id="modified-time-and-md5sums">Modified time and MD5SUMs</h3> 4280 <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> 4281 <p>It does store MD5SUMs so for a more accurate sync, you can use the <code>--checksum</code> flag.</p> 4282 <h3 id="deleting-files">Deleting files</h3> 4283 <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> 4284 <h3 id="using-with-non-.com-amazon-accounts">Using with non <code>.com</code> Amazon accounts</h3> 4285 <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> 4286 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs --> 4287 <h3 id="standard-options-1">Standard Options</h3> 4288 <p>Here are the standard options specific to amazon cloud drive (Amazon Drive).</p> 4289 <h4 id="acd-client-id">–acd-client-id</h4> 4290 <p>Amazon Application Client ID.</p> 4291 <ul> 4292 <li>Config: client_id</li> 4293 <li>Env Var: RCLONE_ACD_CLIENT_ID</li> 4294 <li>Type: string</li> 4295 <li>Default: ""</li> 4296 </ul> 4297 <h4 id="acd-client-secret">–acd-client-secret</h4> 4298 <p>Amazon Application Client Secret.</p> 4299 <ul> 4300 <li>Config: client_secret</li> 4301 <li>Env Var: RCLONE_ACD_CLIENT_SECRET</li> 4302 <li>Type: string</li> 4303 <li>Default: ""</li> 4304 </ul> 4305 <h3 id="advanced-options">Advanced Options</h3> 4306 <p>Here are the advanced options specific to amazon cloud drive (Amazon Drive).</p> 4307 <h4 id="acd-auth-url">–acd-auth-url</h4> 4308 <p>Auth server URL. Leave blank to use Amazon’s.</p> 4309 <ul> 4310 <li>Config: auth_url</li> 4311 <li>Env Var: RCLONE_ACD_AUTH_URL</li> 4312 <li>Type: string</li> 4313 <li>Default: ""</li> 4314 </ul> 4315 <h4 id="acd-token-url">–acd-token-url</h4> 4316 <p>Token server url. leave blank to use Amazon’s.</p> 4317 <ul> 4318 <li>Config: token_url</li> 4319 <li>Env Var: RCLONE_ACD_TOKEN_URL</li> 4320 <li>Type: string</li> 4321 <li>Default: ""</li> 4322 </ul> 4323 <h4 id="acd-checkpoint">–acd-checkpoint</h4> 4324 <p>Checkpoint for internal polling (debug).</p> 4325 <ul> 4326 <li>Config: checkpoint</li> 4327 <li>Env Var: RCLONE_ACD_CHECKPOINT</li> 4328 <li>Type: string</li> 4329 <li>Default: ""</li> 4330 </ul> 4331 <h4 id="acd-upload-wait-per-gb">–acd-upload-wait-per-gb</h4> 4332 <p>Additional time per GB to wait after a failed complete upload to see if it appears.</p> 4333 <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> 4334 <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> 4335 <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> 4336 <p>These values were determined empirically by observing lots of uploads of big files for a range of file sizes.</p> 4337 <p>Upload with the “-v” flag to see more info about what rclone is doing in this situation.</p> 4338 <ul> 4339 <li>Config: upload_wait_per_gb</li> 4340 <li>Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB</li> 4341 <li>Type: Duration</li> 4342 <li>Default: 3m0s</li> 4343 </ul> 4344 <h4 id="acd-templink-threshold">–acd-templink-threshold</h4> 4345 <p>Files >= this size will be downloaded via their tempLink.</p> 4346 <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> 4347 <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> 4348 <ul> 4349 <li>Config: templink_threshold</li> 4350 <li>Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD</li> 4351 <li>Type: SizeSuffix</li> 4352 <li>Default: 9G</li> 4353 </ul> 4354 <!--- autogenerated options stop --> 4355 <h3 id="limitations-1">Limitations</h3> 4356 <p>Note that Amazon Drive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 4357 <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> 4358 <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> 4359 <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> 4360 <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> 4361 <h2 id="amazon-s3-storage-providers">Amazon S3 Storage Providers</h2> 4362 <p>The S3 backend can be used with a number of different providers:</p> 4363 <ul> 4364 <li>AWS S3</li> 4365 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 4366 <li>Ceph</li> 4367 <li>DigitalOcean Spaces</li> 4368 <li>Dreamhost</li> 4369 <li>IBM COS S3</li> 4370 <li>Minio</li> 4371 <li>Wasabi</li> 4372 </ul> 4373 <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> 4374 <p>Once you have made a remote (see the provider specific section above) you can use it like this:</p> 4375 <p>See all buckets</p> 4376 <pre><code>rclone lsd remote:</code></pre> 4377 <p>Make a new bucket</p> 4378 <pre><code>rclone mkdir remote:bucket</code></pre> 4379 <p>List the contents of a bucket</p> 4380 <pre><code>rclone ls remote:bucket</code></pre> 4381 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 4382 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 4383 <h2 id="amazon-s3">AWS S3</h2> 4384 <p>Here is an example of making an s3 configuration. First run</p> 4385 <pre><code>rclone config</code></pre> 4386 <p>This will guide you through an interactive setup process.</p> 4387 <pre><code>No remotes found - make a new one 4388 n) New remote 4389 s) Set configuration password 4390 q) Quit config 4391 n/s/q> n 4392 name> remote 4393 Type of storage to configure. 4394 Choose a number from below, or type in your own value 4395 1 / Alias for an existing remote 4396 \ "alias" 4397 2 / Amazon Drive 4398 \ "amazon cloud drive" 4399 3 / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) 4400 \ "s3" 4401 4 / Backblaze B2 4402 \ "b2" 4403 [snip] 4404 23 / http Connection 4405 \ "http" 4406 Storage> s3 4407 Choose your S3 provider. 4408 Choose a number from below, or type in your own value 4409 1 / Amazon Web Services (AWS) S3 4410 \ "AWS" 4411 2 / Ceph Object Storage 4412 \ "Ceph" 4413 3 / Digital Ocean Spaces 4414 \ "DigitalOcean" 4415 4 / Dreamhost DreamObjects 4416 \ "Dreamhost" 4417 5 / IBM COS S3 4418 \ "IBMCOS" 4419 6 / Minio Object Storage 4420 \ "Minio" 4421 7 / Wasabi Object Storage 4422 \ "Wasabi" 4423 8 / Any other S3 compatible provider 4424 \ "Other" 4425 provider> 1 4426 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. 4427 Choose a number from below, or type in your own value 4428 1 / Enter AWS credentials in the next step 4429 \ "false" 4430 2 / Get AWS credentials from the environment (env vars or IAM) 4431 \ "true" 4432 env_auth> 1 4433 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 4434 access_key_id> XXX 4435 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 4436 secret_access_key> YYY 4437 Region to connect to. 4438 Choose a number from below, or type in your own value 4439 / The default endpoint - a good choice if you are unsure. 4440 1 | US Region, Northern Virginia or Pacific Northwest. 4441 | Leave location constraint empty. 4442 \ "us-east-1" 4443 / US East (Ohio) Region 4444 2 | Needs location constraint us-east-2. 4445 \ "us-east-2" 4446 / US West (Oregon) Region 4447 3 | Needs location constraint us-west-2. 4448 \ "us-west-2" 4449 / US West (Northern California) Region 4450 4 | Needs location constraint us-west-1. 4451 \ "us-west-1" 4452 / Canada (Central) Region 4453 5 | Needs location constraint ca-central-1. 4454 \ "ca-central-1" 4455 / EU (Ireland) Region 4456 6 | Needs location constraint EU or eu-west-1. 4457 \ "eu-west-1" 4458 / EU (London) Region 4459 7 | Needs location constraint eu-west-2. 4460 \ "eu-west-2" 4461 / EU (Frankfurt) Region 4462 8 | Needs location constraint eu-central-1. 4463 \ "eu-central-1" 4464 / Asia Pacific (Singapore) Region 4465 9 | Needs location constraint ap-southeast-1. 4466 \ "ap-southeast-1" 4467 / Asia Pacific (Sydney) Region 4468 10 | Needs location constraint ap-southeast-2. 4469 \ "ap-southeast-2" 4470 / Asia Pacific (Tokyo) Region 4471 11 | Needs location constraint ap-northeast-1. 4472 \ "ap-northeast-1" 4473 / Asia Pacific (Seoul) 4474 12 | Needs location constraint ap-northeast-2. 4475 \ "ap-northeast-2" 4476 / Asia Pacific (Mumbai) 4477 13 | Needs location constraint ap-south-1. 4478 \ "ap-south-1" 4479 / South America (Sao Paulo) Region 4480 14 | Needs location constraint sa-east-1. 4481 \ "sa-east-1" 4482 region> 1 4483 Endpoint for S3 API. 4484 Leave blank if using AWS to use the default endpoint for the region. 4485 endpoint> 4486 Location constraint - must be set to match the Region. Used when creating buckets only. 4487 Choose a number from below, or type in your own value 4488 1 / Empty for US Region, Northern Virginia or Pacific Northwest. 4489 \ "" 4490 2 / US East (Ohio) Region. 4491 \ "us-east-2" 4492 3 / US West (Oregon) Region. 4493 \ "us-west-2" 4494 4 / US West (Northern California) Region. 4495 \ "us-west-1" 4496 5 / Canada (Central) Region. 4497 \ "ca-central-1" 4498 6 / EU (Ireland) Region. 4499 \ "eu-west-1" 4500 7 / EU (London) Region. 4501 \ "eu-west-2" 4502 8 / EU Region. 4503 \ "EU" 4504 9 / Asia Pacific (Singapore) Region. 4505 \ "ap-southeast-1" 4506 10 / Asia Pacific (Sydney) Region. 4507 \ "ap-southeast-2" 4508 11 / Asia Pacific (Tokyo) Region. 4509 \ "ap-northeast-1" 4510 12 / Asia Pacific (Seoul) 4511 \ "ap-northeast-2" 4512 13 / Asia Pacific (Mumbai) 4513 \ "ap-south-1" 4514 14 / South America (Sao Paulo) Region. 4515 \ "sa-east-1" 4516 location_constraint> 1 4517 Canned ACL used when creating buckets and/or storing objects in S3. 4518 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 4519 Choose a number from below, or type in your own value 4520 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 4521 \ "private" 4522 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 4523 \ "public-read" 4524 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 4525 3 | Granting this on a bucket is generally not recommended. 4526 \ "public-read-write" 4527 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. 4528 \ "authenticated-read" 4529 / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 4530 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 4531 \ "bucket-owner-read" 4532 / Both the object owner and the bucket owner get FULL_CONTROL over the object. 4533 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 4534 \ "bucket-owner-full-control" 4535 acl> 1 4536 The server-side encryption algorithm used when storing this object in S3. 4537 Choose a number from below, or type in your own value 4538 1 / None 4539 \ "" 4540 2 / AES256 4541 \ "AES256" 4542 server_side_encryption> 1 4543 The storage class to use when storing objects in S3. 4544 Choose a number from below, or type in your own value 4545 1 / Default 4546 \ "" 4547 2 / Standard storage class 4548 \ "STANDARD" 4549 3 / Reduced redundancy storage class 4550 \ "REDUCED_REDUNDANCY" 4551 4 / Standard Infrequent Access storage class 4552 \ "STANDARD_IA" 4553 5 / One Zone Infrequent Access storage class 4554 \ "ONEZONE_IA" 4555 6 / Glacier storage class 4556 \ "GLACIER" 4557 7 / Glacier Deep Archive storage class 4558 \ "DEEP_ARCHIVE" 4559 storage_class> 1 4560 Remote config 4561 -------------------- 4562 [remote] 4563 type = s3 4564 provider = AWS 4565 env_auth = false 4566 access_key_id = XXX 4567 secret_access_key = YYY 4568 region = us-east-1 4569 endpoint = 4570 location_constraint = 4571 acl = private 4572 server_side_encryption = 4573 storage_class = 4574 -------------------- 4575 y) Yes this is OK 4576 e) Edit this remote 4577 d) Delete this remote 4578 y/e/d> </code></pre> 4579 <h3 id="fast-list-1">–fast-list</h3> 4580 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 4581 <h3 id="update-and-use-server-modtime">–update and –use-server-modtime</h3> 4582 <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> 4583 <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> 4584 <h3 id="modified-time">Modified time</h3> 4585 <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> 4586 <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.<br /> 4587 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> 4588 <h3 id="multipart-uploads">Multipart uploads</h3> 4589 <p>rclone supports multipart uploads with S3 which means that it can upload files bigger than 5GB.</p> 4590 <p>Note that files uploaded <em>both</em> with multipart upload <em>and</em> through crypt remotes do not have MD5 sums.</p> 4591 <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> 4592 <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> 4593 <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> 4594 <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> 4595 <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> 4596 <h3 id="buckets-and-regions">Buckets and Regions</h3> 4597 <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> 4598 <h3 id="authentication-4">Authentication</h3> 4599 <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> 4600 <p>The different authentication methods are tried in this order:</p> 4601 <ul> 4602 <li>Directly in the rclone configuration file (<code>env_auth = false</code> in the config file): 4603 <ul> 4604 <li><code>access_key_id</code> and <code>secret_access_key</code> are required.</li> 4605 <li><code>session_token</code> can be optionally set when using AWS STS.</li> 4606 </ul></li> 4607 <li>Runtime configuration (<code>env_auth = true</code> in the config file): 4608 <ul> 4609 <li>Export the following environment variables before running <code>rclone</code>: 4610 <ul> 4611 <li>Access Key ID: <code>AWS_ACCESS_KEY_ID</code> or <code>AWS_ACCESS_KEY</code></li> 4612 <li>Secret Access Key: <code>AWS_SECRET_ACCESS_KEY</code> or <code>AWS_SECRET_KEY</code></li> 4613 <li>Session Token: <code>AWS_SESSION_TOKEN</code> (optional)</li> 4614 </ul></li> 4615 <li>Or, use a <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html">named profile</a>: 4616 <ul> 4617 <li>Profile files are standard files used by AWS CLI tools</li> 4618 <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: 4619 <ul> 4620 <li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file.</li> 4621 <li><code>AWS_PROFILE</code> to control which profile to use.</li> 4622 </ul></li> 4623 </ul></li> 4624 <li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS only).</li> 4625 <li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS only).</li> 4626 </ul></li> 4627 </ul> 4628 <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> 4629 <h3 id="s3-permissions">S3 Permissions</h3> 4630 <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> 4631 <ul> 4632 <li><code>ListBucket</code></li> 4633 <li><code>DeleteObject</code></li> 4634 <li><code>GetObject</code></li> 4635 <li><code>PutObject</code></li> 4636 <li><code>PutObjectACL</code></li> 4637 </ul> 4638 <p>Example policy:</p> 4639 <pre><code>{ 4640 "Version": "2012-10-17", 4641 "Statement": [ 4642 { 4643 "Effect": "Allow", 4644 "Principal": { 4645 "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" 4646 }, 4647 "Action": [ 4648 "s3:ListBucket", 4649 "s3:DeleteObject", 4650 "s3:GetObject", 4651 "s3:PutObject", 4652 "s3:PutObjectAcl" 4653 ], 4654 "Resource": [ 4655 "arn:aws:s3:::BUCKET_NAME/*", 4656 "arn:aws:s3:::BUCKET_NAME" 4657 ] 4658 } 4659 ] 4660 }</code></pre> 4661 <p>Notes on above:</p> 4662 <ol type="1"> 4663 <li>This is a policy that can be used when creating bucket. It assumes that <code>USER_NAME</code> has been created.</li> 4664 <li>The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket’s objects.</li> 4665 </ol> 4666 <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> 4667 <h3 id="key-management-system-kms">Key Management System (KMS)</h3> 4668 <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> 4669 <p>A proper fix is being worked on in <a href="https://github.com/ncw/rclone/issues/1824">issue #1824</a>.</p> 4670 <h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep Archive</h3> 4671 <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> 4672 <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> 4673 <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> 4674 <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> 4675 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs --> 4676 <h3 id="standard-options-2">Standard Options</h3> 4677 <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> 4678 <h4 id="s3-provider">–s3-provider</h4> 4679 <p>Choose your S3 provider.</p> 4680 <ul> 4681 <li>Config: provider</li> 4682 <li>Env Var: RCLONE_S3_PROVIDER</li> 4683 <li>Type: string</li> 4684 <li>Default: ""</li> 4685 <li>Examples: 4686 <ul> 4687 <li>“AWS” 4688 <ul> 4689 <li>Amazon Web Services (AWS) S3</li> 4690 </ul></li> 4691 <li>“Alibaba” 4692 <ul> 4693 <li>Alibaba Cloud Object Storage System (OSS) formerly Aliyun</li> 4694 </ul></li> 4695 <li>“Ceph” 4696 <ul> 4697 <li>Ceph Object Storage</li> 4698 </ul></li> 4699 <li>“DigitalOcean” 4700 <ul> 4701 <li>Digital Ocean Spaces</li> 4702 </ul></li> 4703 <li>“Dreamhost” 4704 <ul> 4705 <li>Dreamhost DreamObjects</li> 4706 </ul></li> 4707 <li>“IBMCOS” 4708 <ul> 4709 <li>IBM COS S3</li> 4710 </ul></li> 4711 <li>“Minio” 4712 <ul> 4713 <li>Minio Object Storage</li> 4714 </ul></li> 4715 <li>“Netease” 4716 <ul> 4717 <li>Netease Object Storage (NOS)</li> 4718 </ul></li> 4719 <li>“Wasabi” 4720 <ul> 4721 <li>Wasabi Object Storage</li> 4722 </ul></li> 4723 <li>“Other” 4724 <ul> 4725 <li>Any other S3 compatible provider</li> 4726 </ul></li> 4727 </ul></li> 4728 </ul> 4729 <h4 id="s3-env-auth">–s3-env-auth</h4> 4730 <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> 4731 <ul> 4732 <li>Config: env_auth</li> 4733 <li>Env Var: RCLONE_S3_ENV_AUTH</li> 4734 <li>Type: bool</li> 4735 <li>Default: false</li> 4736 <li>Examples: 4737 <ul> 4738 <li>“false” 4739 <ul> 4740 <li>Enter AWS credentials in the next step</li> 4741 </ul></li> 4742 <li>“true” 4743 <ul> 4744 <li>Get AWS credentials from the environment (env vars or IAM)</li> 4745 </ul></li> 4746 </ul></li> 4747 </ul> 4748 <h4 id="s3-access-key-id">–s3-access-key-id</h4> 4749 <p>AWS Access Key ID. Leave blank for anonymous access or runtime credentials.</p> 4750 <ul> 4751 <li>Config: access_key_id</li> 4752 <li>Env Var: RCLONE_S3_ACCESS_KEY_ID</li> 4753 <li>Type: string</li> 4754 <li>Default: ""</li> 4755 </ul> 4756 <h4 id="s3-secret-access-key">–s3-secret-access-key</h4> 4757 <p>AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials.</p> 4758 <ul> 4759 <li>Config: secret_access_key</li> 4760 <li>Env Var: RCLONE_S3_SECRET_ACCESS_KEY</li> 4761 <li>Type: string</li> 4762 <li>Default: ""</li> 4763 </ul> 4764 <h4 id="s3-region">–s3-region</h4> 4765 <p>Region to connect to.</p> 4766 <ul> 4767 <li>Config: region</li> 4768 <li>Env Var: RCLONE_S3_REGION</li> 4769 <li>Type: string</li> 4770 <li>Default: ""</li> 4771 <li>Examples: 4772 <ul> 4773 <li>“us-east-1” 4774 <ul> 4775 <li>The default endpoint - a good choice if you are unsure.</li> 4776 <li>US Region, Northern Virginia or Pacific Northwest.</li> 4777 <li>Leave location constraint empty.</li> 4778 </ul></li> 4779 <li>“us-east-2” 4780 <ul> 4781 <li>US East (Ohio) Region</li> 4782 <li>Needs location constraint us-east-2.</li> 4783 </ul></li> 4784 <li>“us-west-2” 4785 <ul> 4786 <li>US West (Oregon) Region</li> 4787 <li>Needs location constraint us-west-2.</li> 4788 </ul></li> 4789 <li>“us-west-1” 4790 <ul> 4791 <li>US West (Northern California) Region</li> 4792 <li>Needs location constraint us-west-1.</li> 4793 </ul></li> 4794 <li>“ca-central-1” 4795 <ul> 4796 <li>Canada (Central) Region</li> 4797 <li>Needs location constraint ca-central-1.</li> 4798 </ul></li> 4799 <li>“eu-west-1” 4800 <ul> 4801 <li>EU (Ireland) Region</li> 4802 <li>Needs location constraint EU or eu-west-1.</li> 4803 </ul></li> 4804 <li>“eu-west-2” 4805 <ul> 4806 <li>EU (London) Region</li> 4807 <li>Needs location constraint eu-west-2.</li> 4808 </ul></li> 4809 <li>“eu-north-1” 4810 <ul> 4811 <li>EU (Stockholm) Region</li> 4812 <li>Needs location constraint eu-north-1.</li> 4813 </ul></li> 4814 <li>“eu-central-1” 4815 <ul> 4816 <li>EU (Frankfurt) Region</li> 4817 <li>Needs location constraint eu-central-1.</li> 4818 </ul></li> 4819 <li>“ap-southeast-1” 4820 <ul> 4821 <li>Asia Pacific (Singapore) Region</li> 4822 <li>Needs location constraint ap-southeast-1.</li> 4823 </ul></li> 4824 <li>“ap-southeast-2” 4825 <ul> 4826 <li>Asia Pacific (Sydney) Region</li> 4827 <li>Needs location constraint ap-southeast-2.</li> 4828 </ul></li> 4829 <li>“ap-northeast-1” 4830 <ul> 4831 <li>Asia Pacific (Tokyo) Region</li> 4832 <li>Needs location constraint ap-northeast-1.</li> 4833 </ul></li> 4834 <li>“ap-northeast-2” 4835 <ul> 4836 <li>Asia Pacific (Seoul)</li> 4837 <li>Needs location constraint ap-northeast-2.</li> 4838 </ul></li> 4839 <li>“ap-south-1” 4840 <ul> 4841 <li>Asia Pacific (Mumbai)</li> 4842 <li>Needs location constraint ap-south-1.</li> 4843 </ul></li> 4844 <li>“sa-east-1” 4845 <ul> 4846 <li>South America (Sao Paulo) Region</li> 4847 <li>Needs location constraint sa-east-1.</li> 4848 </ul></li> 4849 </ul></li> 4850 </ul> 4851 <h4 id="s3-region-1">–s3-region</h4> 4852 <p>Region to connect to. Leave blank if you are using an S3 clone and you don’t have a region.</p> 4853 <ul> 4854 <li>Config: region</li> 4855 <li>Env Var: RCLONE_S3_REGION</li> 4856 <li>Type: string</li> 4857 <li>Default: ""</li> 4858 <li>Examples: 4859 <ul> 4860 <li>"" 4861 <ul> 4862 <li>Use this if unsure. Will use v4 signatures and an empty region.</li> 4863 </ul></li> 4864 <li>“other-v2-signature” 4865 <ul> 4866 <li>Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH.</li> 4867 </ul></li> 4868 </ul></li> 4869 </ul> 4870 <h4 id="s3-endpoint">–s3-endpoint</h4> 4871 <p>Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region.</p> 4872 <ul> 4873 <li>Config: endpoint</li> 4874 <li>Env Var: RCLONE_S3_ENDPOINT</li> 4875 <li>Type: string</li> 4876 <li>Default: ""</li> 4877 </ul> 4878 <h4 id="s3-endpoint-1">–s3-endpoint</h4> 4879 <p>Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise.</p> 4880 <ul> 4881 <li>Config: endpoint</li> 4882 <li>Env Var: RCLONE_S3_ENDPOINT</li> 4883 <li>Type: string</li> 4884 <li>Default: ""</li> 4885 <li>Examples: 4886 <ul> 4887 <li>“s3-api.us-geo.objectstorage.softlayer.net” 4888 <ul> 4889 <li>US Cross Region Endpoint</li> 4890 </ul></li> 4891 <li>“s3-api.dal.us-geo.objectstorage.softlayer.net” 4892 <ul> 4893 <li>US Cross Region Dallas Endpoint</li> 4894 </ul></li> 4895 <li>“s3-api.wdc-us-geo.objectstorage.softlayer.net” 4896 <ul> 4897 <li>US Cross Region Washington DC Endpoint</li> 4898 </ul></li> 4899 <li>“s3-api.sjc-us-geo.objectstorage.softlayer.net” 4900 <ul> 4901 <li>US Cross Region San Jose Endpoint</li> 4902 </ul></li> 4903 <li>“s3-api.us-geo.objectstorage.service.networklayer.com” 4904 <ul> 4905 <li>US Cross Region Private Endpoint</li> 4906 </ul></li> 4907 <li>“s3-api.dal-us-geo.objectstorage.service.networklayer.com” 4908 <ul> 4909 <li>US Cross Region Dallas Private Endpoint</li> 4910 </ul></li> 4911 <li>“s3-api.wdc-us-geo.objectstorage.service.networklayer.com” 4912 <ul> 4913 <li>US Cross Region Washington DC Private Endpoint</li> 4914 </ul></li> 4915 <li>“s3-api.sjc-us-geo.objectstorage.service.networklayer.com” 4916 <ul> 4917 <li>US Cross Region San Jose Private Endpoint</li> 4918 </ul></li> 4919 <li>“s3.us-east.objectstorage.softlayer.net” 4920 <ul> 4921 <li>US Region East Endpoint</li> 4922 </ul></li> 4923 <li>“s3.us-east.objectstorage.service.networklayer.com” 4924 <ul> 4925 <li>US Region East Private Endpoint</li> 4926 </ul></li> 4927 <li>“s3.us-south.objectstorage.softlayer.net” 4928 <ul> 4929 <li>US Region South Endpoint</li> 4930 </ul></li> 4931 <li>“s3.us-south.objectstorage.service.networklayer.com” 4932 <ul> 4933 <li>US Region South Private Endpoint</li> 4934 </ul></li> 4935 <li>“s3.eu-geo.objectstorage.softlayer.net” 4936 <ul> 4937 <li>EU Cross Region Endpoint</li> 4938 </ul></li> 4939 <li>“s3.fra-eu-geo.objectstorage.softlayer.net” 4940 <ul> 4941 <li>EU Cross Region Frankfurt Endpoint</li> 4942 </ul></li> 4943 <li>“s3.mil-eu-geo.objectstorage.softlayer.net” 4944 <ul> 4945 <li>EU Cross Region Milan Endpoint</li> 4946 </ul></li> 4947 <li>“s3.ams-eu-geo.objectstorage.softlayer.net” 4948 <ul> 4949 <li>EU Cross Region Amsterdam Endpoint</li> 4950 </ul></li> 4951 <li>“s3.eu-geo.objectstorage.service.networklayer.com” 4952 <ul> 4953 <li>EU Cross Region Private Endpoint</li> 4954 </ul></li> 4955 <li>“s3.fra-eu-geo.objectstorage.service.networklayer.com” 4956 <ul> 4957 <li>EU Cross Region Frankfurt Private Endpoint</li> 4958 </ul></li> 4959 <li>“s3.mil-eu-geo.objectstorage.service.networklayer.com” 4960 <ul> 4961 <li>EU Cross Region Milan Private Endpoint</li> 4962 </ul></li> 4963 <li>“s3.ams-eu-geo.objectstorage.service.networklayer.com” 4964 <ul> 4965 <li>EU Cross Region Amsterdam Private Endpoint</li> 4966 </ul></li> 4967 <li>“s3.eu-gb.objectstorage.softlayer.net” 4968 <ul> 4969 <li>Great Britain Endpoint</li> 4970 </ul></li> 4971 <li>“s3.eu-gb.objectstorage.service.networklayer.com” 4972 <ul> 4973 <li>Great Britain Private Endpoint</li> 4974 </ul></li> 4975 <li>“s3.ap-geo.objectstorage.softlayer.net” 4976 <ul> 4977 <li>APAC Cross Regional Endpoint</li> 4978 </ul></li> 4979 <li>“s3.tok-ap-geo.objectstorage.softlayer.net” 4980 <ul> 4981 <li>APAC Cross Regional Tokyo Endpoint</li> 4982 </ul></li> 4983 <li>“s3.hkg-ap-geo.objectstorage.softlayer.net” 4984 <ul> 4985 <li>APAC Cross Regional HongKong Endpoint</li> 4986 </ul></li> 4987 <li>“s3.seo-ap-geo.objectstorage.softlayer.net” 4988 <ul> 4989 <li>APAC Cross Regional Seoul Endpoint</li> 4990 </ul></li> 4991 <li>“s3.ap-geo.objectstorage.service.networklayer.com” 4992 <ul> 4993 <li>APAC Cross Regional Private Endpoint</li> 4994 </ul></li> 4995 <li>“s3.tok-ap-geo.objectstorage.service.networklayer.com” 4996 <ul> 4997 <li>APAC Cross Regional Tokyo Private Endpoint</li> 4998 </ul></li> 4999 <li>“s3.hkg-ap-geo.objectstorage.service.networklayer.com” 5000 <ul> 5001 <li>APAC Cross Regional HongKong Private Endpoint</li> 5002 </ul></li> 5003 <li>“s3.seo-ap-geo.objectstorage.service.networklayer.com” 5004 <ul> 5005 <li>APAC Cross Regional Seoul Private Endpoint</li> 5006 </ul></li> 5007 <li>“s3.mel01.objectstorage.softlayer.net” 5008 <ul> 5009 <li>Melbourne Single Site Endpoint</li> 5010 </ul></li> 5011 <li>“s3.mel01.objectstorage.service.networklayer.com” 5012 <ul> 5013 <li>Melbourne Single Site Private Endpoint</li> 5014 </ul></li> 5015 <li>“s3.tor01.objectstorage.softlayer.net” 5016 <ul> 5017 <li>Toronto Single Site Endpoint</li> 5018 </ul></li> 5019 <li>“s3.tor01.objectstorage.service.networklayer.com” 5020 <ul> 5021 <li>Toronto Single Site Private Endpoint</li> 5022 </ul></li> 5023 </ul></li> 5024 </ul> 5025 <h4 id="s3-endpoint-2">–s3-endpoint</h4> 5026 <p>Endpoint for OSS API.</p> 5027 <ul> 5028 <li>Config: endpoint</li> 5029 <li>Env Var: RCLONE_S3_ENDPOINT</li> 5030 <li>Type: string</li> 5031 <li>Default: ""</li> 5032 <li>Examples: 5033 <ul> 5034 <li>“oss-cn-hangzhou.aliyuncs.com” 5035 <ul> 5036 <li>East China 1 (Hangzhou)</li> 5037 </ul></li> 5038 <li>“oss-cn-shanghai.aliyuncs.com” 5039 <ul> 5040 <li>East China 2 (Shanghai)</li> 5041 </ul></li> 5042 <li>“oss-cn-qingdao.aliyuncs.com” 5043 <ul> 5044 <li>North China 1 (Qingdao)</li> 5045 </ul></li> 5046 <li>“oss-cn-beijing.aliyuncs.com” 5047 <ul> 5048 <li>North China 2 (Beijing)</li> 5049 </ul></li> 5050 <li>“oss-cn-zhangjiakou.aliyuncs.com” 5051 <ul> 5052 <li>North China 3 (Zhangjiakou)</li> 5053 </ul></li> 5054 <li>“oss-cn-huhehaote.aliyuncs.com” 5055 <ul> 5056 <li>North China 5 (Huhehaote)</li> 5057 </ul></li> 5058 <li>“oss-cn-shenzhen.aliyuncs.com” 5059 <ul> 5060 <li>South China 1 (Shenzhen)</li> 5061 </ul></li> 5062 <li>“oss-cn-hongkong.aliyuncs.com” 5063 <ul> 5064 <li>Hong Kong (Hong Kong)</li> 5065 </ul></li> 5066 <li>“oss-us-west-1.aliyuncs.com” 5067 <ul> 5068 <li>US West 1 (Silicon Valley)</li> 5069 </ul></li> 5070 <li>“oss-us-east-1.aliyuncs.com” 5071 <ul> 5072 <li>US East 1 (Virginia)</li> 5073 </ul></li> 5074 <li>“oss-ap-southeast-1.aliyuncs.com” 5075 <ul> 5076 <li>Southeast Asia Southeast 1 (Singapore)</li> 5077 </ul></li> 5078 <li>“oss-ap-southeast-2.aliyuncs.com” 5079 <ul> 5080 <li>Asia Pacific Southeast 2 (Sydney)</li> 5081 </ul></li> 5082 <li>“oss-ap-southeast-3.aliyuncs.com” 5083 <ul> 5084 <li>Southeast Asia Southeast 3 (Kuala Lumpur)</li> 5085 </ul></li> 5086 <li>“oss-ap-southeast-5.aliyuncs.com” 5087 <ul> 5088 <li>Asia Pacific Southeast 5 (Jakarta)</li> 5089 </ul></li> 5090 <li>“oss-ap-northeast-1.aliyuncs.com” 5091 <ul> 5092 <li>Asia Pacific Northeast 1 (Japan)</li> 5093 </ul></li> 5094 <li>“oss-ap-south-1.aliyuncs.com” 5095 <ul> 5096 <li>Asia Pacific South 1 (Mumbai)</li> 5097 </ul></li> 5098 <li>“oss-eu-central-1.aliyuncs.com” 5099 <ul> 5100 <li>Central Europe 1 (Frankfurt)</li> 5101 </ul></li> 5102 <li>“oss-eu-west-1.aliyuncs.com” 5103 <ul> 5104 <li>West Europe (London)</li> 5105 </ul></li> 5106 <li>“oss-me-east-1.aliyuncs.com” 5107 <ul> 5108 <li>Middle East 1 (Dubai)</li> 5109 </ul></li> 5110 </ul></li> 5111 </ul> 5112 <h4 id="s3-endpoint-3">–s3-endpoint</h4> 5113 <p>Endpoint for S3 API. Required when using an S3 clone.</p> 5114 <ul> 5115 <li>Config: endpoint</li> 5116 <li>Env Var: RCLONE_S3_ENDPOINT</li> 5117 <li>Type: string</li> 5118 <li>Default: ""</li> 5119 <li>Examples: 5120 <ul> 5121 <li>“objects-us-east-1.dream.io” 5122 <ul> 5123 <li>Dream Objects endpoint</li> 5124 </ul></li> 5125 <li>“nyc3.digitaloceanspaces.com” 5126 <ul> 5127 <li>Digital Ocean Spaces New York 3</li> 5128 </ul></li> 5129 <li>“ams3.digitaloceanspaces.com” 5130 <ul> 5131 <li>Digital Ocean Spaces Amsterdam 3</li> 5132 </ul></li> 5133 <li>“sgp1.digitaloceanspaces.com” 5134 <ul> 5135 <li>Digital Ocean Spaces Singapore 1</li> 5136 </ul></li> 5137 <li>“s3.wasabisys.com” 5138 <ul> 5139 <li>Wasabi US East endpoint</li> 5140 </ul></li> 5141 <li>“s3.us-west-1.wasabisys.com” 5142 <ul> 5143 <li>Wasabi US West endpoint</li> 5144 </ul></li> 5145 <li>“s3.eu-central-1.wasabisys.com” 5146 <ul> 5147 <li>Wasabi EU Central endpoint</li> 5148 </ul></li> 5149 </ul></li> 5150 </ul> 5151 <h4 id="s3-location-constraint">–s3-location-constraint</h4> 5152 <p>Location constraint - must be set to match the Region. Used when creating buckets only.</p> 5153 <ul> 5154 <li>Config: location_constraint</li> 5155 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 5156 <li>Type: string</li> 5157 <li>Default: ""</li> 5158 <li>Examples: 5159 <ul> 5160 <li>"" 5161 <ul> 5162 <li>Empty for US Region, Northern Virginia or Pacific Northwest.</li> 5163 </ul></li> 5164 <li>“us-east-2” 5165 <ul> 5166 <li>US East (Ohio) Region.</li> 5167 </ul></li> 5168 <li>“us-west-2” 5169 <ul> 5170 <li>US West (Oregon) Region.</li> 5171 </ul></li> 5172 <li>“us-west-1” 5173 <ul> 5174 <li>US West (Northern California) Region.</li> 5175 </ul></li> 5176 <li>“ca-central-1” 5177 <ul> 5178 <li>Canada (Central) Region.</li> 5179 </ul></li> 5180 <li>“eu-west-1” 5181 <ul> 5182 <li>EU (Ireland) Region.</li> 5183 </ul></li> 5184 <li>“eu-west-2” 5185 <ul> 5186 <li>EU (London) Region.</li> 5187 </ul></li> 5188 <li>“eu-north-1” 5189 <ul> 5190 <li>EU (Stockholm) Region.</li> 5191 </ul></li> 5192 <li>“EU” 5193 <ul> 5194 <li>EU Region.</li> 5195 </ul></li> 5196 <li>“ap-southeast-1” 5197 <ul> 5198 <li>Asia Pacific (Singapore) Region.</li> 5199 </ul></li> 5200 <li>“ap-southeast-2” 5201 <ul> 5202 <li>Asia Pacific (Sydney) Region.</li> 5203 </ul></li> 5204 <li>“ap-northeast-1” 5205 <ul> 5206 <li>Asia Pacific (Tokyo) Region.</li> 5207 </ul></li> 5208 <li>“ap-northeast-2” 5209 <ul> 5210 <li>Asia Pacific (Seoul)</li> 5211 </ul></li> 5212 <li>“ap-south-1” 5213 <ul> 5214 <li>Asia Pacific (Mumbai)</li> 5215 </ul></li> 5216 <li>“sa-east-1” 5217 <ul> 5218 <li>South America (Sao Paulo) Region.</li> 5219 </ul></li> 5220 </ul></li> 5221 </ul> 5222 <h4 id="s3-location-constraint-1">–s3-location-constraint</h4> 5223 <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> 5224 <ul> 5225 <li>Config: location_constraint</li> 5226 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 5227 <li>Type: string</li> 5228 <li>Default: ""</li> 5229 <li>Examples: 5230 <ul> 5231 <li>“us-standard” 5232 <ul> 5233 <li>US Cross Region Standard</li> 5234 </ul></li> 5235 <li>“us-vault” 5236 <ul> 5237 <li>US Cross Region Vault</li> 5238 </ul></li> 5239 <li>“us-cold” 5240 <ul> 5241 <li>US Cross Region Cold</li> 5242 </ul></li> 5243 <li>“us-flex” 5244 <ul> 5245 <li>US Cross Region Flex</li> 5246 </ul></li> 5247 <li>“us-east-standard” 5248 <ul> 5249 <li>US East Region Standard</li> 5250 </ul></li> 5251 <li>“us-east-vault” 5252 <ul> 5253 <li>US East Region Vault</li> 5254 </ul></li> 5255 <li>“us-east-cold” 5256 <ul> 5257 <li>US East Region Cold</li> 5258 </ul></li> 5259 <li>“us-east-flex” 5260 <ul> 5261 <li>US East Region Flex</li> 5262 </ul></li> 5263 <li>“us-south-standard” 5264 <ul> 5265 <li>US South Region Standard</li> 5266 </ul></li> 5267 <li>“us-south-vault” 5268 <ul> 5269 <li>US South Region Vault</li> 5270 </ul></li> 5271 <li>“us-south-cold” 5272 <ul> 5273 <li>US South Region Cold</li> 5274 </ul></li> 5275 <li>“us-south-flex” 5276 <ul> 5277 <li>US South Region Flex</li> 5278 </ul></li> 5279 <li>“eu-standard” 5280 <ul> 5281 <li>EU Cross Region Standard</li> 5282 </ul></li> 5283 <li>“eu-vault” 5284 <ul> 5285 <li>EU Cross Region Vault</li> 5286 </ul></li> 5287 <li>“eu-cold” 5288 <ul> 5289 <li>EU Cross Region Cold</li> 5290 </ul></li> 5291 <li>“eu-flex” 5292 <ul> 5293 <li>EU Cross Region Flex</li> 5294 </ul></li> 5295 <li>“eu-gb-standard” 5296 <ul> 5297 <li>Great Britain Standard</li> 5298 </ul></li> 5299 <li>“eu-gb-vault” 5300 <ul> 5301 <li>Great Britain Vault</li> 5302 </ul></li> 5303 <li>“eu-gb-cold” 5304 <ul> 5305 <li>Great Britain Cold</li> 5306 </ul></li> 5307 <li>“eu-gb-flex” 5308 <ul> 5309 <li>Great Britain Flex</li> 5310 </ul></li> 5311 <li>“ap-standard” 5312 <ul> 5313 <li>APAC Standard</li> 5314 </ul></li> 5315 <li>“ap-vault” 5316 <ul> 5317 <li>APAC Vault</li> 5318 </ul></li> 5319 <li>“ap-cold” 5320 <ul> 5321 <li>APAC Cold</li> 5322 </ul></li> 5323 <li>“ap-flex” 5324 <ul> 5325 <li>APAC Flex</li> 5326 </ul></li> 5327 <li>“mel01-standard” 5328 <ul> 5329 <li>Melbourne Standard</li> 5330 </ul></li> 5331 <li>“mel01-vault” 5332 <ul> 5333 <li>Melbourne Vault</li> 5334 </ul></li> 5335 <li>“mel01-cold” 5336 <ul> 5337 <li>Melbourne Cold</li> 5338 </ul></li> 5339 <li>“mel01-flex” 5340 <ul> 5341 <li>Melbourne Flex</li> 5342 </ul></li> 5343 <li>“tor01-standard” 5344 <ul> 5345 <li>Toronto Standard</li> 5346 </ul></li> 5347 <li>“tor01-vault” 5348 <ul> 5349 <li>Toronto Vault</li> 5350 </ul></li> 5351 <li>“tor01-cold” 5352 <ul> 5353 <li>Toronto Cold</li> 5354 </ul></li> 5355 <li>“tor01-flex” 5356 <ul> 5357 <li>Toronto Flex</li> 5358 </ul></li> 5359 </ul></li> 5360 </ul> 5361 <h4 id="s3-location-constraint-2">–s3-location-constraint</h4> 5362 <p>Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only.</p> 5363 <ul> 5364 <li>Config: location_constraint</li> 5365 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 5366 <li>Type: string</li> 5367 <li>Default: ""</li> 5368 </ul> 5369 <h4 id="s3-acl">–s3-acl</h4> 5370 <p>Canned ACL used when creating buckets and storing or copying objects.</p> 5371 <p>This ACL is used for creating objects and if bucket_acl isn’t set, for creating buckets too.</p> 5372 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 5373 <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> 5374 <ul> 5375 <li>Config: acl</li> 5376 <li>Env Var: RCLONE_S3_ACL</li> 5377 <li>Type: string</li> 5378 <li>Default: ""</li> 5379 <li>Examples: 5380 <ul> 5381 <li>“private” 5382 <ul> 5383 <li>Owner gets FULL_CONTROL. No one else has access rights (default).</li> 5384 </ul></li> 5385 <li>“public-read” 5386 <ul> 5387 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ access.</li> 5388 </ul></li> 5389 <li>“public-read-write” 5390 <ul> 5391 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.</li> 5392 <li>Granting this on a bucket is generally not recommended.</li> 5393 </ul></li> 5394 <li>“authenticated-read” 5395 <ul> 5396 <li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.</li> 5397 </ul></li> 5398 <li>“bucket-owner-read” 5399 <ul> 5400 <li>Object owner gets FULL_CONTROL. Bucket owner gets READ access.</li> 5401 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 5402 </ul></li> 5403 <li>“bucket-owner-full-control” 5404 <ul> 5405 <li>Both the object owner and the bucket owner get FULL_CONTROL over the object.</li> 5406 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 5407 </ul></li> 5408 <li>“private” 5409 <ul> 5410 <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> 5411 </ul></li> 5412 <li>“public-read” 5413 <ul> 5414 <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> 5415 </ul></li> 5416 <li>“public-read-write” 5417 <ul> 5418 <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> 5419 </ul></li> 5420 <li>“authenticated-read” 5421 <ul> 5422 <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> 5423 </ul></li> 5424 </ul></li> 5425 </ul> 5426 <h4 id="s3-server-side-encryption">–s3-server-side-encryption</h4> 5427 <p>The server-side encryption algorithm used when storing this object in S3.</p> 5428 <ul> 5429 <li>Config: server_side_encryption</li> 5430 <li>Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION</li> 5431 <li>Type: string</li> 5432 <li>Default: ""</li> 5433 <li>Examples: 5434 <ul> 5435 <li>"" 5436 <ul> 5437 <li>None</li> 5438 </ul></li> 5439 <li>“AES256” 5440 <ul> 5441 <li>AES256</li> 5442 </ul></li> 5443 <li>“aws:kms” 5444 <ul> 5445 <li>aws:kms</li> 5446 </ul></li> 5447 </ul></li> 5448 </ul> 5449 <h4 id="s3-sse-kms-key-id">–s3-sse-kms-key-id</h4> 5450 <p>If using KMS ID you must provide the ARN of Key.</p> 5451 <ul> 5452 <li>Config: sse_kms_key_id</li> 5453 <li>Env Var: RCLONE_S3_SSE_KMS_KEY_ID</li> 5454 <li>Type: string</li> 5455 <li>Default: ""</li> 5456 <li>Examples: 5457 <ul> 5458 <li>"" 5459 <ul> 5460 <li>None</li> 5461 </ul></li> 5462 <li>"arn:aws:kms:us-east-1:*" 5463 <ul> 5464 <li>arn:aws:kms:*</li> 5465 </ul></li> 5466 </ul></li> 5467 </ul> 5468 <h4 id="s3-storage-class">–s3-storage-class</h4> 5469 <p>The storage class to use when storing new objects in S3.</p> 5470 <ul> 5471 <li>Config: storage_class</li> 5472 <li>Env Var: RCLONE_S3_STORAGE_CLASS</li> 5473 <li>Type: string</li> 5474 <li>Default: ""</li> 5475 <li>Examples: 5476 <ul> 5477 <li>"" 5478 <ul> 5479 <li>Default</li> 5480 </ul></li> 5481 <li>“STANDARD” 5482 <ul> 5483 <li>Standard storage class</li> 5484 </ul></li> 5485 <li>“REDUCED_REDUNDANCY” 5486 <ul> 5487 <li>Reduced redundancy storage class</li> 5488 </ul></li> 5489 <li>“STANDARD_IA” 5490 <ul> 5491 <li>Standard Infrequent Access storage class</li> 5492 </ul></li> 5493 <li>“ONEZONE_IA” 5494 <ul> 5495 <li>One Zone Infrequent Access storage class</li> 5496 </ul></li> 5497 <li>“GLACIER” 5498 <ul> 5499 <li>Glacier storage class</li> 5500 </ul></li> 5501 <li>“DEEP_ARCHIVE” 5502 <ul> 5503 <li>Glacier Deep Archive storage class</li> 5504 </ul></li> 5505 </ul></li> 5506 </ul> 5507 <h4 id="s3-storage-class-1">–s3-storage-class</h4> 5508 <p>The storage class to use when storing new objects in OSS.</p> 5509 <ul> 5510 <li>Config: storage_class</li> 5511 <li>Env Var: RCLONE_S3_STORAGE_CLASS</li> 5512 <li>Type: string</li> 5513 <li>Default: ""</li> 5514 <li>Examples: 5515 <ul> 5516 <li>"" 5517 <ul> 5518 <li>Default</li> 5519 </ul></li> 5520 <li>“STANDARD” 5521 <ul> 5522 <li>Standard storage class</li> 5523 </ul></li> 5524 <li>“GLACIER” 5525 <ul> 5526 <li>Archive storage mode.</li> 5527 </ul></li> 5528 <li>“STANDARD_IA” 5529 <ul> 5530 <li>Infrequent access storage mode.</li> 5531 </ul></li> 5532 </ul></li> 5533 </ul> 5534 <h3 id="advanced-options-1">Advanced Options</h3> 5535 <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> 5536 <h4 id="s3-bucket-acl">–s3-bucket-acl</h4> 5537 <p>Canned ACL used when creating buckets.</p> 5538 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 5539 <p>Note that this ACL is applied when only when creating buckets. If it isn’t set then “acl” is used instead.</p> 5540 <ul> 5541 <li>Config: bucket_acl</li> 5542 <li>Env Var: RCLONE_S3_BUCKET_ACL</li> 5543 <li>Type: string</li> 5544 <li>Default: ""</li> 5545 <li>Examples: 5546 <ul> 5547 <li>“private” 5548 <ul> 5549 <li>Owner gets FULL_CONTROL. No one else has access rights (default).</li> 5550 </ul></li> 5551 <li>“public-read” 5552 <ul> 5553 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ access.</li> 5554 </ul></li> 5555 <li>“public-read-write” 5556 <ul> 5557 <li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.</li> 5558 <li>Granting this on a bucket is generally not recommended.</li> 5559 </ul></li> 5560 <li>“authenticated-read” 5561 <ul> 5562 <li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.</li> 5563 </ul></li> 5564 </ul></li> 5565 </ul> 5566 <h4 id="s3-upload-cutoff">–s3-upload-cutoff</h4> 5567 <p>Cutoff for switching to chunked upload</p> 5568 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.</p> 5569 <ul> 5570 <li>Config: upload_cutoff</li> 5571 <li>Env Var: RCLONE_S3_UPLOAD_CUTOFF</li> 5572 <li>Type: SizeSuffix</li> 5573 <li>Default: 200M</li> 5574 </ul> 5575 <h4 id="s3-chunk-size">–s3-chunk-size</h4> 5576 <p>Chunk size to use for uploading.</p> 5577 <p>When uploading files larger than upload_cutoff they will be uploaded as multipart uploads using this chunk size.</p> 5578 <p>Note that “–s3-upload-concurrency” chunks of this size are buffered in memory per transfer.</p> 5579 <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> 5580 <ul> 5581 <li>Config: chunk_size</li> 5582 <li>Env Var: RCLONE_S3_CHUNK_SIZE</li> 5583 <li>Type: SizeSuffix</li> 5584 <li>Default: 5M</li> 5585 </ul> 5586 <h4 id="s3-disable-checksum">–s3-disable-checksum</h4> 5587 <p>Don’t store MD5 checksum with object metadata</p> 5588 <ul> 5589 <li>Config: disable_checksum</li> 5590 <li>Env Var: RCLONE_S3_DISABLE_CHECKSUM</li> 5591 <li>Type: bool</li> 5592 <li>Default: false</li> 5593 </ul> 5594 <h4 id="s3-session-token">–s3-session-token</h4> 5595 <p>An AWS session token</p> 5596 <ul> 5597 <li>Config: session_token</li> 5598 <li>Env Var: RCLONE_S3_SESSION_TOKEN</li> 5599 <li>Type: string</li> 5600 <li>Default: ""</li> 5601 </ul> 5602 <h4 id="s3-upload-concurrency">–s3-upload-concurrency</h4> 5603 <p>Concurrency for multipart uploads.</p> 5604 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 5605 <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> 5606 <ul> 5607 <li>Config: upload_concurrency</li> 5608 <li>Env Var: RCLONE_S3_UPLOAD_CONCURRENCY</li> 5609 <li>Type: int</li> 5610 <li>Default: 4</li> 5611 </ul> 5612 <h4 id="s3-force-path-style">–s3-force-path-style</h4> 5613 <p>If true use path style access if false use virtual hosted style.</p> 5614 <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> 5615 <p>Some providers (eg Aliyun OSS or Netease COS) require this set to false.</p> 5616 <ul> 5617 <li>Config: force_path_style</li> 5618 <li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li> 5619 <li>Type: bool</li> 5620 <li>Default: true</li> 5621 </ul> 5622 <h4 id="s3-v2-auth">–s3-v2-auth</h4> 5623 <p>If true use v2 authentication.</p> 5624 <p>If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.</p> 5625 <p>Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH.</p> 5626 <ul> 5627 <li>Config: v2_auth</li> 5628 <li>Env Var: RCLONE_S3_V2_AUTH</li> 5629 <li>Type: bool</li> 5630 <li>Default: false</li> 5631 </ul> 5632 <h4 id="s3-use-accelerate-endpoint">–s3-use-accelerate-endpoint</h4> 5633 <p>If true use the AWS S3 accelerated endpoint.</p> 5634 <p>See: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html">AWS S3 Transfer acceleration</a></p> 5635 <ul> 5636 <li>Config: use_accelerate_endpoint</li> 5637 <li>Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT</li> 5638 <li>Type: bool</li> 5639 <li>Default: false</li> 5640 </ul> 5641 <!--- autogenerated options stop --> 5642 <h3 id="anonymous-access-to-public-buckets">Anonymous access to public buckets</h3> 5643 <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> 5644 <pre><code>[anons3] 5645 type = s3 5646 provider = AWS 5647 env_auth = false 5648 access_key_id = 5649 secret_access_key = 5650 region = us-east-1 5651 endpoint = 5652 location_constraint = 5653 acl = private 5654 server_side_encryption = 5655 storage_class = </code></pre> 5656 <p>Then use it as normal with the name of the public bucket, eg</p> 5657 <pre><code>rclone lsd anons3:1000genomes</code></pre> 5658 <p>You will be able to list and copy data but not upload it.</p> 5659 <h3 id="ceph">Ceph</h3> 5660 <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> 5661 <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> 5662 <pre><code>[ceph] 5663 type = s3 5664 provider = Ceph 5665 env_auth = false 5666 access_key_id = XXX 5667 secret_access_key = YYY 5668 region = 5669 endpoint = https://ceph.endpoint.example.com 5670 location_constraint = 5671 acl = 5672 server_side_encryption = 5673 storage_class =</code></pre> 5674 <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> 5675 <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> 5676 <p>Eg the dump from Ceph looks something like this (irrelevant keys removed).</p> 5677 <pre><code>{ 5678 "user_id": "xxx", 5679 "display_name": "xxxx", 5680 "keys": [ 5681 { 5682 "user": "xxx", 5683 "access_key": "xxxxxx", 5684 "secret_key": "xxxxxx\/xxxx" 5685 } 5686 ], 5687 }</code></pre> 5688 <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> 5689 <h3 id="dreamhost">Dreamhost</h3> 5690 <p>Dreamhost <a href="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an object storage system based on CEPH.</p> 5691 <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> 5692 <pre><code>[dreamobjects] 5693 type = s3 5694 provider = DreamHost 5695 env_auth = false 5696 access_key_id = your_access_key 5697 secret_access_key = your_secret_key 5698 region = 5699 endpoint = objects-us-west-1.dream.io 5700 location_constraint = 5701 acl = private 5702 server_side_encryption = 5703 storage_class =</code></pre> 5704 <h3 id="digitalocean-spaces">DigitalOcean Spaces</h3> 5705 <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> 5706 <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 promted by <code>rclone config</code> for your <code>access_key_id</code> and <code>secret_access_key</code>.</p> 5707 <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> 5708 <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> 5709 <pre><code>Storage> s3 5710 env_auth> 1 5711 access_key_id> YOUR_ACCESS_KEY 5712 secret_access_key> YOUR_SECRET_KEY 5713 region> 5714 endpoint> nyc3.digitaloceanspaces.com 5715 location_constraint> 5716 acl> 5717 storage_class></code></pre> 5718 <p>The resulting configuration file should look like:</p> 5719 <pre><code>[spaces] 5720 type = s3 5721 provider = DigitalOcean 5722 env_auth = false 5723 access_key_id = YOUR_ACCESS_KEY 5724 secret_access_key = YOUR_SECRET_KEY 5725 region = 5726 endpoint = nyc3.digitaloceanspaces.com 5727 location_constraint = 5728 acl = 5729 server_side_encryption = 5730 storage_class =</code></pre> 5731 <p>Once configured, you can create a new Space and begin copying files. For example:</p> 5732 <pre><code>rclone mkdir spaces:my-new-space 5733 rclone copy /path/to/files spaces:my-new-space</code></pre> 5734 <h3 id="ibm-cos-s3">IBM COS (S3)</h3> 5735 <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> 5736 <p>To configure access to IBM COS S3, follow the steps below:</p> 5737 <ol type="1"> 5738 <li>Run rclone config and select n for a new remote.</li> 5739 </ol> 5740 <pre><code> 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults 5741 No remotes found - make a new one 5742 n) New remote 5743 s) Set configuration password 5744 q) Quit config 5745 n/s/q> n</code></pre> 5746 <ol start="2" type="1"> 5747 <li>Enter the name for the configuration</li> 5748 </ol> 5749 <pre><code> name> <YOUR NAME></code></pre> 5750 <ol start="3" type="1"> 5751 <li>Select “s3” storage.</li> 5752 </ol> 5753 <pre><code>Choose a number from below, or type in your own value 5754 1 / Alias for an existing remote 5755 \ "alias" 5756 2 / Amazon Drive 5757 \ "amazon cloud drive" 5758 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) 5759 \ "s3" 5760 4 / Backblaze B2 5761 \ "b2" 5762 [snip] 5763 23 / http Connection 5764 \ "http" 5765 Storage> 3</code></pre> 5766 <ol start="4" type="1"> 5767 <li>Select IBM COS as the S3 Storage Provider.</li> 5768 </ol> 5769 <pre><code>Choose the S3 provider. 5770 Choose a number from below, or type in your own value 5771 1 / Choose this option to configure Storage to AWS S3 5772 \ "AWS" 5773 2 / Choose this option to configure Storage to Ceph Systems 5774 \ "Ceph" 5775 3 / Choose this option to configure Storage to Dreamhost 5776 \ "Dreamhost" 5777 4 / Choose this option to the configure Storage to IBM COS S3 5778 \ "IBMCOS" 5779 5 / Choose this option to the configure Storage to Minio 5780 \ "Minio" 5781 Provider>4</code></pre> 5782 <ol start="5" type="1"> 5783 <li>Enter the Access Key and Secret.</li> 5784 </ol> 5785 <pre><code> AWS Access Key ID - leave blank for anonymous access or runtime credentials. 5786 access_key_id> <> 5787 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 5788 secret_access_key> <></code></pre> 5789 <ol start="6" type="1"> 5790 <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> 5791 </ol> 5792 <pre><code> Endpoint for IBM COS S3 API. 5793 Specify if using an IBM COS On Premise. 5794 Choose a number from below, or type in your own value 5795 1 / US Cross Region Endpoint 5796 \ "s3-api.us-geo.objectstorage.softlayer.net" 5797 2 / US Cross Region Dallas Endpoint 5798 \ "s3-api.dal.us-geo.objectstorage.softlayer.net" 5799 3 / US Cross Region Washington DC Endpoint 5800 \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" 5801 4 / US Cross Region San Jose Endpoint 5802 \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" 5803 5 / US Cross Region Private Endpoint 5804 \ "s3-api.us-geo.objectstorage.service.networklayer.com" 5805 6 / US Cross Region Dallas Private Endpoint 5806 \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" 5807 7 / US Cross Region Washington DC Private Endpoint 5808 \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" 5809 8 / US Cross Region San Jose Private Endpoint 5810 \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" 5811 9 / US Region East Endpoint 5812 \ "s3.us-east.objectstorage.softlayer.net" 5813 10 / US Region East Private Endpoint 5814 \ "s3.us-east.objectstorage.service.networklayer.com" 5815 11 / US Region South Endpoint 5816 [snip] 5817 34 / Toronto Single Site Private Endpoint 5818 \ "s3.tor01.objectstorage.service.networklayer.com" 5819 endpoint>1</code></pre> 5820 <ol start="7" type="1"> 5821 <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> 5822 </ol> 5823 <pre><code> 1 / US Cross Region Standard 5824 \ "us-standard" 5825 2 / US Cross Region Vault 5826 \ "us-vault" 5827 3 / US Cross Region Cold 5828 \ "us-cold" 5829 4 / US Cross Region Flex 5830 \ "us-flex" 5831 5 / US East Region Standard 5832 \ "us-east-standard" 5833 6 / US East Region Vault 5834 \ "us-east-vault" 5835 7 / US East Region Cold 5836 \ "us-east-cold" 5837 8 / US East Region Flex 5838 \ "us-east-flex" 5839 9 / US South Region Standard 5840 \ "us-south-standard" 5841 10 / US South Region Vault 5842 \ "us-south-vault" 5843 [snip] 5844 32 / Toronto Flex 5845 \ "tor01-flex" 5846 location_constraint>1</code></pre> 5847 <ol start="9" type="1"> 5848 <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> 5849 </ol> 5850 <pre><code>Canned ACL used when creating buckets and/or storing objects in S3. 5851 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 5852 Choose a number from below, or type in your own value 5853 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 5854 \ "private" 5855 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 5856 \ "public-read" 5857 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 5858 \ "public-read-write" 5859 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 5860 \ "authenticated-read" 5861 acl> 1</code></pre> 5862 <ol start="12" type="1"> 5863 <li>Review the displayed configuration and accept to save the “remote” then quit. The config file should look like this</li> 5864 </ol> 5865 <pre><code> [xxx] 5866 type = s3 5867 Provider = IBMCOS 5868 access_key_id = xxx 5869 secret_access_key = yyy 5870 endpoint = s3-api.us-geo.objectstorage.softlayer.net 5871 location_constraint = us-standard 5872 acl = private</code></pre> 5873 <ol start="13" type="1"> 5874 <li>Execute rclone commands</li> 5875 </ol> 5876 <pre><code> 1) Create a bucket. 5877 rclone mkdir IBM-COS-XREGION:newbucket 5878 2) List available buckets. 5879 rclone lsd IBM-COS-XREGION: 5880 -1 2017-11-08 21:16:22 -1 test 5881 -1 2018-02-14 20:16:39 -1 newbucket 5882 3) List contents of a bucket. 5883 rclone ls IBM-COS-XREGION:newbucket 5884 18685952 test.exe 5885 4) Copy a file from local to remote. 5886 rclone copy /Users/file.txt IBM-COS-XREGION:newbucket 5887 5) Copy a file from remote to local. 5888 rclone copy IBM-COS-XREGION:newbucket/file.txt . 5889 6) Delete a file on remote. 5890 rclone delete IBM-COS-XREGION:newbucket/file.txt</code></pre> 5891 <h3 id="minio">Minio</h3> 5892 <p><a href="https://minio.io/">Minio</a> is an object storage server built for cloud application developers and devops.</p> 5893 <p>It is very easy to install and provides an S3 compatible server which can be used by rclone.</p> 5894 <p>To use it, install Minio following the instructions <a href="https://docs.minio.io/docs/minio-quickstart-guide">here</a>.</p> 5895 <p>When it configures itself Minio will print something like this</p> 5896 <pre><code>Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 5897 AccessKey: USWUXHGYZQYFYFFIT3RE 5898 SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 5899 Region: us-east-1 5900 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis 5901 5902 Browser Access: 5903 http://192.168.1.106:9000 http://172.23.0.1:9000 5904 5905 Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide 5906 $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 5907 5908 Object API (Amazon S3 compatible): 5909 Go: https://docs.minio.io/docs/golang-client-quickstart-guide 5910 Java: https://docs.minio.io/docs/java-client-quickstart-guide 5911 Python: https://docs.minio.io/docs/python-client-quickstart-guide 5912 JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide 5913 .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide 5914 5915 Drive Capacity: 26 GiB Free, 165 GiB Total</code></pre> 5916 <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> 5917 <pre><code>env_auth> 1 5918 access_key_id> USWUXHGYZQYFYFFIT3RE 5919 secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 5920 region> us-east-1 5921 endpoint> http://192.168.1.106:9000 5922 location_constraint> 5923 server_side_encryption></code></pre> 5924 <p>Which makes the config file look like this</p> 5925 <pre><code>[minio] 5926 type = s3 5927 provider = Minio 5928 env_auth = false 5929 access_key_id = USWUXHGYZQYFYFFIT3RE 5930 secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 5931 region = us-east-1 5932 endpoint = http://192.168.1.106:9000 5933 location_constraint = 5934 server_side_encryption =</code></pre> 5935 <p>So once set up, for example to copy files into a bucket</p> 5936 <pre><code>rclone copy /path/to/files minio:bucket</code></pre> 5937 <h3 id="scaleway">Scaleway</h3> 5938 <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> 5939 <p>Scaleway provides an S3 interface which can be configured for use with rclone like this:</p> 5940 <pre><code>[scaleway] 5941 type = s3 5942 env_auth = false 5943 endpoint = s3.nl-ams.scw.cloud 5944 access_key_id = SCWXXXXXXXXXXXXXX 5945 secret_access_key = 1111111-2222-3333-44444-55555555555555 5946 region = nl-ams 5947 location_constraint = 5948 acl = private 5949 force_path_style = false 5950 server_side_encryption = 5951 storage_class =</code></pre> 5952 <h3 id="wasabi">Wasabi</h3> 5953 <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> 5954 <p>Wasabi provides an S3 interface which can be configured for use with rclone like this.</p> 5955 <pre><code>No remotes found - make a new one 5956 n) New remote 5957 s) Set configuration password 5958 n/s> n 5959 name> wasabi 5960 Type of storage to configure. 5961 Choose a number from below, or type in your own value 5962 1 / Amazon Drive 5963 \ "amazon cloud drive" 5964 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 5965 \ "s3" 5966 [snip] 5967 Storage> s3 5968 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. 5969 Choose a number from below, or type in your own value 5970 1 / Enter AWS credentials in the next step 5971 \ "false" 5972 2 / Get AWS credentials from the environment (env vars or IAM) 5973 \ "true" 5974 env_auth> 1 5975 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 5976 access_key_id> YOURACCESSKEY 5977 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 5978 secret_access_key> YOURSECRETACCESSKEY 5979 Region to connect to. 5980 Choose a number from below, or type in your own value 5981 / The default endpoint - a good choice if you are unsure. 5982 1 | US Region, Northern Virginia or Pacific Northwest. 5983 | Leave location constraint empty. 5984 \ "us-east-1" 5985 [snip] 5986 region> us-east-1 5987 Endpoint for S3 API. 5988 Leave blank if using AWS to use the default endpoint for the region. 5989 Specify if using an S3 clone such as Ceph. 5990 endpoint> s3.wasabisys.com 5991 Location constraint - must be set to match the Region. Used when creating buckets only. 5992 Choose a number from below, or type in your own value 5993 1 / Empty for US Region, Northern Virginia or Pacific Northwest. 5994 \ "" 5995 [snip] 5996 location_constraint> 5997 Canned ACL used when creating buckets and/or storing objects in S3. 5998 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 5999 Choose a number from below, or type in your own value 6000 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 6001 \ "private" 6002 [snip] 6003 acl> 6004 The server-side encryption algorithm used when storing this object in S3. 6005 Choose a number from below, or type in your own value 6006 1 / None 6007 \ "" 6008 2 / AES256 6009 \ "AES256" 6010 server_side_encryption> 6011 The storage class to use when storing objects in S3. 6012 Choose a number from below, or type in your own value 6013 1 / Default 6014 \ "" 6015 2 / Standard storage class 6016 \ "STANDARD" 6017 3 / Reduced redundancy storage class 6018 \ "REDUCED_REDUNDANCY" 6019 4 / Standard Infrequent Access storage class 6020 \ "STANDARD_IA" 6021 storage_class> 6022 Remote config 6023 -------------------- 6024 [wasabi] 6025 env_auth = false 6026 access_key_id = YOURACCESSKEY 6027 secret_access_key = YOURSECRETACCESSKEY 6028 region = us-east-1 6029 endpoint = s3.wasabisys.com 6030 location_constraint = 6031 acl = 6032 server_side_encryption = 6033 storage_class = 6034 -------------------- 6035 y) Yes this is OK 6036 e) Edit this remote 6037 d) Delete this remote 6038 y/e/d> y</code></pre> 6039 <p>This will leave the config file looking like this.</p> 6040 <pre><code>[wasabi] 6041 type = s3 6042 provider = Wasabi 6043 env_auth = false 6044 access_key_id = YOURACCESSKEY 6045 secret_access_key = YOURSECRETACCESSKEY 6046 region = 6047 endpoint = s3.wasabisys.com 6048 location_constraint = 6049 acl = 6050 server_side_encryption = 6051 storage_class =</code></pre> 6052 <h3 id="alibaba-oss">Alibaba OSS</h3> 6053 <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> 6054 <pre><code>rclone config</code></pre> 6055 <p>This will guide you through an interactive setup process.</p> 6056 <pre><code>No remotes found - make a new one 6057 n) New remote 6058 s) Set configuration password 6059 q) Quit config 6060 n/s/q> n 6061 name> oss 6062 Type of storage to configure. 6063 Enter a string value. Press Enter for the default (""). 6064 Choose a number from below, or type in your own value 6065 [snip] 6066 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) 6067 \ "s3" 6068 [snip] 6069 Storage> s3 6070 Choose your S3 provider. 6071 Enter a string value. Press Enter for the default (""). 6072 Choose a number from below, or type in your own value 6073 1 / Amazon Web Services (AWS) S3 6074 \ "AWS" 6075 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun 6076 \ "Alibaba" 6077 3 / Ceph Object Storage 6078 \ "Ceph" 6079 [snip] 6080 provider> Alibaba 6081 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 6082 Only applies if access_key_id and secret_access_key is blank. 6083 Enter a boolean value (true or false). Press Enter for the default ("false"). 6084 Choose a number from below, or type in your own value 6085 1 / Enter AWS credentials in the next step 6086 \ "false" 6087 2 / Get AWS credentials from the environment (env vars or IAM) 6088 \ "true" 6089 env_auth> 1 6090 AWS Access Key ID. 6091 Leave blank for anonymous access or runtime credentials. 6092 Enter a string value. Press Enter for the default (""). 6093 access_key_id> accesskeyid 6094 AWS Secret Access Key (password) 6095 Leave blank for anonymous access or runtime credentials. 6096 Enter a string value. Press Enter for the default (""). 6097 secret_access_key> secretaccesskey 6098 Endpoint for OSS API. 6099 Enter a string value. Press Enter for the default (""). 6100 Choose a number from below, or type in your own value 6101 1 / East China 1 (Hangzhou) 6102 \ "oss-cn-hangzhou.aliyuncs.com" 6103 2 / East China 2 (Shanghai) 6104 \ "oss-cn-shanghai.aliyuncs.com" 6105 3 / North China 1 (Qingdao) 6106 \ "oss-cn-qingdao.aliyuncs.com" 6107 [snip] 6108 endpoint> 1 6109 Canned ACL used when creating buckets and storing or copying objects. 6110 6111 Note that this ACL is applied when server side copying objects as S3 6112 doesn't copy the ACL from the source but rather writes a fresh one. 6113 Enter a string value. Press Enter for the default (""). 6114 Choose a number from below, or type in your own value 6115 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 6116 \ "private" 6117 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 6118 \ "public-read" 6119 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 6120 [snip] 6121 acl> 1 6122 The storage class to use when storing new objects in OSS. 6123 Enter a string value. Press Enter for the default (""). 6124 Choose a number from below, or type in your own value 6125 1 / Default 6126 \ "" 6127 2 / Standard storage class 6128 \ "STANDARD" 6129 3 / Archive storage mode. 6130 \ "GLACIER" 6131 4 / Infrequent access storage mode. 6132 \ "STANDARD_IA" 6133 storage_class> 1 6134 Edit advanced config? (y/n) 6135 y) Yes 6136 n) No 6137 y/n> n 6138 Remote config 6139 -------------------- 6140 [oss] 6141 type = s3 6142 provider = Alibaba 6143 env_auth = false 6144 access_key_id = accesskeyid 6145 secret_access_key = secretaccesskey 6146 endpoint = oss-cn-hangzhou.aliyuncs.com 6147 acl = private 6148 storage_class = Standard 6149 -------------------- 6150 y) Yes this is OK 6151 e) Edit this remote 6152 d) Delete this remote 6153 y/e/d> y</code></pre> 6154 <h3 id="netease-nos">Netease NOS</h3> 6155 <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> 6156 <h2 id="backblaze-b2">Backblaze B2</h2> 6157 <p>B2 is <a href="https://www.backblaze.com/b2/">Backblaze’s cloud storage system</a>.</p> 6158 <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> 6159 <p>Here is an example of making a b2 configuration. First run</p> 6160 <pre><code>rclone config</code></pre> 6161 <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> 6162 <pre><code>No remotes found - make a new one 6163 n) New remote 6164 q) Quit config 6165 n/q> n 6166 name> remote 6167 Type of storage to configure. 6168 Choose a number from below, or type in your own value 6169 1 / Amazon Drive 6170 \ "amazon cloud drive" 6171 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 6172 \ "s3" 6173 3 / Backblaze B2 6174 \ "b2" 6175 4 / Dropbox 6176 \ "dropbox" 6177 5 / Encrypt/Decrypt a remote 6178 \ "crypt" 6179 6 / Google Cloud Storage (this is not Google Drive) 6180 \ "google cloud storage" 6181 7 / Google Drive 6182 \ "drive" 6183 8 / Hubic 6184 \ "hubic" 6185 9 / Local Disk 6186 \ "local" 6187 10 / Microsoft OneDrive 6188 \ "onedrive" 6189 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 6190 \ "swift" 6191 12 / SSH/SFTP Connection 6192 \ "sftp" 6193 13 / Yandex Disk 6194 \ "yandex" 6195 Storage> 3 6196 Account ID or Application Key ID 6197 account> 123456789abc 6198 Application Key 6199 key> 0123456789abcdef0123456789abcdef0123456789 6200 Endpoint for the service - leave blank normally. 6201 endpoint> 6202 Remote config 6203 -------------------- 6204 [remote] 6205 account = 123456789abc 6206 key = 0123456789abcdef0123456789abcdef0123456789 6207 endpoint = 6208 -------------------- 6209 y) Yes this is OK 6210 e) Edit this remote 6211 d) Delete this remote 6212 y/e/d> y</code></pre> 6213 <p>This remote is called <code>remote</code> and can now be used like this</p> 6214 <p>See all buckets</p> 6215 <pre><code>rclone lsd remote:</code></pre> 6216 <p>Create a new bucket</p> 6217 <pre><code>rclone mkdir remote:bucket</code></pre> 6218 <p>List the contents of a bucket</p> 6219 <pre><code>rclone ls remote:bucket</code></pre> 6220 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 6221 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 6222 <h3 id="application-keys">Application Keys</h3> 6223 <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> 6224 <p>You can use these with rclone too; you will need to use rclone version 1.43 or later.</p> 6225 <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> 6226 <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> 6227 <h3 id="fast-list-2">–fast-list</h3> 6228 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 6229 <h3 id="modified-time-1">Modified time</h3> 6230 <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> 6231 <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> 6232 <h3 id="sha1-checksums">SHA1 checksums</h3> 6233 <p>The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.</p> 6234 <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> 6235 <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="/overview/#features">the overview</a> for exactly which remotes support SHA1.</p> 6236 <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/ncw/rclone/issues/1767">#1767</a>).</p> 6237 <p>Files sizes below <code>--b2-upload-cutoff</code> will always have an SHA1 regardless of the source.</p> 6238 <h3 id="transfers">Transfers</h3> 6239 <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> 6240 <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> 6241 <h3 id="versions">Versions</h3> 6242 <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> 6243 <p>Old versions of files, where available, are visible using the <code>--b2-versions</code> flag.</p> 6244 <p><strong>NB</strong> Note that <code>--b2-versions</code> does not work with crypt at the moment <a href="https://github.com/ncw/rclone/issues/1627">#1627</a>. Using <a href="/docs/#backup-dir-dir">–backup-dir</a> with rclone is the recommended way of working around this.</p> 6245 <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> 6246 <p>Note that <code>cleanup</code> will remove partially uploaded files from the bucket if they are more than a day old.</p> 6247 <p>When you <code>purge</code> a bucket, the current and the old versions will be deleted then the bucket will be deleted.</p> 6248 <p>However <code>delete</code> will cause the current versions of the files to become hidden old versions.</p> 6249 <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> 6250 <p>Show current version and all the versions with <code>--b2-versions</code> flag.</p> 6251 <pre><code>$ rclone -q ls b2:cleanup-test 6252 9 one.txt 6253 6254 $ rclone -q --b2-versions ls b2:cleanup-test 6255 9 one.txt 6256 8 one-v2016-07-04-141032-000.txt 6257 16 one-v2016-07-04-141003-000.txt 6258 15 one-v2016-07-02-155621-000.txt</code></pre> 6259 <p>Retrieve an old version</p> 6260 <pre><code>$ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp 6261 6262 $ ls -l /tmp/one-v2016-07-04-141003-000.txt 6263 -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt</code></pre> 6264 <p>Clean up all the old versions and show that they’ve gone.</p> 6265 <pre><code>$ rclone -q cleanup b2:cleanup-test 6266 6267 $ rclone -q ls b2:cleanup-test 6268 9 one.txt 6269 6270 $ rclone -q --b2-versions ls b2:cleanup-test 6271 9 one.txt</code></pre> 6272 <h3 id="data-usage">Data usage</h3> 6273 <p>It is useful to know how many requests are sent to the server in different scenarios.</p> 6274 <p>All copy commands send the following 4 requests:</p> 6275 <pre><code>/b2api/v1/b2_authorize_account 6276 /b2api/v1/b2_create_bucket 6277 /b2api/v1/b2_list_buckets 6278 /b2api/v1/b2_list_file_names</code></pre> 6279 <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/ncw/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> 6280 <p>Uploading files that do not require chunking, will send 2 requests per file upload:</p> 6281 <pre><code>/b2api/v1/b2_get_upload_url 6282 /b2api/v1/b2_upload_file/</code></pre> 6283 <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> 6284 <pre><code>/b2api/v1/b2_start_large_file 6285 /b2api/v1/b2_get_upload_part_url 6286 /b2api/v1/b2_upload_part/ 6287 /b2api/v1/b2_finish_large_file</code></pre> 6288 <h4 id="versions-1">Versions</h4> 6289 <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> 6290 <p>Listing without <code>--b2-versions</code></p> 6291 <pre><code>$ rclone -q ls b2:cleanup-test 6292 9 one.txt</code></pre> 6293 <p>And with</p> 6294 <pre><code>$ rclone -q --b2-versions ls b2:cleanup-test 6295 9 one.txt 6296 8 one-v2016-07-04-141032-000.txt 6297 16 one-v2016-07-04-141003-000.txt 6298 15 one-v2016-07-02-155621-000.txt</code></pre> 6299 <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> 6300 <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> 6301 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/b2/b2.go then run make backenddocs --> 6302 <h3 id="standard-options-3">Standard Options</h3> 6303 <p>Here are the standard options specific to b2 (Backblaze B2).</p> 6304 <h4 id="b2-account">–b2-account</h4> 6305 <p>Account ID or Application Key ID</p> 6306 <ul> 6307 <li>Config: account</li> 6308 <li>Env Var: RCLONE_B2_ACCOUNT</li> 6309 <li>Type: string</li> 6310 <li>Default: ""</li> 6311 </ul> 6312 <h4 id="b2-key">–b2-key</h4> 6313 <p>Application Key</p> 6314 <ul> 6315 <li>Config: key</li> 6316 <li>Env Var: RCLONE_B2_KEY</li> 6317 <li>Type: string</li> 6318 <li>Default: ""</li> 6319 </ul> 6320 <h4 id="b2-hard-delete">–b2-hard-delete</h4> 6321 <p>Permanently delete files on remote removal, otherwise hide files.</p> 6322 <ul> 6323 <li>Config: hard_delete</li> 6324 <li>Env Var: RCLONE_B2_HARD_DELETE</li> 6325 <li>Type: bool</li> 6326 <li>Default: false</li> 6327 </ul> 6328 <h3 id="advanced-options-2">Advanced Options</h3> 6329 <p>Here are the advanced options specific to b2 (Backblaze B2).</p> 6330 <h4 id="b2-endpoint">–b2-endpoint</h4> 6331 <p>Endpoint for the service. Leave blank normally.</p> 6332 <ul> 6333 <li>Config: endpoint</li> 6334 <li>Env Var: RCLONE_B2_ENDPOINT</li> 6335 <li>Type: string</li> 6336 <li>Default: ""</li> 6337 </ul> 6338 <h4 id="b2-test-mode">–b2-test-mode</h4> 6339 <p>A flag string for X-Bz-Test-Mode header for debugging.</p> 6340 <p>This is for debugging purposes only. Setting it to one of the strings below will cause b2 to return specific errors:</p> 6341 <ul> 6342 <li>“fail_some_uploads”</li> 6343 <li>“expire_some_account_authorization_tokens”</li> 6344 <li>“force_cap_exceeded”</li> 6345 </ul> 6346 <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> 6347 <ul> 6348 <li>Config: test_mode</li> 6349 <li>Env Var: RCLONE_B2_TEST_MODE</li> 6350 <li>Type: string</li> 6351 <li>Default: ""</li> 6352 </ul> 6353 <h4 id="b2-versions">–b2-versions</h4> 6354 <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> 6355 <ul> 6356 <li>Config: versions</li> 6357 <li>Env Var: RCLONE_B2_VERSIONS</li> 6358 <li>Type: bool</li> 6359 <li>Default: false</li> 6360 </ul> 6361 <h4 id="b2-upload-cutoff">–b2-upload-cutoff</h4> 6362 <p>Cutoff for switching to chunked upload.</p> 6363 <p>Files above this size will be uploaded in chunks of “–b2-chunk-size”.</p> 6364 <p>This value should be set no larger than 4.657GiB (== 5GB).</p> 6365 <ul> 6366 <li>Config: upload_cutoff</li> 6367 <li>Env Var: RCLONE_B2_UPLOAD_CUTOFF</li> 6368 <li>Type: SizeSuffix</li> 6369 <li>Default: 200M</li> 6370 </ul> 6371 <h4 id="b2-chunk-size">–b2-chunk-size</h4> 6372 <p>Upload chunk size. Must fit in memory.</p> 6373 <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> 6374 <ul> 6375 <li>Config: chunk_size</li> 6376 <li>Env Var: RCLONE_B2_CHUNK_SIZE</li> 6377 <li>Type: SizeSuffix</li> 6378 <li>Default: 96M</li> 6379 </ul> 6380 <h4 id="b2-disable-checksum">–b2-disable-checksum</h4> 6381 <p>Disable checksums for large (> upload cutoff) files</p> 6382 <ul> 6383 <li>Config: disable_checksum</li> 6384 <li>Env Var: RCLONE_B2_DISABLE_CHECKSUM</li> 6385 <li>Type: bool</li> 6386 <li>Default: false</li> 6387 </ul> 6388 <h4 id="b2-download-url">–b2-download-url</h4> 6389 <p>Custom endpoint for downloads.</p> 6390 <p>This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. Leave blank if you want to use the endpoint provided by Backblaze.</p> 6391 <ul> 6392 <li>Config: download_url</li> 6393 <li>Env Var: RCLONE_B2_DOWNLOAD_URL</li> 6394 <li>Type: string</li> 6395 <li>Default: ""</li> 6396 </ul> 6397 <!--- autogenerated options stop --> 6398 <h2 id="box">Box</h2> 6399 <p>Paths are specified as <code>remote:path</code></p> 6400 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 6401 <p>The initial setup for Box involves getting a token from Box which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 6402 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 6403 <pre><code> rclone config</code></pre> 6404 <p>This will guide you through an interactive setup process:</p> 6405 <pre><code>No remotes found - make a new one 6406 n) New remote 6407 s) Set configuration password 6408 q) Quit config 6409 n/s/q> n 6410 name> remote 6411 Type of storage to configure. 6412 Choose a number from below, or type in your own value 6413 1 / Amazon Drive 6414 \ "amazon cloud drive" 6415 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 6416 \ "s3" 6417 3 / Backblaze B2 6418 \ "b2" 6419 4 / Box 6420 \ "box" 6421 5 / Dropbox 6422 \ "dropbox" 6423 6 / Encrypt/Decrypt a remote 6424 \ "crypt" 6425 7 / FTP Connection 6426 \ "ftp" 6427 8 / Google Cloud Storage (this is not Google Drive) 6428 \ "google cloud storage" 6429 9 / Google Drive 6430 \ "drive" 6431 10 / Hubic 6432 \ "hubic" 6433 11 / Local Disk 6434 \ "local" 6435 12 / Microsoft OneDrive 6436 \ "onedrive" 6437 13 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 6438 \ "swift" 6439 14 / SSH/SFTP Connection 6440 \ "sftp" 6441 15 / Yandex Disk 6442 \ "yandex" 6443 16 / http Connection 6444 \ "http" 6445 Storage> box 6446 Box App Client Id - leave blank normally. 6447 client_id> 6448 Box App Client Secret - leave blank normally. 6449 client_secret> 6450 Remote config 6451 Use auto config? 6452 * Say Y if not sure 6453 * Say N if you are working on a remote or headless machine 6454 y) Yes 6455 n) No 6456 y/n> y 6457 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 6458 Log in and authorize rclone for access 6459 Waiting for code... 6460 Got code 6461 -------------------- 6462 [remote] 6463 client_id = 6464 client_secret = 6465 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} 6466 -------------------- 6467 y) Yes this is OK 6468 e) Edit this remote 6469 d) Delete this remote 6470 y/e/d> y</code></pre> 6471 <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> 6472 <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> 6473 <p>Once configured you can then use <code>rclone</code> like this,</p> 6474 <p>List directories in top level of your Box</p> 6475 <pre><code>rclone lsd remote:</code></pre> 6476 <p>List all the files in your Box</p> 6477 <pre><code>rclone ls remote:</code></pre> 6478 <p>To copy a local directory to an Box directory called backup</p> 6479 <pre><code>rclone copy /home/source remote:backup</code></pre> 6480 <h3 id="using-rclone-with-an-enterprise-account-with-sso">Using rclone with an Enterprise account with SSO</h3> 6481 <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> 6482 <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> 6483 <h3 id="invalid-refresh-token">Invalid refresh token</h3> 6484 <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> 6485 <blockquote> 6486 <p>Each refresh_token is valid for one use in 60 days.</p> 6487 </blockquote> 6488 <p>This means that if you</p> 6489 <ul> 6490 <li>Don’t use the box remote for 60 days</li> 6491 <li>Copy the config file with a box refresh token in and use it in two places</li> 6492 <li>Get an error on a token refresh</li> 6493 </ul> 6494 <p>then rclone will return an error which includes the text <code>Invalid refresh token</code>.</p> 6495 <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> 6496 <p>Here is how to do it.</p> 6497 <pre><code>$ rclone config 6498 Current remotes: 6499 6500 Name Type 6501 ==== ==== 6502 remote box 6503 6504 e) Edit existing remote 6505 n) New remote 6506 d) Delete remote 6507 r) Rename remote 6508 c) Copy remote 6509 s) Set configuration password 6510 q) Quit config 6511 e/n/d/r/c/s/q> e 6512 Choose a number from below, or type in an existing value 6513 1 > remote 6514 remote> remote 6515 -------------------- 6516 [remote] 6517 type = box 6518 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} 6519 -------------------- 6520 Edit remote 6521 Value "client_id" = "" 6522 Edit? (y/n)> 6523 y) Yes 6524 n) No 6525 y/n> n 6526 Value "client_secret" = "" 6527 Edit? (y/n)> 6528 y) Yes 6529 n) No 6530 y/n> n 6531 Remote config 6532 Already have a token - refresh? 6533 y) Yes 6534 n) No 6535 y/n> y 6536 Use auto config? 6537 * Say Y if not sure 6538 * Say N if you are working on a remote or headless machine 6539 y) Yes 6540 n) No 6541 y/n> y 6542 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 6543 Log in and authorize rclone for access 6544 Waiting for code... 6545 Got code 6546 -------------------- 6547 [remote] 6548 type = box 6549 token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} 6550 -------------------- 6551 y) Yes this is OK 6552 e) Edit this remote 6553 d) Delete this remote 6554 y/e/d> y</code></pre> 6555 <h3 id="modified-time-and-hashes">Modified time and hashes</h3> 6556 <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> 6557 <p>Box supports SHA1 type hashes, so you can use the <code>--checksum</code> flag.</p> 6558 <h3 id="transfers-1">Transfers</h3> 6559 <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> 6560 <h3 id="deleting-files-1">Deleting files</h3> 6561 <p>Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.</p> 6562 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/box/box.go then run make backenddocs --> 6563 <h3 id="standard-options-4">Standard Options</h3> 6564 <p>Here are the standard options specific to box (Box).</p> 6565 <h4 id="box-client-id">–box-client-id</h4> 6566 <p>Box App Client Id. Leave blank normally.</p> 6567 <ul> 6568 <li>Config: client_id</li> 6569 <li>Env Var: RCLONE_BOX_CLIENT_ID</li> 6570 <li>Type: string</li> 6571 <li>Default: ""</li> 6572 </ul> 6573 <h4 id="box-client-secret">–box-client-secret</h4> 6574 <p>Box App Client Secret Leave blank normally.</p> 6575 <ul> 6576 <li>Config: client_secret</li> 6577 <li>Env Var: RCLONE_BOX_CLIENT_SECRET</li> 6578 <li>Type: string</li> 6579 <li>Default: ""</li> 6580 </ul> 6581 <h3 id="advanced-options-3">Advanced Options</h3> 6582 <p>Here are the advanced options specific to box (Box).</p> 6583 <h4 id="box-upload-cutoff">–box-upload-cutoff</h4> 6584 <p>Cutoff for switching to multipart upload (>= 50MB).</p> 6585 <ul> 6586 <li>Config: upload_cutoff</li> 6587 <li>Env Var: RCLONE_BOX_UPLOAD_CUTOFF</li> 6588 <li>Type: SizeSuffix</li> 6589 <li>Default: 50M</li> 6590 </ul> 6591 <h4 id="box-commit-retries">–box-commit-retries</h4> 6592 <p>Max number of times to try committing a multipart file.</p> 6593 <ul> 6594 <li>Config: commit_retries</li> 6595 <li>Env Var: RCLONE_BOX_COMMIT_RETRIES</li> 6596 <li>Type: int</li> 6597 <li>Default: 100</li> 6598 </ul> 6599 <!--- autogenerated options stop --> 6600 <h3 id="limitations-2">Limitations</h3> 6601 <p>Note that Box is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 6602 <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> 6603 <p>Box only supports filenames up to 255 characters in length.</p> 6604 <h2 id="cache-beta">Cache (BETA)</h2> 6605 <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> 6606 <p>To get started you just need to have an existing remote which can be configured with <code>cache</code>.</p> 6607 <p>Here is an example of how to make a remote called <code>test-cache</code>. First run:</p> 6608 <pre><code> rclone config</code></pre> 6609 <p>This will guide you through an interactive setup process:</p> 6610 <pre><code>No remotes found - make a new one 6611 n) New remote 6612 r) Rename remote 6613 c) Copy remote 6614 s) Set configuration password 6615 q) Quit config 6616 n/r/c/s/q> n 6617 name> test-cache 6618 Type of storage to configure. 6619 Choose a number from below, or type in your own value 6620 ... 6621 5 / Cache a remote 6622 \ "cache" 6623 ... 6624 Storage> 5 6625 Remote to cache. 6626 Normally should contain a ':' and a path, eg "myremote:path/to/dir", 6627 "myremote:bucket" or maybe "myremote:" (not recommended). 6628 remote> local:/test 6629 Optional: The URL of the Plex server 6630 plex_url> http://127.0.0.1:32400 6631 Optional: The username of the Plex user 6632 plex_username> dummyusername 6633 Optional: The password of the Plex user 6634 y) Yes type in my own password 6635 g) Generate random password 6636 n) No leave this optional password blank 6637 y/g/n> y 6638 Enter the password: 6639 password: 6640 Confirm the password: 6641 password: 6642 The size of a chunk. Lower value good for slow connections but can affect seamless reading. 6643 Default: 5M 6644 Choose a number from below, or type in your own value 6645 1 / 1MB 6646 \ "1m" 6647 2 / 5 MB 6648 \ "5M" 6649 3 / 10 MB 6650 \ "10M" 6651 chunk_size> 2 6652 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. 6653 Accepted units are: "s", "m", "h". 6654 Default: 5m 6655 Choose a number from below, or type in your own value 6656 1 / 1 hour 6657 \ "1h" 6658 2 / 24 hours 6659 \ "24h" 6660 3 / 24 hours 6661 \ "48h" 6662 info_age> 2 6663 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. 6664 Default: 10G 6665 Choose a number from below, or type in your own value 6666 1 / 500 MB 6667 \ "500M" 6668 2 / 1 GB 6669 \ "1G" 6670 3 / 10 GB 6671 \ "10G" 6672 chunk_total_size> 3 6673 Remote config 6674 -------------------- 6675 [test-cache] 6676 remote = local:/test 6677 plex_url = http://127.0.0.1:32400 6678 plex_username = dummyusername 6679 plex_password = *** ENCRYPTED *** 6680 chunk_size = 5M 6681 info_age = 48h 6682 chunk_total_size = 10G</code></pre> 6683 <p>You can then use it like this,</p> 6684 <p>List directories in top level of your drive</p> 6685 <pre><code>rclone lsd test-cache:</code></pre> 6686 <p>List all the files in your drive</p> 6687 <pre><code>rclone ls test-cache:</code></pre> 6688 <p>To start a cached mount</p> 6689 <pre><code>rclone mount --allow-other test-cache: /var/tmp/test-cache</code></pre> 6690 <h3 id="write-features">Write Features</h3> 6691 <h3 id="offline-uploading">Offline uploading</h3> 6692 <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> 6693 <p>A files goes through these states when using this feature:</p> 6694 <ol type="1"> 6695 <li>An upload is started (usually by copying a file on the cache remote)</li> 6696 <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> 6697 <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> 6698 <li>Reading the file still works during the upload but most modifications on it will be prohibited</li> 6699 <li>Once the move is complete the file is unlocked for modifications as it becomes as any other regular file</li> 6700 <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> 6701 </ol> 6702 <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> 6703 <h3 id="write-support">Write Support</h3> 6704 <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> 6705 <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> 6706 <h3 id="read-features">Read Features</h3> 6707 <h4 id="multiple-connections">Multiple connections</h4> 6708 <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> 6709 <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> 6710 <h4 id="plex-integration">Plex Integration</h4> 6711 <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> 6712 <p>Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.</p> 6713 <p>This integration opens the doorway to additional performance improvements which will be explored in the near future.</p> 6714 <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> 6715 <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> 6716 <p>Affected settings: - <code>cache-workers</code>: <em>Configured value</em> during confirmed playback or <em>1</em> all the other times</p> 6717 <h5 id="certificate-validation">Certificate Validation</h5> 6718 <p>When the Plex server is configured to only accept secure connections, it is possible to use <code>.plex.direct</code> URL’s to ensure certificate validation succeeds. These URL’s are used by Plex internally to connect to the Plex server securely.</p> 6719 <p>The format for this URL’s is the following:</p> 6720 <p>https://ip-with-dots-replaced.server-hash.plex.direct:32400/</p> 6721 <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> 6722 <p>To get the <code>server-hash</code> part, the easiest way is to visit</p> 6723 <p>https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token</p> 6724 <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> 6725 <h3 id="known-issues">Known issues</h3> 6726 <h4 id="mount-and-dir-cache-time">Mount and –dir-cache-time</h4> 6727 <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> 6728 <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> 6729 <h4 id="windows-support---experimental">Windows support - Experimental</h4> 6730 <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> 6731 <p>Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependant on them.</p> 6732 <p>Any reports or feedback on how cache behaves on this OS is greatly appreciated.</p> 6733 <ul> 6734 <li>https://github.com/ncw/rclone/issues/1935</li> 6735 <li>https://github.com/ncw/rclone/issues/1907</li> 6736 <li>https://github.com/ncw/rclone/issues/1834</li> 6737 </ul> 6738 <h4 id="risk-of-throttling">Risk of throttling</h4> 6739 <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> 6740 <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> 6741 <p>Some recommendations: - don’t use a very small interval for entry informations (<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> 6742 <p>Future enhancements:</p> 6743 <ul> 6744 <li>https://github.com/ncw/rclone/issues/1937</li> 6745 <li>https://github.com/ncw/rclone/issues/1936</li> 6746 </ul> 6747 <h4 id="cache-and-crypt">cache and crypt</h4> 6748 <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> 6749 <p>There is an issue with wrapping the remotes in this order: <span style="color:red"><strong>cloud remote</strong> -> <strong>crypt</strong> -> <strong>cache</strong></span></p> 6750 <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: <span style="color:green"><strong>cloud remote</strong> -> <strong>cache</strong> -> <strong>crypt</strong></span></p> 6751 <h4 id="absolute-remote-paths">absolute remote paths</h4> 6752 <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> 6753 <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> 6754 <h3 id="cache-and-remote-control-rc">Cache and Remote Control (–rc)</h3> 6755 <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> 6756 <h3 id="rc-cacheexpire">rc cache/expire</h3> 6757 <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> 6758 <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> 6759 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/cache/cache.go then run make backenddocs --> 6760 <h3 id="standard-options-5">Standard Options</h3> 6761 <p>Here are the standard options specific to cache (Cache a remote).</p> 6762 <h4 id="cache-remote">–cache-remote</h4> 6763 <p>Remote to cache. Normally should contain a ‘:’ and a path, eg “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not recommended).</p> 6764 <ul> 6765 <li>Config: remote</li> 6766 <li>Env Var: RCLONE_CACHE_REMOTE</li> 6767 <li>Type: string</li> 6768 <li>Default: ""</li> 6769 </ul> 6770 <h4 id="cache-plex-url">–cache-plex-url</h4> 6771 <p>The URL of the Plex server</p> 6772 <ul> 6773 <li>Config: plex_url</li> 6774 <li>Env Var: RCLONE_CACHE_PLEX_URL</li> 6775 <li>Type: string</li> 6776 <li>Default: ""</li> 6777 </ul> 6778 <h4 id="cache-plex-username">–cache-plex-username</h4> 6779 <p>The username of the Plex user</p> 6780 <ul> 6781 <li>Config: plex_username</li> 6782 <li>Env Var: RCLONE_CACHE_PLEX_USERNAME</li> 6783 <li>Type: string</li> 6784 <li>Default: ""</li> 6785 </ul> 6786 <h4 id="cache-plex-password">–cache-plex-password</h4> 6787 <p>The password of the Plex user</p> 6788 <ul> 6789 <li>Config: plex_password</li> 6790 <li>Env Var: RCLONE_CACHE_PLEX_PASSWORD</li> 6791 <li>Type: string</li> 6792 <li>Default: ""</li> 6793 </ul> 6794 <h4 id="cache-chunk-size">–cache-chunk-size</h4> 6795 <p>The size of a chunk (partial file data).</p> 6796 <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> 6797 <ul> 6798 <li>Config: chunk_size</li> 6799 <li>Env Var: RCLONE_CACHE_CHUNK_SIZE</li> 6800 <li>Type: SizeSuffix</li> 6801 <li>Default: 5M</li> 6802 <li>Examples: 6803 <ul> 6804 <li>“1m” 6805 <ul> 6806 <li>1MB</li> 6807 </ul></li> 6808 <li>“5M” 6809 <ul> 6810 <li>5 MB</li> 6811 </ul></li> 6812 <li>“10M” 6813 <ul> 6814 <li>10 MB</li> 6815 </ul></li> 6816 </ul></li> 6817 </ul> 6818 <h4 id="cache-info-age">–cache-info-age</h4> 6819 <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> 6820 <ul> 6821 <li>Config: info_age</li> 6822 <li>Env Var: RCLONE_CACHE_INFO_AGE</li> 6823 <li>Type: Duration</li> 6824 <li>Default: 6h0m0s</li> 6825 <li>Examples: 6826 <ul> 6827 <li>“1h” 6828 <ul> 6829 <li>1 hour</li> 6830 </ul></li> 6831 <li>“24h” 6832 <ul> 6833 <li>24 hours</li> 6834 </ul></li> 6835 <li>“48h” 6836 <ul> 6837 <li>48 hours</li> 6838 </ul></li> 6839 </ul></li> 6840 </ul> 6841 <h4 id="cache-chunk-total-size">–cache-chunk-total-size</h4> 6842 <p>The total size that the chunks can take up on the local disk.</p> 6843 <p>If the cache exceeds this value then it will start to delete the oldest chunks until it goes under this value.</p> 6844 <ul> 6845 <li>Config: chunk_total_size</li> 6846 <li>Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE</li> 6847 <li>Type: SizeSuffix</li> 6848 <li>Default: 10G</li> 6849 <li>Examples: 6850 <ul> 6851 <li>“500M” 6852 <ul> 6853 <li>500 MB</li> 6854 </ul></li> 6855 <li>“1G” 6856 <ul> 6857 <li>1 GB</li> 6858 </ul></li> 6859 <li>“10G” 6860 <ul> 6861 <li>10 GB</li> 6862 </ul></li> 6863 </ul></li> 6864 </ul> 6865 <h3 id="advanced-options-4">Advanced Options</h3> 6866 <p>Here are the advanced options specific to cache (Cache a remote).</p> 6867 <h4 id="cache-plex-token">–cache-plex-token</h4> 6868 <p>The plex token for authentication - auto set normally</p> 6869 <ul> 6870 <li>Config: plex_token</li> 6871 <li>Env Var: RCLONE_CACHE_PLEX_TOKEN</li> 6872 <li>Type: string</li> 6873 <li>Default: ""</li> 6874 </ul> 6875 <h4 id="cache-plex-insecure">–cache-plex-insecure</h4> 6876 <p>Skip all certificate verifications when connecting to the Plex server</p> 6877 <ul> 6878 <li>Config: plex_insecure</li> 6879 <li>Env Var: RCLONE_CACHE_PLEX_INSECURE</li> 6880 <li>Type: string</li> 6881 <li>Default: ""</li> 6882 </ul> 6883 <h4 id="cache-db-path">–cache-db-path</h4> 6884 <p>Directory to store file structure metadata DB. The remote name is used as the DB file name.</p> 6885 <ul> 6886 <li>Config: db_path</li> 6887 <li>Env Var: RCLONE_CACHE_DB_PATH</li> 6888 <li>Type: string</li> 6889 <li>Default: “$HOME/.cache/rclone/cache-backend”</li> 6890 </ul> 6891 <h4 id="cache-chunk-path">–cache-chunk-path</h4> 6892 <p>Directory to cache chunk files.</p> 6893 <p>Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.</p> 6894 <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> 6895 <ul> 6896 <li>Config: chunk_path</li> 6897 <li>Env Var: RCLONE_CACHE_CHUNK_PATH</li> 6898 <li>Type: string</li> 6899 <li>Default: “$HOME/.cache/rclone/cache-backend”</li> 6900 </ul> 6901 <h4 id="cache-db-purge">–cache-db-purge</h4> 6902 <p>Clear all the cached data for this remote on start.</p> 6903 <ul> 6904 <li>Config: db_purge</li> 6905 <li>Env Var: RCLONE_CACHE_DB_PURGE</li> 6906 <li>Type: bool</li> 6907 <li>Default: false</li> 6908 </ul> 6909 <h4 id="cache-chunk-clean-interval">–cache-chunk-clean-interval</h4> 6910 <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> 6911 <ul> 6912 <li>Config: chunk_clean_interval</li> 6913 <li>Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL</li> 6914 <li>Type: Duration</li> 6915 <li>Default: 1m0s</li> 6916 </ul> 6917 <h4 id="cache-read-retries">–cache-read-retries</h4> 6918 <p>How many times to retry a read from a cache storage.</p> 6919 <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> 6920 <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> 6921 <ul> 6922 <li>Config: read_retries</li> 6923 <li>Env Var: RCLONE_CACHE_READ_RETRIES</li> 6924 <li>Type: int</li> 6925 <li>Default: 10</li> 6926 </ul> 6927 <h4 id="cache-workers">–cache-workers</h4> 6928 <p>How many workers should run in parallel to download chunks.</p> 6929 <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> 6930 <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> 6931 <ul> 6932 <li>Config: workers</li> 6933 <li>Env Var: RCLONE_CACHE_WORKERS</li> 6934 <li>Type: int</li> 6935 <li>Default: 4</li> 6936 </ul> 6937 <h4 id="cache-chunk-no-memory">–cache-chunk-no-memory</h4> 6938 <p>Disable the in-memory cache for storing chunks during streaming.</p> 6939 <p>By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible.</p> 6940 <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> 6941 <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> 6942 <ul> 6943 <li>Config: chunk_no_memory</li> 6944 <li>Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY</li> 6945 <li>Type: bool</li> 6946 <li>Default: false</li> 6947 </ul> 6948 <h4 id="cache-rps">–cache-rps</h4> 6949 <p>Limits the number of requests per second to the source FS (-1 to disable)</p> 6950 <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> 6951 <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> 6952 <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> 6953 <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> 6954 <ul> 6955 <li>Config: rps</li> 6956 <li>Env Var: RCLONE_CACHE_RPS</li> 6957 <li>Type: int</li> 6958 <li>Default: -1</li> 6959 </ul> 6960 <h4 id="cache-writes">–cache-writes</h4> 6961 <p>Cache file data on writes through the FS</p> 6962 <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> 6963 <ul> 6964 <li>Config: writes</li> 6965 <li>Env Var: RCLONE_CACHE_WRITES</li> 6966 <li>Type: bool</li> 6967 <li>Default: false</li> 6968 </ul> 6969 <h4 id="cache-tmp-upload-path">–cache-tmp-upload-path</h4> 6970 <p>Directory to keep temporary files until they are uploaded.</p> 6971 <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> 6972 <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> 6973 <ul> 6974 <li>Config: tmp_upload_path</li> 6975 <li>Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH</li> 6976 <li>Type: string</li> 6977 <li>Default: ""</li> 6978 </ul> 6979 <h4 id="cache-tmp-wait-time">–cache-tmp-wait-time</h4> 6980 <p>How long should files be stored in local cache before being uploaded</p> 6981 <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> 6982 <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> 6983 <ul> 6984 <li>Config: tmp_wait_time</li> 6985 <li>Env Var: RCLONE_CACHE_TMP_WAIT_TIME</li> 6986 <li>Type: Duration</li> 6987 <li>Default: 15s</li> 6988 </ul> 6989 <h4 id="cache-db-wait-time">–cache-db-wait-time</h4> 6990 <p>How long to wait for the DB to be available - 0 is unlimited</p> 6991 <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> 6992 <p>If you set it to 0 then it will wait forever.</p> 6993 <ul> 6994 <li>Config: db_wait_time</li> 6995 <li>Env Var: RCLONE_CACHE_DB_WAIT_TIME</li> 6996 <li>Type: Duration</li> 6997 <li>Default: 1s</li> 6998 </ul> 6999 <!--- autogenerated options stop --> 7000 <h2 id="crypt">Crypt</h2> 7001 <p>The <code>crypt</code> remote encrypts and decrypts another remote.</p> 7002 <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> 7003 <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> 7004 <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> 7005 <pre><code>No remotes found - make a new one 7006 n) New remote 7007 s) Set configuration password 7008 q) Quit config 7009 n/s/q> n 7010 name> secret 7011 Type of storage to configure. 7012 Choose a number from below, or type in your own value 7013 1 / Amazon Drive 7014 \ "amazon cloud drive" 7015 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 7016 \ "s3" 7017 3 / Backblaze B2 7018 \ "b2" 7019 4 / Dropbox 7020 \ "dropbox" 7021 5 / Encrypt/Decrypt a remote 7022 \ "crypt" 7023 6 / Google Cloud Storage (this is not Google Drive) 7024 \ "google cloud storage" 7025 7 / Google Drive 7026 \ "drive" 7027 8 / Hubic 7028 \ "hubic" 7029 9 / Local Disk 7030 \ "local" 7031 10 / Microsoft OneDrive 7032 \ "onedrive" 7033 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 7034 \ "swift" 7035 12 / SSH/SFTP Connection 7036 \ "sftp" 7037 13 / Yandex Disk 7038 \ "yandex" 7039 Storage> 5 7040 Remote to encrypt/decrypt. 7041 Normally should contain a ':' and a path, eg "myremote:path/to/dir", 7042 "myremote:bucket" or maybe "myremote:" (not recommended). 7043 remote> remote:path 7044 How to encrypt the filenames. 7045 Choose a number from below, or type in your own value 7046 1 / Don't encrypt the file names. Adds a ".bin" extension only. 7047 \ "off" 7048 2 / Encrypt the filenames see the docs for the details. 7049 \ "standard" 7050 3 / Very simple filename obfuscation. 7051 \ "obfuscate" 7052 filename_encryption> 2 7053 Option to either encrypt directory names or leave them intact. 7054 Choose a number from below, or type in your own value 7055 1 / Encrypt directory names. 7056 \ "true" 7057 2 / Don't encrypt directory names, leave them intact. 7058 \ "false" 7059 filename_encryption> 1 7060 Password or pass phrase for encryption. 7061 y) Yes type in my own password 7062 g) Generate random password 7063 y/g> y 7064 Enter the password: 7065 password: 7066 Confirm the password: 7067 password: 7068 Password or pass phrase for salt. Optional but recommended. 7069 Should be different to the previous password. 7070 y) Yes type in my own password 7071 g) Generate random password 7072 n) No leave this optional password blank 7073 y/g/n> g 7074 Password strength in bits. 7075 64 is just about memorable 7076 128 is secure 7077 1024 is the maximum 7078 Bits> 128 7079 Your password is: JAsJvRcgR-_veXNfy_sGmQ 7080 Use this password? 7081 y) Yes 7082 n) No 7083 y/n> y 7084 Remote config 7085 -------------------- 7086 [secret] 7087 remote = remote:path 7088 filename_encryption = standard 7089 password = *** ENCRYPTED *** 7090 password2 = *** ENCRYPTED *** 7091 -------------------- 7092 y) Yes this is OK 7093 e) Edit this remote 7094 d) Delete this remote 7095 y/e/d> y</code></pre> 7096 <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> 7097 <p>A long passphrase is recommended, or you can use a random one. Note that if you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible - all the secrets used are derived from those two passwords/passphrases.</p> 7098 <p>Note that rclone does not encrypt</p> 7099 <ul> 7100 <li>file length - this can be calcuated within 16 bytes</li> 7101 <li>modification time - used for syncing</li> 7102 </ul> 7103 <h2 id="specifying-the-remote">Specifying the remote</h2> 7104 <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> 7105 <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> 7106 <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> 7107 <h2 id="example">Example</h2> 7108 <p>To test I made a little directory of files using “standard” file name encryption.</p> 7109 <pre><code>plaintext/ 7110 ├── file0.txt 7111 ├── file1.txt 7112 └── subdir 7113 ├── file2.txt 7114 ├── file3.txt 7115 └── subsubdir 7116 └── file4.txt</code></pre> 7117 <p>Copy these to the remote and list them back</p> 7118 <pre><code>$ rclone -q copy plaintext secret: 7119 $ rclone -q ls secret: 7120 7 file1.txt 7121 6 file0.txt 7122 8 subdir/file2.txt 7123 10 subdir/subsubdir/file4.txt 7124 9 subdir/file3.txt</code></pre> 7125 <p>Now see what that looked like when encrypted</p> 7126 <pre><code>$ rclone -q ls remote:path 7127 55 hagjclgavj2mbiqm6u6cnjjqcg 7128 54 v05749mltvv1tf4onltun46gls 7129 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 7130 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 7131 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps</code></pre> 7132 <p>Note that this retains the directory structure which means you can do this</p> 7133 <pre><code>$ rclone -q ls secret:subdir 7134 8 file2.txt 7135 9 file3.txt 7136 10 subsubdir/file4.txt</code></pre> 7137 <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> 7138 <pre><code>$ rclone -q ls remote:path 7139 54 file0.txt.bin 7140 57 subdir/file3.txt.bin 7141 56 subdir/file2.txt.bin 7142 58 subdir/subsubdir/file4.txt.bin 7143 55 file1.txt.bin</code></pre> 7144 <h3 id="file-name-encryption-modes">File name encryption modes</h3> 7145 <p>Here are some of the features of the file name encryption modes</p> 7146 <p>Off</p> 7147 <ul> 7148 <li>doesn’t hide file names or directory structure</li> 7149 <li>allows for longer file names (~246 characters)</li> 7150 <li>can use sub paths and copy single files</li> 7151 </ul> 7152 <p>Standard</p> 7153 <ul> 7154 <li>file names encrypted</li> 7155 <li>file names can’t be as long (~143 characters)</li> 7156 <li>can use sub paths and copy single files</li> 7157 <li>directory structure visible</li> 7158 <li>identical files names will have identical uploaded names</li> 7159 <li>can use shortcuts to shorten the directory recursion</li> 7160 </ul> 7161 <p>Obfuscation</p> 7162 <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> 7163 <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> 7164 <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> 7165 <ul> 7166 <li>file names very lightly obfuscated</li> 7167 <li>file names can be longer than standard encryption</li> 7168 <li>can use sub paths and copy single files</li> 7169 <li>directory structure visible</li> 7170 <li>identical files names will have identical uploaded names</li> 7171 </ul> 7172 <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> 7173 <p>There may be an even more secure file name encryption mode in the future which will address the long file name problem.</p> 7174 <h3 id="directory-name-encryption">Directory name encryption</h3> 7175 <p>Crypt offers the option of encrypting dir names or leaving them intact. There are two options:</p> 7176 <p>True</p> 7177 <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> 7178 <p>False</p> 7179 <p>Only encrypts file names, skips directory names Example: <code>1/12/123.txt</code> is encrypted to <code>1/12/qgm4avr35m5loi1th53ato71v0</code></p> 7180 <h3 id="modified-time-and-hashes-1">Modified time and hashes</h3> 7181 <p>Crypt stores modification times using the underlying remote so support depends on that.</p> 7182 <p>Hashes are not stored for crypt. However the data integrity is protected by an extremely strong crypto authenticator.</p> 7183 <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> 7184 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs --> 7185 <h3 id="standard-options-6">Standard Options</h3> 7186 <p>Here are the standard options specific to crypt (Encrypt/Decrypt a remote).</p> 7187 <h4 id="crypt-remote">–crypt-remote</h4> 7188 <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> 7189 <ul> 7190 <li>Config: remote</li> 7191 <li>Env Var: RCLONE_CRYPT_REMOTE</li> 7192 <li>Type: string</li> 7193 <li>Default: ""</li> 7194 </ul> 7195 <h4 id="crypt-filename-encryption">–crypt-filename-encryption</h4> 7196 <p>How to encrypt the filenames.</p> 7197 <ul> 7198 <li>Config: filename_encryption</li> 7199 <li>Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION</li> 7200 <li>Type: string</li> 7201 <li>Default: “standard”</li> 7202 <li>Examples: 7203 <ul> 7204 <li>“off” 7205 <ul> 7206 <li>Don’t encrypt the file names. Adds a “.bin” extension only.</li> 7207 </ul></li> 7208 <li>“standard” 7209 <ul> 7210 <li>Encrypt the filenames see the docs for the details.</li> 7211 </ul></li> 7212 <li>“obfuscate” 7213 <ul> 7214 <li>Very simple filename obfuscation.</li> 7215 </ul></li> 7216 </ul></li> 7217 </ul> 7218 <h4 id="crypt-directory-name-encryption">–crypt-directory-name-encryption</h4> 7219 <p>Option to either encrypt directory names or leave them intact.</p> 7220 <ul> 7221 <li>Config: directory_name_encryption</li> 7222 <li>Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION</li> 7223 <li>Type: bool</li> 7224 <li>Default: true</li> 7225 <li>Examples: 7226 <ul> 7227 <li>“true” 7228 <ul> 7229 <li>Encrypt directory names.</li> 7230 </ul></li> 7231 <li>“false” 7232 <ul> 7233 <li>Don’t encrypt directory names, leave them intact.</li> 7234 </ul></li> 7235 </ul></li> 7236 </ul> 7237 <h4 id="crypt-password">–crypt-password</h4> 7238 <p>Password or pass phrase for encryption.</p> 7239 <ul> 7240 <li>Config: password</li> 7241 <li>Env Var: RCLONE_CRYPT_PASSWORD</li> 7242 <li>Type: string</li> 7243 <li>Default: ""</li> 7244 </ul> 7245 <h4 id="crypt-password2">–crypt-password2</h4> 7246 <p>Password or pass phrase for salt. Optional but recommended. Should be different to the previous password.</p> 7247 <ul> 7248 <li>Config: password2</li> 7249 <li>Env Var: RCLONE_CRYPT_PASSWORD2</li> 7250 <li>Type: string</li> 7251 <li>Default: ""</li> 7252 </ul> 7253 <h3 id="advanced-options-5">Advanced Options</h3> 7254 <p>Here are the advanced options specific to crypt (Encrypt/Decrypt a remote).</p> 7255 <h4 id="crypt-show-mapping">–crypt-show-mapping</h4> 7256 <p>For all files listed show how the names encrypt.</p> 7257 <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> 7258 <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> 7259 <ul> 7260 <li>Config: show_mapping</li> 7261 <li>Env Var: RCLONE_CRYPT_SHOW_MAPPING</li> 7262 <li>Type: bool</li> 7263 <li>Default: false</li> 7264 </ul> 7265 <!--- autogenerated options stop --> 7266 <h2 id="backing-up-a-crypted-remote">Backing up a crypted remote</h2> 7267 <p>If you wish to backup a crypted remote, it it 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> 7268 <p>This will have the following advantages</p> 7269 <ul> 7270 <li><code>rclone sync</code> will check the checksums while copying</li> 7271 <li>you can use <code>rclone check</code> between the encrypted remotes</li> 7272 <li>you don’t decrypt and encrypt unnecessarily</li> 7273 </ul> 7274 <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> 7275 <p>To sync the two remotes you would do</p> 7276 <pre><code>rclone sync remote:crypt remote2:crypt</code></pre> 7277 <p>And to check the integrity you would do</p> 7278 <pre><code>rclone check remote:crypt remote2:crypt</code></pre> 7279 <h2 id="file-formats">File formats</h2> 7280 <h3 id="file-encryption">File encryption</h3> 7281 <p>Files are encrypted 1:1 source file to destination object. The file has a header and is divided into chunks.</p> 7282 <h4 id="header">Header</h4> 7283 <ul> 7284 <li>8 bytes magic string <code>RCLONE\x00\x00</code></li> 7285 <li>24 bytes Nonce (IV)</li> 7286 </ul> 7287 <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> 7288 <h4 id="chunk">Chunk</h4> 7289 <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> 7290 <p>Each chunk contains:</p> 7291 <ul> 7292 <li>16 Bytes of Poly1305 authenticator</li> 7293 <li>1 - 65536 bytes XSalsa20 encrypted data</li> 7294 </ul> 7295 <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> 7296 <p>This uses a 32 byte (256 bit key) key derived from the user password.</p> 7297 <h4 id="examples">Examples</h4> 7298 <p>1 byte file will encrypt to</p> 7299 <ul> 7300 <li>32 bytes header</li> 7301 <li>17 bytes data chunk</li> 7302 </ul> 7303 <p>49 bytes total</p> 7304 <p>1MB (1048576 bytes) file will encrypt to</p> 7305 <ul> 7306 <li>32 bytes header</li> 7307 <li>16 chunks of 65568 bytes</li> 7308 </ul> 7309 <p>1049120 bytes total (a 0.05% overhead). This is the overhead for big files.</p> 7310 <h3 id="name-encryption">Name encryption</h3> 7311 <p>File names are encrypted segment by segment - the path is broken up into <code>/</code> separated strings and these are encrypted individually.</p> 7312 <p>File segments are padded using using PKCS#7 to a multiple of 16 bytes before encryption.</p> 7313 <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> 7314 <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> 7315 <p>This means that</p> 7316 <ul> 7317 <li>filenames with the same name will encrypt the same</li> 7318 <li>filenames which start the same won’t have a common prefix</li> 7319 </ul> 7320 <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> 7321 <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> 7322 <ul> 7323 <li>it becomes lower case (no-one likes upper case filenames!)</li> 7324 <li>we strip the padding character <code>=</code></li> 7325 </ul> 7326 <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> 7327 <h3 id="key-derivation">Key derivation</h3> 7328 <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> 7329 <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> 7330 <h2 id="dropbox">Dropbox</h2> 7331 <p>Paths are specified as <code>remote:path</code></p> 7332 <p>Dropbox paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 7333 <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> 7334 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 7335 <pre><code> rclone config</code></pre> 7336 <p>This will guide you through an interactive setup process:</p> 7337 <pre><code>n) New remote 7338 d) Delete remote 7339 q) Quit config 7340 e/n/d/q> n 7341 name> remote 7342 Type of storage to configure. 7343 Choose a number from below, or type in your own value 7344 1 / Amazon Drive 7345 \ "amazon cloud drive" 7346 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 7347 \ "s3" 7348 3 / Backblaze B2 7349 \ "b2" 7350 4 / Dropbox 7351 \ "dropbox" 7352 5 / Encrypt/Decrypt a remote 7353 \ "crypt" 7354 6 / Google Cloud Storage (this is not Google Drive) 7355 \ "google cloud storage" 7356 7 / Google Drive 7357 \ "drive" 7358 8 / Hubic 7359 \ "hubic" 7360 9 / Local Disk 7361 \ "local" 7362 10 / Microsoft OneDrive 7363 \ "onedrive" 7364 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 7365 \ "swift" 7366 12 / SSH/SFTP Connection 7367 \ "sftp" 7368 13 / Yandex Disk 7369 \ "yandex" 7370 Storage> 4 7371 Dropbox App Key - leave blank normally. 7372 app_key> 7373 Dropbox App Secret - leave blank normally. 7374 app_secret> 7375 Remote config 7376 Please visit: 7377 https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code 7378 Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX 7379 -------------------- 7380 [remote] 7381 app_key = 7382 app_secret = 7383 token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7384 -------------------- 7385 y) Yes this is OK 7386 e) Edit this remote 7387 d) Delete this remote 7388 y/e/d> y</code></pre> 7389 <p>You can then use it like this,</p> 7390 <p>List directories in top level of your dropbox</p> 7391 <pre><code>rclone lsd remote:</code></pre> 7392 <p>List all the files in your dropbox</p> 7393 <pre><code>rclone ls remote:</code></pre> 7394 <p>To copy a local directory to a dropbox directory called backup</p> 7395 <pre><code>rclone copy /home/source remote:backup</code></pre> 7396 <h3 id="dropbox-for-business">Dropbox for business</h3> 7397 <p>Rclone supports Dropbox for business and Team Folders.</p> 7398 <p>When using Dropbox for business <code>remote:</code> and <code>remote:path/to/file</code> will refer to your personal folder.</p> 7399 <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> 7400 <p>You can then use team folders like this <code>remote:/TeamFolder</code> and <code>remote:/TeamFolder/path/to/file</code>.</p> 7401 <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> 7402 <h3 id="modified-time-and-hashes-2">Modified time and Hashes</h3> 7403 <p>Dropbox supports modified times, but the only way to set a modification time is to re-upload the file.</p> 7404 <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> 7405 <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> 7406 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs --> 7407 <h3 id="standard-options-7">Standard Options</h3> 7408 <p>Here are the standard options specific to dropbox (Dropbox).</p> 7409 <h4 id="dropbox-client-id">–dropbox-client-id</h4> 7410 <p>Dropbox App Client Id Leave blank normally.</p> 7411 <ul> 7412 <li>Config: client_id</li> 7413 <li>Env Var: RCLONE_DROPBOX_CLIENT_ID</li> 7414 <li>Type: string</li> 7415 <li>Default: ""</li> 7416 </ul> 7417 <h4 id="dropbox-client-secret">–dropbox-client-secret</h4> 7418 <p>Dropbox App Client Secret Leave blank normally.</p> 7419 <ul> 7420 <li>Config: client_secret</li> 7421 <li>Env Var: RCLONE_DROPBOX_CLIENT_SECRET</li> 7422 <li>Type: string</li> 7423 <li>Default: ""</li> 7424 </ul> 7425 <h3 id="advanced-options-6">Advanced Options</h3> 7426 <p>Here are the advanced options specific to dropbox (Dropbox).</p> 7427 <h4 id="dropbox-chunk-size">–dropbox-chunk-size</h4> 7428 <p>Upload chunk size. (< 150M).</p> 7429 <p>Any files larger than this will be uploaded in chunks of this size.</p> 7430 <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> 7431 <ul> 7432 <li>Config: chunk_size</li> 7433 <li>Env Var: RCLONE_DROPBOX_CHUNK_SIZE</li> 7434 <li>Type: SizeSuffix</li> 7435 <li>Default: 48M</li> 7436 </ul> 7437 <h4 id="dropbox-impersonate">–dropbox-impersonate</h4> 7438 <p>Impersonate this user when using a business account.</p> 7439 <ul> 7440 <li>Config: impersonate</li> 7441 <li>Env Var: RCLONE_DROPBOX_IMPERSONATE</li> 7442 <li>Type: string</li> 7443 <li>Default: ""</li> 7444 </ul> 7445 <!--- autogenerated options stop --> 7446 <h3 id="limitations-3">Limitations</h3> 7447 <p>Note that Dropbox is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 7448 <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> 7449 <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> 7450 <h2 id="ftp">FTP</h2> 7451 <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> 7452 <p>Here is an example of making an FTP configuration. First run</p> 7453 <pre><code>rclone config</code></pre> 7454 <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> 7455 <pre><code>No remotes found - make a new one 7456 n) New remote 7457 r) Rename remote 7458 c) Copy remote 7459 s) Set configuration password 7460 q) Quit config 7461 n/r/c/s/q> n 7462 name> remote 7463 Type of storage to configure. 7464 Enter a string value. Press Enter for the default (""). 7465 Choose a number from below, or type in your own value 7466 [snip] 7467 10 / FTP Connection 7468 \ "ftp" 7469 [snip] 7470 Storage> ftp 7471 ** See help for ftp backend at: https://rclone.org/ftp/ ** 7472 7473 FTP host to connect to 7474 Enter a string value. Press Enter for the default (""). 7475 Choose a number from below, or type in your own value 7476 1 / Connect to ftp.example.com 7477 \ "ftp.example.com" 7478 host> ftp.example.com 7479 FTP username, leave blank for current username, ncw 7480 Enter a string value. Press Enter for the default (""). 7481 user> 7482 FTP port, leave blank to use default (21) 7483 Enter a string value. Press Enter for the default (""). 7484 port> 7485 FTP password 7486 y) Yes type in my own password 7487 g) Generate random password 7488 y/g> y 7489 Enter the password: 7490 password: 7491 Confirm the password: 7492 password: 7493 Use FTP over TLS (Implicit) 7494 Enter a boolean value (true or false). Press Enter for the default ("false"). 7495 tls> 7496 Remote config 7497 -------------------- 7498 [remote] 7499 type = ftp 7500 host = ftp.example.com 7501 pass = *** ENCRYPTED *** 7502 -------------------- 7503 y) Yes this is OK 7504 e) Edit this remote 7505 d) Delete this remote 7506 y/e/d> y</code></pre> 7507 <p>This remote is called <code>remote</code> and can now be used like this</p> 7508 <p>See all directories in the home directory</p> 7509 <pre><code>rclone lsd remote:</code></pre> 7510 <p>Make a new directory</p> 7511 <pre><code>rclone mkdir remote:path/to/directory</code></pre> 7512 <p>List the contents of a directory</p> 7513 <pre><code>rclone ls remote:path/to/directory</code></pre> 7514 <p>Sync <code>/home/local/directory</code> to the remote directory, deleting any excess files in the directory.</p> 7515 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 7516 <h3 id="modified-time-2">Modified time</h3> 7517 <p>FTP does not support modified times. Any times you see on the server will be time of upload.</p> 7518 <h3 id="checksums">Checksums</h3> 7519 <p>FTP does not support any checksums.</p> 7520 <h3 id="implicit-tls">Implicit TLS</h3> 7521 <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 explictly set in the config for the remote.</p> 7522 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/ftp/ftp.go then run make backenddocs --> 7523 <h3 id="standard-options-8">Standard Options</h3> 7524 <p>Here are the standard options specific to ftp (FTP Connection).</p> 7525 <h4 id="ftp-host">–ftp-host</h4> 7526 <p>FTP host to connect to</p> 7527 <ul> 7528 <li>Config: host</li> 7529 <li>Env Var: RCLONE_FTP_HOST</li> 7530 <li>Type: string</li> 7531 <li>Default: ""</li> 7532 <li>Examples: 7533 <ul> 7534 <li>“ftp.example.com” 7535 <ul> 7536 <li>Connect to ftp.example.com</li> 7537 </ul></li> 7538 </ul></li> 7539 </ul> 7540 <h4 id="ftp-user">–ftp-user</h4> 7541 <p>FTP username, leave blank for current username, $USER</p> 7542 <ul> 7543 <li>Config: user</li> 7544 <li>Env Var: RCLONE_FTP_USER</li> 7545 <li>Type: string</li> 7546 <li>Default: ""</li> 7547 </ul> 7548 <h4 id="ftp-port">–ftp-port</h4> 7549 <p>FTP port, leave blank to use default (21)</p> 7550 <ul> 7551 <li>Config: port</li> 7552 <li>Env Var: RCLONE_FTP_PORT</li> 7553 <li>Type: string</li> 7554 <li>Default: ""</li> 7555 </ul> 7556 <h4 id="ftp-pass">–ftp-pass</h4> 7557 <p>FTP password</p> 7558 <ul> 7559 <li>Config: pass</li> 7560 <li>Env Var: RCLONE_FTP_PASS</li> 7561 <li>Type: string</li> 7562 <li>Default: ""</li> 7563 </ul> 7564 <h4 id="ftp-tls">–ftp-tls</h4> 7565 <p>Use FTP over TLS (Implicit)</p> 7566 <ul> 7567 <li>Config: tls</li> 7568 <li>Env Var: RCLONE_FTP_TLS</li> 7569 <li>Type: bool</li> 7570 <li>Default: false</li> 7571 </ul> 7572 <h3 id="advanced-options-7">Advanced Options</h3> 7573 <p>Here are the advanced options specific to ftp (FTP Connection).</p> 7574 <h4 id="ftp-concurrency">–ftp-concurrency</h4> 7575 <p>Maximum number of FTP simultaneous connections, 0 for unlimited</p> 7576 <ul> 7577 <li>Config: concurrency</li> 7578 <li>Env Var: RCLONE_FTP_CONCURRENCY</li> 7579 <li>Type: int</li> 7580 <li>Default: 0</li> 7581 </ul> 7582 <h4 id="ftp-no-check-certificate">–ftp-no-check-certificate</h4> 7583 <p>Do not verify the TLS certificate of the server</p> 7584 <ul> 7585 <li>Config: no_check_certificate</li> 7586 <li>Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE</li> 7587 <li>Type: bool</li> 7588 <li>Default: false</li> 7589 </ul> 7590 <!--- autogenerated options stop --> 7591 <h3 id="limitations-4">Limitations</h3> 7592 <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> 7593 <p>Note that <code>--timeout</code> isn’t supported (but <code>--contimeout</code> is).</p> 7594 <p>Note that <code>--bind</code> isn’t supported.</p> 7595 <p>FTP could support server side move but doesn’t yet.</p> 7596 <p>Note that the ftp backend does not support the <code>ftp_proxy</code> environment variable yet.</p> 7597 <p>Note that while implicit FTP over TLS is supported, explicit FTP over TLS is not.</p> 7598 <h2 id="google-cloud-storage">Google Cloud Storage</h2> 7599 <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> 7600 <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> 7601 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 7602 <pre><code> rclone config</code></pre> 7603 <p>This will guide you through an interactive setup process:</p> 7604 <pre><code>n) New remote 7605 d) Delete remote 7606 q) Quit config 7607 e/n/d/q> n 7608 name> remote 7609 Type of storage to configure. 7610 Choose a number from below, or type in your own value 7611 1 / Amazon Drive 7612 \ "amazon cloud drive" 7613 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 7614 \ "s3" 7615 3 / Backblaze B2 7616 \ "b2" 7617 4 / Dropbox 7618 \ "dropbox" 7619 5 / Encrypt/Decrypt a remote 7620 \ "crypt" 7621 6 / Google Cloud Storage (this is not Google Drive) 7622 \ "google cloud storage" 7623 7 / Google Drive 7624 \ "drive" 7625 8 / Hubic 7626 \ "hubic" 7627 9 / Local Disk 7628 \ "local" 7629 10 / Microsoft OneDrive 7630 \ "onedrive" 7631 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 7632 \ "swift" 7633 12 / SSH/SFTP Connection 7634 \ "sftp" 7635 13 / Yandex Disk 7636 \ "yandex" 7637 Storage> 6 7638 Google Application Client Id - leave blank normally. 7639 client_id> 7640 Google Application Client Secret - leave blank normally. 7641 client_secret> 7642 Project number optional - needed only for list/create/delete buckets - see your developer console. 7643 project_number> 12345678 7644 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. 7645 service_account_file> 7646 Access Control List for new objects. 7647 Choose a number from below, or type in your own value 7648 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. 7649 \ "authenticatedRead" 7650 2 / Object owner gets OWNER access, and project team owners get OWNER access. 7651 \ "bucketOwnerFullControl" 7652 3 / Object owner gets OWNER access, and project team owners get READER access. 7653 \ "bucketOwnerRead" 7654 4 / Object owner gets OWNER access [default if left blank]. 7655 \ "private" 7656 5 / Object owner gets OWNER access, and project team members get access according to their roles. 7657 \ "projectPrivate" 7658 6 / Object owner gets OWNER access, and all Users get READER access. 7659 \ "publicRead" 7660 object_acl> 4 7661 Access Control List for new buckets. 7662 Choose a number from below, or type in your own value 7663 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. 7664 \ "authenticatedRead" 7665 2 / Project team owners get OWNER access [default if left blank]. 7666 \ "private" 7667 3 / Project team members get access according to their roles. 7668 \ "projectPrivate" 7669 4 / Project team owners get OWNER access, and all Users get READER access. 7670 \ "publicRead" 7671 5 / Project team owners get OWNER access, and all Users get WRITER access. 7672 \ "publicReadWrite" 7673 bucket_acl> 2 7674 Location for the newly created buckets. 7675 Choose a number from below, or type in your own value 7676 1 / Empty for default location (US). 7677 \ "" 7678 2 / Multi-regional location for Asia. 7679 \ "asia" 7680 3 / Multi-regional location for Europe. 7681 \ "eu" 7682 4 / Multi-regional location for United States. 7683 \ "us" 7684 5 / Taiwan. 7685 \ "asia-east1" 7686 6 / Tokyo. 7687 \ "asia-northeast1" 7688 7 / Singapore. 7689 \ "asia-southeast1" 7690 8 / Sydney. 7691 \ "australia-southeast1" 7692 9 / Belgium. 7693 \ "europe-west1" 7694 10 / London. 7695 \ "europe-west2" 7696 11 / Iowa. 7697 \ "us-central1" 7698 12 / South Carolina. 7699 \ "us-east1" 7700 13 / Northern Virginia. 7701 \ "us-east4" 7702 14 / Oregon. 7703 \ "us-west1" 7704 location> 12 7705 The storage class to use when storing objects in Google Cloud Storage. 7706 Choose a number from below, or type in your own value 7707 1 / Default 7708 \ "" 7709 2 / Multi-regional storage class 7710 \ "MULTI_REGIONAL" 7711 3 / Regional storage class 7712 \ "REGIONAL" 7713 4 / Nearline storage class 7714 \ "NEARLINE" 7715 5 / Coldline storage class 7716 \ "COLDLINE" 7717 6 / Durable reduced availability storage class 7718 \ "DURABLE_REDUCED_AVAILABILITY" 7719 storage_class> 5 7720 Remote config 7721 Use auto config? 7722 * Say Y if not sure 7723 * Say N if you are working on a remote or headless machine or Y didn't work 7724 y) Yes 7725 n) No 7726 y/n> y 7727 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 7728 Log in and authorize rclone for access 7729 Waiting for code... 7730 Got code 7731 -------------------- 7732 [remote] 7733 type = google cloud storage 7734 client_id = 7735 client_secret = 7736 token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} 7737 project_number = 12345678 7738 object_acl = private 7739 bucket_acl = private 7740 -------------------- 7741 y) Yes this is OK 7742 e) Edit this remote 7743 d) Delete this remote 7744 y/e/d> y</code></pre> 7745 <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> 7746 <p>This remote is called <code>remote</code> and can now be used like this</p> 7747 <p>See all the buckets in your project</p> 7748 <pre><code>rclone lsd remote:</code></pre> 7749 <p>Make a new bucket</p> 7750 <pre><code>rclone mkdir remote:bucket</code></pre> 7751 <p>List the contents of a bucket</p> 7752 <pre><code>rclone ls remote:bucket</code></pre> 7753 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 7754 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 7755 <h3 id="service-account-support">Service Account support</h3> 7756 <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> 7757 <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> 7758 <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> 7759 <h3 id="application-default-credentials">Application Default Credentials</h3> 7760 <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> 7761 <p>Note that in the case application default credentials are used, there is no need to explicitly configure a project number.</p> 7762 <h3 id="fast-list-3">–fast-list</h3> 7763 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 7764 <h3 id="modified-time-3">Modified time</h3> 7765 <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> 7766 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs --> 7767 <h3 id="standard-options-9">Standard Options</h3> 7768 <p>Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).</p> 7769 <h4 id="gcs-client-id">–gcs-client-id</h4> 7770 <p>Google Application Client Id Leave blank normally.</p> 7771 <ul> 7772 <li>Config: client_id</li> 7773 <li>Env Var: RCLONE_GCS_CLIENT_ID</li> 7774 <li>Type: string</li> 7775 <li>Default: ""</li> 7776 </ul> 7777 <h4 id="gcs-client-secret">–gcs-client-secret</h4> 7778 <p>Google Application Client Secret Leave blank normally.</p> 7779 <ul> 7780 <li>Config: client_secret</li> 7781 <li>Env Var: RCLONE_GCS_CLIENT_SECRET</li> 7782 <li>Type: string</li> 7783 <li>Default: ""</li> 7784 </ul> 7785 <h4 id="gcs-project-number">–gcs-project-number</h4> 7786 <p>Project number. Optional - needed only for list/create/delete buckets - see your developer console.</p> 7787 <ul> 7788 <li>Config: project_number</li> 7789 <li>Env Var: RCLONE_GCS_PROJECT_NUMBER</li> 7790 <li>Type: string</li> 7791 <li>Default: ""</li> 7792 </ul> 7793 <h4 id="gcs-service-account-file">–gcs-service-account-file</h4> 7794 <p>Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 7795 <ul> 7796 <li>Config: service_account_file</li> 7797 <li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE</li> 7798 <li>Type: string</li> 7799 <li>Default: ""</li> 7800 </ul> 7801 <h4 id="gcs-service-account-credentials">–gcs-service-account-credentials</h4> 7802 <p>Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 7803 <ul> 7804 <li>Config: service_account_credentials</li> 7805 <li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS</li> 7806 <li>Type: string</li> 7807 <li>Default: ""</li> 7808 </ul> 7809 <h4 id="gcs-object-acl">–gcs-object-acl</h4> 7810 <p>Access Control List for new objects.</p> 7811 <ul> 7812 <li>Config: object_acl</li> 7813 <li>Env Var: RCLONE_GCS_OBJECT_ACL</li> 7814 <li>Type: string</li> 7815 <li>Default: ""</li> 7816 <li>Examples: 7817 <ul> 7818 <li>“authenticatedRead” 7819 <ul> 7820 <li>Object owner gets OWNER access, and all Authenticated Users get READER access.</li> 7821 </ul></li> 7822 <li>“bucketOwnerFullControl” 7823 <ul> 7824 <li>Object owner gets OWNER access, and project team owners get OWNER access.</li> 7825 </ul></li> 7826 <li>“bucketOwnerRead” 7827 <ul> 7828 <li>Object owner gets OWNER access, and project team owners get READER access.</li> 7829 </ul></li> 7830 <li>“private” 7831 <ul> 7832 <li>Object owner gets OWNER access [default if left blank].</li> 7833 </ul></li> 7834 <li>“projectPrivate” 7835 <ul> 7836 <li>Object owner gets OWNER access, and project team members get access according to their roles.</li> 7837 </ul></li> 7838 <li>“publicRead” 7839 <ul> 7840 <li>Object owner gets OWNER access, and all Users get READER access.</li> 7841 </ul></li> 7842 </ul></li> 7843 </ul> 7844 <h4 id="gcs-bucket-acl">–gcs-bucket-acl</h4> 7845 <p>Access Control List for new buckets.</p> 7846 <ul> 7847 <li>Config: bucket_acl</li> 7848 <li>Env Var: RCLONE_GCS_BUCKET_ACL</li> 7849 <li>Type: string</li> 7850 <li>Default: ""</li> 7851 <li>Examples: 7852 <ul> 7853 <li>“authenticatedRead” 7854 <ul> 7855 <li>Project team owners get OWNER access, and all Authenticated Users get READER access.</li> 7856 </ul></li> 7857 <li>“private” 7858 <ul> 7859 <li>Project team owners get OWNER access [default if left blank].</li> 7860 </ul></li> 7861 <li>“projectPrivate” 7862 <ul> 7863 <li>Project team members get access according to their roles.</li> 7864 </ul></li> 7865 <li>“publicRead” 7866 <ul> 7867 <li>Project team owners get OWNER access, and all Users get READER access.</li> 7868 </ul></li> 7869 <li>“publicReadWrite” 7870 <ul> 7871 <li>Project team owners get OWNER access, and all Users get WRITER access.</li> 7872 </ul></li> 7873 </ul></li> 7874 </ul> 7875 <h4 id="gcs-bucket-policy-only">–gcs-bucket-policy-only</h4> 7876 <p>Access checks should use bucket-level IAM policies.</p> 7877 <p>If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this.</p> 7878 <p>When it is set, rclone:</p> 7879 <ul> 7880 <li>ignores ACLs set on buckets</li> 7881 <li>ignores ACLs set on objects</li> 7882 <li>creates buckets with Bucket Policy Only set</li> 7883 </ul> 7884 <p>Docs: https://cloud.google.com/storage/docs/bucket-policy-only</p> 7885 <ul> 7886 <li>Config: bucket_policy_only</li> 7887 <li>Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY</li> 7888 <li>Type: bool</li> 7889 <li>Default: false</li> 7890 </ul> 7891 <h4 id="gcs-location">–gcs-location</h4> 7892 <p>Location for the newly created buckets.</p> 7893 <ul> 7894 <li>Config: location</li> 7895 <li>Env Var: RCLONE_GCS_LOCATION</li> 7896 <li>Type: string</li> 7897 <li>Default: ""</li> 7898 <li>Examples: 7899 <ul> 7900 <li>"" 7901 <ul> 7902 <li>Empty for default location (US).</li> 7903 </ul></li> 7904 <li>“asia” 7905 <ul> 7906 <li>Multi-regional location for Asia.</li> 7907 </ul></li> 7908 <li>“eu” 7909 <ul> 7910 <li>Multi-regional location for Europe.</li> 7911 </ul></li> 7912 <li>“us” 7913 <ul> 7914 <li>Multi-regional location for United States.</li> 7915 </ul></li> 7916 <li>“asia-east1” 7917 <ul> 7918 <li>Taiwan.</li> 7919 </ul></li> 7920 <li>“asia-east2” 7921 <ul> 7922 <li>Hong Kong.</li> 7923 </ul></li> 7924 <li>“asia-northeast1” 7925 <ul> 7926 <li>Tokyo.</li> 7927 </ul></li> 7928 <li>“asia-south1” 7929 <ul> 7930 <li>Mumbai.</li> 7931 </ul></li> 7932 <li>“asia-southeast1” 7933 <ul> 7934 <li>Singapore.</li> 7935 </ul></li> 7936 <li>“australia-southeast1” 7937 <ul> 7938 <li>Sydney.</li> 7939 </ul></li> 7940 <li>“europe-north1” 7941 <ul> 7942 <li>Finland.</li> 7943 </ul></li> 7944 <li>“europe-west1” 7945 <ul> 7946 <li>Belgium.</li> 7947 </ul></li> 7948 <li>“europe-west2” 7949 <ul> 7950 <li>London.</li> 7951 </ul></li> 7952 <li>“europe-west3” 7953 <ul> 7954 <li>Frankfurt.</li> 7955 </ul></li> 7956 <li>“europe-west4” 7957 <ul> 7958 <li>Netherlands.</li> 7959 </ul></li> 7960 <li>“us-central1” 7961 <ul> 7962 <li>Iowa.</li> 7963 </ul></li> 7964 <li>“us-east1” 7965 <ul> 7966 <li>South Carolina.</li> 7967 </ul></li> 7968 <li>“us-east4” 7969 <ul> 7970 <li>Northern Virginia.</li> 7971 </ul></li> 7972 <li>“us-west1” 7973 <ul> 7974 <li>Oregon.</li> 7975 </ul></li> 7976 <li>“us-west2” 7977 <ul> 7978 <li>California.</li> 7979 </ul></li> 7980 </ul></li> 7981 </ul> 7982 <h4 id="gcs-storage-class">–gcs-storage-class</h4> 7983 <p>The storage class to use when storing objects in Google Cloud Storage.</p> 7984 <ul> 7985 <li>Config: storage_class</li> 7986 <li>Env Var: RCLONE_GCS_STORAGE_CLASS</li> 7987 <li>Type: string</li> 7988 <li>Default: ""</li> 7989 <li>Examples: 7990 <ul> 7991 <li>"" 7992 <ul> 7993 <li>Default</li> 7994 </ul></li> 7995 <li>“MULTI_REGIONAL” 7996 <ul> 7997 <li>Multi-regional storage class</li> 7998 </ul></li> 7999 <li>“REGIONAL” 8000 <ul> 8001 <li>Regional storage class</li> 8002 </ul></li> 8003 <li>“NEARLINE” 8004 <ul> 8005 <li>Nearline storage class</li> 8006 </ul></li> 8007 <li>“COLDLINE” 8008 <ul> 8009 <li>Coldline storage class</li> 8010 </ul></li> 8011 <li>“DURABLE_REDUCED_AVAILABILITY” 8012 <ul> 8013 <li>Durable reduced availability storage class</li> 8014 </ul></li> 8015 </ul></li> 8016 </ul> 8017 <!--- autogenerated options stop --> 8018 <h2 id="google-drive">Google Drive</h2> 8019 <p>Paths are specified as <code>drive:path</code></p> 8020 <p>Drive paths may be as deep as required, eg <code>drive:directory/subdirectory</code>.</p> 8021 <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> 8022 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 8023 <pre><code> rclone config</code></pre> 8024 <p>This will guide you through an interactive setup process:</p> 8025 <pre><code>No remotes found - make a new one 8026 n) New remote 8027 r) Rename remote 8028 c) Copy remote 8029 s) Set configuration password 8030 q) Quit config 8031 n/r/c/s/q> n 8032 name> remote 8033 Type of storage to configure. 8034 Choose a number from below, or type in your own value 8035 [snip] 8036 10 / Google Drive 8037 \ "drive" 8038 [snip] 8039 Storage> drive 8040 Google Application Client Id - leave blank normally. 8041 client_id> 8042 Google Application Client Secret - leave blank normally. 8043 client_secret> 8044 Scope that rclone should use when requesting access from drive. 8045 Choose a number from below, or type in your own value 8046 1 / Full access all files, excluding Application Data Folder. 8047 \ "drive" 8048 2 / Read-only access to file metadata and file contents. 8049 \ "drive.readonly" 8050 / Access to files created by rclone only. 8051 3 | These are visible in the drive website. 8052 | File authorization is revoked when the user deauthorizes the app. 8053 \ "drive.file" 8054 / Allows read and write access to the Application Data folder. 8055 4 | This is not visible in the drive website. 8056 \ "drive.appfolder" 8057 / Allows read-only access to file metadata but 8058 5 | does not allow any access to read or download file content. 8059 \ "drive.metadata.readonly" 8060 scope> 1 8061 ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). 8062 root_folder_id> 8063 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. 8064 service_account_file> 8065 Remote config 8066 Use auto config? 8067 * Say Y if not sure 8068 * Say N if you are working on a remote or headless machine or Y didn't work 8069 y) Yes 8070 n) No 8071 y/n> y 8072 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 8073 Log in and authorize rclone for access 8074 Waiting for code... 8075 Got code 8076 Configure this as a team drive? 8077 y) Yes 8078 n) No 8079 y/n> n 8080 -------------------- 8081 [remote] 8082 client_id = 8083 client_secret = 8084 scope = drive 8085 root_folder_id = 8086 service_account_file = 8087 token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} 8088 -------------------- 8089 y) Yes this is OK 8090 e) Edit this remote 8091 d) Delete this remote 8092 y/e/d> y</code></pre> 8093 <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> 8094 <p>You can then use it like this,</p> 8095 <p>List directories in top level of your drive</p> 8096 <pre><code>rclone lsd remote:</code></pre> 8097 <p>List all the files in your drive</p> 8098 <pre><code>rclone ls remote:</code></pre> 8099 <p>To copy a local directory to a drive directory called backup</p> 8100 <pre><code>rclone copy /home/source remote:backup</code></pre> 8101 <h3 id="scopes">Scopes</h3> 8102 <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> 8103 <p>The scope are</p> 8104 <h4 id="drive">drive</h4> 8105 <p>This is the default scope and allows full access to all files, except for the Application Data Folder (see below).</p> 8106 <p>Choose this one if you aren’t sure.</p> 8107 <h4 id="drive.readonly">drive.readonly</h4> 8108 <p>This allows read only access to all files. Files may be listed and downloaded but not uploaded, renamed or deleted.</p> 8109 <h4 id="drive.file">drive.file</h4> 8110 <p>With this scope rclone can read/view/modify only those files and folders it creates.</p> 8111 <p>So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone.</p> 8112 <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> 8113 <p>Files created with this scope are visible in the web interface.</p> 8114 <h4 id="drive.appfolder">drive.appfolder</h4> 8115 <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> 8116 <h4 id="drive.metadata.readonly">drive.metadata.readonly</h4> 8117 <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> 8118 <h3 id="root-folder-id">Root folder ID</h3> 8119 <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> 8120 <p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p> 8121 <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> 8122 <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> 8123 <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> 8124 <p><strong>NB</strong> folders under the “Computers” tab seem to be read only (drive gives a 500 error) when using rclone.</p> 8125 <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> 8126 <p>Note also that rclone can’t access any data under the “Backups” tab on the google drive web interface yet.</p> 8127 <h3 id="service-account-support-1">Service Account support</h3> 8128 <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> 8129 <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> 8130 <h4 id="use-case---google-appsg-suite-account-and-individual-drive">Use case - Google Apps/G-suite account and individual Drive</h4> 8131 <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> 8132 <p>There’s a few steps we need to go through to accomplish this:</p> 8133 <h5 id="create-a-service-account-for-example.com">1. Create a service account for example.com</h5> 8134 <ul> 8135 <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> 8136 <li>You must have a project - create one if you don’t.</li> 8137 <li>Then go to “IAM & admin” -> “Service Accounts”.</li> 8138 <li>Use the “Create Credentials” button. Fill in “Service account name” with something that identifies your client. “Role” can be empty.</li> 8139 <li>Tick “Furnish a new private key” - select “Key type JSON”.</li> 8140 <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> 8141 <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> 8142 </ul> 8143 <h5 id="allowing-api-access-to-example.com-google-drive">2. Allowing API access to example.com Google Drive</h5> 8144 <ul> 8145 <li>Go to example.com’s admin console</li> 8146 <li>Go into “Security” (or use the search bar)</li> 8147 <li>Select “Show more” and then “Advanced settings”</li> 8148 <li>Select “Manage API client access” in the “Authentication” section</li> 8149 <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> 8150 <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> 8151 </ul> 8152 <h5 id="configure-rclone-assuming-a-new-install">3. Configure rclone, assuming a new install</h5> 8153 <pre><code>rclone config 8154 8155 n/s/q> n # New 8156 name>gdrive # Gdrive is an example name 8157 Storage> # Select the number shown for Google Drive 8158 client_id> # Can be left blank 8159 client_secret> # Can be left blank 8160 scope> # Select your scope, 1 for example 8161 root_folder_id> # Can be left blank 8162 service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! 8163 y/n> # Auto config, y 8164 </code></pre> 8165 <h5 id="verify-that-its-working">4. Verify that it’s working</h5> 8166 <ul> 8167 <li><code>rclone -v --drive-impersonate foo@example.com lsf gdrive:backup</code></li> 8168 <li>The arguments do: 8169 <ul> 8170 <li><code>-v</code> - verbose logging</li> 8171 <li><code>--drive-impersonate foo@example.com</code> - this is what does the magic, pretending to be user foo.</li> 8172 <li><code>lsf</code> - list files in a parsing friendly way</li> 8173 <li><code>gdrive:backup</code> - use the remote called gdrive, work in the folder named backup.</li> 8174 </ul></li> 8175 </ul> 8176 <h3 id="team-drives">Team drives</h3> 8177 <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> 8178 <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> 8179 <p>For example:</p> 8180 <pre><code>Configure this as a team drive? 8181 y) Yes 8182 n) No 8183 y/n> y 8184 Fetching team drive list... 8185 Choose a number from below, or type in your own value 8186 1 / Rclone Test 8187 \ "xxxxxxxxxxxxxxxxxxxx" 8188 2 / Rclone Test 2 8189 \ "yyyyyyyyyyyyyyyyyyyy" 8190 3 / Rclone Test 3 8191 \ "zzzzzzzzzzzzzzzzzzzz" 8192 Enter a Team Drive ID> 1 8193 -------------------- 8194 [remote] 8195 client_id = 8196 client_secret = 8197 token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} 8198 team_drive = xxxxxxxxxxxxxxxxxxxx 8199 -------------------- 8200 y) Yes this is OK 8201 e) Edit this remote 8202 d) Delete this remote 8203 y/e/d> y</code></pre> 8204 <h3 id="fast-list-4">–fast-list</h3> 8205 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 8206 <p>It does this by combining multiple <code>list</code> calls into a single API request.</p> 8207 <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> 8208 <pre><code>trashed=false and 'a' in parents 8209 trashed=false and 'b' in parents 8210 trashed=false and 'c' in parents</code></pre> 8211 <p>These can now be combined into a single request:</p> 8212 <pre><code>trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)</code></pre> 8213 <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> 8214 <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> 8215 <pre><code>rclone lsjson -vv -R --checkers=6 gdrive:folder</code></pre> 8216 <p>small folder (220 directories, 700 files):</p> 8217 <ul> 8218 <li>without <code>--fast-list</code>: 38s</li> 8219 <li>with <code>--fast-list</code>: 10s</li> 8220 </ul> 8221 <p>large folder (10600 directories, 39000 files):</p> 8222 <ul> 8223 <li>without <code>--fast-list</code>: 22:05 min</li> 8224 <li>with <code>--fast-list</code>: 58s</li> 8225 </ul> 8226 <h3 id="modified-time-4">Modified time</h3> 8227 <p>Google drive stores modification times accurate to 1 ms.</p> 8228 <h3 id="revisions">Revisions</h3> 8229 <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> 8230 <p>Revisions follow the standard google policy which at time of writing was</p> 8231 <ul> 8232 <li>They are deleted after 30 days or 100 revisions (whatever comes first).</li> 8233 <li>They do not count towards a user storage quota.</li> 8234 </ul> 8235 <h3 id="deleting-files-2">Deleting files</h3> 8236 <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> 8237 <h3 id="emptying-trash">Emptying trash</h3> 8238 <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> 8239 <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> 8240 <h3 id="quota-information">Quota information</h3> 8241 <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> 8242 <h4 id="importexport-of-google-documents">Import/Export of google documents</h4> 8243 <p>Google documents can be exported from and uploaded to Google Drive.</p> 8244 <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> 8245 <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> 8246 <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> 8247 <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> 8248 <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> 8249 <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> 8250 <p>Here are some examples for allowed and prohibited conversions.</p> 8251 <table> 8252 <thead> 8253 <tr class="header"> 8254 <th>export-formats</th> 8255 <th>import-formats</th> 8256 <th>Upload Ext</th> 8257 <th>Document Ext</th> 8258 <th>Allowed</th> 8259 </tr> 8260 </thead> 8261 <tbody> 8262 <tr class="odd"> 8263 <td>odt</td> 8264 <td>odt</td> 8265 <td>odt</td> 8266 <td>odt</td> 8267 <td>Yes</td> 8268 </tr> 8269 <tr class="even"> 8270 <td>odt</td> 8271 <td>docx,odt</td> 8272 <td>odt</td> 8273 <td>odt</td> 8274 <td>Yes</td> 8275 </tr> 8276 <tr class="odd"> 8277 <td></td> 8278 <td>docx</td> 8279 <td>docx</td> 8280 <td>docx</td> 8281 <td>Yes</td> 8282 </tr> 8283 <tr class="even"> 8284 <td></td> 8285 <td>odt</td> 8286 <td>odt</td> 8287 <td>docx</td> 8288 <td>No</td> 8289 </tr> 8290 <tr class="odd"> 8291 <td>odt,docx</td> 8292 <td>docx,odt</td> 8293 <td>docx</td> 8294 <td>odt</td> 8295 <td>No</td> 8296 </tr> 8297 <tr class="even"> 8298 <td>docx,odt</td> 8299 <td>docx,odt</td> 8300 <td>docx</td> 8301 <td>docx</td> 8302 <td>Yes</td> 8303 </tr> 8304 <tr class="odd"> 8305 <td>docx,odt</td> 8306 <td>docx,odt</td> 8307 <td>odt</td> 8308 <td>docx</td> 8309 <td>No</td> 8310 </tr> 8311 </tbody> 8312 </table> 8313 <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> 8314 <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> 8315 <p>This list can be changed by Google Drive at any time and might not represent the currently available conversions.</p> 8316 <table> 8317 <colgroup> 8318 <col style="width: 28%" /> 8319 <col style="width: 34%" /> 8320 <col style="width: 37%" /> 8321 </colgroup> 8322 <thead> 8323 <tr class="header"> 8324 <th>Extension</th> 8325 <th>Mime Type</th> 8326 <th>Description</th> 8327 </tr> 8328 </thead> 8329 <tbody> 8330 <tr class="odd"> 8331 <td>csv</td> 8332 <td>text/csv</td> 8333 <td>Standard CSV format for Spreadsheets</td> 8334 </tr> 8335 <tr class="even"> 8336 <td>docx</td> 8337 <td>application/vnd.openxmlformats-officedocument.wordprocessingml.document</td> 8338 <td>Microsoft Office Document</td> 8339 </tr> 8340 <tr class="odd"> 8341 <td>epub</td> 8342 <td>application/epub+zip</td> 8343 <td>E-book format</td> 8344 </tr> 8345 <tr class="even"> 8346 <td>html</td> 8347 <td>text/html</td> 8348 <td>An HTML Document</td> 8349 </tr> 8350 <tr class="odd"> 8351 <td>jpg</td> 8352 <td>image/jpeg</td> 8353 <td>A JPEG Image File</td> 8354 </tr> 8355 <tr class="even"> 8356 <td>json</td> 8357 <td>application/vnd.google-apps.script+json</td> 8358 <td>JSON Text Format</td> 8359 </tr> 8360 <tr class="odd"> 8361 <td>odp</td> 8362 <td>application/vnd.oasis.opendocument.presentation</td> 8363 <td>Openoffice Presentation</td> 8364 </tr> 8365 <tr class="even"> 8366 <td>ods</td> 8367 <td>application/vnd.oasis.opendocument.spreadsheet</td> 8368 <td>Openoffice Spreadsheet</td> 8369 </tr> 8370 <tr class="odd"> 8371 <td>ods</td> 8372 <td>application/x-vnd.oasis.opendocument.spreadsheet</td> 8373 <td>Openoffice Spreadsheet</td> 8374 </tr> 8375 <tr class="even"> 8376 <td>odt</td> 8377 <td>application/vnd.oasis.opendocument.text</td> 8378 <td>Openoffice Document</td> 8379 </tr> 8380 <tr class="odd"> 8381 <td>pdf</td> 8382 <td>application/pdf</td> 8383 <td>Adobe PDF Format</td> 8384 </tr> 8385 <tr class="even"> 8386 <td>png</td> 8387 <td>image/png</td> 8388 <td>PNG Image Format</td> 8389 </tr> 8390 <tr class="odd"> 8391 <td>pptx</td> 8392 <td>application/vnd.openxmlformats-officedocument.presentationml.presentation</td> 8393 <td>Microsoft Office Powerpoint</td> 8394 </tr> 8395 <tr class="even"> 8396 <td>rtf</td> 8397 <td>application/rtf</td> 8398 <td>Rich Text Format</td> 8399 </tr> 8400 <tr class="odd"> 8401 <td>svg</td> 8402 <td>image/svg+xml</td> 8403 <td>Scalable Vector Graphics Format</td> 8404 </tr> 8405 <tr class="even"> 8406 <td>tsv</td> 8407 <td>text/tab-separated-values</td> 8408 <td>Standard TSV format for spreadsheets</td> 8409 </tr> 8410 <tr class="odd"> 8411 <td>txt</td> 8412 <td>text/plain</td> 8413 <td>Plain Text</td> 8414 </tr> 8415 <tr class="even"> 8416 <td>xlsx</td> 8417 <td>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td> 8418 <td>Microsoft Office Spreadsheet</td> 8419 </tr> 8420 <tr class="odd"> 8421 <td>zip</td> 8422 <td>application/zip</td> 8423 <td>A ZIP file of HTML, Images CSS</td> 8424 </tr> 8425 </tbody> 8426 </table> 8427 <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> 8428 <table> 8429 <thead> 8430 <tr class="header"> 8431 <th>Extension</th> 8432 <th>Description</th> 8433 <th>OS Support</th> 8434 </tr> 8435 </thead> 8436 <tbody> 8437 <tr class="odd"> 8438 <td>desktop</td> 8439 <td>freedesktop.org specified desktop entry</td> 8440 <td>Linux</td> 8441 </tr> 8442 <tr class="even"> 8443 <td>link.html</td> 8444 <td>An HTML Document with a redirect</td> 8445 <td>All</td> 8446 </tr> 8447 <tr class="odd"> 8448 <td>url</td> 8449 <td>INI style link file</td> 8450 <td>macOS, Windows</td> 8451 </tr> 8452 <tr class="even"> 8453 <td>webloc</td> 8454 <td>macOS specific XML format</td> 8455 <td>macOS</td> 8456 </tr> 8457 </tbody> 8458 </table> 8459 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/drive/drive.go then run make backenddocs --> 8460 <h3 id="standard-options-10">Standard Options</h3> 8461 <p>Here are the standard options specific to drive (Google Drive).</p> 8462 <h4 id="drive-client-id">–drive-client-id</h4> 8463 <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> 8464 <ul> 8465 <li>Config: client_id</li> 8466 <li>Env Var: RCLONE_DRIVE_CLIENT_ID</li> 8467 <li>Type: string</li> 8468 <li>Default: ""</li> 8469 </ul> 8470 <h4 id="drive-client-secret">–drive-client-secret</h4> 8471 <p>Google Application Client Secret Setting your own is recommended.</p> 8472 <ul> 8473 <li>Config: client_secret</li> 8474 <li>Env Var: RCLONE_DRIVE_CLIENT_SECRET</li> 8475 <li>Type: string</li> 8476 <li>Default: ""</li> 8477 </ul> 8478 <h4 id="drive-scope">–drive-scope</h4> 8479 <p>Scope that rclone should use when requesting access from drive.</p> 8480 <ul> 8481 <li>Config: scope</li> 8482 <li>Env Var: RCLONE_DRIVE_SCOPE</li> 8483 <li>Type: string</li> 8484 <li>Default: ""</li> 8485 <li>Examples: 8486 <ul> 8487 <li>“drive” 8488 <ul> 8489 <li>Full access all files, excluding Application Data Folder.</li> 8490 </ul></li> 8491 <li>“drive.readonly” 8492 <ul> 8493 <li>Read-only access to file metadata and file contents.</li> 8494 </ul></li> 8495 <li>“drive.file” 8496 <ul> 8497 <li>Access to files created by rclone only.</li> 8498 <li>These are visible in the drive website.</li> 8499 <li>File authorization is revoked when the user deauthorizes the app.</li> 8500 </ul></li> 8501 <li>“drive.appfolder” 8502 <ul> 8503 <li>Allows read and write access to the Application Data folder.</li> 8504 <li>This is not visible in the drive website.</li> 8505 </ul></li> 8506 <li>“drive.metadata.readonly” 8507 <ul> 8508 <li>Allows read-only access to file metadata but</li> 8509 <li>does not allow any access to read or download file content.</li> 8510 </ul></li> 8511 </ul></li> 8512 </ul> 8513 <h4 id="drive-root-folder-id">–drive-root-folder-id</h4> 8514 <p>ID of the root folder Leave blank normally. Fill in to access “Computers” folders. (see docs).</p> 8515 <ul> 8516 <li>Config: root_folder_id</li> 8517 <li>Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID</li> 8518 <li>Type: string</li> 8519 <li>Default: ""</li> 8520 </ul> 8521 <h4 id="drive-service-account-file">–drive-service-account-file</h4> 8522 <p>Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 8523 <ul> 8524 <li>Config: service_account_file</li> 8525 <li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE</li> 8526 <li>Type: string</li> 8527 <li>Default: ""</li> 8528 </ul> 8529 <h3 id="advanced-options-8">Advanced Options</h3> 8530 <p>Here are the advanced options specific to drive (Google Drive).</p> 8531 <h4 id="drive-service-account-credentials">–drive-service-account-credentials</h4> 8532 <p>Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.</p> 8533 <ul> 8534 <li>Config: service_account_credentials</li> 8535 <li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS</li> 8536 <li>Type: string</li> 8537 <li>Default: ""</li> 8538 </ul> 8539 <h4 id="drive-team-drive">–drive-team-drive</h4> 8540 <p>ID of the Team Drive</p> 8541 <ul> 8542 <li>Config: team_drive</li> 8543 <li>Env Var: RCLONE_DRIVE_TEAM_DRIVE</li> 8544 <li>Type: string</li> 8545 <li>Default: ""</li> 8546 </ul> 8547 <h4 id="drive-auth-owner-only">–drive-auth-owner-only</h4> 8548 <p>Only consider files owned by the authenticated user.</p> 8549 <ul> 8550 <li>Config: auth_owner_only</li> 8551 <li>Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY</li> 8552 <li>Type: bool</li> 8553 <li>Default: false</li> 8554 </ul> 8555 <h4 id="drive-use-trash">–drive-use-trash</h4> 8556 <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> 8557 <ul> 8558 <li>Config: use_trash</li> 8559 <li>Env Var: RCLONE_DRIVE_USE_TRASH</li> 8560 <li>Type: bool</li> 8561 <li>Default: true</li> 8562 </ul> 8563 <h4 id="drive-skip-gdocs">–drive-skip-gdocs</h4> 8564 <p>Skip google documents in all listings. If given, gdocs practically become invisible to rclone.</p> 8565 <ul> 8566 <li>Config: skip_gdocs</li> 8567 <li>Env Var: RCLONE_DRIVE_SKIP_GDOCS</li> 8568 <li>Type: bool</li> 8569 <li>Default: false</li> 8570 </ul> 8571 <h4 id="drive-skip-checksum-gphotos">–drive-skip-checksum-gphotos</h4> 8572 <p>Skip MD5 checksum on Google photos and videos only.</p> 8573 <p>Use this if you get checksum errors when transferring Google photos or videos.</p> 8574 <p>Setting this flag will cause Google photos and videos to return a blank MD5 checksum.</p> 8575 <p>Google photos are identifed by being in the “photos” space.</p> 8576 <p>Corrupted checksums are caused by Google modifying the image/video but not updating the checksum.</p> 8577 <ul> 8578 <li>Config: skip_checksum_gphotos</li> 8579 <li>Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS</li> 8580 <li>Type: bool</li> 8581 <li>Default: false</li> 8582 </ul> 8583 <h4 id="drive-shared-with-me">–drive-shared-with-me</h4> 8584 <p>Only show files that are shared with me.</p> 8585 <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> 8586 <p>This works both with the “list” (lsd, lsl, etc) and the “copy” commands (copy, sync, etc), and with all other commands too.</p> 8587 <ul> 8588 <li>Config: shared_with_me</li> 8589 <li>Env Var: RCLONE_DRIVE_SHARED_WITH_ME</li> 8590 <li>Type: bool</li> 8591 <li>Default: false</li> 8592 </ul> 8593 <h4 id="drive-trashed-only">–drive-trashed-only</h4> 8594 <p>Only show files that are in the trash. This will show trashed files in their original directory structure.</p> 8595 <ul> 8596 <li>Config: trashed_only</li> 8597 <li>Env Var: RCLONE_DRIVE_TRASHED_ONLY</li> 8598 <li>Type: bool</li> 8599 <li>Default: false</li> 8600 </ul> 8601 <h4 id="drive-formats">–drive-formats</h4> 8602 <p>Deprecated: see export_formats</p> 8603 <ul> 8604 <li>Config: formats</li> 8605 <li>Env Var: RCLONE_DRIVE_FORMATS</li> 8606 <li>Type: string</li> 8607 <li>Default: ""</li> 8608 </ul> 8609 <h4 id="drive-export-formats">–drive-export-formats</h4> 8610 <p>Comma separated list of preferred formats for downloading Google docs.</p> 8611 <ul> 8612 <li>Config: export_formats</li> 8613 <li>Env Var: RCLONE_DRIVE_EXPORT_FORMATS</li> 8614 <li>Type: string</li> 8615 <li>Default: “docx,xlsx,pptx,svg”</li> 8616 </ul> 8617 <h4 id="drive-import-formats">–drive-import-formats</h4> 8618 <p>Comma separated list of preferred formats for uploading Google docs.</p> 8619 <ul> 8620 <li>Config: import_formats</li> 8621 <li>Env Var: RCLONE_DRIVE_IMPORT_FORMATS</li> 8622 <li>Type: string</li> 8623 <li>Default: ""</li> 8624 </ul> 8625 <h4 id="drive-allow-import-name-change">–drive-allow-import-name-change</h4> 8626 <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> 8627 <ul> 8628 <li>Config: allow_import_name_change</li> 8629 <li>Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE</li> 8630 <li>Type: bool</li> 8631 <li>Default: false</li> 8632 </ul> 8633 <h4 id="drive-use-created-date">–drive-use-created-date</h4> 8634 <p>Use file created date instead of modified date.,</p> 8635 <p>Useful when downloading data and you want the creation date used in place of the last modified date.</p> 8636 <p><strong>WARNING</strong>: This flag may have some unexpected consequences.</p> 8637 <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> 8638 <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> 8639 <ul> 8640 <li>Config: use_created_date</li> 8641 <li>Env Var: RCLONE_DRIVE_USE_CREATED_DATE</li> 8642 <li>Type: bool</li> 8643 <li>Default: false</li> 8644 </ul> 8645 <h4 id="drive-list-chunk">–drive-list-chunk</h4> 8646 <p>Size of listing chunk 100-1000. 0 to disable.</p> 8647 <ul> 8648 <li>Config: list_chunk</li> 8649 <li>Env Var: RCLONE_DRIVE_LIST_CHUNK</li> 8650 <li>Type: int</li> 8651 <li>Default: 1000</li> 8652 </ul> 8653 <h4 id="drive-impersonate">–drive-impersonate</h4> 8654 <p>Impersonate this user when using a service account.</p> 8655 <ul> 8656 <li>Config: impersonate</li> 8657 <li>Env Var: RCLONE_DRIVE_IMPERSONATE</li> 8658 <li>Type: string</li> 8659 <li>Default: ""</li> 8660 </ul> 8661 <h4 id="drive-alternate-export">–drive-alternate-export</h4> 8662 <p>Use alternate export URLs for google documents export.,</p> 8663 <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> 8664 <p>See rclone issue <a href="https://github.com/ncw/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> 8665 <ul> 8666 <li>Config: alternate_export</li> 8667 <li>Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT</li> 8668 <li>Type: bool</li> 8669 <li>Default: false</li> 8670 </ul> 8671 <h4 id="drive-upload-cutoff">–drive-upload-cutoff</h4> 8672 <p>Cutoff for switching to chunked upload</p> 8673 <ul> 8674 <li>Config: upload_cutoff</li> 8675 <li>Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF</li> 8676 <li>Type: SizeSuffix</li> 8677 <li>Default: 8M</li> 8678 </ul> 8679 <h4 id="drive-chunk-size">–drive-chunk-size</h4> 8680 <p>Upload chunk size. Must a power of 2 >= 256k.</p> 8681 <p>Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.</p> 8682 <p>Reducing this will reduce memory usage but decrease performance.</p> 8683 <ul> 8684 <li>Config: chunk_size</li> 8685 <li>Env Var: RCLONE_DRIVE_CHUNK_SIZE</li> 8686 <li>Type: SizeSuffix</li> 8687 <li>Default: 8M</li> 8688 </ul> 8689 <h4 id="drive-acknowledge-abuse">–drive-acknowledge-abuse</h4> 8690 <p>Set to allow files which return cannotDownloadAbusiveFile to be downloaded.</p> 8691 <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> 8692 <ul> 8693 <li>Config: acknowledge_abuse</li> 8694 <li>Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE</li> 8695 <li>Type: bool</li> 8696 <li>Default: false</li> 8697 </ul> 8698 <h4 id="drive-keep-revision-forever">–drive-keep-revision-forever</h4> 8699 <p>Keep new head revision of each file forever.</p> 8700 <ul> 8701 <li>Config: keep_revision_forever</li> 8702 <li>Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER</li> 8703 <li>Type: bool</li> 8704 <li>Default: false</li> 8705 </ul> 8706 <h4 id="drive-size-as-quota">–drive-size-as-quota</h4> 8707 <p>Show storage quota usage for file size.</p> 8708 <p>The storage used by a file is the size of the current version plus any older versions that have been set to keep forever.</p> 8709 <ul> 8710 <li>Config: size_as_quota</li> 8711 <li>Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA</li> 8712 <li>Type: bool</li> 8713 <li>Default: false</li> 8714 </ul> 8715 <h4 id="drive-v2-download-min-size">–drive-v2-download-min-size</h4> 8716 <p>If Object’s are greater, use drive v2 API to download.</p> 8717 <ul> 8718 <li>Config: v2_download_min_size</li> 8719 <li>Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE</li> 8720 <li>Type: SizeSuffix</li> 8721 <li>Default: off</li> 8722 </ul> 8723 <h4 id="drive-pacer-min-sleep">–drive-pacer-min-sleep</h4> 8724 <p>Minimum time to sleep between API calls.</p> 8725 <ul> 8726 <li>Config: pacer_min_sleep</li> 8727 <li>Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP</li> 8728 <li>Type: Duration</li> 8729 <li>Default: 100ms</li> 8730 </ul> 8731 <h4 id="drive-pacer-burst">–drive-pacer-burst</h4> 8732 <p>Number of API calls to allow without sleeping.</p> 8733 <ul> 8734 <li>Config: pacer_burst</li> 8735 <li>Env Var: RCLONE_DRIVE_PACER_BURST</li> 8736 <li>Type: int</li> 8737 <li>Default: 100</li> 8738 </ul> 8739 <h4 id="drive-server-side-across-configs">–drive-server-side-across-configs</h4> 8740 <p>Allow server side operations (eg copy) to work across different drive configs.</p> 8741 <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 beween any two configurations.</p> 8742 <ul> 8743 <li>Config: server_side_across_configs</li> 8744 <li>Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS</li> 8745 <li>Type: bool</li> 8746 <li>Default: false</li> 8747 </ul> 8748 <!--- autogenerated options stop --> 8749 <h3 id="limitations-5">Limitations</h3> 8750 <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> 8751 <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> 8752 <h4 id="limitations-of-google-docs">Limitations of Google Docs</h4> 8753 <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> 8754 <p>This is because rclone can’t find out the size of the Google docs without downloading them.</p> 8755 <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> 8756 <p>However an unfortunate consequence of this is that you can’t download Google docs using <code>rclone mount</code> - you will get a 0 sized file. If you try again the doc may gain its correct size and be downloadable.</p> 8757 <h3 id="duplicated-files">Duplicated files</h3> 8758 <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> 8759 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 8760 <p>Use <code>rclone dedupe</code> to fix duplicated files.</p> 8761 <p>Note that this isn’t just a problem with rclone, even Google Photos on Android duplicates files on drive sometimes.</p> 8762 <h3 id="rclone-appears-to-be-re-copying-files-it-shouldnt">Rclone appears to be re-copying files it shouldn’t</h3> 8763 <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> 8764 <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> 8765 <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> 8766 <h3 id="making-your-own-client_id">Making your own client_id</h3> 8767 <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> 8768 <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> 8769 <p>Here is how to create your own Google Drive client ID for rclone:</p> 8770 <ol type="1"> 8771 <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> 8772 <li><p>Select a project or create a new project.</p></li> 8773 <li><p>Under “ENABLE APIS AND SERVICES” search for “Drive”, and enable the then “Google Drive API”.</p></li> 8774 <li><p>Click “Credentials” in the left-side panel (not “Create credentials”, which opens the wizard), then “Create credentials”, then “OAuth client ID”. It will prompt you to set the OAuth consent screen product name, if you haven’t set one already.</p></li> 8775 <li><p>Choose an application type of “other”, and click “Create”. (the default name is fine)</p></li> 8776 <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> 8777 </ol> 8778 <p>(Thanks to <span class="citation" data-cites="balazer">@balazer</span> on github for these instructions.)</p> 8779 <h2 id="http">HTTP</h2> 8780 <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> 8781 <p>Paths are specified as <code>remote:</code> or <code>remote:path/to/dir</code>.</p> 8782 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 8783 <pre><code> rclone config</code></pre> 8784 <p>This will guide you through an interactive setup process:</p> 8785 <pre><code>No remotes found - make a new one 8786 n) New remote 8787 s) Set configuration password 8788 q) Quit config 8789 n/s/q> n 8790 name> remote 8791 Type of storage to configure. 8792 Choose a number from below, or type in your own value 8793 1 / Amazon Drive 8794 \ "amazon cloud drive" 8795 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 8796 \ "s3" 8797 3 / Backblaze B2 8798 \ "b2" 8799 4 / Dropbox 8800 \ "dropbox" 8801 5 / Encrypt/Decrypt a remote 8802 \ "crypt" 8803 6 / FTP Connection 8804 \ "ftp" 8805 7 / Google Cloud Storage (this is not Google Drive) 8806 \ "google cloud storage" 8807 8 / Google Drive 8808 \ "drive" 8809 9 / Hubic 8810 \ "hubic" 8811 10 / Local Disk 8812 \ "local" 8813 11 / Microsoft OneDrive 8814 \ "onedrive" 8815 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 8816 \ "swift" 8817 13 / SSH/SFTP Connection 8818 \ "sftp" 8819 14 / Yandex Disk 8820 \ "yandex" 8821 15 / http Connection 8822 \ "http" 8823 Storage> http 8824 URL of http host to connect to 8825 Choose a number from below, or type in your own value 8826 1 / Connect to example.com 8827 \ "https://example.com" 8828 url> https://beta.rclone.org 8829 Remote config 8830 -------------------- 8831 [remote] 8832 url = https://beta.rclone.org 8833 -------------------- 8834 y) Yes this is OK 8835 e) Edit this remote 8836 d) Delete this remote 8837 y/e/d> y 8838 Current remotes: 8839 8840 Name Type 8841 ==== ==== 8842 remote http 8843 8844 e) Edit existing remote 8845 n) New remote 8846 d) Delete remote 8847 r) Rename remote 8848 c) Copy remote 8849 s) Set configuration password 8850 q) Quit config 8851 e/n/d/r/c/s/q> q</code></pre> 8852 <p>This remote is called <code>remote</code> and can now be used like this</p> 8853 <p>See all the top level directories</p> 8854 <pre><code>rclone lsd remote:</code></pre> 8855 <p>List the contents of a directory</p> 8856 <pre><code>rclone ls remote:directory</code></pre> 8857 <p>Sync the remote <code>directory</code> to <code>/home/local/directory</code>, deleting any excess files.</p> 8858 <pre><code>rclone sync remote:directory /home/local/directory</code></pre> 8859 <h3 id="read-only">Read only</h3> 8860 <p>This remote is read only - you can’t upload files to an HTTP server.</p> 8861 <h3 id="modified-time-5">Modified time</h3> 8862 <p>Most HTTP servers store time accurate to 1 second.</p> 8863 <h3 id="checksum">Checksum</h3> 8864 <p>No checksums are stored.</p> 8865 <h3 id="usage-without-a-config-file">Usage without a config file</h3> 8866 <p>Since the http remote only has one config parameter it is easy to use without a config file:</p> 8867 <pre><code>rclone lsd --http-url https://beta.rclone.org :http:</code></pre> 8868 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/http/http.go then run make backenddocs --> 8869 <h3 id="standard-options-11">Standard Options</h3> 8870 <p>Here are the standard options specific to http (http Connection).</p> 8871 <h4 id="http-url">–http-url</h4> 8872 <p>URL of http host to connect to</p> 8873 <ul> 8874 <li>Config: url</li> 8875 <li>Env Var: RCLONE_HTTP_URL</li> 8876 <li>Type: string</li> 8877 <li>Default: ""</li> 8878 <li>Examples: 8879 <ul> 8880 <li>“https://example.com” 8881 <ul> 8882 <li>Connect to example.com</li> 8883 </ul></li> 8884 <li>“https://user:pass@example.com” 8885 <ul> 8886 <li>Connect to example.com using a username and password</li> 8887 </ul></li> 8888 </ul></li> 8889 </ul> 8890 <h3 id="advanced-options-9">Advanced Options</h3> 8891 <p>Here are the advanced options specific to http (http Connection).</p> 8892 <h4 id="http-no-slash">–http-no-slash</h4> 8893 <p>Set this if the site doesn’t end directories with /</p> 8894 <p>Use this if your target website does not use / on the end of directories.</p> 8895 <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> 8896 <p>Note that this may cause rclone to confuse genuine HTML files with directories.</p> 8897 <ul> 8898 <li>Config: no_slash</li> 8899 <li>Env Var: RCLONE_HTTP_NO_SLASH</li> 8900 <li>Type: bool</li> 8901 <li>Default: false</li> 8902 </ul> 8903 <!--- autogenerated options stop --> 8904 <h2 id="hubic">Hubic</h2> 8905 <p>Paths are specified as <code>remote:path</code></p> 8906 <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> 8907 <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> 8908 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 8909 <pre><code> rclone config</code></pre> 8910 <p>This will guide you through an interactive setup process:</p> 8911 <pre><code>n) New remote 8912 s) Set configuration password 8913 n/s> n 8914 name> remote 8915 Type of storage to configure. 8916 Choose a number from below, or type in your own value 8917 1 / Amazon Drive 8918 \ "amazon cloud drive" 8919 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 8920 \ "s3" 8921 3 / Backblaze B2 8922 \ "b2" 8923 4 / Dropbox 8924 \ "dropbox" 8925 5 / Encrypt/Decrypt a remote 8926 \ "crypt" 8927 6 / Google Cloud Storage (this is not Google Drive) 8928 \ "google cloud storage" 8929 7 / Google Drive 8930 \ "drive" 8931 8 / Hubic 8932 \ "hubic" 8933 9 / Local Disk 8934 \ "local" 8935 10 / Microsoft OneDrive 8936 \ "onedrive" 8937 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 8938 \ "swift" 8939 12 / SSH/SFTP Connection 8940 \ "sftp" 8941 13 / Yandex Disk 8942 \ "yandex" 8943 Storage> 8 8944 Hubic Client Id - leave blank normally. 8945 client_id> 8946 Hubic Client Secret - leave blank normally. 8947 client_secret> 8948 Remote config 8949 Use auto config? 8950 * Say Y if not sure 8951 * Say N if you are working on a remote or headless machine 8952 y) Yes 8953 n) No 8954 y/n> y 8955 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 8956 Log in and authorize rclone for access 8957 Waiting for code... 8958 Got code 8959 -------------------- 8960 [remote] 8961 client_id = 8962 client_secret = 8963 token = {"access_token":"XXXXXX"} 8964 -------------------- 8965 y) Yes this is OK 8966 e) Edit this remote 8967 d) Delete this remote 8968 y/e/d> y</code></pre> 8969 <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> 8970 <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> 8971 <p>Once configured you can then use <code>rclone</code> like this,</p> 8972 <p>List containers in the top level of your Hubic</p> 8973 <pre><code>rclone lsd remote:</code></pre> 8974 <p>List all the files in your Hubic</p> 8975 <pre><code>rclone ls remote:</code></pre> 8976 <p>To copy a local directory to an Hubic directory called backup</p> 8977 <pre><code>rclone copy /home/source remote:backup</code></pre> 8978 <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> 8979 <pre><code>rclone copy /home/source remote:default/backup</code></pre> 8980 <h3 id="fast-list-5">–fast-list</h3> 8981 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 8982 <h3 id="modified-time-6">Modified time</h3> 8983 <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> 8984 <p>This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p> 8985 <p>Note that Hubic wraps the Swift backend, so most of the properties of are the same.</p> 8986 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/hubic/hubic.go then run make backenddocs --> 8987 <h3 id="standard-options-12">Standard Options</h3> 8988 <p>Here are the standard options specific to hubic (Hubic).</p> 8989 <h4 id="hubic-client-id">–hubic-client-id</h4> 8990 <p>Hubic Client Id Leave blank normally.</p> 8991 <ul> 8992 <li>Config: client_id</li> 8993 <li>Env Var: RCLONE_HUBIC_CLIENT_ID</li> 8994 <li>Type: string</li> 8995 <li>Default: ""</li> 8996 </ul> 8997 <h4 id="hubic-client-secret">–hubic-client-secret</h4> 8998 <p>Hubic Client Secret Leave blank normally.</p> 8999 <ul> 9000 <li>Config: client_secret</li> 9001 <li>Env Var: RCLONE_HUBIC_CLIENT_SECRET</li> 9002 <li>Type: string</li> 9003 <li>Default: ""</li> 9004 </ul> 9005 <h3 id="advanced-options-10">Advanced Options</h3> 9006 <p>Here are the advanced options specific to hubic (Hubic).</p> 9007 <h4 id="hubic-chunk-size">–hubic-chunk-size</h4> 9008 <p>Above this size files will be chunked into a _segments container.</p> 9009 <p>Above this size files will be chunked into a _segments container. The default for this is 5GB which is its maximum value.</p> 9010 <ul> 9011 <li>Config: chunk_size</li> 9012 <li>Env Var: RCLONE_HUBIC_CHUNK_SIZE</li> 9013 <li>Type: SizeSuffix</li> 9014 <li>Default: 5G</li> 9015 </ul> 9016 <h4 id="hubic-no-chunk">–hubic-no-chunk</h4> 9017 <p>Don’t chunk files during streaming upload.</p> 9018 <p>When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.</p> 9019 <p>This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.</p> 9020 <p>Rclone will still chunk files bigger than chunk_size when doing normal copy operations.</p> 9021 <ul> 9022 <li>Config: no_chunk</li> 9023 <li>Env Var: RCLONE_HUBIC_NO_CHUNK</li> 9024 <li>Type: bool</li> 9025 <li>Default: false</li> 9026 </ul> 9027 <!--- autogenerated options stop --> 9028 <h3 id="limitations-6">Limitations</h3> 9029 <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> 9030 <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> 9031 <h2 id="jottacloud">Jottacloud</h2> 9032 <p>Paths are specified as <code>remote:path</code></p> 9033 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9034 <p>To configure Jottacloud you will need to enter your username and password and select a mountpoint.</p> 9035 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 9036 <pre><code> rclone config</code></pre> 9037 <p>This will guide you through an interactive setup process:</p> 9038 <pre><code>No remotes found - make a new one 9039 n) New remote 9040 s) Set configuration password 9041 q) Quit config 9042 n/s/q> n 9043 name> jotta 9044 Type of storage to configure. 9045 Enter a string value. Press Enter for the default (""). 9046 Choose a number from below, or type in your own value 9047 [snip] 9048 14 / JottaCloud 9049 \ "jottacloud" 9050 [snip] 9051 Storage> jottacloud 9052 ** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** 9053 9054 User Name: 9055 Enter a string value. Press Enter for the default (""). 9056 user> user@email.tld 9057 Edit advanced config? (y/n) 9058 y) Yes 9059 n) No 9060 y/n> n 9061 Remote config 9062 9063 Do you want to create a machine specific API key? 9064 9065 Rclone has it's own Jottacloud API KEY which works fine as long as one only uses rclone on a single machine. When you want to use rclone with this account on more than one machine it's recommended to create a machine specific API key. These keys can NOT be shared between machines. 9066 9067 y) Yes 9068 n) No 9069 y/n> y 9070 Your Jottacloud password is only required during setup and will not be stored. 9071 password: 9072 9073 Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? 9074 9075 y) Yes 9076 n) No 9077 y/n> y 9078 Please select the device to use. Normally this will be Jotta 9079 Choose a number from below, or type in an existing value 9080 1 > DESKTOP-3H31129 9081 2 > test1 9082 3 > Jotta 9083 Devices> 3 9084 Please select the mountpoint to user. Normally this will be Archive 9085 Choose a number from below, or type in an existing value 9086 1 > Archive 9087 2 > Shared 9088 3 > Sync 9089 Mountpoints> 1 9090 -------------------- 9091 [jotta] 9092 type = jottacloud 9093 user = 0xC4KE@gmail.com 9094 client_id = ..... 9095 client_secret = ........ 9096 token = {........} 9097 device = Jotta 9098 mountpoint = Archive 9099 -------------------- 9100 y) Yes this is OK 9101 e) Edit this remote 9102 d) Delete this remote 9103 y/e/d> y</code></pre> 9104 <p>Once configured you can then use <code>rclone</code> like this,</p> 9105 <p>List directories in top level of your Jottacloud</p> 9106 <pre><code>rclone lsd remote:</code></pre> 9107 <p>List all the files in your Jottacloud</p> 9108 <pre><code>rclone ls remote:</code></pre> 9109 <p>To copy a local directory to an Jottacloud directory called backup</p> 9110 <pre><code>rclone copy /home/source remote:backup</code></pre> 9111 <h3 id="devices-and-mountpoints">Devices and Mountpoints</h3> 9112 <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, Sync and Shared mountpoints. In most cases you’ll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by the official rclone provides the option to select other devices and mountpoints during config.</p> 9113 <h3 id="fast-list-6">–fast-list</h3> 9114 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 9115 <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> 9116 <h3 id="modified-time-and-hashes-3">Modified time and hashes</h3> 9117 <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> 9118 <p>Jottacloud supports MD5 type hashes, so you can use the <code>--checksum</code> flag.</p> 9119 <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 <code>--jottacloud-md5-memory-limit</code> flag.</p> 9120 <h3 id="deleting-files-3">Deleting files</h3> 9121 <p>By default rclone will send all files to the trash when deleting files. Due to a lack of API documentation emptying the trash is currently only possible via the Jottacloud website. If deleting permanently is required then use the <code>--jottacloud-hard-delete</code> flag, or set the equivalent environment variable.</p> 9122 <h3 id="versions-2">Versions</h3> 9123 <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> 9124 <h3 id="quota-information-1">Quota information</h3> 9125 <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> 9126 <h3 id="device-ids">Device IDs</h3> 9127 <p>Jottacloud requires each ‘device’ to be registered. Rclone brings such a registration to easily access your account but if you want to use Jottacloud together with rclone on multiple machines you NEED to create a seperate deviceID/deviceSecrect on each machine. You will asked during setting up the remote. Please be aware that this also means that copying the rclone config from one machine to another does NOT work with Jottacloud accounts. You have to create it on each machine.</p> 9128 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/jottacloud/jottacloud.go then run make backenddocs --> 9129 <h3 id="standard-options-13">Standard Options</h3> 9130 <p>Here are the standard options specific to jottacloud (JottaCloud).</p> 9131 <h4 id="jottacloud-user">–jottacloud-user</h4> 9132 <p>User Name:</p> 9133 <ul> 9134 <li>Config: user</li> 9135 <li>Env Var: RCLONE_JOTTACLOUD_USER</li> 9136 <li>Type: string</li> 9137 <li>Default: ""</li> 9138 </ul> 9139 <h3 id="advanced-options-11">Advanced Options</h3> 9140 <p>Here are the advanced options specific to jottacloud (JottaCloud).</p> 9141 <h4 id="jottacloud-md5-memory-limit">–jottacloud-md5-memory-limit</h4> 9142 <p>Files bigger than this will be cached on disk to calculate the MD5 if required.</p> 9143 <ul> 9144 <li>Config: md5_memory_limit</li> 9145 <li>Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT</li> 9146 <li>Type: SizeSuffix</li> 9147 <li>Default: 10M</li> 9148 </ul> 9149 <h4 id="jottacloud-hard-delete">–jottacloud-hard-delete</h4> 9150 <p>Delete files permanently rather than putting them into the trash.</p> 9151 <ul> 9152 <li>Config: hard_delete</li> 9153 <li>Env Var: RCLONE_JOTTACLOUD_HARD_DELETE</li> 9154 <li>Type: bool</li> 9155 <li>Default: false</li> 9156 </ul> 9157 <h4 id="jottacloud-unlink">–jottacloud-unlink</h4> 9158 <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> 9159 <ul> 9160 <li>Config: unlink</li> 9161 <li>Env Var: RCLONE_JOTTACLOUD_UNLINK</li> 9162 <li>Type: bool</li> 9163 <li>Default: false</li> 9164 </ul> 9165 <h4 id="jottacloud-upload-resume-limit">–jottacloud-upload-resume-limit</h4> 9166 <p>Files bigger than this can be resumed if the upload fail’s.</p> 9167 <ul> 9168 <li>Config: upload_resume_limit</li> 9169 <li>Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT</li> 9170 <li>Type: SizeSuffix</li> 9171 <li>Default: 10M</li> 9172 </ul> 9173 <!--- autogenerated options stop --> 9174 <h3 id="limitations-7">Limitations</h3> 9175 <p>Note that Jottacloud is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9176 <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> 9177 <p>Jottacloud only supports filenames up to 255 characters in length.</p> 9178 <h3 id="troubleshooting">Troubleshooting</h3> 9179 <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> 9180 <h2 id="koofr">Koofr</h2> 9181 <p>Paths are specified as <code>remote:path</code></p> 9182 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9183 <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> 9184 <p>Here is an example of how to make a remote called <code>koofr</code>. First run:</p> 9185 <pre><code> rclone config</code></pre> 9186 <p>This will guide you through an interactive setup process:</p> 9187 <pre><code>No remotes found - make a new one 9188 n) New remote 9189 s) Set configuration password 9190 q) Quit config 9191 n/s/q> n 9192 name> koofr 9193 Type of storage to configure. 9194 Enter a string value. Press Enter for the default (""). 9195 Choose a number from below, or type in your own value 9196 1 / A stackable unification remote, which can appear to merge the contents of several remotes 9197 \ "union" 9198 2 / Alias for an existing remote 9199 \ "alias" 9200 3 / Amazon Drive 9201 \ "amazon cloud drive" 9202 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) 9203 \ "s3" 9204 5 / Backblaze B2 9205 \ "b2" 9206 6 / Box 9207 \ "box" 9208 7 / Cache a remote 9209 \ "cache" 9210 8 / Dropbox 9211 \ "dropbox" 9212 9 / Encrypt/Decrypt a remote 9213 \ "crypt" 9214 10 / FTP Connection 9215 \ "ftp" 9216 11 / Google Cloud Storage (this is not Google Drive) 9217 \ "google cloud storage" 9218 12 / Google Drive 9219 \ "drive" 9220 13 / Hubic 9221 \ "hubic" 9222 14 / JottaCloud 9223 \ "jottacloud" 9224 15 / Koofr 9225 \ "koofr" 9226 16 / Local Disk 9227 \ "local" 9228 17 / Mega 9229 \ "mega" 9230 18 / Microsoft Azure Blob Storage 9231 \ "azureblob" 9232 19 / Microsoft OneDrive 9233 \ "onedrive" 9234 20 / OpenDrive 9235 \ "opendrive" 9236 21 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 9237 \ "swift" 9238 22 / Pcloud 9239 \ "pcloud" 9240 23 / QingCloud Object Storage 9241 \ "qingstor" 9242 24 / SSH/SFTP Connection 9243 \ "sftp" 9244 25 / Webdav 9245 \ "webdav" 9246 26 / Yandex Disk 9247 \ "yandex" 9248 27 / http Connection 9249 \ "http" 9250 Storage> koofr 9251 ** See help for koofr backend at: https://rclone.org/koofr/ ** 9252 9253 Your Koofr user name 9254 Enter a string value. Press Enter for the default (""). 9255 user> USER@NAME 9256 Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) 9257 y) Yes type in my own password 9258 g) Generate random password 9259 y/g> y 9260 Enter the password: 9261 password: 9262 Confirm the password: 9263 password: 9264 Edit advanced config? (y/n) 9265 y) Yes 9266 n) No 9267 y/n> n 9268 Remote config 9269 -------------------- 9270 [koofr] 9271 type = koofr 9272 baseurl = https://app.koofr.net 9273 user = USER@NAME 9274 password = *** ENCRYPTED *** 9275 -------------------- 9276 y) Yes this is OK 9277 e) Edit this remote 9278 d) Delete this remote 9279 y/e/d> y</code></pre> 9280 <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> 9281 <p>Once configured you can then use <code>rclone</code> like this,</p> 9282 <p>List directories in top level of your Koofr</p> 9283 <pre><code>rclone lsd koofr:</code></pre> 9284 <p>List all the files in your Koofr</p> 9285 <pre><code>rclone ls koofr:</code></pre> 9286 <p>To copy a local directory to an Koofr directory called backup</p> 9287 <pre><code>rclone copy /home/source remote:backup</code></pre> 9288 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs --> 9289 <h3 id="standard-options-14">Standard Options</h3> 9290 <p>Here are the standard options specific to koofr (Koofr).</p> 9291 <h4 id="koofr-user">–koofr-user</h4> 9292 <p>Your Koofr user name</p> 9293 <ul> 9294 <li>Config: user</li> 9295 <li>Env Var: RCLONE_KOOFR_USER</li> 9296 <li>Type: string</li> 9297 <li>Default: ""</li> 9298 </ul> 9299 <h4 id="koofr-password">–koofr-password</h4> 9300 <p>Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)</p> 9301 <ul> 9302 <li>Config: password</li> 9303 <li>Env Var: RCLONE_KOOFR_PASSWORD</li> 9304 <li>Type: string</li> 9305 <li>Default: ""</li> 9306 </ul> 9307 <h3 id="advanced-options-12">Advanced Options</h3> 9308 <p>Here are the advanced options specific to koofr (Koofr).</p> 9309 <h4 id="koofr-endpoint">–koofr-endpoint</h4> 9310 <p>The Koofr API endpoint to use</p> 9311 <ul> 9312 <li>Config: endpoint</li> 9313 <li>Env Var: RCLONE_KOOFR_ENDPOINT</li> 9314 <li>Type: string</li> 9315 <li>Default: “https://app.koofr.net”</li> 9316 </ul> 9317 <h4 id="koofr-mountid">–koofr-mountid</h4> 9318 <p>Mount ID of the mount to use. If omitted, the primary mount is used.</p> 9319 <ul> 9320 <li>Config: mountid</li> 9321 <li>Env Var: RCLONE_KOOFR_MOUNTID</li> 9322 <li>Type: string</li> 9323 <li>Default: ""</li> 9324 </ul> 9325 <!--- autogenerated options stop --> 9326 <h3 id="limitations-8">Limitations</h3> 9327 <p>Note that Koofr is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9328 <h2 id="mega">Mega</h2> 9329 <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> 9330 <p>This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption.</p> 9331 <p>Paths are specified as <code>remote:path</code></p> 9332 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9333 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 9334 <pre><code> rclone config</code></pre> 9335 <p>This will guide you through an interactive setup process:</p> 9336 <pre><code>No remotes found - make a new one 9337 n) New remote 9338 s) Set configuration password 9339 q) Quit config 9340 n/s/q> n 9341 name> remote 9342 Type of storage to configure. 9343 Choose a number from below, or type in your own value 9344 1 / Alias for an existing remote 9345 \ "alias" 9346 [snip] 9347 14 / Mega 9348 \ "mega" 9349 [snip] 9350 23 / http Connection 9351 \ "http" 9352 Storage> mega 9353 User name 9354 user> you@example.com 9355 Password. 9356 y) Yes type in my own password 9357 g) Generate random password 9358 n) No leave this optional password blank 9359 y/g/n> y 9360 Enter the password: 9361 password: 9362 Confirm the password: 9363 password: 9364 Remote config 9365 -------------------- 9366 [remote] 9367 type = mega 9368 user = you@example.com 9369 pass = *** ENCRYPTED *** 9370 -------------------- 9371 y) Yes this is OK 9372 e) Edit this remote 9373 d) Delete this remote 9374 y/e/d> y</code></pre> 9375 <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> 9376 <p>Once configured you can then use <code>rclone</code> like this,</p> 9377 <p>List directories in top level of your Mega</p> 9378 <pre><code>rclone lsd remote:</code></pre> 9379 <p>List all the files in your Mega</p> 9380 <pre><code>rclone ls remote:</code></pre> 9381 <p>To copy a local directory to an Mega directory called backup</p> 9382 <pre><code>rclone copy /home/source remote:backup</code></pre> 9383 <h3 id="modified-time-and-hashes-4">Modified time and hashes</h3> 9384 <p>Mega does not support modification times or hashes yet.</p> 9385 <h3 id="duplicated-files-1">Duplicated files</h3> 9386 <p>Mega can have two files with exactly the same name and path (unlike a normal file system).</p> 9387 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 9388 <p>Use <code>rclone dedupe</code> to fix duplicated files.</p> 9389 <h3 id="failure-to-log-in">Failure to log-in</h3> 9390 <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, sucessive rclone commands.</p> 9391 <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> 9392 <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> 9393 <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> 9394 <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> 9395 <p>Note that this has been observed by trial and error and might not be set in stone.</p> 9396 <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> 9397 <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 sucession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. Web access looks unaffected though.</p> 9398 <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> 9399 <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> 9400 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/mega/mega.go then run make backenddocs --> 9401 <h3 id="standard-options-15">Standard Options</h3> 9402 <p>Here are the standard options specific to mega (Mega).</p> 9403 <h4 id="mega-user">–mega-user</h4> 9404 <p>User name</p> 9405 <ul> 9406 <li>Config: user</li> 9407 <li>Env Var: RCLONE_MEGA_USER</li> 9408 <li>Type: string</li> 9409 <li>Default: ""</li> 9410 </ul> 9411 <h4 id="mega-pass">–mega-pass</h4> 9412 <p>Password.</p> 9413 <ul> 9414 <li>Config: pass</li> 9415 <li>Env Var: RCLONE_MEGA_PASS</li> 9416 <li>Type: string</li> 9417 <li>Default: ""</li> 9418 </ul> 9419 <h3 id="advanced-options-13">Advanced Options</h3> 9420 <p>Here are the advanced options specific to mega (Mega).</p> 9421 <h4 id="mega-debug">–mega-debug</h4> 9422 <p>Output more debug from Mega.</p> 9423 <p>If this flag is set (along with -vv) it will print further debugging information from the mega backend.</p> 9424 <ul> 9425 <li>Config: debug</li> 9426 <li>Env Var: RCLONE_MEGA_DEBUG</li> 9427 <li>Type: bool</li> 9428 <li>Default: false</li> 9429 </ul> 9430 <h4 id="mega-hard-delete">–mega-hard-delete</h4> 9431 <p>Delete files permanently rather than putting them into the trash.</p> 9432 <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> 9433 <ul> 9434 <li>Config: hard_delete</li> 9435 <li>Env Var: RCLONE_MEGA_HARD_DELETE</li> 9436 <li>Type: bool</li> 9437 <li>Default: false</li> 9438 </ul> 9439 <!--- autogenerated options stop --> 9440 <h3 id="limitations-9">Limitations</h3> 9441 <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> 9442 <p>Mega allows duplicate files which may confuse rclone.</p> 9443 <h2 id="microsoft-azure-blob-storage">Microsoft Azure Blob Storage</h2> 9444 <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> 9445 <p>Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called <code>remote</code>. First run:</p> 9446 <pre><code> rclone config</code></pre> 9447 <p>This will guide you through an interactive setup process:</p> 9448 <pre><code>No remotes found - make a new one 9449 n) New remote 9450 s) Set configuration password 9451 q) Quit config 9452 n/s/q> n 9453 name> remote 9454 Type of storage to configure. 9455 Choose a number from below, or type in your own value 9456 1 / Amazon Drive 9457 \ "amazon cloud drive" 9458 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 9459 \ "s3" 9460 3 / Backblaze B2 9461 \ "b2" 9462 4 / Box 9463 \ "box" 9464 5 / Dropbox 9465 \ "dropbox" 9466 6 / Encrypt/Decrypt a remote 9467 \ "crypt" 9468 7 / FTP Connection 9469 \ "ftp" 9470 8 / Google Cloud Storage (this is not Google Drive) 9471 \ "google cloud storage" 9472 9 / Google Drive 9473 \ "drive" 9474 10 / Hubic 9475 \ "hubic" 9476 11 / Local Disk 9477 \ "local" 9478 12 / Microsoft Azure Blob Storage 9479 \ "azureblob" 9480 13 / Microsoft OneDrive 9481 \ "onedrive" 9482 14 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 9483 \ "swift" 9484 15 / SSH/SFTP Connection 9485 \ "sftp" 9486 16 / Yandex Disk 9487 \ "yandex" 9488 17 / http Connection 9489 \ "http" 9490 Storage> azureblob 9491 Storage Account Name 9492 account> account_name 9493 Storage Account Key 9494 key> base64encodedkey== 9495 Endpoint for the service - leave blank normally. 9496 endpoint> 9497 Remote config 9498 -------------------- 9499 [remote] 9500 account = account_name 9501 key = base64encodedkey== 9502 endpoint = 9503 -------------------- 9504 y) Yes this is OK 9505 e) Edit this remote 9506 d) Delete this remote 9507 y/e/d> y</code></pre> 9508 <p>See all containers</p> 9509 <pre><code>rclone lsd remote:</code></pre> 9510 <p>Make a new container</p> 9511 <pre><code>rclone mkdir remote:container</code></pre> 9512 <p>List the contents of a container</p> 9513 <pre><code>rclone ls remote:container</code></pre> 9514 <p>Sync <code>/home/local/directory</code> to the remote container, deleting any excess files in the container.</p> 9515 <pre><code>rclone sync /home/local/directory remote:container</code></pre> 9516 <h3 id="fast-list-7">–fast-list</h3> 9517 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 9518 <h3 id="modified-time-7">Modified time</h3> 9519 <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> 9520 <h3 id="hashes">Hashes</h3> 9521 <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> 9522 <h3 id="authenticating-with-azure-blob-storage">Authenticating with Azure Blob Storage</h3> 9523 <p>Rclone has 3 ways of authenticating with Azure Blob Storage:</p> 9524 <h4 id="account-and-key">Account and Key</h4> 9525 <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> 9526 <h4 id="sas-url">SAS URL</h4> 9527 <p>This can be an account level SAS URL or container level SAS URL</p> 9528 <p>To use it leave <code>account</code>, <code>key</code> blank and fill in <code>sas_url</code>.</p> 9529 <p>Account level SAS URL or container level SAS URL can be obtained from Azure portal or 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> 9530 <p>If You use container level SAS URL, rclone operations are permitted only on particular container, eg</p> 9531 <pre><code>rclone ls azureblob:container or rclone ls azureblob:</code></pre> 9532 <p>Since container name already exists in SAS URL, you can leave it empty as well.</p> 9533 <p>However these will not work</p> 9534 <pre><code>rclone lsd azureblob: 9535 rclone ls azureblob:othercontainer</code></pre> 9536 <p>This would be useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment.</p> 9537 <h3 id="multipart-uploads-1">Multipart uploads</h3> 9538 <p>Rclone supports multipart uploads with Azure Blob storage. Files bigger than 256MB will be uploaded using chunked upload by default.</p> 9539 <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> 9540 <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> 9541 <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> 9542 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs --> 9543 <h3 id="standard-options-16">Standard Options</h3> 9544 <p>Here are the standard options specific to azureblob (Microsoft Azure Blob Storage).</p> 9545 <h4 id="azureblob-account">–azureblob-account</h4> 9546 <p>Storage Account Name (leave blank to use connection string or SAS URL)</p> 9547 <ul> 9548 <li>Config: account</li> 9549 <li>Env Var: RCLONE_AZUREBLOB_ACCOUNT</li> 9550 <li>Type: string</li> 9551 <li>Default: ""</li> 9552 </ul> 9553 <h4 id="azureblob-key">–azureblob-key</h4> 9554 <p>Storage Account Key (leave blank to use connection string or SAS URL)</p> 9555 <ul> 9556 <li>Config: key</li> 9557 <li>Env Var: RCLONE_AZUREBLOB_KEY</li> 9558 <li>Type: string</li> 9559 <li>Default: ""</li> 9560 </ul> 9561 <h4 id="azureblob-sas-url">–azureblob-sas-url</h4> 9562 <p>SAS URL for container level access only (leave blank if using account/key or connection string)</p> 9563 <ul> 9564 <li>Config: sas_url</li> 9565 <li>Env Var: RCLONE_AZUREBLOB_SAS_URL</li> 9566 <li>Type: string</li> 9567 <li>Default: ""</li> 9568 </ul> 9569 <h3 id="advanced-options-14">Advanced Options</h3> 9570 <p>Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage).</p> 9571 <h4 id="azureblob-endpoint">–azureblob-endpoint</h4> 9572 <p>Endpoint for the service Leave blank normally.</p> 9573 <ul> 9574 <li>Config: endpoint</li> 9575 <li>Env Var: RCLONE_AZUREBLOB_ENDPOINT</li> 9576 <li>Type: string</li> 9577 <li>Default: ""</li> 9578 </ul> 9579 <h4 id="azureblob-upload-cutoff">–azureblob-upload-cutoff</h4> 9580 <p>Cutoff for switching to chunked upload (<= 256MB).</p> 9581 <ul> 9582 <li>Config: upload_cutoff</li> 9583 <li>Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF</li> 9584 <li>Type: SizeSuffix</li> 9585 <li>Default: 256M</li> 9586 </ul> 9587 <h4 id="azureblob-chunk-size">–azureblob-chunk-size</h4> 9588 <p>Upload chunk size (<= 100MB).</p> 9589 <p>Note that this is stored in memory and there may be up to “–transfers” chunks stored at once in memory.</p> 9590 <ul> 9591 <li>Config: chunk_size</li> 9592 <li>Env Var: RCLONE_AZUREBLOB_CHUNK_SIZE</li> 9593 <li>Type: SizeSuffix</li> 9594 <li>Default: 4M</li> 9595 </ul> 9596 <h4 id="azureblob-list-chunk">–azureblob-list-chunk</h4> 9597 <p>Size of blob list.</p> 9598 <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> 9599 <ul> 9600 <li>Config: list_chunk</li> 9601 <li>Env Var: RCLONE_AZUREBLOB_LIST_CHUNK</li> 9602 <li>Type: int</li> 9603 <li>Default: 5000</li> 9604 </ul> 9605 <h4 id="azureblob-access-tier">–azureblob-access-tier</h4> 9606 <p>Access tier of blob: hot, cool or archive.</p> 9607 <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> 9608 <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> 9609 <ul> 9610 <li>Config: access_tier</li> 9611 <li>Env Var: RCLONE_AZUREBLOB_ACCESS_TIER</li> 9612 <li>Type: string</li> 9613 <li>Default: ""</li> 9614 </ul> 9615 <!--- autogenerated options stop --> 9616 <h3 id="limitations-10">Limitations</h3> 9617 <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> 9618 <h2 id="microsoft-onedrive">Microsoft OneDrive</h2> 9619 <p>Paths are specified as <code>remote:path</code></p> 9620 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9621 <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> 9622 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 9623 <pre><code> rclone config</code></pre> 9624 <p>This will guide you through an interactive setup process:</p> 9625 <pre><code>e) Edit existing remote 9626 n) New remote 9627 d) Delete remote 9628 r) Rename remote 9629 c) Copy remote 9630 s) Set configuration password 9631 q) Quit config 9632 e/n/d/r/c/s/q> n 9633 name> remote 9634 Type of storage to configure. 9635 Enter a string value. Press Enter for the default (""). 9636 Choose a number from below, or type in your own value 9637 ... 9638 18 / Microsoft OneDrive 9639 \ "onedrive" 9640 ... 9641 Storage> 18 9642 Microsoft App Client Id 9643 Leave blank normally. 9644 Enter a string value. Press Enter for the default (""). 9645 client_id> 9646 Microsoft App Client Secret 9647 Leave blank normally. 9648 Enter a string value. Press Enter for the default (""). 9649 client_secret> 9650 Edit advanced config? (y/n) 9651 y) Yes 9652 n) No 9653 y/n> n 9654 Remote config 9655 Use auto config? 9656 * Say Y if not sure 9657 * Say N if you are working on a remote or headless machine 9658 y) Yes 9659 n) No 9660 y/n> y 9661 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 9662 Log in and authorize rclone for access 9663 Waiting for code... 9664 Got code 9665 Choose a number from below, or type in an existing value 9666 1 / OneDrive Personal or Business 9667 \ "onedrive" 9668 2 / Sharepoint site 9669 \ "sharepoint" 9670 3 / Type in driveID 9671 \ "driveid" 9672 4 / Type in SiteID 9673 \ "siteid" 9674 5 / Search a Sharepoint site 9675 \ "search" 9676 Your choice> 1 9677 Found 1 drives, please select the one you want to use: 9678 0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk 9679 Chose drive to use:> 0 9680 Found drive 'root' of type 'business', URL: https://org-my.sharepoint.com/personal/you/Documents 9681 Is that okay? 9682 y) Yes 9683 n) No 9684 y/n> y 9685 -------------------- 9686 [remote] 9687 type = onedrive 9688 token = {"access_token":"youraccesstoken","token_type":"Bearer","refresh_token":"yourrefreshtoken","expiry":"2018-08-26T22:39:52.486512262+08:00"} 9689 drive_id = b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk 9690 drive_type = business 9691 -------------------- 9692 y) Yes this is OK 9693 e) Edit this remote 9694 d) Delete this remote 9695 y/e/d> y</code></pre> 9696 <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> 9697 <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> 9698 <p>Once configured you can then use <code>rclone</code> like this,</p> 9699 <p>List directories in top level of your OneDrive</p> 9700 <pre><code>rclone lsd remote:</code></pre> 9701 <p>List all the files in your OneDrive</p> 9702 <pre><code>rclone ls remote:</code></pre> 9703 <p>To copy a local directory to an OneDrive directory called backup</p> 9704 <pre><code>rclone copy /home/source remote:backup</code></pre> 9705 <h3 id="getting-your-own-client-id-and-key">Getting your own Client ID and Key</h3> 9706 <p>rclone uses a pair of Client ID and Key shared by all rclone users when performing requests by default. 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> 9707 <ol type="1"> 9708 <li>Open https://apps.dev.microsoft.com/#/appList, then click <code>Add an app</code> (Choose <code>Converged applications</code> if applicable)</li> 9709 <li>Enter a name for your app, and click continue. Copy and keep the <code>Application Id</code> under the app name for later use.</li> 9710 <li>Under section <code>Application Secrets</code>, click <code>Generate New Password</code>. Copy and keep that password for later use.</li> 9711 <li>Under section <code>Platforms</code>, click <code>Add platform</code>, then <code>Web</code>. Enter <code>http://localhost:53682/</code> in <code>Redirect URLs</code>.</li> 9712 <li>Under section <code>Microsoft Graph Permissions</code>, <code>Add</code> these <code>delegated permissions</code>: <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>.</li> 9713 <li>Scroll to the bottom and click <code>Save</code>.</li> 9714 </ol> 9715 <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> 9716 <h3 id="modified-time-and-hashes-5">Modified time and hashes</h3> 9717 <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> 9718 <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> 9719 <p>For all types of OneDrive you can use the <code>--checksum</code> flag.</p> 9720 <h3 id="deleting-files-4">Deleting files</h3> 9721 <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> 9722 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/onedrive/onedrive.go then run make backenddocs --> 9723 <h3 id="standard-options-17">Standard Options</h3> 9724 <p>Here are the standard options specific to onedrive (Microsoft OneDrive).</p> 9725 <h4 id="onedrive-client-id">–onedrive-client-id</h4> 9726 <p>Microsoft App Client Id Leave blank normally.</p> 9727 <ul> 9728 <li>Config: client_id</li> 9729 <li>Env Var: RCLONE_ONEDRIVE_CLIENT_ID</li> 9730 <li>Type: string</li> 9731 <li>Default: ""</li> 9732 </ul> 9733 <h4 id="onedrive-client-secret">–onedrive-client-secret</h4> 9734 <p>Microsoft App Client Secret Leave blank normally.</p> 9735 <ul> 9736 <li>Config: client_secret</li> 9737 <li>Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET</li> 9738 <li>Type: string</li> 9739 <li>Default: ""</li> 9740 </ul> 9741 <h3 id="advanced-options-15">Advanced Options</h3> 9742 <p>Here are the advanced options specific to onedrive (Microsoft OneDrive).</p> 9743 <h4 id="onedrive-chunk-size">–onedrive-chunk-size</h4> 9744 <p>Chunk size to upload files with - must be multiple of 320k.</p> 9745 <p>Above this size files will be chunked - must be multiple of 320k. Note that the chunks will be buffered into memory.</p> 9746 <ul> 9747 <li>Config: chunk_size</li> 9748 <li>Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE</li> 9749 <li>Type: SizeSuffix</li> 9750 <li>Default: 10M</li> 9751 </ul> 9752 <h4 id="onedrive-drive-id">–onedrive-drive-id</h4> 9753 <p>The ID of the drive to use</p> 9754 <ul> 9755 <li>Config: drive_id</li> 9756 <li>Env Var: RCLONE_ONEDRIVE_DRIVE_ID</li> 9757 <li>Type: string</li> 9758 <li>Default: ""</li> 9759 </ul> 9760 <h4 id="onedrive-drive-type">–onedrive-drive-type</h4> 9761 <p>The type of the drive ( personal | business | documentLibrary )</p> 9762 <ul> 9763 <li>Config: drive_type</li> 9764 <li>Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE</li> 9765 <li>Type: string</li> 9766 <li>Default: ""</li> 9767 </ul> 9768 <h4 id="onedrive-expose-onenote-files">–onedrive-expose-onenote-files</h4> 9769 <p>Set to make OneNote files show up in directory listings.</p> 9770 <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> 9771 <ul> 9772 <li>Config: expose_onenote_files</li> 9773 <li>Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES</li> 9774 <li>Type: bool</li> 9775 <li>Default: false</li> 9776 </ul> 9777 <!--- autogenerated options stop --> 9778 <h3 id="limitations-11">Limitations</h3> 9779 <p>Note that OneDrive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9780 <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> 9781 <p>The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019).</p> 9782 <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> 9783 <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/ncw/rclone/issues/2707">#2707</a> for more info.</p> 9784 <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> 9785 <h3 id="versioning-issue">Versioning issue</h3> 9786 <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> 9787 <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> 9788 <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> 9789 <ol type="1"> 9790 <li><code>Install-Module -Name Microsoft.Online.SharePoint.PowerShell</code> (in case you haven’t installed this already)</li> 9791 <li><code>Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking</code></li> 9792 <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> 9793 <li><code>Set-SPOTenant -EnableMinimumVersionRequirement $False</code></li> 9794 <li><code>Disconnect-SPOService</code> (to disconnect from the server)</li> 9795 </ol> 9796 <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> 9797 <p>User <a href="https://github.com/Weropol">Weropol</a> has found a method to disable versioning on OneDrive</p> 9798 <ol type="1"> 9799 <li>Open the settings menu by clicking on the gear symbol at the top of the OneDrive Business page.</li> 9800 <li>Click Site settings.</li> 9801 <li>Once on the Site settings page, navigate to Site Administration > Site libraries and lists.</li> 9802 <li>Click Customize “Documents”.</li> 9803 <li>Click General Settings > Versioning Settings.</li> 9804 <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> 9805 <li>Apply the changes by clicking OK.</li> 9806 <li>Use rclone to upload or modify files. (I also use the –no-update-modtime flag)</li> 9807 <li>Restore the versioning settings after using rclone. (Optional)</li> 9808 </ol> 9809 <h3 id="troubleshooting-1">Troubleshooting</h3> 9810 <pre><code>Error: access_denied 9811 Code: AADSTS65005 9812 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> 9813 <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> 9814 <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> 9815 <pre><code>Error: invalid_grant 9816 Code: AADSTS50076 9817 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> 9818 <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> 9819 <h2 id="opendrive">OpenDrive</h2> 9820 <p>Paths are specified as <code>remote:path</code></p> 9821 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 9822 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 9823 <pre><code> rclone config</code></pre> 9824 <p>This will guide you through an interactive setup process:</p> 9825 <pre><code>n) New remote 9826 d) Delete remote 9827 q) Quit config 9828 e/n/d/q> n 9829 name> remote 9830 Type of storage to configure. 9831 Choose a number from below, or type in your own value 9832 1 / Amazon Drive 9833 \ "amazon cloud drive" 9834 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 9835 \ "s3" 9836 3 / Backblaze B2 9837 \ "b2" 9838 4 / Dropbox 9839 \ "dropbox" 9840 5 / Encrypt/Decrypt a remote 9841 \ "crypt" 9842 6 / Google Cloud Storage (this is not Google Drive) 9843 \ "google cloud storage" 9844 7 / Google Drive 9845 \ "drive" 9846 8 / Hubic 9847 \ "hubic" 9848 9 / Local Disk 9849 \ "local" 9850 10 / OpenDrive 9851 \ "opendrive" 9852 11 / Microsoft OneDrive 9853 \ "onedrive" 9854 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 9855 \ "swift" 9856 13 / SSH/SFTP Connection 9857 \ "sftp" 9858 14 / Yandex Disk 9859 \ "yandex" 9860 Storage> 10 9861 Username 9862 username> 9863 Password 9864 y) Yes type in my own password 9865 g) Generate random password 9866 y/g> y 9867 Enter the password: 9868 password: 9869 Confirm the password: 9870 password: 9871 -------------------- 9872 [remote] 9873 username = 9874 password = *** ENCRYPTED *** 9875 -------------------- 9876 y) Yes this is OK 9877 e) Edit this remote 9878 d) Delete this remote 9879 y/e/d> y</code></pre> 9880 <p>List directories in top level of your OpenDrive</p> 9881 <pre><code>rclone lsd remote:</code></pre> 9882 <p>List all the files in your OpenDrive</p> 9883 <pre><code>rclone ls remote:</code></pre> 9884 <p>To copy a local directory to an OpenDrive directory called backup</p> 9885 <pre><code>rclone copy /home/source remote:backup</code></pre> 9886 <h3 id="modified-time-and-md5sums-1">Modified time and MD5SUMs</h3> 9887 <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> 9888 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/opendrive/opendrive.go then run make backenddocs --> 9889 <h3 id="standard-options-18">Standard Options</h3> 9890 <p>Here are the standard options specific to opendrive (OpenDrive).</p> 9891 <h4 id="opendrive-username">–opendrive-username</h4> 9892 <p>Username</p> 9893 <ul> 9894 <li>Config: username</li> 9895 <li>Env Var: RCLONE_OPENDRIVE_USERNAME</li> 9896 <li>Type: string</li> 9897 <li>Default: ""</li> 9898 </ul> 9899 <h4 id="opendrive-password">–opendrive-password</h4> 9900 <p>Password.</p> 9901 <ul> 9902 <li>Config: password</li> 9903 <li>Env Var: RCLONE_OPENDRIVE_PASSWORD</li> 9904 <li>Type: string</li> 9905 <li>Default: ""</li> 9906 </ul> 9907 <!--- autogenerated options stop --> 9908 <h3 id="limitations-12">Limitations</h3> 9909 <p>Note that OpenDrive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.</p> 9910 <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> 9911 <h2 id="qingstor">QingStor</h2> 9912 <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> 9913 <p>Here is an example of making an QingStor configuration. First run</p> 9914 <pre><code>rclone config</code></pre> 9915 <p>This will guide you through an interactive setup process.</p> 9916 <pre><code>No remotes found - make a new one 9917 n) New remote 9918 r) Rename remote 9919 c) Copy remote 9920 s) Set configuration password 9921 q) Quit config 9922 n/r/c/s/q> n 9923 name> remote 9924 Type of storage to configure. 9925 Choose a number from below, or type in your own value 9926 1 / Amazon Drive 9927 \ "amazon cloud drive" 9928 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 9929 \ "s3" 9930 3 / Backblaze B2 9931 \ "b2" 9932 4 / Dropbox 9933 \ "dropbox" 9934 5 / Encrypt/Decrypt a remote 9935 \ "crypt" 9936 6 / FTP Connection 9937 \ "ftp" 9938 7 / Google Cloud Storage (this is not Google Drive) 9939 \ "google cloud storage" 9940 8 / Google Drive 9941 \ "drive" 9942 9 / Hubic 9943 \ "hubic" 9944 10 / Local Disk 9945 \ "local" 9946 11 / Microsoft OneDrive 9947 \ "onedrive" 9948 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 9949 \ "swift" 9950 13 / QingStor Object Storage 9951 \ "qingstor" 9952 14 / SSH/SFTP Connection 9953 \ "sftp" 9954 15 / Yandex Disk 9955 \ "yandex" 9956 Storage> 13 9957 Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. 9958 Choose a number from below, or type in your own value 9959 1 / Enter QingStor credentials in the next step 9960 \ "false" 9961 2 / Get QingStor credentials from the environment (env vars or IAM) 9962 \ "true" 9963 env_auth> 1 9964 QingStor Access Key ID - leave blank for anonymous access or runtime credentials. 9965 access_key_id> access_key 9966 QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 9967 secret_access_key> secret_key 9968 Enter a endpoint URL to connection QingStor API. 9969 Leave blank will use the default value "https://qingstor.com:443" 9970 endpoint> 9971 Zone connect to. Default is "pek3a". 9972 Choose a number from below, or type in your own value 9973 / The Beijing (China) Three Zone 9974 1 | Needs location constraint pek3a. 9975 \ "pek3a" 9976 / The Shanghai (China) First Zone 9977 2 | Needs location constraint sh1a. 9978 \ "sh1a" 9979 zone> 1 9980 Number of connnection retry. 9981 Leave blank will use the default value "3". 9982 connection_retries> 9983 Remote config 9984 -------------------- 9985 [remote] 9986 env_auth = false 9987 access_key_id = access_key 9988 secret_access_key = secret_key 9989 endpoint = 9990 zone = pek3a 9991 connection_retries = 9992 -------------------- 9993 y) Yes this is OK 9994 e) Edit this remote 9995 d) Delete this remote 9996 y/e/d> y</code></pre> 9997 <p>This remote is called <code>remote</code> and can now be used like this</p> 9998 <p>See all buckets</p> 9999 <pre><code>rclone lsd remote:</code></pre> 10000 <p>Make a new bucket</p> 10001 <pre><code>rclone mkdir remote:bucket</code></pre> 10002 <p>List the contents of a bucket</p> 10003 <pre><code>rclone ls remote:bucket</code></pre> 10004 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 10005 <pre><code>rclone sync /home/local/directory remote:bucket</code></pre> 10006 <h3 id="fast-list-8">–fast-list</h3> 10007 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 10008 <h3 id="multipart-uploads-2">Multipart uploads</h3> 10009 <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> 10010 <h3 id="buckets-and-zone">Buckets and Zone</h3> 10011 <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> 10012 <h3 id="authentication-5">Authentication</h3> 10013 <p>There are two ways to supply <code>rclone</code> with a set of QingStor credentials. In order of precedence:</p> 10014 <ul> 10015 <li>Directly in the rclone configuration file (as configured by <code>rclone config</code>) 10016 <ul> 10017 <li>set <code>access_key_id</code> and <code>secret_access_key</code></li> 10018 </ul></li> 10019 <li>Runtime configuration: 10020 <ul> 10021 <li>set <code>env_auth</code> to <code>true</code> in the config file</li> 10022 <li>Exporting the following environment variables before running <code>rclone</code> 10023 <ul> 10024 <li>Access Key ID: <code>QS_ACCESS_KEY_ID</code> or <code>QS_ACCESS_KEY</code></li> 10025 <li>Secret Access Key: <code>QS_SECRET_ACCESS_KEY</code> or <code>QS_SECRET_KEY</code></li> 10026 </ul></li> 10027 </ul></li> 10028 </ul> 10029 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/qingstor/qingstor.go then run make backenddocs --> 10030 <h3 id="standard-options-19">Standard Options</h3> 10031 <p>Here are the standard options specific to qingstor (QingCloud Object Storage).</p> 10032 <h4 id="qingstor-env-auth">–qingstor-env-auth</h4> 10033 <p>Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.</p> 10034 <ul> 10035 <li>Config: env_auth</li> 10036 <li>Env Var: RCLONE_QINGSTOR_ENV_AUTH</li> 10037 <li>Type: bool</li> 10038 <li>Default: false</li> 10039 <li>Examples: 10040 <ul> 10041 <li>“false” 10042 <ul> 10043 <li>Enter QingStor credentials in the next step</li> 10044 </ul></li> 10045 <li>“true” 10046 <ul> 10047 <li>Get QingStor credentials from the environment (env vars or IAM)</li> 10048 </ul></li> 10049 </ul></li> 10050 </ul> 10051 <h4 id="qingstor-access-key-id">–qingstor-access-key-id</h4> 10052 <p>QingStor Access Key ID Leave blank for anonymous access or runtime credentials.</p> 10053 <ul> 10054 <li>Config: access_key_id</li> 10055 <li>Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID</li> 10056 <li>Type: string</li> 10057 <li>Default: ""</li> 10058 </ul> 10059 <h4 id="qingstor-secret-access-key">–qingstor-secret-access-key</h4> 10060 <p>QingStor Secret Access Key (password) Leave blank for anonymous access or runtime credentials.</p> 10061 <ul> 10062 <li>Config: secret_access_key</li> 10063 <li>Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY</li> 10064 <li>Type: string</li> 10065 <li>Default: ""</li> 10066 </ul> 10067 <h4 id="qingstor-endpoint">–qingstor-endpoint</h4> 10068 <p>Enter a endpoint URL to connection QingStor API. Leave blank will use the default value “https://qingstor.com:443”</p> 10069 <ul> 10070 <li>Config: endpoint</li> 10071 <li>Env Var: RCLONE_QINGSTOR_ENDPOINT</li> 10072 <li>Type: string</li> 10073 <li>Default: ""</li> 10074 </ul> 10075 <h4 id="qingstor-zone">–qingstor-zone</h4> 10076 <p>Zone to connect to. Default is “pek3a”.</p> 10077 <ul> 10078 <li>Config: zone</li> 10079 <li>Env Var: RCLONE_QINGSTOR_ZONE</li> 10080 <li>Type: string</li> 10081 <li>Default: ""</li> 10082 <li>Examples: 10083 <ul> 10084 <li>“pek3a” 10085 <ul> 10086 <li>The Beijing (China) Three Zone</li> 10087 <li>Needs location constraint pek3a.</li> 10088 </ul></li> 10089 <li>“sh1a” 10090 <ul> 10091 <li>The Shanghai (China) First Zone</li> 10092 <li>Needs location constraint sh1a.</li> 10093 </ul></li> 10094 <li>“gd2a” 10095 <ul> 10096 <li>The Guangdong (China) Second Zone</li> 10097 <li>Needs location constraint gd2a.</li> 10098 </ul></li> 10099 </ul></li> 10100 </ul> 10101 <h3 id="advanced-options-16">Advanced Options</h3> 10102 <p>Here are the advanced options specific to qingstor (QingCloud Object Storage).</p> 10103 <h4 id="qingstor-connection-retries">–qingstor-connection-retries</h4> 10104 <p>Number of connection retries.</p> 10105 <ul> 10106 <li>Config: connection_retries</li> 10107 <li>Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES</li> 10108 <li>Type: int</li> 10109 <li>Default: 3</li> 10110 </ul> 10111 <h4 id="qingstor-upload-cutoff">–qingstor-upload-cutoff</h4> 10112 <p>Cutoff for switching to chunked upload</p> 10113 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.</p> 10114 <ul> 10115 <li>Config: upload_cutoff</li> 10116 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF</li> 10117 <li>Type: SizeSuffix</li> 10118 <li>Default: 200M</li> 10119 </ul> 10120 <h4 id="qingstor-chunk-size">–qingstor-chunk-size</h4> 10121 <p>Chunk size to use for uploading.</p> 10122 <p>When uploading files larger than upload_cutoff they will be uploaded as multipart uploads using this chunk size.</p> 10123 <p>Note that “–qingstor-upload-concurrency” chunks of this size are buffered in memory per transfer.</p> 10124 <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> 10125 <ul> 10126 <li>Config: chunk_size</li> 10127 <li>Env Var: RCLONE_QINGSTOR_CHUNK_SIZE</li> 10128 <li>Type: SizeSuffix</li> 10129 <li>Default: 4M</li> 10130 </ul> 10131 <h4 id="qingstor-upload-concurrency">–qingstor-upload-concurrency</h4> 10132 <p>Concurrency for multipart uploads.</p> 10133 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 10134 <p>NB if you set this to > 1 then the checksums of multpart uploads become corrupted (the uploads themselves are not corrupted though).</p> 10135 <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> 10136 <ul> 10137 <li>Config: upload_concurrency</li> 10138 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY</li> 10139 <li>Type: int</li> 10140 <li>Default: 1</li> 10141 </ul> 10142 <!--- autogenerated options stop --> 10143 <h2 id="swift">Swift</h2> 10144 <p>Swift refers to <a href="https://docs.openstack.org/swift/latest/">Openstack Object Storage</a>. Commercial implementations of that being:</p> 10145 <ul> 10146 <li><a href="https://www.rackspace.com/cloud/files/">Rackspace Cloud Files</a></li> 10147 <li><a href="https://www.memset.com/cloud/storage/">Memset Memstore</a></li> 10148 <li><a href="https://www.ovh.co.uk/public-cloud/storage/object-storage/">OVH Object Storage</a></li> 10149 <li><a href="https://cloud.oracle.com/storage-opc">Oracle Cloud Storage</a></li> 10150 <li><a href="https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html">IBM Bluemix Cloud ObjectStorage Swift</a></li> 10151 </ul> 10152 <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> 10153 <p>Here is an example of making a swift configuration. First run</p> 10154 <pre><code>rclone config</code></pre> 10155 <p>This will guide you through an interactive setup process.</p> 10156 <pre><code>No remotes found - make a new one 10157 n) New remote 10158 s) Set configuration password 10159 q) Quit config 10160 n/s/q> n 10161 name> remote 10162 Type of storage to configure. 10163 Choose a number from below, or type in your own value 10164 1 / Amazon Drive 10165 \ "amazon cloud drive" 10166 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 10167 \ "s3" 10168 3 / Backblaze B2 10169 \ "b2" 10170 4 / Box 10171 \ "box" 10172 5 / Cache a remote 10173 \ "cache" 10174 6 / Dropbox 10175 \ "dropbox" 10176 7 / Encrypt/Decrypt a remote 10177 \ "crypt" 10178 8 / FTP Connection 10179 \ "ftp" 10180 9 / Google Cloud Storage (this is not Google Drive) 10181 \ "google cloud storage" 10182 10 / Google Drive 10183 \ "drive" 10184 11 / Hubic 10185 \ "hubic" 10186 12 / Local Disk 10187 \ "local" 10188 13 / Microsoft Azure Blob Storage 10189 \ "azureblob" 10190 14 / Microsoft OneDrive 10191 \ "onedrive" 10192 15 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 10193 \ "swift" 10194 16 / Pcloud 10195 \ "pcloud" 10196 17 / QingCloud Object Storage 10197 \ "qingstor" 10198 18 / SSH/SFTP Connection 10199 \ "sftp" 10200 19 / Webdav 10201 \ "webdav" 10202 20 / Yandex Disk 10203 \ "yandex" 10204 21 / http Connection 10205 \ "http" 10206 Storage> swift 10207 Get swift credentials from environment variables in standard OpenStack form. 10208 Choose a number from below, or type in your own value 10209 1 / Enter swift credentials in the next step 10210 \ "false" 10211 2 / Get swift credentials from environment vars. Leave other fields blank if using this. 10212 \ "true" 10213 env_auth> true 10214 User name to log in (OS_USERNAME). 10215 user> 10216 API key or password (OS_PASSWORD). 10217 key> 10218 Authentication URL for server (OS_AUTH_URL). 10219 Choose a number from below, or type in your own value 10220 1 / Rackspace US 10221 \ "https://auth.api.rackspacecloud.com/v1.0" 10222 2 / Rackspace UK 10223 \ "https://lon.auth.api.rackspacecloud.com/v1.0" 10224 3 / Rackspace v2 10225 \ "https://identity.api.rackspacecloud.com/v2.0" 10226 4 / Memset Memstore UK 10227 \ "https://auth.storage.memset.com/v1.0" 10228 5 / Memset Memstore UK v2 10229 \ "https://auth.storage.memset.com/v2.0" 10230 6 / OVH 10231 \ "https://auth.cloud.ovh.net/v2.0" 10232 auth> 10233 User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). 10234 user_id> 10235 User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) 10236 domain> 10237 Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) 10238 tenant> 10239 Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) 10240 tenant_id> 10241 Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) 10242 tenant_domain> 10243 Region name - optional (OS_REGION_NAME) 10244 region> 10245 Storage URL - optional (OS_STORAGE_URL) 10246 storage_url> 10247 Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) 10248 auth_token> 10249 AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) 10250 auth_version> 10251 Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) 10252 Choose a number from below, or type in your own value 10253 1 / Public (default, choose this if not sure) 10254 \ "public" 10255 2 / Internal (use internal service net) 10256 \ "internal" 10257 3 / Admin 10258 \ "admin" 10259 endpoint_type> 10260 Remote config 10261 -------------------- 10262 [test] 10263 env_auth = true 10264 user = 10265 key = 10266 auth = 10267 user_id = 10268 domain = 10269 tenant = 10270 tenant_id = 10271 tenant_domain = 10272 region = 10273 storage_url = 10274 auth_token = 10275 auth_version = 10276 endpoint_type = 10277 -------------------- 10278 y) Yes this is OK 10279 e) Edit this remote 10280 d) Delete this remote 10281 y/e/d> y</code></pre> 10282 <p>This remote is called <code>remote</code> and can now be used like this</p> 10283 <p>See all containers</p> 10284 <pre><code>rclone lsd remote:</code></pre> 10285 <p>Make a new container</p> 10286 <pre><code>rclone mkdir remote:container</code></pre> 10287 <p>List the contents of a container</p> 10288 <pre><code>rclone ls remote:container</code></pre> 10289 <p>Sync <code>/home/local/directory</code> to the remote container, deleting any excess files in the container.</p> 10290 <pre><code>rclone sync /home/local/directory remote:container</code></pre> 10291 <h3 id="configuration-from-an-openstack-credentials-file">Configuration from an OpenStack credentials file</h3> 10292 <p>An OpenStack credentials file typically looks something something like this (without the comments)</p> 10293 <pre><code>export OS_AUTH_URL=https://a.provider.net/v2.0 10294 export OS_TENANT_ID=ffffffffffffffffffffffffffffffff 10295 export OS_TENANT_NAME="1234567890123456" 10296 export OS_USERNAME="123abc567xy" 10297 echo "Please enter your OpenStack Password: " 10298 read -sr OS_PASSWORD_INPUT 10299 export OS_PASSWORD=$OS_PASSWORD_INPUT 10300 export OS_REGION_NAME="SBG1" 10301 if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi</code></pre> 10302 <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> 10303 <pre><code>[remote] 10304 type = swift 10305 user = $OS_USERNAME 10306 key = $OS_PASSWORD 10307 auth = $OS_AUTH_URL 10308 tenant = $OS_TENANT_NAME</code></pre> 10309 <p>Note that you may (or may not) need to set <code>region</code> too - try without first.</p> 10310 <h3 id="configuration-from-the-environment">Configuration from the environment</h3> 10311 <p>If you prefer you can configure rclone to use swift using a standard set of OpenStack environment variables.</p> 10312 <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> 10313 <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> 10314 <h3 id="using-an-alternate-authentication-method">Using an alternate authentication method</h3> 10315 <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> 10316 <h4 id="using-rclone-without-a-config-file">Using rclone without a config file</h4> 10317 <p>You can use rclone with swift without a config file, if desired, like this:</p> 10318 <pre><code>source openstack-credentials-file 10319 export RCLONE_CONFIG_MYREMOTE_TYPE=swift 10320 export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true 10321 rclone lsd myremote:</code></pre> 10322 <h3 id="fast-list-9">–fast-list</h3> 10323 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="/docs/#fast-list">rclone docs</a> for more details.</p> 10324 <h3 id="update-and-use-server-modtime-1">–update and –use-server-modtime</h3> 10325 <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> 10326 <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> 10327 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/swift/swift.go then run make backenddocs --> 10328 <h3 id="standard-options-20">Standard Options</h3> 10329 <p>Here are the standard options specific to swift (Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).</p> 10330 <h4 id="swift-env-auth">–swift-env-auth</h4> 10331 <p>Get swift credentials from environment variables in standard OpenStack form.</p> 10332 <ul> 10333 <li>Config: env_auth</li> 10334 <li>Env Var: RCLONE_SWIFT_ENV_AUTH</li> 10335 <li>Type: bool</li> 10336 <li>Default: false</li> 10337 <li>Examples: 10338 <ul> 10339 <li>“false” 10340 <ul> 10341 <li>Enter swift credentials in the next step</li> 10342 </ul></li> 10343 <li>“true” 10344 <ul> 10345 <li>Get swift credentials from environment vars. Leave other fields blank if using this.</li> 10346 </ul></li> 10347 </ul></li> 10348 </ul> 10349 <h4 id="swift-user">–swift-user</h4> 10350 <p>User name to log in (OS_USERNAME).</p> 10351 <ul> 10352 <li>Config: user</li> 10353 <li>Env Var: RCLONE_SWIFT_USER</li> 10354 <li>Type: string</li> 10355 <li>Default: ""</li> 10356 </ul> 10357 <h4 id="swift-key">–swift-key</h4> 10358 <p>API key or password (OS_PASSWORD).</p> 10359 <ul> 10360 <li>Config: key</li> 10361 <li>Env Var: RCLONE_SWIFT_KEY</li> 10362 <li>Type: string</li> 10363 <li>Default: ""</li> 10364 </ul> 10365 <h4 id="swift-auth">–swift-auth</h4> 10366 <p>Authentication URL for server (OS_AUTH_URL).</p> 10367 <ul> 10368 <li>Config: auth</li> 10369 <li>Env Var: RCLONE_SWIFT_AUTH</li> 10370 <li>Type: string</li> 10371 <li>Default: ""</li> 10372 <li>Examples: 10373 <ul> 10374 <li>“https://auth.api.rackspacecloud.com/v1.0” 10375 <ul> 10376 <li>Rackspace US</li> 10377 </ul></li> 10378 <li>“https://lon.auth.api.rackspacecloud.com/v1.0” 10379 <ul> 10380 <li>Rackspace UK</li> 10381 </ul></li> 10382 <li>“https://identity.api.rackspacecloud.com/v2.0” 10383 <ul> 10384 <li>Rackspace v2</li> 10385 </ul></li> 10386 <li>“https://auth.storage.memset.com/v1.0” 10387 <ul> 10388 <li>Memset Memstore UK</li> 10389 </ul></li> 10390 <li>“https://auth.storage.memset.com/v2.0” 10391 <ul> 10392 <li>Memset Memstore UK v2</li> 10393 </ul></li> 10394 <li>“https://auth.cloud.ovh.net/v2.0” 10395 <ul> 10396 <li>OVH</li> 10397 </ul></li> 10398 </ul></li> 10399 </ul> 10400 <h4 id="swift-user-id">–swift-user-id</h4> 10401 <p>User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).</p> 10402 <ul> 10403 <li>Config: user_id</li> 10404 <li>Env Var: RCLONE_SWIFT_USER_ID</li> 10405 <li>Type: string</li> 10406 <li>Default: ""</li> 10407 </ul> 10408 <h4 id="swift-domain">–swift-domain</h4> 10409 <p>User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)</p> 10410 <ul> 10411 <li>Config: domain</li> 10412 <li>Env Var: RCLONE_SWIFT_DOMAIN</li> 10413 <li>Type: string</li> 10414 <li>Default: ""</li> 10415 </ul> 10416 <h4 id="swift-tenant">–swift-tenant</h4> 10417 <p>Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)</p> 10418 <ul> 10419 <li>Config: tenant</li> 10420 <li>Env Var: RCLONE_SWIFT_TENANT</li> 10421 <li>Type: string</li> 10422 <li>Default: ""</li> 10423 </ul> 10424 <h4 id="swift-tenant-id">–swift-tenant-id</h4> 10425 <p>Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)</p> 10426 <ul> 10427 <li>Config: tenant_id</li> 10428 <li>Env Var: RCLONE_SWIFT_TENANT_ID</li> 10429 <li>Type: string</li> 10430 <li>Default: ""</li> 10431 </ul> 10432 <h4 id="swift-tenant-domain">–swift-tenant-domain</h4> 10433 <p>Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)</p> 10434 <ul> 10435 <li>Config: tenant_domain</li> 10436 <li>Env Var: RCLONE_SWIFT_TENANT_DOMAIN</li> 10437 <li>Type: string</li> 10438 <li>Default: ""</li> 10439 </ul> 10440 <h4 id="swift-region">–swift-region</h4> 10441 <p>Region name - optional (OS_REGION_NAME)</p> 10442 <ul> 10443 <li>Config: region</li> 10444 <li>Env Var: RCLONE_SWIFT_REGION</li> 10445 <li>Type: string</li> 10446 <li>Default: ""</li> 10447 </ul> 10448 <h4 id="swift-storage-url">–swift-storage-url</h4> 10449 <p>Storage URL - optional (OS_STORAGE_URL)</p> 10450 <ul> 10451 <li>Config: storage_url</li> 10452 <li>Env Var: RCLONE_SWIFT_STORAGE_URL</li> 10453 <li>Type: string</li> 10454 <li>Default: ""</li> 10455 </ul> 10456 <h4 id="swift-auth-token">–swift-auth-token</h4> 10457 <p>Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)</p> 10458 <ul> 10459 <li>Config: auth_token</li> 10460 <li>Env Var: RCLONE_SWIFT_AUTH_TOKEN</li> 10461 <li>Type: string</li> 10462 <li>Default: ""</li> 10463 </ul> 10464 <h4 id="swift-application-credential-id">–swift-application-credential-id</h4> 10465 <p>Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)</p> 10466 <ul> 10467 <li>Config: application_credential_id</li> 10468 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID</li> 10469 <li>Type: string</li> 10470 <li>Default: ""</li> 10471 </ul> 10472 <h4 id="swift-application-credential-name">–swift-application-credential-name</h4> 10473 <p>Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)</p> 10474 <ul> 10475 <li>Config: application_credential_name</li> 10476 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME</li> 10477 <li>Type: string</li> 10478 <li>Default: ""</li> 10479 </ul> 10480 <h4 id="swift-application-credential-secret">–swift-application-credential-secret</h4> 10481 <p>Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)</p> 10482 <ul> 10483 <li>Config: application_credential_secret</li> 10484 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET</li> 10485 <li>Type: string</li> 10486 <li>Default: ""</li> 10487 </ul> 10488 <h4 id="swift-auth-version">–swift-auth-version</h4> 10489 <p>AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)</p> 10490 <ul> 10491 <li>Config: auth_version</li> 10492 <li>Env Var: RCLONE_SWIFT_AUTH_VERSION</li> 10493 <li>Type: int</li> 10494 <li>Default: 0</li> 10495 </ul> 10496 <h4 id="swift-endpoint-type">–swift-endpoint-type</h4> 10497 <p>Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE)</p> 10498 <ul> 10499 <li>Config: endpoint_type</li> 10500 <li>Env Var: RCLONE_SWIFT_ENDPOINT_TYPE</li> 10501 <li>Type: string</li> 10502 <li>Default: “public”</li> 10503 <li>Examples: 10504 <ul> 10505 <li>“public” 10506 <ul> 10507 <li>Public (default, choose this if not sure)</li> 10508 </ul></li> 10509 <li>“internal” 10510 <ul> 10511 <li>Internal (use internal service net)</li> 10512 </ul></li> 10513 <li>“admin” 10514 <ul> 10515 <li>Admin</li> 10516 </ul></li> 10517 </ul></li> 10518 </ul> 10519 <h4 id="swift-storage-policy">–swift-storage-policy</h4> 10520 <p>The storage policy to use when creating a new container</p> 10521 <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> 10522 <ul> 10523 <li>Config: storage_policy</li> 10524 <li>Env Var: RCLONE_SWIFT_STORAGE_POLICY</li> 10525 <li>Type: string</li> 10526 <li>Default: ""</li> 10527 <li>Examples: 10528 <ul> 10529 <li>"" 10530 <ul> 10531 <li>Default</li> 10532 </ul></li> 10533 <li>“pcs” 10534 <ul> 10535 <li>OVH Public Cloud Storage</li> 10536 </ul></li> 10537 <li>“pca” 10538 <ul> 10539 <li>OVH Public Cloud Archive</li> 10540 </ul></li> 10541 </ul></li> 10542 </ul> 10543 <h3 id="advanced-options-17">Advanced Options</h3> 10544 <p>Here are the advanced options specific to swift (Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).</p> 10545 <h4 id="swift-chunk-size">–swift-chunk-size</h4> 10546 <p>Above this size files will be chunked into a _segments container.</p> 10547 <p>Above this size files will be chunked into a _segments container. The default for this is 5GB which is its maximum value.</p> 10548 <ul> 10549 <li>Config: chunk_size</li> 10550 <li>Env Var: RCLONE_SWIFT_CHUNK_SIZE</li> 10551 <li>Type: SizeSuffix</li> 10552 <li>Default: 5G</li> 10553 </ul> 10554 <h4 id="swift-no-chunk">–swift-no-chunk</h4> 10555 <p>Don’t chunk files during streaming upload.</p> 10556 <p>When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.</p> 10557 <p>This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.</p> 10558 <p>Rclone will still chunk files bigger than chunk_size when doing normal copy operations.</p> 10559 <ul> 10560 <li>Config: no_chunk</li> 10561 <li>Env Var: RCLONE_SWIFT_NO_CHUNK</li> 10562 <li>Type: bool</li> 10563 <li>Default: false</li> 10564 </ul> 10565 <!--- autogenerated options stop --> 10566 <h3 id="modified-time-8">Modified time</h3> 10567 <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> 10568 <p>This is a defacto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p> 10569 <h3 id="limitations-13">Limitations</h3> 10570 <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> 10571 <h3 id="troubleshooting-2">Troubleshooting</h3> 10572 <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> 10573 <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> 10574 <p>So this most likely means your username / password is wrong. You can investigate further with the <code>--dump-bodies</code> flag.</p> 10575 <p>This may also be caused by specifying the region when you shouldn’t have (eg OVH).</p> 10576 <h4 id="rclone-gives-failed-to-create-file-system-response-didnt-have-storage-storage-url-and-auth-token">Rclone gives Failed to create file system: Response didn’t have storage storage url and auth token</h4> 10577 <p>This is most likely caused by forgetting to specify your tenant when setting up a swift remote.</p> 10578 <h2 id="pcloud">pCloud</h2> 10579 <p>Paths are specified as <code>remote:path</code></p> 10580 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 10581 <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> 10582 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 10583 <pre><code> rclone config</code></pre> 10584 <p>This will guide you through an interactive setup process:</p> 10585 <pre><code>No remotes found - make a new one 10586 n) New remote 10587 s) Set configuration password 10588 q) Quit config 10589 n/s/q> n 10590 name> remote 10591 Type of storage to configure. 10592 Choose a number from below, or type in your own value 10593 1 / Amazon Drive 10594 \ "amazon cloud drive" 10595 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 10596 \ "s3" 10597 3 / Backblaze B2 10598 \ "b2" 10599 4 / Box 10600 \ "box" 10601 5 / Dropbox 10602 \ "dropbox" 10603 6 / Encrypt/Decrypt a remote 10604 \ "crypt" 10605 7 / FTP Connection 10606 \ "ftp" 10607 8 / Google Cloud Storage (this is not Google Drive) 10608 \ "google cloud storage" 10609 9 / Google Drive 10610 \ "drive" 10611 10 / Hubic 10612 \ "hubic" 10613 11 / Local Disk 10614 \ "local" 10615 12 / Microsoft Azure Blob Storage 10616 \ "azureblob" 10617 13 / Microsoft OneDrive 10618 \ "onedrive" 10619 14 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 10620 \ "swift" 10621 15 / Pcloud 10622 \ "pcloud" 10623 16 / QingCloud Object Storage 10624 \ "qingstor" 10625 17 / SSH/SFTP Connection 10626 \ "sftp" 10627 18 / Yandex Disk 10628 \ "yandex" 10629 19 / http Connection 10630 \ "http" 10631 Storage> pcloud 10632 Pcloud App Client Id - leave blank normally. 10633 client_id> 10634 Pcloud App Client Secret - leave blank normally. 10635 client_secret> 10636 Remote config 10637 Use auto config? 10638 * Say Y if not sure 10639 * Say N if you are working on a remote or headless machine 10640 y) Yes 10641 n) No 10642 y/n> y 10643 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 10644 Log in and authorize rclone for access 10645 Waiting for code... 10646 Got code 10647 -------------------- 10648 [remote] 10649 client_id = 10650 client_secret = 10651 token = {"access_token":"XXX","token_type":"bearer","expiry":"0001-01-01T00:00:00Z"} 10652 -------------------- 10653 y) Yes this is OK 10654 e) Edit this remote 10655 d) Delete this remote 10656 y/e/d> y</code></pre> 10657 <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> 10658 <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> 10659 <p>Once configured you can then use <code>rclone</code> like this,</p> 10660 <p>List directories in top level of your pCloud</p> 10661 <pre><code>rclone lsd remote:</code></pre> 10662 <p>List all the files in your pCloud</p> 10663 <pre><code>rclone ls remote:</code></pre> 10664 <p>To copy a local directory to an pCloud directory called backup</p> 10665 <pre><code>rclone copy /home/source remote:backup</code></pre> 10666 <h3 id="modified-time-and-hashes-6">Modified time and hashes</h3> 10667 <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> 10668 <p>pCloud supports MD5 and SHA1 type hashes, so you can use the <code>--checksum</code> flag.</p> 10669 <h3 id="deleting-files-5">Deleting files</h3> 10670 <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> 10671 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs --> 10672 <h3 id="standard-options-21">Standard Options</h3> 10673 <p>Here are the standard options specific to pcloud (Pcloud).</p> 10674 <h4 id="pcloud-client-id">–pcloud-client-id</h4> 10675 <p>Pcloud App Client Id Leave blank normally.</p> 10676 <ul> 10677 <li>Config: client_id</li> 10678 <li>Env Var: RCLONE_PCLOUD_CLIENT_ID</li> 10679 <li>Type: string</li> 10680 <li>Default: ""</li> 10681 </ul> 10682 <h4 id="pcloud-client-secret">–pcloud-client-secret</h4> 10683 <p>Pcloud App Client Secret Leave blank normally.</p> 10684 <ul> 10685 <li>Config: client_secret</li> 10686 <li>Env Var: RCLONE_PCLOUD_CLIENT_SECRET</li> 10687 <li>Type: string</li> 10688 <li>Default: ""</li> 10689 </ul> 10690 <!--- autogenerated options stop --> 10691 <h2 id="sftp">SFTP</h2> 10692 <p>SFTP is the <a href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">Secure (or SSH) File Transfer Protocol</a>.</p> 10693 <p>SFTP runs over SSH v2 and is installed as standard with most modern SSH installations.</p> 10694 <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> 10695 <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> 10696 <p>Here is an example of making an SFTP configuration. First run</p> 10697 <pre><code>rclone config</code></pre> 10698 <p>This will guide you through an interactive setup process.</p> 10699 <pre><code>No remotes found - make a new one 10700 n) New remote 10701 s) Set configuration password 10702 q) Quit config 10703 n/s/q> n 10704 name> remote 10705 Type of storage to configure. 10706 Choose a number from below, or type in your own value 10707 1 / Amazon Drive 10708 \ "amazon cloud drive" 10709 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 10710 \ "s3" 10711 3 / Backblaze B2 10712 \ "b2" 10713 4 / Dropbox 10714 \ "dropbox" 10715 5 / Encrypt/Decrypt a remote 10716 \ "crypt" 10717 6 / FTP Connection 10718 \ "ftp" 10719 7 / Google Cloud Storage (this is not Google Drive) 10720 \ "google cloud storage" 10721 8 / Google Drive 10722 \ "drive" 10723 9 / Hubic 10724 \ "hubic" 10725 10 / Local Disk 10726 \ "local" 10727 11 / Microsoft OneDrive 10728 \ "onedrive" 10729 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 10730 \ "swift" 10731 13 / SSH/SFTP Connection 10732 \ "sftp" 10733 14 / Yandex Disk 10734 \ "yandex" 10735 15 / http Connection 10736 \ "http" 10737 Storage> sftp 10738 SSH host to connect to 10739 Choose a number from below, or type in your own value 10740 1 / Connect to example.com 10741 \ "example.com" 10742 host> example.com 10743 SSH username, leave blank for current username, ncw 10744 user> sftpuser 10745 SSH port, leave blank to use default (22) 10746 port> 10747 SSH password, leave blank to use ssh-agent. 10748 y) Yes type in my own password 10749 g) Generate random password 10750 n) No leave this optional password blank 10751 y/g/n> n 10752 Path to unencrypted PEM-encoded private key file, leave blank to use ssh-agent. 10753 key_file> 10754 Remote config 10755 -------------------- 10756 [remote] 10757 host = example.com 10758 user = sftpuser 10759 port = 10760 pass = 10761 key_file = 10762 -------------------- 10763 y) Yes this is OK 10764 e) Edit this remote 10765 d) Delete this remote 10766 y/e/d> y</code></pre> 10767 <p>This remote is called <code>remote</code> and can now be used like this:</p> 10768 <p>See all directories in the home directory</p> 10769 <pre><code>rclone lsd remote:</code></pre> 10770 <p>Make a new directory</p> 10771 <pre><code>rclone mkdir remote:path/to/directory</code></pre> 10772 <p>List the contents of a directory</p> 10773 <pre><code>rclone ls remote:path/to/directory</code></pre> 10774 <p>Sync <code>/home/local/directory</code> to the remote directory, deleting any excess files in the directory.</p> 10775 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 10776 <h3 id="ssh-authentication">SSH Authentication</h3> 10777 <p>The SFTP remote supports three authentication methods:</p> 10778 <ul> 10779 <li>Password</li> 10780 <li>Key file</li> 10781 <li>ssh-agent</li> 10782 </ul> 10783 <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> 10784 <p>If you don’t specify <code>pass</code> or <code>key_file</code> then rclone will attempt to contact an ssh-agent.</p> 10785 <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> can also be specified to force the usage of a specific key in the ssh-agent.</p> 10786 <p>Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment.</p> 10787 <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> 10788 <h3 id="ssh-agent-on-macos">ssh-agent on macOS</h3> 10789 <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> 10790 <pre><code>eval `ssh-agent -s` && ssh-add -A</code></pre> 10791 <p>And then at the end of the session</p> 10792 <pre><code>eval `ssh-agent -k`</code></pre> 10793 <p>These commands can be used in scripts of course.</p> 10794 <h3 id="modified-time-9">Modified time</h3> 10795 <p>Modified times are stored on the server to 1 second precision.</p> 10796 <p>Modified times are used in syncing and are fully supported.</p> 10797 <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> 10798 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/sftp/sftp.go then run make backenddocs --> 10799 <h3 id="standard-options-22">Standard Options</h3> 10800 <p>Here are the standard options specific to sftp (SSH/SFTP Connection).</p> 10801 <h4 id="sftp-host">–sftp-host</h4> 10802 <p>SSH host to connect to</p> 10803 <ul> 10804 <li>Config: host</li> 10805 <li>Env Var: RCLONE_SFTP_HOST</li> 10806 <li>Type: string</li> 10807 <li>Default: ""</li> 10808 <li>Examples: 10809 <ul> 10810 <li>“example.com” 10811 <ul> 10812 <li>Connect to example.com</li> 10813 </ul></li> 10814 </ul></li> 10815 </ul> 10816 <h4 id="sftp-user">–sftp-user</h4> 10817 <p>SSH username, leave blank for current username, ncw</p> 10818 <ul> 10819 <li>Config: user</li> 10820 <li>Env Var: RCLONE_SFTP_USER</li> 10821 <li>Type: string</li> 10822 <li>Default: ""</li> 10823 </ul> 10824 <h4 id="sftp-port">–sftp-port</h4> 10825 <p>SSH port, leave blank to use default (22)</p> 10826 <ul> 10827 <li>Config: port</li> 10828 <li>Env Var: RCLONE_SFTP_PORT</li> 10829 <li>Type: string</li> 10830 <li>Default: ""</li> 10831 </ul> 10832 <h4 id="sftp-pass">–sftp-pass</h4> 10833 <p>SSH password, leave blank to use ssh-agent.</p> 10834 <ul> 10835 <li>Config: pass</li> 10836 <li>Env Var: RCLONE_SFTP_PASS</li> 10837 <li>Type: string</li> 10838 <li>Default: ""</li> 10839 </ul> 10840 <h4 id="sftp-key-file">–sftp-key-file</h4> 10841 <p>Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.</p> 10842 <ul> 10843 <li>Config: key_file</li> 10844 <li>Env Var: RCLONE_SFTP_KEY_FILE</li> 10845 <li>Type: string</li> 10846 <li>Default: ""</li> 10847 </ul> 10848 <h4 id="sftp-key-file-pass">–sftp-key-file-pass</h4> 10849 <p>The passphrase to decrypt the PEM-encoded private key file.</p> 10850 <p>Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys in the new OpenSSH format can’t be used.</p> 10851 <ul> 10852 <li>Config: key_file_pass</li> 10853 <li>Env Var: RCLONE_SFTP_KEY_FILE_PASS</li> 10854 <li>Type: string</li> 10855 <li>Default: ""</li> 10856 </ul> 10857 <h4 id="sftp-key-use-agent">–sftp-key-use-agent</h4> 10858 <p>When set forces the usage of the ssh-agent.</p> 10859 <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> 10860 <ul> 10861 <li>Config: key_use_agent</li> 10862 <li>Env Var: RCLONE_SFTP_KEY_USE_AGENT</li> 10863 <li>Type: bool</li> 10864 <li>Default: false</li> 10865 </ul> 10866 <h4 id="sftp-use-insecure-cipher">–sftp-use-insecure-cipher</h4> 10867 <p>Enable the use of the aes128-cbc cipher. This cipher is insecure and may allow plaintext data to be recovered by an attacker.</p> 10868 <ul> 10869 <li>Config: use_insecure_cipher</li> 10870 <li>Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER</li> 10871 <li>Type: bool</li> 10872 <li>Default: false</li> 10873 <li>Examples: 10874 <ul> 10875 <li>“false” 10876 <ul> 10877 <li>Use default Cipher list.</li> 10878 </ul></li> 10879 <li>“true” 10880 <ul> 10881 <li>Enables the use of the aes128-cbc cipher.</li> 10882 </ul></li> 10883 </ul></li> 10884 </ul> 10885 <h4 id="sftp-disable-hashcheck">–sftp-disable-hashcheck</h4> 10886 <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> 10887 <ul> 10888 <li>Config: disable_hashcheck</li> 10889 <li>Env Var: RCLONE_SFTP_DISABLE_HASHCHECK</li> 10890 <li>Type: bool</li> 10891 <li>Default: false</li> 10892 </ul> 10893 <h3 id="advanced-options-18">Advanced Options</h3> 10894 <p>Here are the advanced options specific to sftp (SSH/SFTP Connection).</p> 10895 <h4 id="sftp-ask-password">–sftp-ask-password</h4> 10896 <p>Allow asking for SFTP password when needed.</p> 10897 <ul> 10898 <li>Config: ask_password</li> 10899 <li>Env Var: RCLONE_SFTP_ASK_PASSWORD</li> 10900 <li>Type: bool</li> 10901 <li>Default: false</li> 10902 </ul> 10903 <h4 id="sftp-path-override">–sftp-path-override</h4> 10904 <p>Override path used by SSH connection.</p> 10905 <p>This allows checksum calculation when SFTP and SSH paths are different. This issue affects among others Synology NAS boxes.</p> 10906 <p>Shared folders can be found in directories representing volumes</p> 10907 <pre><code>rclone sync /home/local/directory remote:/directory --ssh-path-override /volume2/directory</code></pre> 10908 <p>Home directory can be found in a shared folder called “home”</p> 10909 <pre><code>rclone sync /home/local/directory remote:/home/directory --ssh-path-override /volume1/homes/USER/directory</code></pre> 10910 <ul> 10911 <li>Config: path_override</li> 10912 <li>Env Var: RCLONE_SFTP_PATH_OVERRIDE</li> 10913 <li>Type: string</li> 10914 <li>Default: ""</li> 10915 </ul> 10916 <h4 id="sftp-set-modtime">–sftp-set-modtime</h4> 10917 <p>Set the modified time on the remote if set.</p> 10918 <ul> 10919 <li>Config: set_modtime</li> 10920 <li>Env Var: RCLONE_SFTP_SET_MODTIME</li> 10921 <li>Type: bool</li> 10922 <li>Default: true</li> 10923 </ul> 10924 <!--- autogenerated options stop --> 10925 <h3 id="limitations-14">Limitations</h3> 10926 <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> 10927 <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> 10928 <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> 10929 <p>The only ssh agent supported under Windows is Putty’s pageant.</p> 10930 <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> 10931 <p>SFTP isn’t supported under plan9 until <a href="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p> 10932 <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> 10933 <p>Note that <code>--timeout</code> isn’t supported (but <code>--contimeout</code> is).</p> 10934 <h2 id="union">Union</h2> 10935 <p>The <code>union</code> remote provides a unification similar to UnionFS using other remotes.</p> 10936 <p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p> 10937 <p>During the initial setup with <code>rclone config</code> you will specify the target remotes as a space separated list. The target remotes can either be a local paths or other remotes.</p> 10938 <p>The order of the remotes is important as it defines which remotes take precedence over others if there are files with the same name in the same logical path. The last remote is the topmost remote and replaces files with the same name from previous remotes.</p> 10939 <p>Only the last remote is used to write to and delete from, all other remotes are read-only.</p> 10940 <p>Subfolders can be used in target remote. Assume a union remote named <code>backup</code> with the remotes <code>mydrive:private/backup mydrive2:/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive2:/backup/desktop</code>.</p> 10941 <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> 10942 <p>Here is an example of how to make a union called <code>remote</code> for local folders. First run:</p> 10943 <pre><code> rclone config</code></pre> 10944 <p>This will guide you through an interactive setup process:</p> 10945 <pre><code>No remotes found - make a new one 10946 n) New remote 10947 s) Set configuration password 10948 q) Quit config 10949 n/s/q> n 10950 name> remote 10951 Type of storage to configure. 10952 Choose a number from below, or type in your own value 10953 1 / Alias for an existing remote 10954 \ "alias" 10955 2 / Amazon Drive 10956 \ "amazon cloud drive" 10957 3 / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) 10958 \ "s3" 10959 4 / Backblaze B2 10960 \ "b2" 10961 5 / Box 10962 \ "box" 10963 6 / Builds a stackable unification remote, which can appear to merge the contents of several remotes 10964 \ "union" 10965 7 / Cache a remote 10966 \ "cache" 10967 8 / Dropbox 10968 \ "dropbox" 10969 9 / Encrypt/Decrypt a remote 10970 \ "crypt" 10971 10 / FTP Connection 10972 \ "ftp" 10973 11 / Google Cloud Storage (this is not Google Drive) 10974 \ "google cloud storage" 10975 12 / Google Drive 10976 \ "drive" 10977 13 / Hubic 10978 \ "hubic" 10979 14 / JottaCloud 10980 \ "jottacloud" 10981 15 / Local Disk 10982 \ "local" 10983 16 / Mega 10984 \ "mega" 10985 17 / Microsoft Azure Blob Storage 10986 \ "azureblob" 10987 18 / Microsoft OneDrive 10988 \ "onedrive" 10989 19 / OpenDrive 10990 \ "opendrive" 10991 20 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 10992 \ "swift" 10993 21 / Pcloud 10994 \ "pcloud" 10995 22 / QingCloud Object Storage 10996 \ "qingstor" 10997 23 / SSH/SFTP Connection 10998 \ "sftp" 10999 24 / Webdav 11000 \ "webdav" 11001 25 / Yandex Disk 11002 \ "yandex" 11003 26 / http Connection 11004 \ "http" 11005 Storage> union 11006 List of space separated remotes. 11007 Can be 'remotea:test/dir remoteb:', '"remotea:test/space dir" remoteb:', etc. 11008 The last remote is used to write to. 11009 Enter a string value. Press Enter for the default (""). 11010 remotes> 11011 Remote config 11012 -------------------- 11013 [remote] 11014 type = union 11015 remotes = C:\dir1 C:\dir2 C:\dir3 11016 -------------------- 11017 y) Yes this is OK 11018 e) Edit this remote 11019 d) Delete this remote 11020 y/e/d> y 11021 Current remotes: 11022 11023 Name Type 11024 ==== ==== 11025 remote union 11026 11027 e) Edit existing remote 11028 n) New remote 11029 d) Delete remote 11030 r) Rename remote 11031 c) Copy remote 11032 s) Set configuration password 11033 q) Quit config 11034 e/n/d/r/c/s/q> q</code></pre> 11035 <p>Once configured you can then use <code>rclone</code> like this,</p> 11036 <p>List directories in top level in <code>C:\dir1</code>, <code>C:\dir2</code> and <code>C:\dir3</code></p> 11037 <pre><code>rclone lsd remote:</code></pre> 11038 <p>List all the files in <code>C:\dir1</code>, <code>C:\dir2</code> and <code>C:\dir3</code></p> 11039 <pre><code>rclone ls remote:</code></pre> 11040 <p>Copy another local directory to the union directory called source, which will be placed into <code>C:\dir3</code></p> 11041 <pre><code>rclone copy C:\source remote:source</code></pre> 11042 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/union/union.go then run make backenddocs --> 11043 <h3 id="standard-options-23">Standard Options</h3> 11044 <p>Here are the standard options specific to union (A stackable unification remote, which can appear to merge the contents of several remotes).</p> 11045 <h4 id="union-remotes">–union-remotes</h4> 11046 <p>List of space separated remotes. Can be ‘remotea:test/dir remoteb:’, ‘“remotea:test/space dir” remoteb:’, etc. The last remote is used to write to.</p> 11047 <ul> 11048 <li>Config: remotes</li> 11049 <li>Env Var: RCLONE_UNION_REMOTES</li> 11050 <li>Type: string</li> 11051 <li>Default: ""</li> 11052 </ul> 11053 <!--- autogenerated options stop --> 11054 <h2 id="webdav">WebDAV</h2> 11055 <p>Paths are specified as <code>remote:path</code></p> 11056 <p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 11057 <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> 11058 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 11059 <pre><code> rclone config</code></pre> 11060 <p>This will guide you through an interactive setup process:</p> 11061 <pre><code>No remotes found - make a new one 11062 n) New remote 11063 s) Set configuration password 11064 q) Quit config 11065 n/s/q> n 11066 name> remote 11067 Type of storage to configure. 11068 Choose a number from below, or type in your own value 11069 [snip] 11070 22 / Webdav 11071 \ "webdav" 11072 [snip] 11073 Storage> webdav 11074 URL of http host to connect to 11075 Choose a number from below, or type in your own value 11076 1 / Connect to example.com 11077 \ "https://example.com" 11078 url> https://example.com/remote.php/webdav/ 11079 Name of the Webdav site/service/software you are using 11080 Choose a number from below, or type in your own value 11081 1 / Nextcloud 11082 \ "nextcloud" 11083 2 / Owncloud 11084 \ "owncloud" 11085 3 / Sharepoint 11086 \ "sharepoint" 11087 4 / Other site/service or software 11088 \ "other" 11089 vendor> 1 11090 User name 11091 user> user 11092 Password. 11093 y) Yes type in my own password 11094 g) Generate random password 11095 n) No leave this optional password blank 11096 y/g/n> y 11097 Enter the password: 11098 password: 11099 Confirm the password: 11100 password: 11101 Bearer token instead of user/pass (eg a Macaroon) 11102 bearer_token> 11103 Remote config 11104 -------------------- 11105 [remote] 11106 type = webdav 11107 url = https://example.com/remote.php/webdav/ 11108 vendor = nextcloud 11109 user = user 11110 pass = *** ENCRYPTED *** 11111 bearer_token = 11112 -------------------- 11113 y) Yes this is OK 11114 e) Edit this remote 11115 d) Delete this remote 11116 y/e/d> y</code></pre> 11117 <p>Once configured you can then use <code>rclone</code> like this,</p> 11118 <p>List directories in top level of your WebDAV</p> 11119 <pre><code>rclone lsd remote:</code></pre> 11120 <p>List all the files in your WebDAV</p> 11121 <pre><code>rclone ls remote:</code></pre> 11122 <p>To copy a local directory to an WebDAV directory called backup</p> 11123 <pre><code>rclone copy /home/source remote:backup</code></pre> 11124 <h3 id="modified-time-and-hashes-7">Modified time and hashes</h3> 11125 <p>Plain WebDAV does not support modified times. However when used with Owncloud or Nextcloud rclone will support modified times.</p> 11126 <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> 11127 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/webdav/webdav.go then run make backenddocs --> 11128 <h3 id="standard-options-24">Standard Options</h3> 11129 <p>Here are the standard options specific to webdav (Webdav).</p> 11130 <h4 id="webdav-url">–webdav-url</h4> 11131 <p>URL of http host to connect to</p> 11132 <ul> 11133 <li>Config: url</li> 11134 <li>Env Var: RCLONE_WEBDAV_URL</li> 11135 <li>Type: string</li> 11136 <li>Default: ""</li> 11137 <li>Examples: 11138 <ul> 11139 <li>“https://example.com” 11140 <ul> 11141 <li>Connect to example.com</li> 11142 </ul></li> 11143 </ul></li> 11144 </ul> 11145 <h4 id="webdav-vendor">–webdav-vendor</h4> 11146 <p>Name of the Webdav site/service/software you are using</p> 11147 <ul> 11148 <li>Config: vendor</li> 11149 <li>Env Var: RCLONE_WEBDAV_VENDOR</li> 11150 <li>Type: string</li> 11151 <li>Default: ""</li> 11152 <li>Examples: 11153 <ul> 11154 <li>“nextcloud” 11155 <ul> 11156 <li>Nextcloud</li> 11157 </ul></li> 11158 <li>“owncloud” 11159 <ul> 11160 <li>Owncloud</li> 11161 </ul></li> 11162 <li>“sharepoint” 11163 <ul> 11164 <li>Sharepoint</li> 11165 </ul></li> 11166 <li>“other” 11167 <ul> 11168 <li>Other site/service or software</li> 11169 </ul></li> 11170 </ul></li> 11171 </ul> 11172 <h4 id="webdav-user">–webdav-user</h4> 11173 <p>User name</p> 11174 <ul> 11175 <li>Config: user</li> 11176 <li>Env Var: RCLONE_WEBDAV_USER</li> 11177 <li>Type: string</li> 11178 <li>Default: ""</li> 11179 </ul> 11180 <h4 id="webdav-pass">–webdav-pass</h4> 11181 <p>Password.</p> 11182 <ul> 11183 <li>Config: pass</li> 11184 <li>Env Var: RCLONE_WEBDAV_PASS</li> 11185 <li>Type: string</li> 11186 <li>Default: ""</li> 11187 </ul> 11188 <h4 id="webdav-bearer-token">–webdav-bearer-token</h4> 11189 <p>Bearer token instead of user/pass (eg a Macaroon)</p> 11190 <ul> 11191 <li>Config: bearer_token</li> 11192 <li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN</li> 11193 <li>Type: string</li> 11194 <li>Default: ""</li> 11195 </ul> 11196 <!--- autogenerated options stop --> 11197 <h2 id="provider-notes">Provider notes</h2> 11198 <p>See below for notes on specific providers.</p> 11199 <h3 id="owncloud">Owncloud</h3> 11200 <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> 11201 <p>Owncloud supports modified times using the <code>X-OC-Mtime</code> header.</p> 11202 <h3 id="nextcloud">Nextcloud</h3> 11203 <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> 11204 <h3 id="put.io">Put.io</h3> 11205 <p>put.io can be accessed in a read only way using webdav.</p> 11206 <p>Configure the <code>url</code> as <code>https://webdav.put.io</code> and use your normal account username and password for <code>user</code> and <code>pass</code>. Set the <code>vendor</code> to <code>other</code>.</p> 11207 <p>Your config file should end up looking like this:</p> 11208 <pre><code>[putio] 11209 type = webdav 11210 url = https://webdav.put.io 11211 vendor = other 11212 user = YourUserName 11213 pass = encryptedpassword</code></pre> 11214 <p>If you are using <code>put.io</code> with <code>rclone mount</code> then use the <code>--read-only</code> flag to signal to the OS that it can’t write to the mount.</p> 11215 <p>For more help see <a href="http://help.put.io/apps-and-integrations/ftp-and-webdav">the put.io webdav docs</a>.</p> 11216 <h3 id="sharepoint">Sharepoint</h3> 11217 <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/ncw/rclone/issues/1975">github#1975</a></p> 11218 <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> 11219 <p>To use a sharepoint remote with rclone, add it like this: First, you need to get your remote’s URL:</p> 11220 <ul> 11221 <li>Go <a href="https://onedrive.live.com/about/en-us/signin/">here</a> to open your OneDrive or to sign in</li> 11222 <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> 11223 </ul> 11224 <p>You’ll only need this URL upto the email address. After that, you’ll most likely want to add “/Documents”. That subdirectory contains the actual data stored on your OneDrive.</p> 11225 <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> 11226 <p>Your config file should look like this:</p> 11227 <pre><code>[sharepoint] 11228 type = webdav 11229 url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents 11230 vendor = other 11231 user = YourEmailAddress 11232 pass = encryptedpassword</code></pre> 11233 <h3 id="dcache">dCache</h3> 11234 <p><a href="https://www.dcache.org/">dCache</a> is a storage system with WebDAV doors that support, beside basic and x509, authentication with <a href="https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anupam_macaroons_v02.pdf">Macaroons</a> (bearer tokens).</p> 11235 <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> 11236 <p>The config will end up looking something like this.</p> 11237 <pre><code>[dcache] 11238 type = webdav 11239 url = https://dcache... 11240 vendor = other 11241 user = 11242 pass = 11243 bearer_token = your-macaroon</code></pre> 11244 <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> 11245 <h2 id="yandex-disk">Yandex Disk</h2> 11246 <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> 11247 <p>Yandex paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 11248 <p>Here is an example of making a yandex configuration. First run</p> 11249 <pre><code>rclone config</code></pre> 11250 <p>This will guide you through an interactive setup process:</p> 11251 <pre><code>No remotes found - make a new one 11252 n) New remote 11253 s) Set configuration password 11254 n/s> n 11255 name> remote 11256 Type of storage to configure. 11257 Choose a number from below, or type in your own value 11258 1 / Amazon Drive 11259 \ "amazon cloud drive" 11260 2 / Amazon S3 (also Dreamhost, Ceph, Minio) 11261 \ "s3" 11262 3 / Backblaze B2 11263 \ "b2" 11264 4 / Dropbox 11265 \ "dropbox" 11266 5 / Encrypt/Decrypt a remote 11267 \ "crypt" 11268 6 / Google Cloud Storage (this is not Google Drive) 11269 \ "google cloud storage" 11270 7 / Google Drive 11271 \ "drive" 11272 8 / Hubic 11273 \ "hubic" 11274 9 / Local Disk 11275 \ "local" 11276 10 / Microsoft OneDrive 11277 \ "onedrive" 11278 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11279 \ "swift" 11280 12 / SSH/SFTP Connection 11281 \ "sftp" 11282 13 / Yandex Disk 11283 \ "yandex" 11284 Storage> 13 11285 Yandex Client Id - leave blank normally. 11286 client_id> 11287 Yandex Client Secret - leave blank normally. 11288 client_secret> 11289 Remote config 11290 Use auto config? 11291 * Say Y if not sure 11292 * Say N if you are working on a remote or headless machine 11293 y) Yes 11294 n) No 11295 y/n> y 11296 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 11297 Log in and authorize rclone for access 11298 Waiting for code... 11299 Got code 11300 -------------------- 11301 [remote] 11302 client_id = 11303 client_secret = 11304 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","expiry":"2016-12-29T12:27:11.362788025Z"} 11305 -------------------- 11306 y) Yes this is OK 11307 e) Edit this remote 11308 d) Delete this remote 11309 y/e/d> y</code></pre> 11310 <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> 11311 <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> 11312 <p>Once configured you can then use <code>rclone</code> like this,</p> 11313 <p>See top level directories</p> 11314 <pre><code>rclone lsd remote:</code></pre> 11315 <p>Make a new directory</p> 11316 <pre><code>rclone mkdir remote:directory</code></pre> 11317 <p>List the contents of a directory</p> 11318 <pre><code>rclone ls remote:directory</code></pre> 11319 <p>Sync <code>/home/local/directory</code> to the remote path, deleting any excess files in the path.</p> 11320 <pre><code>rclone sync /home/local/directory remote:directory</code></pre> 11321 <h3 id="modified-time-10">Modified time</h3> 11322 <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> 11323 <h3 id="md5-checksums">MD5 checksums</h3> 11324 <p>MD5 checksums are natively supported by Yandex Disk.</p> 11325 <h3 id="emptying-trash-1">Emptying Trash</h3> 11326 <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> 11327 <h3 id="quota-information-2">Quota information</h3> 11328 <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> 11329 <h3 id="limitations-15">Limitations</h3> 11330 <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> 11331 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/yandex/yandex.go then run make backenddocs --> 11332 <h3 id="standard-options-25">Standard Options</h3> 11333 <p>Here are the standard options specific to yandex (Yandex Disk).</p> 11334 <h4 id="yandex-client-id">–yandex-client-id</h4> 11335 <p>Yandex Client Id Leave blank normally.</p> 11336 <ul> 11337 <li>Config: client_id</li> 11338 <li>Env Var: RCLONE_YANDEX_CLIENT_ID</li> 11339 <li>Type: string</li> 11340 <li>Default: ""</li> 11341 </ul> 11342 <h4 id="yandex-client-secret">–yandex-client-secret</h4> 11343 <p>Yandex Client Secret Leave blank normally.</p> 11344 <ul> 11345 <li>Config: client_secret</li> 11346 <li>Env Var: RCLONE_YANDEX_CLIENT_SECRET</li> 11347 <li>Type: string</li> 11348 <li>Default: ""</li> 11349 </ul> 11350 <h3 id="advanced-options-19">Advanced Options</h3> 11351 <p>Here are the advanced options specific to yandex (Yandex Disk).</p> 11352 <h4 id="yandex-unlink">–yandex-unlink</h4> 11353 <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> 11354 <ul> 11355 <li>Config: unlink</li> 11356 <li>Env Var: RCLONE_YANDEX_UNLINK</li> 11357 <li>Type: bool</li> 11358 <li>Default: false</li> 11359 </ul> 11360 <!--- autogenerated options stop --> 11361 <h2 id="local-filesystem">Local Filesystem</h2> 11362 <p>Local paths are specified as normal filesystem paths, eg <code>/path/to/wherever</code>, so</p> 11363 <pre><code>rclone sync /home/source /tmp/destination</code></pre> 11364 <p>Will sync <code>/home/source</code> to <code>/tmp/destination</code></p> 11365 <p>These can be configured into the config file for consistencies sake, but it is probably easier not to.</p> 11366 <h3 id="modified-time-11">Modified time</h3> 11367 <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> 11368 <h3 id="filenames">Filenames</h3> 11369 <p>Filenames are expected to be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.</p> 11370 <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> 11371 <p>If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with the unicode replacement character, ‘�’. <code>rclone</code> will emit a debug message in this case (use <code>-v</code> to see), eg</p> 11372 <pre><code>Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"</code></pre> 11373 <h3 id="long-paths-on-windows">Long paths on Windows</h3> 11374 <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> 11375 <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> 11376 <p>However, in rare cases this may cause problems with buggy file system drivers like <a href="https://github.com/ncw/rclone/issues/261">EncFS</a>. To disable UNC conversion globally, add this to your <code>.rclone.conf</code> file:</p> 11377 <pre><code>[local] 11378 nounc = true</code></pre> 11379 <p>If you want to selectively disable UNC, you can add it to a separate entry like this:</p> 11380 <pre><code>[nounc] 11381 type = local 11382 nounc = true</code></pre> 11383 <p>And use rclone like this:</p> 11384 <p><code>rclone copy c:\src nounc:z:\dst</code></p> 11385 <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> 11386 <h3 id="symlinks-junction-points">Symlinks / Junction points</h3> 11387 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 11388 <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> 11389 <p>This flag applies to all commands.</p> 11390 <p>For example, supposing you have a directory structure like this</p> 11391 <pre><code>$ tree /tmp/a 11392 /tmp/a 11393 ├── b -> ../b 11394 ├── expected -> ../expected 11395 ├── one 11396 └── two 11397 └── three</code></pre> 11398 <p>Then you can see the difference with and without the flag like this</p> 11399 <pre><code>$ rclone ls /tmp/a 11400 6 one 11401 6 two/three</code></pre> 11402 <p>and</p> 11403 <pre><code>$ rclone -L ls /tmp/a 11404 4174 expected 11405 6 one 11406 6 two/three 11407 6 b/two 11408 6 b/one</code></pre> 11409 <h4 id="links--l">–links, -l</h4> 11410 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 11411 <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> 11412 <p>The text file will contain the target of the symbolic link (see example).</p> 11413 <p>This flag applies to all commands.</p> 11414 <p>For example, supposing you have a directory structure like this</p> 11415 <pre><code>$ tree /tmp/a 11416 /tmp/a 11417 ├── file1 -> ./file4 11418 └── file2 -> /home/user/file3</code></pre> 11419 <p>Copying the entire directory with ‘-l’</p> 11420 <pre><code>$ rclone copyto -l /tmp/a/file1 remote:/tmp/a/</code></pre> 11421 <p>The remote files are created with a ‘.rclonelink’ suffix</p> 11422 <pre><code>$ rclone ls remote:/tmp/a 11423 5 file1.rclonelink 11424 14 file2.rclonelink</code></pre> 11425 <p>The remote files will contain the target of the symbolic links</p> 11426 <pre><code>$ rclone cat remote:/tmp/a/file1.rclonelink 11427 ./file4 11428 11429 $ rclone cat remote:/tmp/a/file2.rclonelink 11430 /home/user/file3</code></pre> 11431 <p>Copying them back with ‘-l’</p> 11432 <pre><code>$ rclone copyto -l remote:/tmp/a/ /tmp/b/ 11433 11434 $ tree /tmp/b 11435 /tmp/b 11436 ├── file1 -> ./file4 11437 └── file2 -> /home/user/file3</code></pre> 11438 <p>However, if copied back without ‘-l’</p> 11439 <pre><code>$ rclone copyto remote:/tmp/a/ /tmp/b/ 11440 11441 $ tree /tmp/b 11442 /tmp/b 11443 ├── file1.rclonelink 11444 └── file2.rclonelink</code></pre> 11445 <p>Note that this flag is incompatible with <code>-copy-links</code> / <code>-L</code>.</p> 11446 <h3 id="restricting-filesystems-with-one-file-system">Restricting filesystems with –one-file-system</h3> 11447 <p>Normally rclone will recurse through filesystems as mounted.</p> 11448 <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> 11449 <p>For example if you have a directory hierarchy like this</p> 11450 <pre><code>root 11451 ├── disk1 - disk1 mounted on the root 11452 │ └── file3 - stored on disk1 11453 ├── disk2 - disk2 mounted on the root 11454 │ └── file4 - stored on disk12 11455 ├── file1 - stored on the root disk 11456 └── file2 - stored on the root disk</code></pre> 11457 <p>Using <code>rclone --one-file-system copy root remote:</code> will only copy <code>file1</code> and <code>file2</code>. Eg</p> 11458 <pre><code>$ rclone -q --one-file-system ls root 11459 0 file1 11460 0 file2</code></pre> 11461 <pre><code>$ rclone -q ls root 11462 0 disk1/file3 11463 0 disk2/file4 11464 0 file1 11465 0 file2</code></pre> 11466 <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> 11467 <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> 11468 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/local/local.go then run make backenddocs --> 11469 <h3 id="standard-options-26">Standard Options</h3> 11470 <p>Here are the standard options specific to local (Local Disk).</p> 11471 <h4 id="local-nounc">–local-nounc</h4> 11472 <p>Disable UNC (long path names) conversion on Windows</p> 11473 <ul> 11474 <li>Config: nounc</li> 11475 <li>Env Var: RCLONE_LOCAL_NOUNC</li> 11476 <li>Type: string</li> 11477 <li>Default: ""</li> 11478 <li>Examples: 11479 <ul> 11480 <li>“true” 11481 <ul> 11482 <li>Disables long file names</li> 11483 </ul></li> 11484 </ul></li> 11485 </ul> 11486 <h3 id="advanced-options-20">Advanced Options</h3> 11487 <p>Here are the advanced options specific to local (Local Disk).</p> 11488 <h4 id="copy-links">–copy-links</h4> 11489 <p>Follow symlinks and copy the pointed to item.</p> 11490 <ul> 11491 <li>Config: copy_links</li> 11492 <li>Env Var: RCLONE_LOCAL_COPY_LINKS</li> 11493 <li>Type: bool</li> 11494 <li>Default: false</li> 11495 </ul> 11496 <h4 id="links">–links</h4> 11497 <p>Translate symlinks to/from regular files with a ‘.rclonelink’ extension</p> 11498 <ul> 11499 <li>Config: links</li> 11500 <li>Env Var: RCLONE_LOCAL_LINKS</li> 11501 <li>Type: bool</li> 11502 <li>Default: false</li> 11503 </ul> 11504 <h4 id="skip-links">–skip-links</h4> 11505 <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> 11506 <ul> 11507 <li>Config: skip_links</li> 11508 <li>Env Var: RCLONE_LOCAL_SKIP_LINKS</li> 11509 <li>Type: bool</li> 11510 <li>Default: false</li> 11511 </ul> 11512 <h4 id="local-no-unicode-normalization">–local-no-unicode-normalization</h4> 11513 <p>Don’t apply unicode normalization to paths and filenames (Deprecated)</p> 11514 <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> 11515 <ul> 11516 <li>Config: no_unicode_normalization</li> 11517 <li>Env Var: RCLONE_LOCAL_NO_UNICODE_NORMALIZATION</li> 11518 <li>Type: bool</li> 11519 <li>Default: false</li> 11520 </ul> 11521 <h4 id="local-no-check-updated">–local-no-check-updated</h4> 11522 <p>Don’t check to see if the files change during upload</p> 11523 <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> 11524 <p>However on some file systems this modification time check may fail (eg <a href="https://github.com/ncw/rclone/issues/2206">Glusterfs #2206</a>) so this check can be disabled with this flag.</p> 11525 <ul> 11526 <li>Config: no_check_updated</li> 11527 <li>Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED</li> 11528 <li>Type: bool</li> 11529 <li>Default: false</li> 11530 </ul> 11531 <h4 id="one-file-system">–one-file-system</h4> 11532 <p>Don’t cross filesystem boundaries (unix/macOS only).</p> 11533 <ul> 11534 <li>Config: one_file_system</li> 11535 <li>Env Var: RCLONE_LOCAL_ONE_FILE_SYSTEM</li> 11536 <li>Type: bool</li> 11537 <li>Default: false</li> 11538 </ul> 11539 <!--- autogenerated options stop --> 11540 <h1 id="changelog">Changelog</h1> 11541 <h2 id="v1.48.0---2019-06-15">v1.48.0 - 2019-06-15</h2> 11542 <ul> 11543 <li>New commands 11544 <ul> 11545 <li>serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood)</li> 11546 </ul></li> 11547 <li>New Features 11548 <ul> 11549 <li>Multi threaded downloads to local storage (Nick Craig-Wood) 11550 <ul> 11551 <li>controlled with <code>--multi-thread-cutoff</code> and <code>--multi-thread-streams</code></li> 11552 </ul></li> 11553 <li>Use rclone.conf from rclone executable directory to enable portable use (albertony)</li> 11554 <li>Allow sync of a file and a directory with the same name (forgems) 11555 <ul> 11556 <li>this is common on bucket based remotes, eg s3, gcs</li> 11557 </ul></li> 11558 <li>Add <code>--ignore-case-sync</code> for forced case insensitivity (garry415)</li> 11559 <li>Implement <code>--stats-one-line-date</code> and <code>--stats-one-line-date-format</code> (Peter Berbec)</li> 11560 <li>Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood)</li> 11561 <li>Use go-homedir to read the home directory more reliably (Nick Craig-Wood)</li> 11562 <li>Enable creating encrypted config through external script invocation (Wojciech Smigielski)</li> 11563 <li>build: Drop support for go1.8 (Nick Craig-Wood)</li> 11564 <li>config: Make config create/update encrypt passwords where necessary (Nick Craig-Wood)</li> 11565 <li>copyurl: Honor <code>--no-check-certificate</code> (Stefan Breunig)</li> 11566 <li>install: Linux skip man pages if no mandb (didil)</li> 11567 <li>lsf: Support showing the Tier of the object (Nick Craig-Wood)</li> 11568 <li>lsjson 11569 <ul> 11570 <li>Added EncryptedPath to output (calisro)</li> 11571 <li>Support showing the Tier of the object (Nick Craig-Wood)</li> 11572 <li>Add IsBucket field for bucket based remote listing of the root (Nick Craig-Wood)</li> 11573 </ul></li> 11574 <li>rc 11575 <ul> 11576 <li>Add <code>--loopback</code> flag to run commands directly without a server (Nick Craig-Wood)</li> 11577 <li>Add operations/fsinfo: Return information about the remote (Nick Craig-Wood)</li> 11578 <li>Skip auth for OPTIONS request (Nick Craig-Wood)</li> 11579 <li>cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick Craig-Wood)</li> 11580 <li>jobs: Make job expiry timeouts configurable (Aleksandar Jankovic)</li> 11581 </ul></li> 11582 <li>serve dlna reworked and improved (Dan Walters)</li> 11583 <li>serve ftp: add <code>--ftp-public-ip</code> flag to specify public IP (calistri)</li> 11584 <li>serve restic: Add support for <code>--private-repos</code> in <code>serve restic</code> (Florian Apolloner)</li> 11585 <li>serve webdav: Combine serve webdav and serve http (Gary Kim)</li> 11586 <li>size: Ignore negative sizes when calculating total (Garry McNulty)</li> 11587 </ul></li> 11588 <li>Bug Fixes 11589 <ul> 11590 <li>Make move and copy individual files obey <code>--backup-dir</code> (Nick Craig-Wood)</li> 11591 <li>If <code>--ignore-checksum</code> is in effect, don’t calculate checksum (Nick Craig-Wood)</li> 11592 <li>moveto: Fix case-insensitive same remote move (Gary Kim)</li> 11593 <li>rc: Fix serving bucket based objects with <code>--rc-serve</code> (Nick Craig-Wood)</li> 11594 <li>serve webdav: Fix serveDir not being updated with changes from webdav (Gary Kim)</li> 11595 </ul></li> 11596 <li>Mount 11597 <ul> 11598 <li>Fix poll interval documentation (Animosity022)</li> 11599 </ul></li> 11600 <li>VFS 11601 <ul> 11602 <li>Make WriteAt for non cached files work with non-sequential writes (Nick Craig-Wood)</li> 11603 </ul></li> 11604 <li>Local 11605 <ul> 11606 <li>Only calculate the required hashes for big speedup (Nick Craig-Wood)</li> 11607 <li>Log errors when listing instead of returning an error (Nick Craig-Wood)</li> 11608 <li>Fix preallocate warning on Linux with ZFS (Nick Craig-Wood)</li> 11609 </ul></li> 11610 <li>Crypt 11611 <ul> 11612 <li>Make rclone dedupe work through crypt (Nick Craig-Wood)</li> 11613 <li>Fix wrapping of ChangeNotify to decrypt directories properly (Nick Craig-Wood)</li> 11614 <li>Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood)</li> 11615 <li>Implement Optional methods SetTier, GetTier (Nick Craig-Wood)</li> 11616 </ul></li> 11617 <li>B2 11618 <ul> 11619 <li>Implement server side copy (Nick Craig-Wood)</li> 11620 <li>Implement SetModTime (Nick Craig-Wood)</li> 11621 </ul></li> 11622 <li>Drive 11623 <ul> 11624 <li>Fix move and copy from TeamDrive to GDrive (Fionera)</li> 11625 <li>Add notes that cleanup works in the background on drive (Nick Craig-Wood)</li> 11626 <li>Add <code>--drive-server-side-across-configs</code> to default back to old server side copy semantics by default (Nick Craig-Wood)</li> 11627 <li>Add <code>--drive-size-as-quota</code> to show storage quota usage for file size (Garry McNulty)</li> 11628 </ul></li> 11629 <li>FTP 11630 <ul> 11631 <li>Add FTP List timeout (Jeff Quinn)</li> 11632 <li>Add FTP over TLS support (Gary Kim)</li> 11633 <li>Add <code>--ftp-no-check-certificate</code> option for FTPS (Gary Kim)</li> 11634 </ul></li> 11635 <li>Google Cloud Storage 11636 <ul> 11637 <li>Fix upload errors when uploading pre 1970 files (Nick Craig-Wood)</li> 11638 </ul></li> 11639 <li>Jottacloud 11640 <ul> 11641 <li>Add support for selecting device and mountpoint. (buengese)</li> 11642 </ul></li> 11643 <li>Mega 11644 <ul> 11645 <li>Add cleanup support (Gary Kim)</li> 11646 </ul></li> 11647 <li>Onedrive 11648 <ul> 11649 <li>More accurately check if root is found (Cnly)</li> 11650 </ul></li> 11651 <li>S3 11652 <ul> 11653 <li>Suppport S3 Accelerated endpoints with <code>--s3-use-accelerate-endpoint</code> (Nick Craig-Wood)</li> 11654 <li>Add config info for Wasabi’s EU Central endpoint (Robert Marko)</li> 11655 <li>Make SetModTime work for GLACIER while syncing (Philip Harvey)</li> 11656 </ul></li> 11657 <li>SFTP 11658 <ul> 11659 <li>Add About support (Gary Kim)</li> 11660 <li>Fix about parsing of <code>df</code> results so it can cope with -ve results (Nick Craig-Wood)</li> 11661 <li>Send custom client version and debug server version (Nick Craig-Wood)</li> 11662 </ul></li> 11663 <li>WebDAV 11664 <ul> 11665 <li>Retry on 423 Locked errors (Nick Craig-Wood)</li> 11666 </ul></li> 11667 </ul> 11668 <h2 id="v1.47.0---2019-04-13">v1.47.0 - 2019-04-13</h2> 11669 <ul> 11670 <li>New backends 11671 <ul> 11672 <li>Backend for Koofr cloud storage service. (jaKa)</li> 11673 </ul></li> 11674 <li>New Features 11675 <ul> 11676 <li>Resume downloads if the reader fails in copy (Nick Craig-Wood) 11677 <ul> 11678 <li>this means rclone will restart transfers if the source has an error</li> 11679 <li>this is most useful for downloads or cloud to cloud copies</li> 11680 </ul></li> 11681 <li>Use <code>--fast-list</code> for listing operations where it won’t use more memory (Nick Craig-Wood) 11682 <ul> 11683 <li>this should speed up the following operations on remotes which support <code>ListR</code></li> 11684 <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> 11685 <li>use <code>--disable ListR</code> to get old behaviour if required</li> 11686 </ul></li> 11687 <li>Make <code>--files-from</code> traverse the destination unless <code>--no-traverse</code> is set (Nick Craig-Wood) 11688 <ul> 11689 <li>this fixes <code>--files-from</code> with Google drive and excessive API use in general.</li> 11690 </ul></li> 11691 <li>Make server side copy account bytes and obey <code>--max-transfer</code> (Nick Craig-Wood)</li> 11692 <li>Add <code>--create-empty-src-dirs</code> flag and default to not creating empty dirs (ishuah)</li> 11693 <li>Add client side TLS/SSL flags <code>--ca-cert</code>/<code>--client-cert</code>/<code>--client-key</code> (Nick Craig-Wood)</li> 11694 <li>Implement <code>--suffix-keep-extension</code> for use with <code>--suffix</code> (Nick Craig-Wood)</li> 11695 <li>build: 11696 <ul> 11697 <li>Switch to semvar compliant version tags to be go modules compliant (Nick Craig-Wood)</li> 11698 <li>Update to use go1.12.x for the build (Nick Craig-Wood)</li> 11699 </ul></li> 11700 <li>serve dlna: Add connection manager service description to improve compatibility (Dan Walters)</li> 11701 <li>lsf: Add ‘e’ format to show encrypted names and ‘o’ for original IDs (Nick Craig-Wood)</li> 11702 <li>lsjson: Added <code>--files-only</code> and <code>--dirs-only</code> flags (calistri)</li> 11703 <li>rc: Implement operations/publiclink the equivalent of <code>rclone link</code> (Nick Craig-Wood)</li> 11704 </ul></li> 11705 <li>Bug Fixes 11706 <ul> 11707 <li>accounting: Fix total ETA when <code>--stats-unit bits</code> is in effect (Nick Craig-Wood)</li> 11708 <li>Bash TAB completion 11709 <ul> 11710 <li>Use private custom func to fix clash between rclone and kubectl (Nick Craig-Wood)</li> 11711 <li>Fix for remotes with underscores in their names (Six)</li> 11712 <li>Fix completion of remotes (Florian Gamböck)</li> 11713 <li>Fix autocompletion of remote paths with spaces (Danil Semelenov)</li> 11714 </ul></li> 11715 <li>serve dlna: Fix root XML service descriptor (Dan Walters)</li> 11716 <li>ncdu: Fix display corruption with Chinese characters (Nick Craig-Wood)</li> 11717 <li>Add SIGTERM to signals which run the exit handlers on unix (Nick Craig-Wood)</li> 11718 <li>rc: Reload filter when the options are set via the rc (Nick Craig-Wood)</li> 11719 </ul></li> 11720 <li>VFS / Mount 11721 <ul> 11722 <li>Fix FreeBSD: Ignore Truncate if called with no readers and already the correct size (Nick Craig-Wood)</li> 11723 <li>Read directory and check for a file before mkdir (Nick Craig-Wood)</li> 11724 <li>Shorten the locking window for vfs/refresh (Nick Craig-Wood)</li> 11725 </ul></li> 11726 <li>Azure Blob 11727 <ul> 11728 <li>Enable MD5 checksums when uploading files bigger than the “Cutoff” (Dr.Rx)</li> 11729 <li>Fix SAS URL support (Nick Craig-Wood)</li> 11730 </ul></li> 11731 <li>B2 11732 <ul> 11733 <li>Allow manual configuration of backblaze downloadUrl (Vince)</li> 11734 <li>Ignore already_hidden error on remove (Nick Craig-Wood)</li> 11735 <li>Ignore malformed <code>src_last_modified_millis</code> (Nick Craig-Wood)</li> 11736 </ul></li> 11737 <li>Drive 11738 <ul> 11739 <li>Add <code>--skip-checksum-gphotos</code> to ignore incorrect checksums on Google Photos (Nick Craig-Wood)</li> 11740 <li>Allow server side move/copy between different remotes. (Fionera)</li> 11741 <li>Add docs on team drives and <code>--fast-list</code> eventual consistency (Nestar47)</li> 11742 <li>Fix imports of text files (Nick Craig-Wood)</li> 11743 <li>Fix range requests on 0 length files (Nick Craig-Wood)</li> 11744 <li>Fix creation of duplicates with server side copy (Nick Craig-Wood)</li> 11745 </ul></li> 11746 <li>Dropbox 11747 <ul> 11748 <li>Retry blank errors to fix long listings (Nick Craig-Wood)</li> 11749 </ul></li> 11750 <li>FTP 11751 <ul> 11752 <li>Add <code>--ftp-concurrency</code> to limit maximum number of connections (Nick Craig-Wood)</li> 11753 </ul></li> 11754 <li>Google Cloud Storage 11755 <ul> 11756 <li>Fall back to default application credentials (marcintustin)</li> 11757 <li>Allow bucket policy only buckets (Nick Craig-Wood)</li> 11758 </ul></li> 11759 <li>HTTP 11760 <ul> 11761 <li>Add <code>--http-no-slash</code> for websites with directories with no slashes (Nick Craig-Wood)</li> 11762 <li>Remove duplicates from listings (Nick Craig-Wood)</li> 11763 <li>Fix socket leak on 404 errors (Nick Craig-Wood)</li> 11764 </ul></li> 11765 <li>Jottacloud 11766 <ul> 11767 <li>Fix token refresh (Sebastian Bünger)</li> 11768 <li>Add device registration (Oliver Heyme)</li> 11769 </ul></li> 11770 <li>Onedrive 11771 <ul> 11772 <li>Implement graceful cancel of multipart uploads if rclone is interrupted (Cnly)</li> 11773 <li>Always add trailing colon to path when addressing items, (Cnly)</li> 11774 <li>Return errors instead of panic for invalid uploads (Fabian Möller)</li> 11775 </ul></li> 11776 <li>S3 11777 <ul> 11778 <li>Add support for “Glacier Deep Archive” storage class (Manu)</li> 11779 <li>Update Dreamhost endpoint (Nick Craig-Wood)</li> 11780 <li>Note incompatibility with CEPH Jewel (Nick Craig-Wood)</li> 11781 </ul></li> 11782 <li>SFTP 11783 <ul> 11784 <li>Allow custom ssh client config (Alexandru Bumbacea)</li> 11785 </ul></li> 11786 <li>Swift 11787 <ul> 11788 <li>Obey Retry-After to enable OVH restore from cold storage (Nick Craig-Wood)</li> 11789 <li>Work around token expiry on CEPH (Nick Craig-Wood)</li> 11790 </ul></li> 11791 <li>WebDAV 11792 <ul> 11793 <li>Allow IsCollection property to be integer or boolean (Nick Craig-Wood)</li> 11794 <li>Fix race when creating directories (Nick Craig-Wood)</li> 11795 <li>Fix About/df when reading the available/total returns 0 (Nick Craig-Wood)</li> 11796 </ul></li> 11797 </ul> 11798 <h2 id="v1.46---2019-02-09">v1.46 - 2019-02-09</h2> 11799 <ul> 11800 <li>New backends 11801 <ul> 11802 <li>Support Alibaba Cloud (Aliyun) OSS via the s3 backend (Nick Craig-Wood)</li> 11803 </ul></li> 11804 <li>New commands 11805 <ul> 11806 <li>serve dlna: serves a remove via DLNA for the local network (nicolov)</li> 11807 </ul></li> 11808 <li>New Features 11809 <ul> 11810 <li>copy, move: Restore deprecated <code>--no-traverse</code> flag (Nick Craig-Wood) 11811 <ul> 11812 <li>This is useful for when transferring a small number of files into a large destination</li> 11813 </ul></li> 11814 <li>genautocomplete: Add remote path completion for bash completion (Christopher Peterson & Danil Semelenov)</li> 11815 <li>Buffer memory handling reworked to return memory to the OS better (Nick Craig-Wood) 11816 <ul> 11817 <li>Buffer recycling library to replace sync.Pool</li> 11818 <li>Optionally use memory mapped memory for better memory shrinking</li> 11819 <li>Enable with <code>--use-mmap</code> if having memory problems - not default yet</li> 11820 </ul></li> 11821 <li>Parallelise reading of files specified by <code>--files-from</code> (Nick Craig-Wood)</li> 11822 <li>check: Add stats showing total files matched. (Dario Guzik)</li> 11823 <li>Allow rename/delete open files under Windows (Nick Craig-Wood)</li> 11824 <li>lsjson: Use exactly the correct number of decimal places in the seconds (Nick Craig-Wood)</li> 11825 <li>Add cookie support with cmdline switch <code>--use-cookies</code> for all HTTP based remotes (qip)</li> 11826 <li>Warn if <code>--checksum</code> is set but there are no hashes available (Nick Craig-Wood)</li> 11827 <li>Rework rate limiting (pacer) to be more accurate and allow bursting (Nick Craig-Wood)</li> 11828 <li>Improve error reporting for too many/few arguments in commands (Nick Craig-Wood)</li> 11829 <li>listremotes: Remove <code>-l</code> short flag as it conflicts with the new global flag (weetmuts)</li> 11830 <li>Make http serving with auth generate INFO messages on auth fail (Nick Craig-Wood)</li> 11831 </ul></li> 11832 <li>Bug Fixes 11833 <ul> 11834 <li>Fix layout of stats (Nick Craig-Wood)</li> 11835 <li>Fix <code>--progress</code> crash under Windows Jenkins (Nick Craig-Wood)</li> 11836 <li>Fix transfer of google/onedrive docs by calling Rcat in Copy when size is -1 (Cnly)</li> 11837 <li>copyurl: Fix checking of <code>--dry-run</code> (Denis Skovpen)</li> 11838 </ul></li> 11839 <li>Mount 11840 <ul> 11841 <li>Check that mountpoint and local directory to mount don’t overlap (Nick Craig-Wood)</li> 11842 <li>Fix mount size under 32 bit Windows (Nick Craig-Wood)</li> 11843 </ul></li> 11844 <li>VFS 11845 <ul> 11846 <li>Implement renaming of directories for backends without DirMove (Nick Craig-Wood) 11847 <ul> 11848 <li>now all backends except b2 support renaming directories</li> 11849 </ul></li> 11850 <li>Implement <code>--vfs-cache-max-size</code> to limit the total size of the cache (Nick Craig-Wood)</li> 11851 <li>Add <code>--dir-perms</code> and <code>--file-perms</code> flags to set default permissions (Nick Craig-Wood)</li> 11852 <li>Fix deadlock on concurrent operations on a directory (Nick Craig-Wood)</li> 11853 <li>Fix deadlock between RWFileHandle.close and File.Remove (Nick Craig-Wood)</li> 11854 <li>Fix renaming/deleting open files with cache mode “writes” under Windows (Nick Craig-Wood)</li> 11855 <li>Fix panic on rename with <code>--dry-run</code> set (Nick Craig-Wood)</li> 11856 <li>Fix vfs/refresh with recurse=true needing the <code>--fast-list</code> flag</li> 11857 </ul></li> 11858 <li>Local 11859 <ul> 11860 <li>Add support for <code>-l</code>/<code>--links</code> (symbolic link translation) (yair@unicorn) 11861 <ul> 11862 <li>this works by showing links as <code>link.rclonelink</code> - see local backend docs for more info</li> 11863 <li>this errors if used with <code>-L</code>/<code>--copy-links</code></li> 11864 </ul></li> 11865 <li>Fix renaming/deleting open files on Windows (Nick Craig-Wood)</li> 11866 </ul></li> 11867 <li>Crypt 11868 <ul> 11869 <li>Check for maximum length before decrypting filename to fix panic (Garry McNulty)</li> 11870 </ul></li> 11871 <li>Azure Blob 11872 <ul> 11873 <li>Allow building azureblob backend on *BSD (themylogin)</li> 11874 <li>Use the rclone HTTP client to support <code>--dump headers</code>, <code>--tpslimit</code> etc (Nick Craig-Wood)</li> 11875 <li>Use the s3 pacer for 0 delay in non error conditions (Nick Craig-Wood)</li> 11876 <li>Ignore directory markers (Nick Craig-Wood)</li> 11877 <li>Stop Mkdir attempting to create existing containers (Nick Craig-Wood)</li> 11878 </ul></li> 11879 <li>B2 11880 <ul> 11881 <li>cleanup: will remove unfinished large files >24hrs old (Garry McNulty)</li> 11882 <li>For a bucket limited application key check the bucket name (Nick Craig-Wood) 11883 <ul> 11884 <li>before this, rclone would use the authorised bucket regardless of what you put on the command line</li> 11885 </ul></li> 11886 <li>Added <code>--b2-disable-checksum</code> flag (Wojciech Smigielski) 11887 <ul> 11888 <li>this enables large files to be uploaded without a SHA-1 hash for speed reasons</li> 11889 </ul></li> 11890 </ul></li> 11891 <li>Drive 11892 <ul> 11893 <li>Set default pacer to 100ms for 10 tps (Nick Craig-Wood) 11894 <ul> 11895 <li>This fits the Google defaults much better and reduces the 403 errors massively</li> 11896 <li>Add <code>--drive-pacer-min-sleep</code> and <code>--drive-pacer-burst</code> to control the pacer</li> 11897 </ul></li> 11898 <li>Improve ChangeNotify support for items with multiple parents (Fabian Möller)</li> 11899 <li>Fix ListR for items with multiple parents - this fixes oddities with <code>vfs/refresh</code> (Fabian Möller)</li> 11900 <li>Fix using <code>--drive-impersonate</code> and appfolders (Nick Craig-Wood)</li> 11901 <li>Fix google docs in rclone mount for some (not all) applications (Nick Craig-Wood)</li> 11902 </ul></li> 11903 <li>Dropbox 11904 <ul> 11905 <li>Retry-After support for Dropbox backend (Mathieu Carbou)</li> 11906 </ul></li> 11907 <li>FTP 11908 <ul> 11909 <li>Wait for 60 seconds for a connection to Close then declare it dead (Nick Craig-Wood) 11910 <ul> 11911 <li>helps with indefinite hangs on some FTP servers</li> 11912 </ul></li> 11913 </ul></li> 11914 <li>Google Cloud Storage 11915 <ul> 11916 <li>Update google cloud storage endpoints (weetmuts)</li> 11917 </ul></li> 11918 <li>HTTP 11919 <ul> 11920 <li>Add an example with username and password which is supported but wasn’t documented (Nick Craig-Wood)</li> 11921 <li>Fix backend with <code>--files-from</code> and non-existent files (Nick Craig-Wood)</li> 11922 </ul></li> 11923 <li>Hubic 11924 <ul> 11925 <li>Make error message more informative if authentication fails (Nick Craig-Wood)</li> 11926 </ul></li> 11927 <li>Jottacloud 11928 <ul> 11929 <li>Resume and deduplication support (Oliver Heyme)</li> 11930 <li>Use token auth for all API requests Don’t store password anymore (Sebastian Bünger)</li> 11931 <li>Add support for 2-factor authentification (Sebastian Bünger)</li> 11932 </ul></li> 11933 <li>Mega 11934 <ul> 11935 <li>Implement v2 account login which fixes logins for newer Mega accounts (Nick Craig-Wood)</li> 11936 <li>Return error if an unknown length file is attempted to be uploaded (Nick Craig-Wood)</li> 11937 <li>Add new error codes for better error reporting (Nick Craig-Wood)</li> 11938 </ul></li> 11939 <li>Onedrive 11940 <ul> 11941 <li>Fix broken support for “shared with me” folders (Alex Chen)</li> 11942 <li>Fix root ID not normalised (Cnly)</li> 11943 <li>Return err instead of panic on unknown-sized uploads (Cnly)</li> 11944 </ul></li> 11945 <li>Qingstor 11946 <ul> 11947 <li>Fix go routine leak on multipart upload errors (Nick Craig-Wood)</li> 11948 <li>Add upload chunk size/concurrency/cutoff control (Nick Craig-Wood)</li> 11949 <li>Default <code>--qingstor-upload-concurrency</code> to 1 to work around bug (Nick Craig-Wood)</li> 11950 </ul></li> 11951 <li>S3 11952 <ul> 11953 <li>Implement <code>--s3-upload-cutoff</code> for single part uploads below this (Nick Craig-Wood)</li> 11954 <li>Change <code>--s3-upload-concurrency</code> default to 4 to increase perfomance (Nick Craig-Wood)</li> 11955 <li>Add <code>--s3-bucket-acl</code> to control bucket ACL (Nick Craig-Wood)</li> 11956 <li>Auto detect region for buckets on operation failure (Nick Craig-Wood)</li> 11957 <li>Add GLACIER storage class (William Cocker)</li> 11958 <li>Add Scaleway to s3 documentation (Rémy Léone)</li> 11959 <li>Add AWS endpoint eu-north-1 (weetmuts)</li> 11960 </ul></li> 11961 <li>SFTP 11962 <ul> 11963 <li>Add support for PEM encrypted private keys (Fabian Möller)</li> 11964 <li>Add option to force the usage of an ssh-agent (Fabian Möller)</li> 11965 <li>Perform environment variable expansion on key-file (Fabian Möller)</li> 11966 <li>Fix rmdir on Windows based servers (eg CrushFTP) (Nick Craig-Wood)</li> 11967 <li>Fix rmdir deleting directory contents on some SFTP servers (Nick Craig-Wood)</li> 11968 <li>Fix error on dangling symlinks (Nick Craig-Wood)</li> 11969 </ul></li> 11970 <li>Swift 11971 <ul> 11972 <li>Add <code>--swift-no-chunk</code> to disable segmented uploads in rcat/mount (Nick Craig-Wood)</li> 11973 <li>Introduce application credential auth support (kayrus)</li> 11974 <li>Fix memory usage by slimming Object (Nick Craig-Wood)</li> 11975 <li>Fix extra requests on upload (Nick Craig-Wood)</li> 11976 <li>Fix reauth on big files (Nick Craig-Wood)</li> 11977 </ul></li> 11978 <li>Union 11979 <ul> 11980 <li>Fix poll-interval not working (Nick Craig-Wood)</li> 11981 </ul></li> 11982 <li>WebDAV 11983 <ul> 11984 <li>Support About which means rclone mount will show the correct disk size (Nick Craig-Wood)</li> 11985 <li>Support MD5 and SHA1 hashes with Owncloud and Nextcloud (Nick Craig-Wood)</li> 11986 <li>Fail soft on time parsing errors (Nick Craig-Wood)</li> 11987 <li>Fix infinite loop on failed directory creation (Nick Craig-Wood)</li> 11988 <li>Fix identification of directories for Bitrix Site Manager (Nick Craig-Wood)</li> 11989 <li>Fix upload of 0 length files on some servers (Nick Craig-Wood)</li> 11990 <li>Fix if MKCOL fails with 423 Locked assume the directory exists (Nick Craig-Wood)</li> 11991 </ul></li> 11992 </ul> 11993 <h2 id="v1.45---2018-11-24">v1.45 - 2018-11-24</h2> 11994 <ul> 11995 <li>New backends 11996 <ul> 11997 <li>The Yandex backend was re-written - see below for details (Sebastian Bünger)</li> 11998 </ul></li> 11999 <li>New commands 12000 <ul> 12001 <li>rcd: New command just to serve the remote control API (Nick Craig-Wood)</li> 12002 </ul></li> 12003 <li>New Features 12004 <ul> 12005 <li>The remote control API (rc) was greatly expanded to allow full control over rclone (Nick Craig-Wood) 12006 <ul> 12007 <li>sensitive operations require authorization or the <code>--rc-no-auth</code> flag</li> 12008 <li>config/* operations to configure rclone</li> 12009 <li>options/* for reading/setting command line flags</li> 12010 <li>operations/* for all low level operations, eg copy file, list directory</li> 12011 <li>sync/* for sync, copy and move</li> 12012 <li><code>--rc-files</code> flag to serve files on the rc http server 12013 <ul> 12014 <li>this is for building web native GUIs for rclone</li> 12015 </ul></li> 12016 <li>Optionally serving objects on the rc http server</li> 12017 <li>Ensure rclone fails to start up if the <code>--rc</code> port is in use already</li> 12018 <li>See <a href="https://rclone.org/rc/">the rc docs</a> for more info</li> 12019 </ul></li> 12020 <li>sync/copy/move 12021 <ul> 12022 <li>Make <code>--files-from</code> only read the objects specified and don’t scan directories (Nick Craig-Wood) 12023 <ul> 12024 <li>This is a huge speed improvement for destinations with lots of files</li> 12025 </ul></li> 12026 </ul></li> 12027 <li>filter: Add <code>--ignore-case</code> flag (Nick Craig-Wood)</li> 12028 <li>ncdu: Add remove function (‘d’ key) (Henning Surmeier)</li> 12029 <li>rc command 12030 <ul> 12031 <li>Add <code>--json</code> flag for structured JSON input (Nick Craig-Wood)</li> 12032 <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> 12033 </ul></li> 12034 <li>build 12035 <ul> 12036 <li>Require go1.8 or later for compilation (Nick Craig-Wood)</li> 12037 <li>Enable softfloat on MIPS arch (Scott Edlund)</li> 12038 <li>Integration test framework revamped with a better report and better retries (Nick Craig-Wood)</li> 12039 </ul></li> 12040 </ul></li> 12041 <li>Bug Fixes 12042 <ul> 12043 <li>cmd: Make –progress update the stats correctly at the end (Nick Craig-Wood)</li> 12044 <li>config: Create config directory on save if it is missing (Nick Craig-Wood)</li> 12045 <li>dedupe: Check for existing filename before renaming a dupe file (ssaqua)</li> 12046 <li>move: Don’t create directories with –dry-run (Nick Craig-Wood)</li> 12047 <li>operations: Fix Purge and Rmdirs when dir is not the root (Nick Craig-Wood)</li> 12048 <li>serve http/webdav/restic: Ensure rclone exits if the port is in use (Nick Craig-Wood)</li> 12049 </ul></li> 12050 <li>Mount 12051 <ul> 12052 <li>Make <code>--volname</code> work for Windows and macOS (Nick Craig-Wood)</li> 12053 </ul></li> 12054 <li>Azure Blob 12055 <ul> 12056 <li>Avoid context deadline exceeded error by setting a large TryTimeout value (brused27)</li> 12057 <li>Fix erroneous Rmdir error “directory not empty” (Nick Craig-Wood)</li> 12058 <li>Wait for up to 60s to create a just deleted container (Nick Craig-Wood)</li> 12059 </ul></li> 12060 <li>Dropbox 12061 <ul> 12062 <li>Add dropbox impersonate support (Jake Coggiano)</li> 12063 </ul></li> 12064 <li>Jottacloud 12065 <ul> 12066 <li>Fix bug in <code>--fast-list</code> handing of empty folders (albertony)</li> 12067 </ul></li> 12068 <li>Opendrive 12069 <ul> 12070 <li>Fix transfer of files with <code>+</code> and <code>&</code> in (Nick Craig-Wood)</li> 12071 <li>Fix retries of upload chunks (Nick Craig-Wood)</li> 12072 </ul></li> 12073 <li>S3 12074 <ul> 12075 <li>Set ACL for server side copies to that provided by the user (Nick Craig-Wood)</li> 12076 <li>Fix role_arn, credential_source, … (Erik Swanson)</li> 12077 <li>Add config info for Wasabi’s US-West endpoint (Henry Ptasinski)</li> 12078 </ul></li> 12079 <li>SFTP 12080 <ul> 12081 <li>Ensure file hash checking is really disabled (Jon Fautley)</li> 12082 </ul></li> 12083 <li>Swift 12084 <ul> 12085 <li>Add pacer for retries to make swift more reliable (Nick Craig-Wood)</li> 12086 </ul></li> 12087 <li>WebDAV 12088 <ul> 12089 <li>Add Content-Type to PUT requests (Nick Craig-Wood)</li> 12090 <li>Fix config parsing so <code>--webdav-user</code> and <code>--webdav-pass</code> flags work (Nick Craig-Wood)</li> 12091 <li>Add RFC3339 date format (Ralf Hemberger)</li> 12092 </ul></li> 12093 <li>Yandex 12094 <ul> 12095 <li>The yandex backend was re-written (Sebastian Bünger) 12096 <ul> 12097 <li>This implements low level retries (Sebastian Bünger)</li> 12098 <li>Copy, Move, DirMove, PublicLink and About optional interfaces (Sebastian Bünger)</li> 12099 <li>Improved general error handling (Sebastian Bünger)</li> 12100 <li>Removed ListR for now due to inconsistent behaviour (Sebastian Bünger)</li> 12101 </ul></li> 12102 </ul></li> 12103 </ul> 12104 <h2 id="v1.44---2018-10-15">v1.44 - 2018-10-15</h2> 12105 <ul> 12106 <li>New commands 12107 <ul> 12108 <li>serve ftp: Add ftp server (Antoine GIRARD)</li> 12109 <li>settier: perform storage tier changes on supported remotes (sandeepkru)</li> 12110 </ul></li> 12111 <li>New Features 12112 <ul> 12113 <li>Reworked command line help 12114 <ul> 12115 <li>Make default help less verbose (Nick Craig-Wood)</li> 12116 <li>Split flags up into global and backend flags (Nick Craig-Wood)</li> 12117 <li>Implement specialised help for flags and backends (Nick Craig-Wood)</li> 12118 <li>Show URL of backend help page when starting config (Nick Craig-Wood)</li> 12119 </ul></li> 12120 <li>stats: Long names now split in center (Joanna Marek)</li> 12121 <li>Add –log-format flag for more control over log output (dcpu)</li> 12122 <li>rc: Add support for OPTIONS and basic CORS (frenos)</li> 12123 <li>stats: show FatalErrors and NoRetryErrors in stats (Cédric Connes)</li> 12124 </ul></li> 12125 <li>Bug Fixes 12126 <ul> 12127 <li>Fix -P not ending with a new line (Nick Craig-Wood)</li> 12128 <li>config: don’t create default config dir when user supplies –config (albertony)</li> 12129 <li>Don’t print non-ASCII characters with –progress on windows (Nick Craig-Wood)</li> 12130 <li>Correct logs for excluded items (ssaqua)</li> 12131 </ul></li> 12132 <li>Mount 12133 <ul> 12134 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 12135 </ul></li> 12136 <li>VFS 12137 <ul> 12138 <li>Fix race condition detected by serve ftp tests (Nick Craig-Wood)</li> 12139 <li>Add vfs/poll-interval rc command (Fabian Möller)</li> 12140 <li>Enable rename for nearly all remotes using server side Move or Copy (Nick Craig-Wood)</li> 12141 <li>Reduce directory cache cleared by poll-interval (Fabian Möller)</li> 12142 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 12143 </ul></li> 12144 <li>Local 12145 <ul> 12146 <li>Skip bad symlinks in dir listing with -L enabled (Cédric Connes)</li> 12147 <li>Preallocate files on Windows to reduce fragmentation (Nick Craig-Wood)</li> 12148 <li>Preallocate files on linux with fallocate(2) (Nick Craig-Wood)</li> 12149 </ul></li> 12150 <li>Cache 12151 <ul> 12152 <li>Add cache/fetch rc function (Fabian Möller)</li> 12153 <li>Fix worker scale down (Fabian Möller)</li> 12154 <li>Improve performance by not sending info requests for cached chunks (dcpu)</li> 12155 <li>Fix error return value of cache/fetch rc method (Fabian Möller)</li> 12156 <li>Documentation fix for cache-chunk-total-size (Anagh Kumar Baranwal)</li> 12157 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 12158 <li>Add plex_insecure option to skip certificate validation (Fabian Möller)</li> 12159 <li>Remove entries that no longer exist in the source (dcpu)</li> 12160 </ul></li> 12161 <li>Crypt 12162 <ul> 12163 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 12164 </ul></li> 12165 <li>Alias 12166 <ul> 12167 <li>Fix handling of Windows network paths (Nick Craig-Wood)</li> 12168 </ul></li> 12169 <li>Azure Blob 12170 <ul> 12171 <li>Add –azureblob-list-chunk parameter (Santiago Rodríguez)</li> 12172 <li>Implemented settier command support on azureblob remote. (sandeepkru)</li> 12173 <li>Work around SDK bug which causes errors for chunk-sized files (Nick Craig-Wood)</li> 12174 </ul></li> 12175 <li>Box 12176 <ul> 12177 <li>Implement link sharing. (Sebastian Bünger)</li> 12178 </ul></li> 12179 <li>Drive 12180 <ul> 12181 <li>Add –drive-import-formats - google docs can now be imported (Fabian Möller) 12182 <ul> 12183 <li>Rewrite mime type and extension handling (Fabian Möller)</li> 12184 <li>Add document links (Fabian Möller)</li> 12185 <li>Add support for multipart document extensions (Fabian Möller)</li> 12186 <li>Add support for apps-script to json export (Fabian Möller)</li> 12187 <li>Fix escaped chars in documents during list (Fabian Möller)</li> 12188 </ul></li> 12189 <li>Add –drive-v2-download-min-size a workaround for slow downloads (Fabian Möller)</li> 12190 <li>Improve directory notifications in ChangeNotify (Fabian Möller)</li> 12191 <li>When listing team drives in config, continue on failure (Nick Craig-Wood)</li> 12192 </ul></li> 12193 <li>FTP 12194 <ul> 12195 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 12196 </ul></li> 12197 <li>Google Cloud Storage 12198 <ul> 12199 <li>Fix service_account_file being ignored (Fabian Möller)</li> 12200 </ul></li> 12201 <li>Jottacloud 12202 <ul> 12203 <li>Minor improvement in quota info (omit if unlimited) (albertony)</li> 12204 <li>Add –fast-list support (albertony)</li> 12205 <li>Add permanent delete support: –jottacloud-hard-delete (albertony)</li> 12206 <li>Add link sharing support (albertony)</li> 12207 <li>Fix handling of reserved characters. (Sebastian Bünger)</li> 12208 <li>Fix socket leak on Object.Remove (Nick Craig-Wood)</li> 12209 </ul></li> 12210 <li>Onedrive 12211 <ul> 12212 <li>Rework to support Microsoft Graph (Cnly) 12213 <ul> 12214 <li><strong>NB</strong> this will require re-authenticating the remote</li> 12215 </ul></li> 12216 <li>Removed upload cutoff and always do session uploads (Oliver Heyme)</li> 12217 <li>Use single-part upload for empty files (Cnly)</li> 12218 <li>Fix new fields not saved when editing old config (Alex Chen)</li> 12219 <li>Fix sometimes special chars in filenames not replaced (Alex Chen)</li> 12220 <li>Ignore OneNote files by default (Alex Chen)</li> 12221 <li>Add link sharing support (jackyzy823)</li> 12222 </ul></li> 12223 <li>S3 12224 <ul> 12225 <li>Use custom pacer, to retry operations when reasonable (Craig Miskell)</li> 12226 <li>Use configured server-side-encryption and storace class options when calling CopyObject() (Paul Kohout)</li> 12227 <li>Make –s3-v2-auth flag (Nick Craig-Wood)</li> 12228 <li>Fix v2 auth on files with spaces (Nick Craig-Wood)</li> 12229 </ul></li> 12230 <li>Union 12231 <ul> 12232 <li>Implement union backend which reads from multiple backends (Felix Brucker)</li> 12233 <li>Implement optional interfaces (Move, DirMove, Copy etc) (Nick Craig-Wood)</li> 12234 <li>Fix ChangeNotify to support multiple remotes (Fabian Möller)</li> 12235 <li>Fix –backup-dir on union backend (Nick Craig-Wood)</li> 12236 </ul></li> 12237 <li>WebDAV 12238 <ul> 12239 <li>Add another time format (Nick Craig-Wood)</li> 12240 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 12241 <li>Add workaround for missing mtime (buergi)</li> 12242 <li>Sharepoint: Renew cookies after 12hrs (Henning Surmeier)</li> 12243 </ul></li> 12244 <li>Yandex 12245 <ul> 12246 <li>Remove redundant nil checks (teresy)</li> 12247 </ul></li> 12248 </ul> 12249 <h2 id="v1.43.1---2018-09-07">v1.43.1 - 2018-09-07</h2> 12250 <p>Point release to fix hubic and azureblob backends.</p> 12251 <ul> 12252 <li>Bug Fixes 12253 <ul> 12254 <li>ncdu: Return error instead of log.Fatal in Show (Fabian Möller)</li> 12255 <li>cmd: Fix crash with –progress and –stats 0 (Nick Craig-Wood)</li> 12256 <li>docs: Tidy website display (Anagh Kumar Baranwal)</li> 12257 </ul></li> 12258 <li>Azure Blob: 12259 <ul> 12260 <li>Fix multi-part uploads. (sandeepkru)</li> 12261 </ul></li> 12262 <li>Hubic 12263 <ul> 12264 <li>Fix uploads (Nick Craig-Wood)</li> 12265 <li>Retry auth fetching if it fails to make hubic more reliable (Nick Craig-Wood)</li> 12266 </ul></li> 12267 </ul> 12268 <h2 id="v1.43---2018-09-01">v1.43 - 2018-09-01</h2> 12269 <ul> 12270 <li>New backends 12271 <ul> 12272 <li>Jottacloud (Sebastian Bünger)</li> 12273 </ul></li> 12274 <li>New commands 12275 <ul> 12276 <li>copyurl: copies a URL to a remote (Denis)</li> 12277 </ul></li> 12278 <li>New Features 12279 <ul> 12280 <li>Reworked config for backends (Nick Craig-Wood) 12281 <ul> 12282 <li>All backend config can now be supplied by command line, env var or config file</li> 12283 <li>Advanced section in the config wizard for the optional items</li> 12284 <li>A large step towards rclone backends being usable in other go software</li> 12285 <li>Allow on the fly remotes with :backend: syntax</li> 12286 </ul></li> 12287 <li>Stats revamp 12288 <ul> 12289 <li>Add <code>--progress</code>/<code>-P</code> flag to show interactive progress (Nick Craig-Wood)</li> 12290 <li>Show the total progress of the sync in the stats (Nick Craig-Wood)</li> 12291 <li>Add <code>--stats-one-line</code> flag for single line stats (Nick Craig-Wood)</li> 12292 </ul></li> 12293 <li>Added weekday schedule into <code>--bwlimit</code> (Mateusz)</li> 12294 <li>lsjson: Add option to show the original object IDs (Fabian Möller)</li> 12295 <li>serve webdav: Make Content-Type without reading the file and add <code>--etag-hash</code> (Nick Craig-Wood)</li> 12296 <li>build 12297 <ul> 12298 <li>Build macOS with native compiler (Nick Craig-Wood)</li> 12299 <li>Update to use go1.11 for the build (Nick Craig-Wood)</li> 12300 </ul></li> 12301 <li>rc 12302 <ul> 12303 <li>Added core/stats to return the stats (reddi1)</li> 12304 </ul></li> 12305 <li><code>version --check</code>: Prints the current release and beta versions (Nick Craig-Wood)</li> 12306 </ul></li> 12307 <li>Bug Fixes 12308 <ul> 12309 <li>accounting 12310 <ul> 12311 <li>Fix time to completion estimates (Nick Craig-Wood)</li> 12312 <li>Fix moving average speed for file stats (Nick Craig-Wood)</li> 12313 </ul></li> 12314 <li>config: Fix error reading password from piped input (Nick Craig-Wood)</li> 12315 <li>move: Fix <code>--delete-empty-src-dirs</code> flag to delete all empty dirs on move (ishuah)</li> 12316 </ul></li> 12317 <li>Mount 12318 <ul> 12319 <li>Implement <code>--daemon-timeout</code> flag for OSXFUSE (Nick Craig-Wood)</li> 12320 <li>Fix mount <code>--daemon</code> not working with encrypted config (Alex Chen)</li> 12321 <li>Clip the number of blocks to 2^32-1 on macOS - fixes borg backup (Nick Craig-Wood)</li> 12322 </ul></li> 12323 <li>VFS 12324 <ul> 12325 <li>Enable vfs-read-chunk-size by default (Fabian Möller)</li> 12326 <li>Add the vfs/refresh rc command (Fabian Möller)</li> 12327 <li>Add non recursive mode to vfs/refresh rc command (Fabian Möller)</li> 12328 <li>Try to seek buffer on read only files (Fabian Möller)</li> 12329 </ul></li> 12330 <li>Local 12331 <ul> 12332 <li>Fix crash when deprecated <code>--local-no-unicode-normalization</code> is supplied (Nick Craig-Wood)</li> 12333 <li>Fix mkdir error when trying to copy files to the root of a drive on windows (Nick Craig-Wood)</li> 12334 </ul></li> 12335 <li>Cache 12336 <ul> 12337 <li>Fix nil pointer deref when using lsjson on cached directory (Nick Craig-Wood)</li> 12338 <li>Fix nil pointer deref for occasional crash on playback (Nick Craig-Wood)</li> 12339 </ul></li> 12340 <li>Crypt 12341 <ul> 12342 <li>Fix accounting when checking hashes on upload (Nick Craig-Wood)</li> 12343 </ul></li> 12344 <li>Amazon Cloud Drive 12345 <ul> 12346 <li>Make very clear in the docs that rclone has no ACD keys (Nick Craig-Wood)</li> 12347 </ul></li> 12348 <li>Azure Blob 12349 <ul> 12350 <li>Add connection string and SAS URL auth (Nick Craig-Wood)</li> 12351 <li>List the container to see if it exists (Nick Craig-Wood)</li> 12352 <li>Port new Azure Blob Storage SDK (sandeepkru)</li> 12353 <li>Added blob tier, tier between Hot, Cool and Archive. (sandeepkru)</li> 12354 <li>Remove leading / from paths (Nick Craig-Wood)</li> 12355 </ul></li> 12356 <li>B2 12357 <ul> 12358 <li>Support Application Keys (Nick Craig-Wood)</li> 12359 <li>Remove leading / from paths (Nick Craig-Wood)</li> 12360 </ul></li> 12361 <li>Box 12362 <ul> 12363 <li>Fix upload of > 2GB files on 32 bit platforms (Nick Craig-Wood)</li> 12364 <li>Make <code>--box-commit-retries</code> flag defaulting to 100 to fix large uploads (Nick Craig-Wood)</li> 12365 </ul></li> 12366 <li>Drive 12367 <ul> 12368 <li>Add <code>--drive-keep-revision-forever</code> flag (lewapm)</li> 12369 <li>Handle gdocs when filtering file names in list (Fabian Möller)</li> 12370 <li>Support using <code>--fast-list</code> for large speedups (Fabian Möller)</li> 12371 </ul></li> 12372 <li>FTP 12373 <ul> 12374 <li>Fix Put mkParentDir failed: 521 for BunnyCDN (Nick Craig-Wood)</li> 12375 </ul></li> 12376 <li>Google Cloud Storage 12377 <ul> 12378 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 12379 </ul></li> 12380 <li>Jottacloud 12381 <ul> 12382 <li>Fix MD5 error check (Oliver Heyme)</li> 12383 <li>Handle empty time values (Martin Polden)</li> 12384 <li>Calculate missing MD5s (Oliver Heyme)</li> 12385 <li>Docs, fixes and tests for MD5 calculation (Nick Craig-Wood)</li> 12386 <li>Add optional MimeTyper interface. (Sebastian Bünger)</li> 12387 <li>Implement optional About interface (for <code>df</code> support). (Sebastian Bünger)</li> 12388 </ul></li> 12389 <li>Mega 12390 <ul> 12391 <li>Wait for events instead of arbitrary sleeping (Nick Craig-Wood)</li> 12392 <li>Add <code>--mega-hard-delete</code> flag (Nick Craig-Wood)</li> 12393 <li>Fix failed logins with upper case chars in email (Nick Craig-Wood)</li> 12394 </ul></li> 12395 <li>Onedrive 12396 <ul> 12397 <li>Shared folder support (Yoni Jah)</li> 12398 <li>Implement DirMove (Cnly)</li> 12399 <li>Fix rmdir sometimes deleting directories with contents (Nick Craig-Wood)</li> 12400 </ul></li> 12401 <li>Pcloud 12402 <ul> 12403 <li>Delete half uploaded files on upload error (Nick Craig-Wood)</li> 12404 </ul></li> 12405 <li>Qingstor 12406 <ul> 12407 <li>Remove leading / from paths (Nick Craig-Wood)</li> 12408 </ul></li> 12409 <li>S3 12410 <ul> 12411 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 12412 <li>Add <code>--s3-force-path-style</code> (Nick Craig-Wood)</li> 12413 <li>Add support for KMS Key ID (bsteiss)</li> 12414 <li>Remove leading / from paths (Nick Craig-Wood)</li> 12415 </ul></li> 12416 <li>Swift 12417 <ul> 12418 <li>Add <code>storage_policy</code> (Ruben Vandamme)</li> 12419 <li>Make it so just <code>storage_url</code> or <code>auth_token</code> can be overidden (Nick Craig-Wood)</li> 12420 <li>Fix server side copy bug for unusal file names (Nick Craig-Wood)</li> 12421 <li>Remove leading / from paths (Nick Craig-Wood)</li> 12422 </ul></li> 12423 <li>WebDAV 12424 <ul> 12425 <li>Ensure we call MKCOL with a URL with a trailing / for QNAP interop (Nick Craig-Wood)</li> 12426 <li>If root ends with / then don’t check if it is a file (Nick Craig-Wood)</li> 12427 <li>Don’t accept redirects when reading metadata (Nick Craig-Wood)</li> 12428 <li>Add bearer token (Macaroon) support for dCache (Nick Craig-Wood)</li> 12429 <li>Document dCache and Macaroons (Onno Zweers)</li> 12430 <li>Sharepoint recursion with different depth (Henning)</li> 12431 <li>Attempt to remove failed uploads (Nick Craig-Wood)</li> 12432 </ul></li> 12433 <li>Yandex 12434 <ul> 12435 <li>Fix listing/deleting files in the root (Nick Craig-Wood)</li> 12436 </ul></li> 12437 </ul> 12438 <h2 id="v1.42---2018-06-16">v1.42 - 2018-06-16</h2> 12439 <ul> 12440 <li>New backends 12441 <ul> 12442 <li>OpenDrive (Oliver Heyme, Jakub Karlicek, ncw)</li> 12443 </ul></li> 12444 <li>New commands 12445 <ul> 12446 <li>deletefile command (Filip Bartodziej)</li> 12447 </ul></li> 12448 <li>New Features 12449 <ul> 12450 <li>copy, move: Copy single files directly, don’t use <code>--files-from</code> work-around 12451 <ul> 12452 <li>this makes them much more efficient</li> 12453 </ul></li> 12454 <li>Implement <code>--max-transfer</code> flag to quit transferring at a limit 12455 <ul> 12456 <li>make exit code 8 for <code>--max-transfer</code> exceeded</li> 12457 </ul></li> 12458 <li>copy: copy empty source directories to destination (Ishuah Kariuki)</li> 12459 <li>check: Add <code>--one-way</code> flag (Kasper Byrdal Nielsen)</li> 12460 <li>Add siginfo handler for macOS for ctrl-T stats (kubatasiemski)</li> 12461 <li>rc 12462 <ul> 12463 <li>add core/gc to run a garbage collection on demand</li> 12464 <li>enable go profiling by default on the <code>--rc</code> port</li> 12465 <li>return error from remote on failure</li> 12466 </ul></li> 12467 <li>lsf 12468 <ul> 12469 <li>Add <code>--absolute</code> flag to add a leading / onto path names</li> 12470 <li>Add <code>--csv</code> flag for compliant CSV output</li> 12471 <li>Add ‘m’ format specifier to show the MimeType</li> 12472 <li>Implement ‘i’ format for showing object ID</li> 12473 </ul></li> 12474 <li>lsjson 12475 <ul> 12476 <li>Add MimeType to the output</li> 12477 <li>Add ID field to output to show Object ID</li> 12478 </ul></li> 12479 <li>Add <code>--retries-sleep</code> flag (Benjamin Joseph Dag)</li> 12480 <li>Oauth tidy up web page and error handling (Henning Surmeier)</li> 12481 </ul></li> 12482 <li>Bug Fixes 12483 <ul> 12484 <li>Password prompt output with <code>--log-file</code> fixed for unix (Filip Bartodziej)</li> 12485 <li>Calculate ModifyWindow each time on the fly to fix various problems (Stefan Breunig)</li> 12486 </ul></li> 12487 <li>Mount 12488 <ul> 12489 <li>Only print “File.rename error” if there actually is an error (Stefan Breunig)</li> 12490 <li>Delay rename if file has open writers instead of failing outright (Stefan Breunig)</li> 12491 <li>Ensure atexit gets run on interrupt</li> 12492 <li>macOS enhancements 12493 <ul> 12494 <li>Make <code>--noappledouble</code> <code>--noapplexattr</code></li> 12495 <li>Add <code>--volname</code> flag and remove special chars from it</li> 12496 <li>Make Get/List/Set/Remove xattr return ENOSYS for efficiency</li> 12497 <li>Make <code>--daemon</code> work for macOS without CGO</li> 12498 </ul></li> 12499 </ul></li> 12500 <li>VFS 12501 <ul> 12502 <li>Add <code>--vfs-read-chunk-size</code> and <code>--vfs-read-chunk-size-limit</code> (Fabian Möller)</li> 12503 <li>Fix ChangeNotify for new or changed folders (Fabian Möller)</li> 12504 </ul></li> 12505 <li>Local 12506 <ul> 12507 <li>Fix symlink/junction point directory handling under Windows 12508 <ul> 12509 <li><strong>NB</strong> you will need to add <code>-L</code> to your command line to copy files with reparse points</li> 12510 </ul></li> 12511 </ul></li> 12512 <li>Cache 12513 <ul> 12514 <li>Add non cached dirs on notifications (Remus Bunduc)</li> 12515 <li>Allow root to be expired from rc (Remus Bunduc)</li> 12516 <li>Clean remaining empty folders from temp upload path (Remus Bunduc)</li> 12517 <li>Cache lists using batch writes (Remus Bunduc)</li> 12518 <li>Use secure websockets for HTTPS Plex addresses (John Clayton)</li> 12519 <li>Reconnect plex websocket on failures (Remus Bunduc)</li> 12520 <li>Fix panic when running without plex configs (Remus Bunduc)</li> 12521 <li>Fix root folder caching (Remus Bunduc)</li> 12522 </ul></li> 12523 <li>Crypt 12524 <ul> 12525 <li>Check the crypted hash of files when uploading for extra data security</li> 12526 </ul></li> 12527 <li>Dropbox 12528 <ul> 12529 <li>Make Dropbox for business folders accessible using an initial <code>/</code> in the path</li> 12530 </ul></li> 12531 <li>Google Cloud Storage 12532 <ul> 12533 <li>Low level retry all operations if necessary</li> 12534 </ul></li> 12535 <li>Google Drive 12536 <ul> 12537 <li>Add <code>--drive-acknowledge-abuse</code> to download flagged files</li> 12538 <li>Add <code>--drive-alternate-export</code> to fix large doc export</li> 12539 <li>Don’t attempt to choose Team Drives when using rclone config create</li> 12540 <li>Fix change list polling with team drives</li> 12541 <li>Fix ChangeNotify for folders (Fabian Möller)</li> 12542 <li>Fix about (and df on a mount) for team drives</li> 12543 </ul></li> 12544 <li>Onedrive 12545 <ul> 12546 <li>Errorhandler for onedrive for business requests (Henning Surmeier)</li> 12547 </ul></li> 12548 <li>S3 12549 <ul> 12550 <li>Adjust upload concurrency with <code>--s3-upload-concurrency</code> (themylogin)</li> 12551 <li>Fix <code>--s3-chunk-size</code> which was always using the minimum</li> 12552 </ul></li> 12553 <li>SFTP 12554 <ul> 12555 <li>Add <code>--ssh-path-override</code> flag (Piotr Oleszczyk)</li> 12556 <li>Fix slow downloads for long latency connections</li> 12557 </ul></li> 12558 <li>Webdav 12559 <ul> 12560 <li>Add workarounds for biz.mail.ru</li> 12561 <li>Ignore Reason-Phrase in status line to fix 4shared (Rodrigo)</li> 12562 <li>Better error message generation</li> 12563 </ul></li> 12564 </ul> 12565 <h2 id="v1.41---2018-04-28">v1.41 - 2018-04-28</h2> 12566 <ul> 12567 <li>New backends 12568 <ul> 12569 <li>Mega support added</li> 12570 <li>Webdav now supports SharePoint cookie authentication (hensur)</li> 12571 </ul></li> 12572 <li>New commands 12573 <ul> 12574 <li>link: create public link to files and folders (Stefan Breunig)</li> 12575 <li>about: gets quota info from a remote (a-roussos, ncw)</li> 12576 <li>hashsum: a generic tool for any hash to produce md5sum like output</li> 12577 </ul></li> 12578 <li>New Features 12579 <ul> 12580 <li>lsd: Add -R flag and fix and update docs for all ls commands</li> 12581 <li>ncdu: added a “refresh” key - CTRL-L (Keith Goldfarb)</li> 12582 <li>serve restic: Add append-only mode (Steve Kriss)</li> 12583 <li>serve restic: Disallow overwriting files in append-only mode (Alexander Neumann)</li> 12584 <li>serve restic: Print actual listener address (Matt Holt)</li> 12585 <li>size: Add –json flag (Matthew Holt)</li> 12586 <li>sync: implement –ignore-errors (Mateusz Pabian)</li> 12587 <li>dedupe: Add dedupe largest functionality (Richard Yang)</li> 12588 <li>fs: Extend SizeSuffix to include TB and PB for rclone about</li> 12589 <li>fs: add –dump goroutines and –dump openfiles for debugging</li> 12590 <li>rc: implement core/memstats to print internal memory usage info</li> 12591 <li>rc: new call rc/pid (Michael P. Dubner)</li> 12592 </ul></li> 12593 <li>Compile 12594 <ul> 12595 <li>Drop support for go1.6</li> 12596 </ul></li> 12597 <li>Release 12598 <ul> 12599 <li>Fix <code>make tarball</code> (Chih-Hsuan Yen)</li> 12600 </ul></li> 12601 <li>Bug Fixes 12602 <ul> 12603 <li>filter: fix –min-age and –max-age together check</li> 12604 <li>fs: limit MaxIdleConns and MaxIdleConnsPerHost in transport</li> 12605 <li>lsd,lsf: make sure all times we output are in local time</li> 12606 <li>rc: fix setting bwlimit to unlimited</li> 12607 <li>rc: take note of the –rc-addr flag too as per the docs</li> 12608 </ul></li> 12609 <li>Mount 12610 <ul> 12611 <li>Use About to return the correct disk total/used/free (eg in <code>df</code>)</li> 12612 <li>Set <code>--attr-timeout default</code> to <code>1s</code> - fixes: 12613 <ul> 12614 <li>rclone using too much memory</li> 12615 <li>rclone not serving files to samba</li> 12616 <li>excessive time listing directories</li> 12617 </ul></li> 12618 <li>Fix <code>df -i</code> (upstream fix)</li> 12619 </ul></li> 12620 <li>VFS 12621 <ul> 12622 <li>Filter files <code>.</code> and <code>..</code> from directory listing</li> 12623 <li>Only make the VFS cache if –vfs-cache-mode > Off</li> 12624 </ul></li> 12625 <li>Local 12626 <ul> 12627 <li>Add –local-no-check-updated to disable updated file checks</li> 12628 <li>Retry remove on Windows sharing violation error</li> 12629 </ul></li> 12630 <li>Cache 12631 <ul> 12632 <li>Flush the memory cache after close</li> 12633 <li>Purge file data on notification</li> 12634 <li>Always forget parent dir for notifications</li> 12635 <li>Integrate with Plex websocket</li> 12636 <li>Add rc cache/stats (seuffert)</li> 12637 <li>Add info log on notification</li> 12638 </ul></li> 12639 <li>Box 12640 <ul> 12641 <li>Fix failure reading large directories - parse file/directory size as float</li> 12642 </ul></li> 12643 <li>Dropbox 12644 <ul> 12645 <li>Fix crypt+obfuscate on dropbox</li> 12646 <li>Fix repeatedly uploading the same files</li> 12647 </ul></li> 12648 <li>FTP 12649 <ul> 12650 <li>Work around strange response from box FTP server</li> 12651 <li>More workarounds for FTP servers to fix mkParentDir error</li> 12652 <li>Fix no error on listing non-existent directory</li> 12653 </ul></li> 12654 <li>Google Cloud Storage 12655 <ul> 12656 <li>Add service_account_credentials (Matt Holt)</li> 12657 <li>Detect bucket presence by listing it - minimises permissions needed</li> 12658 <li>Ignore zero length directory markers</li> 12659 </ul></li> 12660 <li>Google Drive 12661 <ul> 12662 <li>Add service_account_credentials (Matt Holt)</li> 12663 <li>Fix directory move leaving a hardlinked directory behind</li> 12664 <li>Return proper google errors when Opening files</li> 12665 <li>When initialized with a filepath, optional features used incorrect root path (Stefan Breunig)</li> 12666 </ul></li> 12667 <li>HTTP 12668 <ul> 12669 <li>Fix sync for servers which don’t return Content-Length in HEAD</li> 12670 </ul></li> 12671 <li>Onedrive 12672 <ul> 12673 <li>Add QuickXorHash support for OneDrive for business</li> 12674 <li>Fix socket leak in multipart session upload</li> 12675 </ul></li> 12676 <li>S3 12677 <ul> 12678 <li>Look in S3 named profile files for credentials</li> 12679 <li>Add <code>--s3-disable-checksum</code> to disable checksum uploading (Chris Redekop)</li> 12680 <li>Hierarchical configuration support (Giri Badanahatti)</li> 12681 <li>Add in config for all the supported S3 providers</li> 12682 <li>Add One Zone Infrequent Access storage class (Craig Rachel)</li> 12683 <li>Add –use-server-modtime support (Peter Baumgartner)</li> 12684 <li>Add –s3-chunk-size option to control multipart uploads</li> 12685 <li>Ignore zero length directory markers</li> 12686 </ul></li> 12687 <li>SFTP 12688 <ul> 12689 <li>Update docs to match code, fix typos and clarify disable_hashcheck prompt (Michael G. Noll)</li> 12690 <li>Update docs with Synology quirks</li> 12691 <li>Fail soft with a debug on hash failure</li> 12692 </ul></li> 12693 <li>Swift 12694 <ul> 12695 <li>Add –use-server-modtime support (Peter Baumgartner)</li> 12696 </ul></li> 12697 <li>Webdav 12698 <ul> 12699 <li>Support SharePoint cookie authentication (hensur)</li> 12700 <li>Strip leading and trailing / off root</li> 12701 </ul></li> 12702 </ul> 12703 <h2 id="v1.40---2018-03-19">v1.40 - 2018-03-19</h2> 12704 <ul> 12705 <li>New backends 12706 <ul> 12707 <li>Alias backend to create aliases for existing remote names (Fabian Möller)</li> 12708 </ul></li> 12709 <li>New commands 12710 <ul> 12711 <li><code>lsf</code>: list for parsing purposes (Jakub Tasiemski) 12712 <ul> 12713 <li>by default this is a simple non recursive list of files and directories</li> 12714 <li>it can be configured to add more info in an easy to parse way</li> 12715 </ul></li> 12716 <li><code>serve restic</code>: for serving a remote as a Restic REST endpoint 12717 <ul> 12718 <li>This enables restic to use any backends that rclone can access</li> 12719 <li>Thanks Alexander Neumann for help, patches and review</li> 12720 </ul></li> 12721 <li><code>rc</code>: enable the remote control of a running rclone 12722 <ul> 12723 <li>The running rclone must be started with –rc and related flags.</li> 12724 <li>Currently there is support for bwlimit, and flushing for mount and cache.</li> 12725 </ul></li> 12726 </ul></li> 12727 <li>New Features 12728 <ul> 12729 <li><code>--max-delete</code> flag to add a delete threshold (Bjørn Erik Pedersen)</li> 12730 <li>All backends now support RangeOption for ranged Open 12731 <ul> 12732 <li><code>cat</code>: Use RangeOption for limited fetches to make more efficient</li> 12733 <li><code>cryptcheck</code>: make reading of nonce more efficient with RangeOption</li> 12734 </ul></li> 12735 <li>serve http/webdav/restic 12736 <ul> 12737 <li>support SSL/TLS</li> 12738 <li>add <code>--user</code> <code>--pass</code> and <code>--htpasswd</code> for authentication</li> 12739 </ul></li> 12740 <li><code>copy</code>/<code>move</code>: detect file size change during copy/move and abort transfer (ishuah)</li> 12741 <li><code>cryptdecode</code>: added option to return encrypted file names. (ishuah)</li> 12742 <li><code>lsjson</code>: add <code>--encrypted</code> to show encrypted name (Jakub Tasiemski)</li> 12743 <li>Add <code>--stats-file-name-length</code> to specify the printed file name length for stats (Will Gunn)</li> 12744 </ul></li> 12745 <li>Compile 12746 <ul> 12747 <li>Code base was shuffled and factored 12748 <ul> 12749 <li>backends moved into a backend directory</li> 12750 <li>large packages split up</li> 12751 <li>See the CONTRIBUTING.md doc for info as to what lives where now</li> 12752 </ul></li> 12753 <li>Update to using go1.10 as the default go version</li> 12754 <li>Implement daily <a href="https://pub.rclone.org/integration-tests/">full integration tests</a></li> 12755 </ul></li> 12756 <li>Release 12757 <ul> 12758 <li>Include a source tarball and sign it and the binaries</li> 12759 <li>Sign the git tags as part of the release process</li> 12760 <li>Add .deb and .rpm packages as part of the build</li> 12761 <li>Make a beta release for all branches on the main repo (but not pull requests)</li> 12762 </ul></li> 12763 <li>Bug Fixes 12764 <ul> 12765 <li>config: fixes errors on non existing config by loading config file only on first access</li> 12766 <li>config: retry saving the config after failure (Mateusz)</li> 12767 <li>sync: when using <code>--backup-dir</code> don’t delete files if we can’t set their modtime 12768 <ul> 12769 <li>this fixes odd behaviour with Dropbox and <code>--backup-dir</code></li> 12770 </ul></li> 12771 <li>fshttp: fix idle timeouts for HTTP connections</li> 12772 <li><code>serve http</code>: fix serving files with : in - fixes</li> 12773 <li>Fix <code>--exclude-if-present</code> to ignore directories which it doesn’t have permission for (Iakov Davydov)</li> 12774 <li>Make accounting work properly with crypt and b2</li> 12775 <li>remove <code>--no-traverse</code> flag because it is obsolete</li> 12776 </ul></li> 12777 <li>Mount 12778 <ul> 12779 <li>Add <code>--attr-timeout</code> flag to control attribute caching in kernel 12780 <ul> 12781 <li>this now defaults to 0 which is correct but less efficient</li> 12782 <li>see <a href="/commands/rclone_mount/#attribute-caching">the mount docs</a> for more info</li> 12783 </ul></li> 12784 <li>Add <code>--daemon</code> flag to allow mount to run in the background (ishuah)</li> 12785 <li>Fix: Return ENOSYS rather than EIO on attempted link 12786 <ul> 12787 <li>This fixes FileZilla accessing an rclone mount served over sftp.</li> 12788 </ul></li> 12789 <li>Fix setting modtime twice</li> 12790 <li>Mount tests now run on CI for Linux (mount & cmount)/Mac/Windows</li> 12791 <li>Many bugs fixed in the VFS layer - see below</li> 12792 </ul></li> 12793 <li>VFS 12794 <ul> 12795 <li>Many fixes for <code>--vfs-cache-mode</code> writes and above 12796 <ul> 12797 <li>Update cached copy if we know it has changed (fixes stale data)</li> 12798 <li>Clean path names before using them in the cache</li> 12799 <li>Disable cache cleaner if <code>--vfs-cache-poll-interval=0</code></li> 12800 <li>Fill and clean the cache immediately on startup</li> 12801 </ul></li> 12802 <li>Fix Windows opening every file when it stats the file</li> 12803 <li>Fix applying modtime for an open Write Handle</li> 12804 <li>Fix creation of files when truncating</li> 12805 <li>Write 0 bytes when flushing unwritten handles to avoid race conditions in FUSE</li> 12806 <li>Downgrade “poll-interval is not supported” message to Info</li> 12807 <li>Make OpenFile and friends return EINVAL if O_RDONLY and O_TRUNC</li> 12808 </ul></li> 12809 <li>Local 12810 <ul> 12811 <li>Downgrade “invalid cross-device link: trying copy” to debug</li> 12812 <li>Make DirMove return fs.ErrorCantDirMove to allow fallback to Copy for cross device</li> 12813 <li>Fix race conditions updating the hashes</li> 12814 </ul></li> 12815 <li>Cache 12816 <ul> 12817 <li>Add support for polling - cache will update when remote changes on supported backends</li> 12818 <li>Reduce log level for Plex api</li> 12819 <li>Fix dir cache issue</li> 12820 <li>Implement <code>--cache-db-wait-time</code> flag</li> 12821 <li>Improve efficiency with RangeOption and RangeSeek</li> 12822 <li>Fix dirmove with temp fs enabled</li> 12823 <li>Notify vfs when using temp fs</li> 12824 <li>Offline uploading</li> 12825 <li>Remote control support for path flushing</li> 12826 </ul></li> 12827 <li>Amazon cloud drive 12828 <ul> 12829 <li>Rclone no longer has any working keys - disable integration tests</li> 12830 <li>Implement DirChangeNotify to notify cache/vfs/mount of changes</li> 12831 </ul></li> 12832 <li>Azureblob 12833 <ul> 12834 <li>Don’t check for bucket/container presense if listing was OK 12835 <ul> 12836 <li>this makes rclone do one less request per invocation</li> 12837 </ul></li> 12838 <li>Improve accounting for chunked uploads</li> 12839 </ul></li> 12840 <li>Backblaze B2 12841 <ul> 12842 <li>Don’t check for bucket/container presense if listing was OK 12843 <ul> 12844 <li>this makes rclone do one less request per invocation</li> 12845 </ul></li> 12846 </ul></li> 12847 <li>Box 12848 <ul> 12849 <li>Improve accounting for chunked uploads</li> 12850 </ul></li> 12851 <li>Dropbox 12852 <ul> 12853 <li>Fix custom oauth client parameters</li> 12854 </ul></li> 12855 <li>Google Cloud Storage 12856 <ul> 12857 <li>Don’t check for bucket/container presense if listing was OK 12858 <ul> 12859 <li>this makes rclone do one less request per invocation</li> 12860 </ul></li> 12861 </ul></li> 12862 <li>Google Drive 12863 <ul> 12864 <li>Migrate to api v3 (Fabian Möller)</li> 12865 <li>Add scope configuration and root folder selection</li> 12866 <li>Add <code>--drive-impersonate</code> for service accounts 12867 <ul> 12868 <li>thanks to everyone who tested, explored and contributed docs</li> 12869 </ul></li> 12870 <li>Add <code>--drive-use-created-date</code> to use created date as modified date (nbuchanan)</li> 12871 <li>Request the export formats only when required 12872 <ul> 12873 <li>This makes rclone quicker when there are no google docs</li> 12874 </ul></li> 12875 <li>Fix finding paths with latin1 chars (a workaround for a drive bug)</li> 12876 <li>Fix copying of a single Google doc file</li> 12877 <li>Fix <code>--drive-auth-owner-only</code> to look in all directories</li> 12878 </ul></li> 12879 <li>HTTP 12880 <ul> 12881 <li>Fix handling of directories with & in</li> 12882 </ul></li> 12883 <li>Onedrive 12884 <ul> 12885 <li>Removed upload cutoff and always do session uploads 12886 <ul> 12887 <li>this stops the creation of multiple versions on business onedrive</li> 12888 </ul></li> 12889 <li>Overwrite object size value with real size when reading file. (Victor) 12890 <ul> 12891 <li>this fixes oddities when onedrive misreports the size of images</li> 12892 </ul></li> 12893 </ul></li> 12894 <li>Pcloud 12895 <ul> 12896 <li>Remove unused chunked upload flag and code</li> 12897 </ul></li> 12898 <li>Qingstor 12899 <ul> 12900 <li>Don’t check for bucket/container presense if listing was OK 12901 <ul> 12902 <li>this makes rclone do one less request per invocation</li> 12903 </ul></li> 12904 </ul></li> 12905 <li>S3 12906 <ul> 12907 <li>Support hashes for multipart files (Chris Redekop)</li> 12908 <li>Initial support for IBM COS (S3) (Giri Badanahatti)</li> 12909 <li>Update docs to discourage use of v2 auth with CEPH and others</li> 12910 <li>Don’t check for bucket/container presense if listing was OK 12911 <ul> 12912 <li>this makes rclone do one less request per invocation</li> 12913 </ul></li> 12914 <li>Fix server side copy and set modtime on files with + in</li> 12915 </ul></li> 12916 <li>SFTP 12917 <ul> 12918 <li>Add option to disable remote hash check command execution (Jon Fautley)</li> 12919 <li>Add <code>--sftp-ask-password</code> flag to prompt for password when needed (Leo R. Lundgren)</li> 12920 <li>Add <code>set_modtime</code> configuration option</li> 12921 <li>Fix following of symlinks</li> 12922 <li>Fix reading config file outside of Fs setup</li> 12923 <li>Fix reading $USER in username fallback not $HOME</li> 12924 <li>Fix running under crontab - Use correct OS way of reading username</li> 12925 </ul></li> 12926 <li>Swift 12927 <ul> 12928 <li>Fix refresh of authentication token 12929 <ul> 12930 <li>in v1.39 a bug was introduced which ignored new tokens - this fixes it</li> 12931 </ul></li> 12932 <li>Fix extra HEAD transaction when uploading a new file</li> 12933 <li>Don’t check for bucket/container presense if listing was OK 12934 <ul> 12935 <li>this makes rclone do one less request per invocation</li> 12936 </ul></li> 12937 </ul></li> 12938 <li>Webdav 12939 <ul> 12940 <li>Add new time formats to support mydrive.ch and others</li> 12941 </ul></li> 12942 </ul> 12943 <h2 id="v1.39---2017-12-23">v1.39 - 2017-12-23</h2> 12944 <ul> 12945 <li>New backends 12946 <ul> 12947 <li>WebDAV 12948 <ul> 12949 <li>tested with nextcloud, owncloud, put.io and others!</li> 12950 </ul></li> 12951 <li>Pcloud</li> 12952 <li>cache - wraps a cache around other backends (Remus Bunduc) 12953 <ul> 12954 <li>useful in combination with mount</li> 12955 <li>NB this feature is in beta so use with care</li> 12956 </ul></li> 12957 </ul></li> 12958 <li>New commands 12959 <ul> 12960 <li>serve command with subcommands: 12961 <ul> 12962 <li>serve webdav: this implements a webdav server for any rclone remote.</li> 12963 <li>serve http: command to serve a remote over HTTP</li> 12964 </ul></li> 12965 <li>config: add sub commands for full config file management 12966 <ul> 12967 <li>create/delete/dump/edit/file/password/providers/show/update</li> 12968 </ul></li> 12969 <li>touch: to create or update the timestamp of a file (Jakub Tasiemski)</li> 12970 </ul></li> 12971 <li>New Features 12972 <ul> 12973 <li>curl install for rclone (Filip Bartodziej)</li> 12974 <li>–stats now shows percentage, size, rate and ETA in condensed form (Ishuah Kariuki)</li> 12975 <li>–exclude-if-present to exclude a directory if a file is present (Iakov Davydov)</li> 12976 <li>rmdirs: add –leave-root flag (lewpam)</li> 12977 <li>move: add –delete-empty-src-dirs flag to remove dirs after move (Ishuah Kariuki)</li> 12978 <li>Add –dump flag, introduce –dump requests, responses and remove –dump-auth, –dump-filters 12979 <ul> 12980 <li>Obscure X-Auth-Token: from headers when dumping too</li> 12981 </ul></li> 12982 <li>Document and implement exit codes for different failure modes (Ishuah Kariuki)</li> 12983 </ul></li> 12984 <li>Compile</li> 12985 <li>Bug Fixes 12986 <ul> 12987 <li>Retry lots more different types of errors to make multipart transfers more reliable</li> 12988 <li>Save the config before asking for a token, fixes disappearing oauth config</li> 12989 <li>Warn the user if –include and –exclude are used together (Ernest Borowski)</li> 12990 <li>Fix duplicate files (eg on Google drive) causing spurious copies</li> 12991 <li>Allow trailing and leading whitespace for passwords (Jason Rose)</li> 12992 <li>ncdu: fix crashes on empty directories</li> 12993 <li>rcat: fix goroutine leak</li> 12994 <li>moveto/copyto: Fix to allow copying to the same name</li> 12995 </ul></li> 12996 <li>Mount 12997 <ul> 12998 <li>–vfs-cache mode to make writes into mounts more reliable. 12999 <ul> 13000 <li>this requires caching files on the disk (see –cache-dir)</li> 13001 <li>As this is a new feature, use with care</li> 13002 </ul></li> 13003 <li>Use sdnotify to signal systemd the mount is ready (Fabian Möller)</li> 13004 <li>Check if directory is not empty before mounting (Ernest Borowski)</li> 13005 </ul></li> 13006 <li>Local 13007 <ul> 13008 <li>Add error message for cross file system moves</li> 13009 <li>Fix equality check for times</li> 13010 </ul></li> 13011 <li>Dropbox 13012 <ul> 13013 <li>Rework multipart upload 13014 <ul> 13015 <li>buffer the chunks when uploading large files so they can be retried</li> 13016 <li>change default chunk size to 48MB now we are buffering them in memory</li> 13017 <li>retry every error after the first chunk is done successfully</li> 13018 </ul></li> 13019 <li>Fix error when renaming directories</li> 13020 </ul></li> 13021 <li>Swift 13022 <ul> 13023 <li>Fix crash on bad authentication</li> 13024 </ul></li> 13025 <li>Google Drive 13026 <ul> 13027 <li>Add service account support (Tim Cooijmans)</li> 13028 </ul></li> 13029 <li>S3 13030 <ul> 13031 <li>Make it work properly with Digital Ocean Spaces (Andrew Starr-Bochicchio)</li> 13032 <li>Fix crash if a bad listing is received</li> 13033 <li>Add support for ECS task IAM roles (David Minor)</li> 13034 </ul></li> 13035 <li>Backblaze B2 13036 <ul> 13037 <li>Fix multipart upload retries</li> 13038 <li>Fix –hard-delete to make it work 100% of the time</li> 13039 </ul></li> 13040 <li>Swift 13041 <ul> 13042 <li>Allow authentication with storage URL and auth key (Giovanni Pizzi)</li> 13043 <li>Add new fields for swift configuration to support IBM Bluemix Swift (Pierre Carlson)</li> 13044 <li>Add OS_TENANT_ID and OS_USER_ID to config</li> 13045 <li>Allow configs with user id instead of user name</li> 13046 <li>Check if swift segments container exists before creating (John Leach)</li> 13047 <li>Fix memory leak in swift transfers (upstream fix)</li> 13048 </ul></li> 13049 <li>SFTP 13050 <ul> 13051 <li>Add option to enable the use of aes128-cbc cipher (Jon Fautley)</li> 13052 </ul></li> 13053 <li>Amazon cloud drive 13054 <ul> 13055 <li>Fix download of large files failing with “Only one auth mechanism allowed”</li> 13056 </ul></li> 13057 <li>crypt 13058 <ul> 13059 <li>Option to encrypt directory names or leave them intact</li> 13060 <li>Implement DirChangeNotify (Fabian Möller)</li> 13061 </ul></li> 13062 <li>onedrive 13063 <ul> 13064 <li>Add option to choose resourceURL during setup of OneDrive Business account if more than one is available for user</li> 13065 </ul></li> 13066 </ul> 13067 <h2 id="v1.38---2017-09-30">v1.38 - 2017-09-30</h2> 13068 <ul> 13069 <li>New backends 13070 <ul> 13071 <li>Azure Blob Storage (thanks Andrei Dragomir)</li> 13072 <li>Box</li> 13073 <li>Onedrive for Business (thanks Oliver Heyme)</li> 13074 <li>QingStor from QingCloud (thanks wuyu)</li> 13075 </ul></li> 13076 <li>New commands 13077 <ul> 13078 <li><code>rcat</code> - read from standard input and stream upload</li> 13079 <li><code>tree</code> - shows a nicely formatted recursive listing</li> 13080 <li><code>cryptdecode</code> - decode crypted file names (thanks ishuah)</li> 13081 <li><code>config show</code> - print the config file</li> 13082 <li><code>config file</code> - print the config file location</li> 13083 </ul></li> 13084 <li>New Features 13085 <ul> 13086 <li>Empty directories are deleted on <code>sync</code></li> 13087 <li><code>dedupe</code> - implement merging of duplicate directories</li> 13088 <li><code>check</code> and <code>cryptcheck</code> made more consistent and use less memory</li> 13089 <li><code>cleanup</code> for remaining remotes (thanks ishuah)</li> 13090 <li><code>--immutable</code> for ensuring that files don’t change (thanks Jacob McNamee)</li> 13091 <li><code>--user-agent</code> option (thanks Alex McGrath Kraak)</li> 13092 <li><code>--disable</code> flag to disable optional features</li> 13093 <li><code>--bind</code> flag for choosing the local addr on outgoing connections</li> 13094 <li>Support for zsh auto-completion (thanks bpicode)</li> 13095 <li>Stop normalizing file names but do a normalized compare in <code>sync</code></li> 13096 </ul></li> 13097 <li>Compile 13098 <ul> 13099 <li>Update to using go1.9 as the default go version</li> 13100 <li>Remove snapd build due to maintenance problems</li> 13101 </ul></li> 13102 <li>Bug Fixes 13103 <ul> 13104 <li>Improve retriable error detection which makes multipart uploads better</li> 13105 <li>Make <code>check</code> obey <code>--ignore-size</code></li> 13106 <li>Fix bwlimit toggle in conjunction with schedules (thanks cbruegg)</li> 13107 <li><code>config</code> ensures newly written config is on the same mount</li> 13108 </ul></li> 13109 <li>Local 13110 <ul> 13111 <li>Revert to copy when moving file across file system boundaries</li> 13112 <li><code>--skip-links</code> to suppress symlink warnings (thanks Zhiming Wang)</li> 13113 </ul></li> 13114 <li>Mount 13115 <ul> 13116 <li>Re-use <code>rcat</code> internals to support uploads from all remotes</li> 13117 </ul></li> 13118 <li>Dropbox 13119 <ul> 13120 <li>Fix “entry doesn’t belong in directory” error</li> 13121 <li>Stop using deprecated API methods</li> 13122 </ul></li> 13123 <li>Swift 13124 <ul> 13125 <li>Fix server side copy to empty container with <code>--fast-list</code></li> 13126 </ul></li> 13127 <li>Google Drive 13128 <ul> 13129 <li>Change the default for <code>--drive-use-trash</code> to <code>true</code></li> 13130 </ul></li> 13131 <li>S3 13132 <ul> 13133 <li>Set session token when using STS (thanks Girish Ramakrishnan)</li> 13134 <li>Glacier docs and error messages (thanks Jan Varho)</li> 13135 <li>Read 1000 (not 1024) items in dir listings to fix Wasabi</li> 13136 </ul></li> 13137 <li>Backblaze B2 13138 <ul> 13139 <li>Fix SHA1 mismatch when downloading files with no SHA1</li> 13140 <li>Calculate missing hashes on the fly instead of spooling</li> 13141 <li><code>--b2-hard-delete</code> to permanently delete (not hide) files (thanks John Papandriopoulos)</li> 13142 </ul></li> 13143 <li>Hubic 13144 <ul> 13145 <li>Fix creating containers - no longer have to use the <code>default</code> container</li> 13146 </ul></li> 13147 <li>Swift 13148 <ul> 13149 <li>Optionally configure from a standard set of OpenStack environment vars</li> 13150 <li>Add <code>endpoint_type</code> config</li> 13151 </ul></li> 13152 <li>Google Cloud Storage 13153 <ul> 13154 <li>Fix bucket creation to work with limited permission users</li> 13155 </ul></li> 13156 <li>SFTP 13157 <ul> 13158 <li>Implement connection pooling for multiple ssh connections</li> 13159 <li>Limit new connections per second</li> 13160 <li>Add support for MD5 and SHA1 hashes where available (thanks Christian Brüggemann)</li> 13161 </ul></li> 13162 <li>HTTP 13163 <ul> 13164 <li>Fix URL encoding issues</li> 13165 <li>Fix directories with <code>:</code> in</li> 13166 <li>Fix panic with URL encoded content</li> 13167 </ul></li> 13168 </ul> 13169 <h2 id="v1.37---2017-07-22">v1.37 - 2017-07-22</h2> 13170 <ul> 13171 <li>New backends 13172 <ul> 13173 <li>FTP - thanks to Antonio Messina</li> 13174 <li>HTTP - thanks to Vasiliy Tolstov</li> 13175 </ul></li> 13176 <li>New commands 13177 <ul> 13178 <li>rclone ncdu - for exploring a remote with a text based user interface.</li> 13179 <li>rclone lsjson - for listing with a machine readable output</li> 13180 <li>rclone dbhashsum - to show Dropbox style hashes of files (local or Dropbox)</li> 13181 </ul></li> 13182 <li>New Features 13183 <ul> 13184 <li>Implement –fast-list flag 13185 <ul> 13186 <li>This allows remotes to list recursively if they can</li> 13187 <li>This uses less transactions (important if you pay for them)</li> 13188 <li>This may or may not be quicker</li> 13189 <li>This will use more memory as it has to hold the listing in memory</li> 13190 <li>–old-sync-method deprecated - the remaining uses are covered by –fast-list</li> 13191 <li>This involved a major re-write of all the listing code</li> 13192 </ul></li> 13193 <li>Add –tpslimit and –tpslimit-burst to limit transactions per second 13194 <ul> 13195 <li>this is useful in conjuction with <code>rclone mount</code> to limit external apps</li> 13196 </ul></li> 13197 <li>Add –stats-log-level so can see –stats without -v</li> 13198 <li>Print password prompts to stderr - Hraban Luyat</li> 13199 <li>Warn about duplicate files when syncing</li> 13200 <li>Oauth improvements 13201 <ul> 13202 <li>allow auth_url and token_url to be set in the config file</li> 13203 <li>Print redirection URI if using own credentials.</li> 13204 </ul></li> 13205 <li>Don’t Mkdir at the start of sync to save transactions</li> 13206 </ul></li> 13207 <li>Compile 13208 <ul> 13209 <li>Update build to go1.8.3</li> 13210 <li>Require go1.6 for building rclone</li> 13211 <li>Compile 386 builds with “GO386=387” for maximum compatibility</li> 13212 </ul></li> 13213 <li>Bug Fixes 13214 <ul> 13215 <li>Fix menu selection when no remotes</li> 13216 <li>Config saving reworked to not kill the file if disk gets full</li> 13217 <li>Don’t delete remote if name does not change while renaming</li> 13218 <li>moveto, copyto: report transfers and checks as per move and copy</li> 13219 </ul></li> 13220 <li>Local 13221 <ul> 13222 <li>Add –local-no-unicode-normalization flag - Bob Potter</li> 13223 </ul></li> 13224 <li>Mount 13225 <ul> 13226 <li>Now supported on Windows using cgofuse and WinFsp - thanks to Bill Zissimopoulos for much help</li> 13227 <li>Compare checksums on upload/download via FUSE</li> 13228 <li>Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM - Jérôme Vizcaino</li> 13229 <li>On read only open of file, make open pending until first read</li> 13230 <li>Make –read-only reject modify operations</li> 13231 <li>Implement ModTime via FUSE for remotes that support it</li> 13232 <li>Allow modTime to be changed even before all writers are closed</li> 13233 <li>Fix panic on renames</li> 13234 <li>Fix hang on errored upload</li> 13235 </ul></li> 13236 <li>Crypt 13237 <ul> 13238 <li>Report the name:root as specified by the user</li> 13239 <li>Add an “obfuscate” option for filename encryption - Stephen Harris</li> 13240 </ul></li> 13241 <li>Amazon Drive 13242 <ul> 13243 <li>Fix initialization order for token renewer</li> 13244 <li>Remove revoked credentials, allow oauth proxy config and update docs</li> 13245 </ul></li> 13246 <li>B2 13247 <ul> 13248 <li>Reduce minimum chunk size to 5MB</li> 13249 </ul></li> 13250 <li>Drive 13251 <ul> 13252 <li>Add team drive support</li> 13253 <li>Reduce bandwidth by adding fields for partial responses - Martin Kristensen</li> 13254 <li>Implement –drive-shared-with-me flag to view shared with me files - Danny Tsai</li> 13255 <li>Add –drive-trashed-only to read only the files in the trash</li> 13256 <li>Remove obsolete –drive-full-list</li> 13257 <li>Add missing seek to start on retries of chunked uploads</li> 13258 <li>Fix stats accounting for upload</li> 13259 <li>Convert / in names to a unicode equivalent (／)</li> 13260 <li>Poll for Google Drive changes when mounted</li> 13261 </ul></li> 13262 <li>OneDrive 13263 <ul> 13264 <li>Fix the uploading of files with spaces</li> 13265 <li>Fix initialization order for token renewer</li> 13266 <li>Display speeds accurately when uploading - Yoni Jah</li> 13267 <li>Swap to using http://localhost:53682/ as redirect URL - Michael Ledin</li> 13268 <li>Retry on token expired error, reset upload body on retry - Yoni Jah</li> 13269 </ul></li> 13270 <li>Google Cloud Storage 13271 <ul> 13272 <li>Add ability to specify location and storage class via config and command line - thanks gdm85</li> 13273 <li>Create container if necessary on server side copy</li> 13274 <li>Increase directory listing chunk to 1000 to increase performance</li> 13275 <li>Obtain a refresh token for GCS - Steven Lu</li> 13276 </ul></li> 13277 <li>Yandex 13278 <ul> 13279 <li>Fix the name reported in log messages (was empty)</li> 13280 <li>Correct error return for listing empty directory</li> 13281 </ul></li> 13282 <li>Dropbox 13283 <ul> 13284 <li>Rewritten to use the v2 API 13285 <ul> 13286 <li>Now supports ModTime 13287 <ul> 13288 <li>Can only set by uploading the file again</li> 13289 <li>If you uploaded with an old rclone, rclone may upload everything again</li> 13290 <li>Use <code>--size-only</code> or <code>--checksum</code> to avoid this</li> 13291 </ul></li> 13292 <li>Now supports the Dropbox content hashing scheme</li> 13293 <li>Now supports low level retries</li> 13294 </ul></li> 13295 </ul></li> 13296 <li>S3 13297 <ul> 13298 <li>Work around eventual consistency in bucket creation</li> 13299 <li>Create container if necessary on server side copy</li> 13300 <li>Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar Ahmed</li> 13301 </ul></li> 13302 <li>Swift, Hubic 13303 <ul> 13304 <li>Fix zero length directory markers showing in the subdirectory listing 13305 <ul> 13306 <li>this caused lots of duplicate transfers</li> 13307 </ul></li> 13308 <li>Fix paged directory listings 13309 <ul> 13310 <li>this caused duplicate directory errors</li> 13311 </ul></li> 13312 <li>Create container if necessary on server side copy</li> 13313 <li>Increase directory listing chunk to 1000 to increase performance</li> 13314 <li>Make sensible error if the user forgets the container</li> 13315 </ul></li> 13316 <li>SFTP 13317 <ul> 13318 <li>Add support for using ssh key files</li> 13319 <li>Fix under Windows</li> 13320 <li>Fix ssh agent on Windows</li> 13321 <li>Adapt to latest version of library - Igor Kharin</li> 13322 </ul></li> 13323 </ul> 13324 <h2 id="v1.36---2017-03-18">v1.36 - 2017-03-18</h2> 13325 <ul> 13326 <li>New Features 13327 <ul> 13328 <li>SFTP remote (Jack Schmidt)</li> 13329 <li>Re-implement sync routine to work a directory at a time reducing memory usage</li> 13330 <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> 13331 <li>Implement –backup-dir and –suffix</li> 13332 <li>Implement –track-renames (initial implementation by Bjørn Erik Pedersen)</li> 13333 <li>Add time-based bandwidth limits (Lukas Loesche)</li> 13334 <li>rclone cryptcheck: checks integrity of crypt remotes</li> 13335 <li>Allow all config file variables and options to be set from environment variables</li> 13336 <li>Add –buffer-size parameter to control buffer size for copy</li> 13337 <li>Make –delete-after the default</li> 13338 <li>Add –ignore-checksum flag (fixed by Hisham Zarka)</li> 13339 <li>rclone check: Add –download flag to check all the data, not just hashes</li> 13340 <li>rclone cat: add –head, –tail, –offset, –count and –discard</li> 13341 <li>rclone config: when choosing from a list, allow the value to be entered too</li> 13342 <li>rclone config: allow rename and copy of remotes</li> 13343 <li>rclone obscure: for generating encrypted passwords for rclone’s config (T.C. Ferguson)</li> 13344 <li>Comply with XDG Base Directory specification (Dario Giovannetti) 13345 <ul> 13346 <li>this moves the default location of the config file in a backwards compatible way</li> 13347 </ul></li> 13348 <li>Release changes 13349 <ul> 13350 <li>Ubuntu snap support (Dedsec1)</li> 13351 <li>Compile with go 1.8</li> 13352 <li>MIPS/Linux big and little endian support</li> 13353 </ul></li> 13354 </ul></li> 13355 <li>Bug Fixes 13356 <ul> 13357 <li>Fix copyto copying things to the wrong place if the destination dir didn’t exist</li> 13358 <li>Fix parsing of remotes in moveto and copyto</li> 13359 <li>Fix –delete-before deleting files on copy</li> 13360 <li>Fix –files-from with an empty file copying everything</li> 13361 <li>Fix sync: don’t update mod times if –dry-run set</li> 13362 <li>Fix MimeType propagation</li> 13363 <li>Fix filters to add ** rules to directory rules</li> 13364 </ul></li> 13365 <li>Local 13366 <ul> 13367 <li>Implement -L, –copy-links flag to allow rclone to follow symlinks</li> 13368 <li>Open files in write only mode so rclone can write to an rclone mount</li> 13369 <li>Fix unnormalised unicode causing problems reading directories</li> 13370 <li>Fix interaction between -x flag and –max-depth</li> 13371 </ul></li> 13372 <li>Mount 13373 <ul> 13374 <li>Implement proper directory handling (mkdir, rmdir, renaming)</li> 13375 <li>Make include and exclude filters apply to mount</li> 13376 <li>Implement read and write async buffers - control with –buffer-size</li> 13377 <li>Fix fsync on for directories</li> 13378 <li>Fix retry on network failure when reading off crypt</li> 13379 </ul></li> 13380 <li>Crypt 13381 <ul> 13382 <li>Add –crypt-show-mapping to show encrypted file mapping</li> 13383 <li>Fix crypt writer getting stuck in a loop 13384 <ul> 13385 <li><strong>IMPORTANT</strong> this bug had the potential to cause data corruption when 13386 <ul> 13387 <li>reading data from a network based remote and</li> 13388 <li>writing to a crypt on Google Drive</li> 13389 </ul></li> 13390 <li>Use the cryptcheck command to validate your data if you are concerned</li> 13391 <li>If syncing two crypt remotes, sync the unencrypted remote</li> 13392 </ul></li> 13393 </ul></li> 13394 <li>Amazon Drive 13395 <ul> 13396 <li>Fix panics on Move (rename)</li> 13397 <li>Fix panic on token expiry</li> 13398 </ul></li> 13399 <li>B2 13400 <ul> 13401 <li>Fix inconsistent listings and rclone check</li> 13402 <li>Fix uploading empty files with go1.8</li> 13403 <li>Constrain memory usage when doing multipart uploads</li> 13404 <li>Fix upload url not being refreshed properly</li> 13405 </ul></li> 13406 <li>Drive 13407 <ul> 13408 <li>Fix Rmdir on directories with trashed files</li> 13409 <li>Fix “Ignoring unknown object” when downloading</li> 13410 <li>Add –drive-list-chunk</li> 13411 <li>Add –drive-skip-gdocs (Károly Oláh)</li> 13412 </ul></li> 13413 <li>OneDrive 13414 <ul> 13415 <li>Implement Move</li> 13416 <li>Fix Copy 13417 <ul> 13418 <li>Fix overwrite detection in Copy</li> 13419 <li>Fix waitForJob to parse errors correctly</li> 13420 </ul></li> 13421 <li>Use token renewer to stop auth errors on long uploads</li> 13422 <li>Fix uploading empty files with go1.8</li> 13423 </ul></li> 13424 <li>Google Cloud Storage 13425 <ul> 13426 <li>Fix depth 1 directory listings</li> 13427 </ul></li> 13428 <li>Yandex 13429 <ul> 13430 <li>Fix single level directory listing</li> 13431 </ul></li> 13432 <li>Dropbox 13433 <ul> 13434 <li>Normalise the case for single level directory listings</li> 13435 <li>Fix depth 1 listing</li> 13436 </ul></li> 13437 <li>S3 13438 <ul> 13439 <li>Added ca-central-1 region (Jon Yergatian)</li> 13440 </ul></li> 13441 </ul> 13442 <h2 id="v1.35---2017-01-02">v1.35 - 2017-01-02</h2> 13443 <ul> 13444 <li>New Features 13445 <ul> 13446 <li>moveto and copyto commands for choosing a destination name on copy/move</li> 13447 <li>rmdirs command to recursively delete empty directories</li> 13448 <li>Allow repeated –include/–exclude/–filter options</li> 13449 <li>Only show transfer stats on commands which transfer stuff 13450 <ul> 13451 <li>show stats on any command using the <code>--stats</code> flag</li> 13452 </ul></li> 13453 <li>Allow overlapping directories in move when server side dir move is supported</li> 13454 <li>Add –stats-unit option - thanks Scott McGillivray</li> 13455 </ul></li> 13456 <li>Bug Fixes 13457 <ul> 13458 <li>Fix the config file being overwritten when two rclones are running</li> 13459 <li>Make rclone lsd obey the filters properly</li> 13460 <li>Fix compilation on mips</li> 13461 <li>Fix not transferring files that don’t differ in size</li> 13462 <li>Fix panic on nil retry/fatal error</li> 13463 </ul></li> 13464 <li>Mount 13465 <ul> 13466 <li>Retry reads on error - should help with reliability a lot</li> 13467 <li>Report the modification times for directories from the remote</li> 13468 <li>Add bandwidth accounting and limiting (fixes –bwlimit)</li> 13469 <li>If –stats provided will show stats and which files are transferring</li> 13470 <li>Support R/W files if truncate is set.</li> 13471 <li>Implement statfs interface so df works</li> 13472 <li>Note that write is now supported on Amazon Drive</li> 13473 <li>Report number of blocks in a file - thanks Stefan Breunig</li> 13474 </ul></li> 13475 <li>Crypt 13476 <ul> 13477 <li>Prevent the user pointing crypt at itself</li> 13478 <li>Fix failed to authenticate decrypted block errors 13479 <ul> 13480 <li>these will now return the underlying unexpected EOF instead</li> 13481 </ul></li> 13482 </ul></li> 13483 <li>Amazon Drive 13484 <ul> 13485 <li>Add support for server side move and directory move - thanks Stefan Breunig</li> 13486 <li>Fix nil pointer deref on size attribute</li> 13487 </ul></li> 13488 <li>B2 13489 <ul> 13490 <li>Use new prefix and delimiter parameters in directory listings 13491 <ul> 13492 <li>This makes –max-depth 1 dir listings as used in mount much faster</li> 13493 </ul></li> 13494 <li>Reauth the account while doing uploads too - should help with token expiry</li> 13495 </ul></li> 13496 <li>Drive 13497 <ul> 13498 <li>Make DirMove more efficient and complain about moving the root</li> 13499 <li>Create destination directory on Move()</li> 13500 </ul></li> 13501 </ul> 13502 <h2 id="v1.34---2016-11-06">v1.34 - 2016-11-06</h2> 13503 <ul> 13504 <li>New Features 13505 <ul> 13506 <li>Stop single file and <code>--files-from</code> operations iterating through the source bucket.</li> 13507 <li>Stop removing failed upload to cloud storage remotes</li> 13508 <li>Make ContentType be preserved for cloud to cloud copies</li> 13509 <li>Add support to toggle bandwidth limits via SIGUSR2 - thanks Marco Paganini</li> 13510 <li><code>rclone check</code> shows count of hashes that couldn’t be checked</li> 13511 <li><code>rclone listremotes</code> command</li> 13512 <li>Support linux/arm64 build - thanks Fredrik Fornwall</li> 13513 <li>Remove <code>Authorization:</code> lines from <code>--dump-headers</code> output</li> 13514 </ul></li> 13515 <li>Bug Fixes 13516 <ul> 13517 <li>Ignore files with control characters in the names</li> 13518 <li>Fix <code>rclone move</code> command 13519 <ul> 13520 <li>Delete src files which already existed in dst</li> 13521 <li>Fix deletion of src file when dst file older</li> 13522 </ul></li> 13523 <li>Fix <code>rclone check</code> on crypted file systems</li> 13524 <li>Make failed uploads not count as “Transferred”</li> 13525 <li>Make sure high level retries show with <code>-q</code></li> 13526 <li>Use a vendor directory with godep for repeatable builds</li> 13527 </ul></li> 13528 <li><code>rclone mount</code> - FUSE 13529 <ul> 13530 <li>Implement FUSE mount options 13531 <ul> 13532 <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> 13533 <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> 13534 </ul></li> 13535 <li>Add <code>--dir-cache-time</code> to control caching of directory entries</li> 13536 <li>Implement seek for files opened for read (useful for video players) 13537 <ul> 13538 <li>with <code>-no-seek</code> flag to disable</li> 13539 </ul></li> 13540 <li>Fix crash on 32 bit ARM (alignment of 64 bit counter)</li> 13541 <li>…and many more internal fixes and improvements!</li> 13542 </ul></li> 13543 <li>Crypt 13544 <ul> 13545 <li>Don’t show encrypted password in configurator to stop confusion</li> 13546 </ul></li> 13547 <li>Amazon Drive 13548 <ul> 13549 <li>New wait for upload option <code>--acd-upload-wait-per-gb</code> 13550 <ul> 13551 <li>upload timeouts scale by file size and can be disabled</li> 13552 </ul></li> 13553 <li>Add 502 Bad Gateway to list of errors we retry</li> 13554 <li>Fix overwriting a file with a zero length file</li> 13555 <li>Fix ACD file size warning limit - thanks Felix Bünemann</li> 13556 </ul></li> 13557 <li>Local 13558 <ul> 13559 <li>Unix: implement <code>-x</code>/<code>--one-file-system</code> to stay on a single file system 13560 <ul> 13561 <li>thanks Durval Menezes and Luiz Carlos Rumbelsperger Viana</li> 13562 </ul></li> 13563 <li>Windows: ignore the symlink bit on files</li> 13564 <li>Windows: Ignore directory based junction points</li> 13565 </ul></li> 13566 <li>B2 13567 <ul> 13568 <li>Make sure each upload has at least one upload slot - fixes strange upload stats</li> 13569 <li>Fix uploads when using crypt</li> 13570 <li>Fix download of large files (sha1 mismatch)</li> 13571 <li>Return error when we try to create a bucket which someone else owns</li> 13572 <li>Update B2 docs with Data usage, and Crypt section - thanks Tomasz Mazur</li> 13573 </ul></li> 13574 <li>S3 13575 <ul> 13576 <li>Command line and config file support for 13577 <ul> 13578 <li>Setting/overriding ACL - thanks Radek Senfeld</li> 13579 <li>Setting storage class - thanks Asko Tamm</li> 13580 </ul></li> 13581 </ul></li> 13582 <li>Drive 13583 <ul> 13584 <li>Make exponential backoff work exactly as per Google specification</li> 13585 <li>add <code>.epub</code>, <code>.odp</code> and <code>.tsv</code> as export formats.</li> 13586 </ul></li> 13587 <li>Swift 13588 <ul> 13589 <li>Don’t read metadata for directory marker objects</li> 13590 </ul></li> 13591 </ul> 13592 <h2 id="v1.33---2016-08-24">v1.33 - 2016-08-24</h2> 13593 <ul> 13594 <li>New Features 13595 <ul> 13596 <li>Implement encryption 13597 <ul> 13598 <li>data encrypted in NACL secretbox format</li> 13599 <li>with optional file name encryption</li> 13600 </ul></li> 13601 <li>New commands 13602 <ul> 13603 <li>rclone mount - implements FUSE mounting of remotes (EXPERIMENTAL) 13604 <ul> 13605 <li>works on Linux, FreeBSD and OS X (need testers for the last 2!)</li> 13606 </ul></li> 13607 <li>rclone cat - outputs remote file or files to the terminal</li> 13608 <li>rclone genautocomplete - command to make a bash completion script for rclone</li> 13609 </ul></li> 13610 <li>Editing a remote using <code>rclone config</code> now goes through the wizard</li> 13611 <li>Compile with go 1.7 - this fixes rclone on macOS Sierra and on 386 processors</li> 13612 <li>Use cobra for sub commands and docs generation</li> 13613 </ul></li> 13614 <li>drive 13615 <ul> 13616 <li>Document how to make your own client_id</li> 13617 </ul></li> 13618 <li>s3 13619 <ul> 13620 <li>User-configurable Amazon S3 ACL (thanks Radek Šenfeld)</li> 13621 </ul></li> 13622 <li>b2 13623 <ul> 13624 <li>Fix stats accounting for upload - no more jumping to 100% done</li> 13625 <li>On cleanup delete hide marker if it is the current file</li> 13626 <li>New B2 API endpoint (thanks Per Cederberg)</li> 13627 <li>Set maximum backoff to 5 Minutes</li> 13628 </ul></li> 13629 <li>onedrive 13630 <ul> 13631 <li>Fix URL escaping in file names - eg uploading files with <code>+</code> in them.</li> 13632 </ul></li> 13633 <li>amazon cloud drive 13634 <ul> 13635 <li>Fix token expiry during large uploads</li> 13636 <li>Work around 408 REQUEST_TIMEOUT and 504 GATEWAY_TIMEOUT errors</li> 13637 </ul></li> 13638 <li>local 13639 <ul> 13640 <li>Fix filenames with invalid UTF-8 not being uploaded</li> 13641 <li>Fix problem with some UTF-8 characters on OS X</li> 13642 </ul></li> 13643 </ul> 13644 <h2 id="v1.32---2016-07-13">v1.32 - 2016-07-13</h2> 13645 <ul> 13646 <li>Backblaze B2 13647 <ul> 13648 <li>Fix upload of files large files not in root</li> 13649 </ul></li> 13650 </ul> 13651 <h2 id="v1.31---2016-07-13">v1.31 - 2016-07-13</h2> 13652 <ul> 13653 <li>New Features 13654 <ul> 13655 <li>Reduce memory on sync by about 50%</li> 13656 <li>Implement –no-traverse flag to stop copy traversing the destination remote. 13657 <ul> 13658 <li>This can be used to reduce memory usage down to the smallest possible.</li> 13659 <li>Useful to copy a small number of files into a large destination folder.</li> 13660 </ul></li> 13661 <li>Implement cleanup command for emptying trash / removing old versions of files 13662 <ul> 13663 <li>Currently B2 only</li> 13664 </ul></li> 13665 <li>Single file handling improved 13666 <ul> 13667 <li>Now copied with –files-from</li> 13668 <li>Automatically sets –no-traverse when copying a single file</li> 13669 </ul></li> 13670 <li>Info on using installing with ansible - thanks Stefan Weichinger</li> 13671 <li>Implement –no-update-modtime flag to stop rclone fixing the remote modified times.</li> 13672 </ul></li> 13673 <li>Bug Fixes 13674 <ul> 13675 <li>Fix move command - stop it running for overlapping Fses - this was causing data loss.</li> 13676 </ul></li> 13677 <li>Local 13678 <ul> 13679 <li>Fix incomplete hashes - this was causing problems for B2.</li> 13680 </ul></li> 13681 <li>Amazon Drive 13682 <ul> 13683 <li>Rename Amazon Cloud Drive to Amazon Drive - no changes to config file needed.</li> 13684 </ul></li> 13685 <li>Swift 13686 <ul> 13687 <li>Add support for non-default project domain - thanks Antonio Messina.</li> 13688 </ul></li> 13689 <li>S3 13690 <ul> 13691 <li>Add instructions on how to use rclone with minio.</li> 13692 <li>Add ap-northeast-2 (Seoul) and ap-south-1 (Mumbai) regions.</li> 13693 <li>Skip setting the modified time for objects > 5GB as it isn’t possible.</li> 13694 </ul></li> 13695 <li>Backblaze B2 13696 <ul> 13697 <li>Add –b2-versions flag so old versions can be listed and retreived.</li> 13698 <li>Treat 403 errors (eg cap exceeded) as fatal.</li> 13699 <li>Implement cleanup command for deleting old file versions.</li> 13700 <li>Make error handling compliant with B2 integrations notes.</li> 13701 <li>Fix handling of token expiry.</li> 13702 <li>Implement –b2-test-mode to set <code>X-Bz-Test-Mode</code> header.</li> 13703 <li>Set cutoff for chunked upload to 200MB as per B2 guidelines.</li> 13704 <li>Make upload multi-threaded.</li> 13705 </ul></li> 13706 <li>Dropbox 13707 <ul> 13708 <li>Don’t retry 461 errors.</li> 13709 </ul></li> 13710 </ul> 13711 <h2 id="v1.30---2016-06-18">v1.30 - 2016-06-18</h2> 13712 <ul> 13713 <li>New Features 13714 <ul> 13715 <li>Directory listing code reworked for more features and better error reporting (thanks to Klaus Post for help). This enables 13716 <ul> 13717 <li>Directory include filtering for efficiency</li> 13718 <li>–max-depth parameter</li> 13719 <li>Better error reporting</li> 13720 <li>More to come</li> 13721 </ul></li> 13722 <li>Retry more errors</li> 13723 <li>Add –ignore-size flag - for uploading images to onedrive</li> 13724 <li>Log -v output to stdout by default</li> 13725 <li>Display the transfer stats in more human readable form</li> 13726 <li>Make 0 size files specifiable with <code>--max-size 0b</code></li> 13727 <li>Add <code>b</code> suffix so we can specify bytes in –bwlimit, –min-size etc</li> 13728 <li>Use “password:” instead of “password>” prompt - thanks Klaus Post and Leigh Klotz</li> 13729 </ul></li> 13730 <li>Bug Fixes 13731 <ul> 13732 <li>Fix retry doing one too many retries</li> 13733 </ul></li> 13734 <li>Local 13735 <ul> 13736 <li>Fix problems with OS X and UTF-8 characters</li> 13737 </ul></li> 13738 <li>Amazon Drive 13739 <ul> 13740 <li>Check a file exists before uploading to help with 408 Conflict errors</li> 13741 <li>Reauth on 401 errors - this has been causing a lot of problems</li> 13742 <li>Work around spurious 403 errors</li> 13743 <li>Restart directory listings on error</li> 13744 </ul></li> 13745 <li>Google Drive 13746 <ul> 13747 <li>Check a file exists before uploading to help with duplicates</li> 13748 <li>Fix retry of multipart uploads</li> 13749 </ul></li> 13750 <li>Backblaze B2 13751 <ul> 13752 <li>Implement large file uploading</li> 13753 </ul></li> 13754 <li>S3 13755 <ul> 13756 <li>Add AES256 server-side encryption for - thanks Justin R. Wilson</li> 13757 </ul></li> 13758 <li>Google Cloud Storage 13759 <ul> 13760 <li>Make sure we don’t use conflicting content types on upload</li> 13761 <li>Add service account support - thanks Michal Witkowski</li> 13762 </ul></li> 13763 <li>Swift 13764 <ul> 13765 <li>Add auth version parameter</li> 13766 <li>Add domain option for openstack (v3 auth) - thanks Fabian Ruff</li> 13767 </ul></li> 13768 </ul> 13769 <h2 id="v1.29---2016-04-18">v1.29 - 2016-04-18</h2> 13770 <ul> 13771 <li>New Features 13772 <ul> 13773 <li>Implement <code>-I, --ignore-times</code> for unconditional upload</li> 13774 <li>Improve <code>dedupe</code>command 13775 <ul> 13776 <li>Now removes identical copies without asking</li> 13777 <li>Now obeys <code>--dry-run</code></li> 13778 <li>Implement <code>--dedupe-mode</code> for non interactive running 13779 <ul> 13780 <li><code>--dedupe-mode interactive</code> - interactive the default.</li> 13781 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 13782 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 13783 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 13784 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 13785 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 13786 </ul></li> 13787 </ul></li> 13788 </ul></li> 13789 <li>Bug fixes 13790 <ul> 13791 <li>Make rclone check obey the <code>--size-only</code> flag.</li> 13792 <li>Use “application/octet-stream” if discovered mime type is invalid.</li> 13793 <li>Fix missing “quit” option when there are no remotes.</li> 13794 </ul></li> 13795 <li>Google Drive 13796 <ul> 13797 <li>Increase default chunk size to 8 MB - increases upload speed of big files</li> 13798 <li>Speed up directory listings and make more reliable</li> 13799 <li>Add missing retries for Move and DirMove - increases reliability</li> 13800 <li>Preserve mime type on file update</li> 13801 </ul></li> 13802 <li>Backblaze B2 13803 <ul> 13804 <li>Enable mod time syncing 13805 <ul> 13806 <li>This means that B2 will now check modification times</li> 13807 <li>It will upload new files to update the modification times</li> 13808 <li>(there isn’t an API to just set the mod time.)</li> 13809 <li>If you want the old behaviour use <code>--size-only</code>.</li> 13810 </ul></li> 13811 <li>Update API to new version</li> 13812 <li>Fix parsing of mod time when not in metadata</li> 13813 </ul></li> 13814 <li>Swift/Hubic 13815 <ul> 13816 <li>Don’t return an MD5SUM for static large objects</li> 13817 </ul></li> 13818 <li>S3 13819 <ul> 13820 <li>Fix uploading files bigger than 50GB</li> 13821 </ul></li> 13822 </ul> 13823 <h2 id="v1.28---2016-03-01">v1.28 - 2016-03-01</h2> 13824 <ul> 13825 <li>New Features 13826 <ul> 13827 <li>Configuration file encryption - thanks Klaus Post</li> 13828 <li>Improve <code>rclone config</code> adding more help and making it easier to understand</li> 13829 <li>Implement <code>-u</code>/<code>--update</code> so creation times can be used on all remotes</li> 13830 <li>Implement <code>--low-level-retries</code> flag</li> 13831 <li>Optionally disable gzip compression on downloads with <code>--no-gzip-encoding</code></li> 13832 </ul></li> 13833 <li>Bug fixes 13834 <ul> 13835 <li>Don’t make directories if <code>--dry-run</code> set</li> 13836 <li>Fix and document the <code>move</code> command</li> 13837 <li>Fix redirecting stderr on unix-like OSes when using <code>--log-file</code></li> 13838 <li>Fix <code>delete</code> command to wait until all finished - fixes missing deletes.</li> 13839 </ul></li> 13840 <li>Backblaze B2 13841 <ul> 13842 <li>Use one upload URL per go routine fixes <code>more than one upload using auth token</code></li> 13843 <li>Add pacing, retries and reauthentication - fixes token expiry problems</li> 13844 <li>Upload without using a temporary file from local (and remotes which support SHA1)</li> 13845 <li>Fix reading metadata for all files when it shouldn’t have been</li> 13846 </ul></li> 13847 <li>Drive 13848 <ul> 13849 <li>Fix listing drive documents at root</li> 13850 <li>Disable copy and move for Google docs</li> 13851 </ul></li> 13852 <li>Swift 13853 <ul> 13854 <li>Fix uploading of chunked files with non ASCII characters</li> 13855 <li>Allow setting of <code>storage_url</code> in the config - thanks Xavier Lucas</li> 13856 </ul></li> 13857 <li>S3 13858 <ul> 13859 <li>Allow IAM role and credentials from environment variables - thanks Brian Stengaard</li> 13860 <li>Allow low privilege users to use S3 (check if directory exists during Mkdir) - thanks Jakub Gedeon</li> 13861 </ul></li> 13862 <li>Amazon Drive 13863 <ul> 13864 <li>Retry on more things to make directory listings more reliable</li> 13865 </ul></li> 13866 </ul> 13867 <h2 id="v1.27---2016-01-31">v1.27 - 2016-01-31</h2> 13868 <ul> 13869 <li>New Features 13870 <ul> 13871 <li>Easier headless configuration with <code>rclone authorize</code></li> 13872 <li>Add support for multiple hash types - we now check SHA1 as well as MD5 hashes.</li> 13873 <li><code>delete</code> command which does obey the filters (unlike <code>purge</code>)</li> 13874 <li><code>dedupe</code> command to deduplicate a remote. Useful with Google Drive.</li> 13875 <li>Add <code>--ignore-existing</code> flag to skip all files that exist on destination.</li> 13876 <li>Add <code>--delete-before</code>, <code>--delete-during</code>, <code>--delete-after</code> flags.</li> 13877 <li>Add <code>--memprofile</code> flag to debug memory use.</li> 13878 <li>Warn the user about files with same name but different case</li> 13879 <li>Make <code>--include</code> rules add their implict exclude * at the end of the filter list</li> 13880 <li>Deprecate compiling with go1.3</li> 13881 </ul></li> 13882 <li>Amazon Drive 13883 <ul> 13884 <li>Fix download of files > 10 GB</li> 13885 <li>Fix directory traversal (“Next token is expired”) for large directory listings</li> 13886 <li>Remove 409 conflict from error codes we will retry - stops very long pauses</li> 13887 </ul></li> 13888 <li>Backblaze B2 13889 <ul> 13890 <li>SHA1 hashes now checked by rclone core</li> 13891 </ul></li> 13892 <li>Drive 13893 <ul> 13894 <li>Add <code>--drive-auth-owner-only</code> to only consider files owned by the user - thanks Björn Harrtell</li> 13895 <li>Export Google documents</li> 13896 </ul></li> 13897 <li>Dropbox 13898 <ul> 13899 <li>Make file exclusion error controllable with -q</li> 13900 </ul></li> 13901 <li>Swift 13902 <ul> 13903 <li>Fix upload from unprivileged user.</li> 13904 </ul></li> 13905 <li>S3 13906 <ul> 13907 <li>Fix updating of mod times of files with <code>+</code> in.</li> 13908 </ul></li> 13909 <li>Local 13910 <ul> 13911 <li>Add local file system option to disable UNC on Windows.</li> 13912 </ul></li> 13913 </ul> 13914 <h2 id="v1.26---2016-01-02">v1.26 - 2016-01-02</h2> 13915 <ul> 13916 <li>New Features 13917 <ul> 13918 <li>Yandex storage backend - thank you Dmitry Burdeev (“dibu”)</li> 13919 <li>Implement Backblaze B2 storage backend</li> 13920 <li>Add –min-age and –max-age flags - thank you Adriano Aurélio Meirelles</li> 13921 <li>Make ls/lsl/md5sum/size/check obey includes and excludes</li> 13922 </ul></li> 13923 <li>Fixes 13924 <ul> 13925 <li>Fix crash in http logging</li> 13926 <li>Upload releases to github too</li> 13927 </ul></li> 13928 <li>Swift 13929 <ul> 13930 <li>Fix sync for chunked files</li> 13931 </ul></li> 13932 <li>OneDrive 13933 <ul> 13934 <li>Re-enable server side copy</li> 13935 <li>Don’t mask HTTP error codes with JSON decode error</li> 13936 </ul></li> 13937 <li>S3 13938 <ul> 13939 <li>Fix corrupting Content-Type on mod time update (thanks Joseph Spurrier)</li> 13940 </ul></li> 13941 </ul> 13942 <h2 id="v1.25---2015-11-14">v1.25 - 2015-11-14</h2> 13943 <ul> 13944 <li>New features 13945 <ul> 13946 <li>Implement Hubic storage system</li> 13947 </ul></li> 13948 <li>Fixes 13949 <ul> 13950 <li>Fix deletion of some excluded files without –delete-excluded 13951 <ul> 13952 <li>This could have deleted files unexpectedly on sync</li> 13953 <li>Always check first with <code>--dry-run</code>!</li> 13954 </ul></li> 13955 </ul></li> 13956 <li>Swift 13957 <ul> 13958 <li>Stop SetModTime losing metadata (eg X-Object-Manifest) 13959 <ul> 13960 <li>This could have caused data loss for files > 5GB in size</li> 13961 </ul></li> 13962 <li>Use ContentType from Object to avoid lookups in listings</li> 13963 </ul></li> 13964 <li>OneDrive 13965 <ul> 13966 <li>disable server side copy as it seems to be broken at Microsoft</li> 13967 </ul></li> 13968 </ul> 13969 <h2 id="v1.24---2015-11-07">v1.24 - 2015-11-07</h2> 13970 <ul> 13971 <li>New features 13972 <ul> 13973 <li>Add support for Microsoft OneDrive</li> 13974 <li>Add <code>--no-check-certificate</code> option to disable server certificate verification</li> 13975 <li>Add async readahead buffer for faster transfer of big files</li> 13976 </ul></li> 13977 <li>Fixes 13978 <ul> 13979 <li>Allow spaces in remotes and check remote names for validity at creation time</li> 13980 <li>Allow ‘&’ and disallow ‘:’ in Windows filenames.</li> 13981 </ul></li> 13982 <li>Swift 13983 <ul> 13984 <li>Ignore directory marker objects where appropriate - allows working with Hubic</li> 13985 <li>Don’t delete the container if fs wasn’t at root</li> 13986 </ul></li> 13987 <li>S3 13988 <ul> 13989 <li>Don’t delete the bucket if fs wasn’t at root</li> 13990 </ul></li> 13991 <li>Google Cloud Storage 13992 <ul> 13993 <li>Don’t delete the bucket if fs wasn’t at root</li> 13994 </ul></li> 13995 </ul> 13996 <h2 id="v1.23---2015-10-03">v1.23 - 2015-10-03</h2> 13997 <ul> 13998 <li>New features 13999 <ul> 14000 <li>Implement <code>rclone size</code> for measuring remotes</li> 14001 </ul></li> 14002 <li>Fixes 14003 <ul> 14004 <li>Fix headless config for drive and gcs</li> 14005 <li>Tell the user they should try again if the webserver method failed</li> 14006 <li>Improve output of <code>--dump-headers</code></li> 14007 </ul></li> 14008 <li>S3 14009 <ul> 14010 <li>Allow anonymous access to public buckets</li> 14011 </ul></li> 14012 <li>Swift 14013 <ul> 14014 <li>Stop chunked operations logging “Failed to read info: Object Not Found”</li> 14015 <li>Use Content-Length on uploads for extra reliability</li> 14016 </ul></li> 14017 </ul> 14018 <h2 id="v1.22---2015-09-28">v1.22 - 2015-09-28</h2> 14019 <ul> 14020 <li>Implement rsync like include and exclude flags</li> 14021 <li>swift 14022 <ul> 14023 <li>Support files > 5GB - thanks Sergey Tolmachev</li> 14024 </ul></li> 14025 </ul> 14026 <h2 id="v1.21---2015-09-22">v1.21 - 2015-09-22</h2> 14027 <ul> 14028 <li>New features 14029 <ul> 14030 <li>Display individual transfer progress</li> 14031 <li>Make lsl output times in localtime</li> 14032 </ul></li> 14033 <li>Fixes 14034 <ul> 14035 <li>Fix allowing user to override credentials again in Drive, GCS and ACD</li> 14036 </ul></li> 14037 <li>Amazon Drive 14038 <ul> 14039 <li>Implement compliant pacing scheme</li> 14040 </ul></li> 14041 <li>Google Drive 14042 <ul> 14043 <li>Make directory reads concurrent for increased speed.</li> 14044 </ul></li> 14045 </ul> 14046 <h2 id="v1.20---2015-09-15">v1.20 - 2015-09-15</h2> 14047 <ul> 14048 <li>New features 14049 <ul> 14050 <li>Amazon Drive support</li> 14051 <li>Oauth support redone - fix many bugs and improve usability 14052 <ul> 14053 <li>Use “golang.org/x/oauth2” as oauth libary of choice</li> 14054 <li>Improve oauth usability for smoother initial signup</li> 14055 <li>drive, googlecloudstorage: optionally use auto config for the oauth token</li> 14056 </ul></li> 14057 <li>Implement –dump-headers and –dump-bodies debug flags</li> 14058 <li>Show multiple matched commands if abbreviation too short</li> 14059 <li>Implement server side move where possible</li> 14060 </ul></li> 14061 <li>local 14062 <ul> 14063 <li>Always use UNC paths internally on Windows - fixes a lot of bugs</li> 14064 </ul></li> 14065 <li>dropbox 14066 <ul> 14067 <li>force use of our custom transport which makes timeouts work</li> 14068 </ul></li> 14069 <li>Thanks to Klaus Post for lots of help with this release</li> 14070 </ul> 14071 <h2 id="v1.19---2015-08-28">v1.19 - 2015-08-28</h2> 14072 <ul> 14073 <li>New features 14074 <ul> 14075 <li>Server side copies for s3/swift/drive/dropbox/gcs</li> 14076 <li>Move command - uses server side copies if it can</li> 14077 <li>Implement –retries flag - tries 3 times by default</li> 14078 <li>Build for plan9/amd64 and solaris/amd64 too</li> 14079 </ul></li> 14080 <li>Fixes 14081 <ul> 14082 <li>Make a current version download with a fixed URL for scripting</li> 14083 <li>Ignore rmdir in limited fs rather than throwing error</li> 14084 </ul></li> 14085 <li>dropbox 14086 <ul> 14087 <li>Increase chunk size to improve upload speeds massively</li> 14088 <li>Issue an error message when trying to upload bad file name</li> 14089 </ul></li> 14090 </ul> 14091 <h2 id="v1.18---2015-08-17">v1.18 - 2015-08-17</h2> 14092 <ul> 14093 <li>drive 14094 <ul> 14095 <li>Add <code>--drive-use-trash</code> flag so rclone trashes instead of deletes</li> 14096 <li>Add “Forbidden to download” message for files with no downloadURL</li> 14097 </ul></li> 14098 <li>dropbox 14099 <ul> 14100 <li>Remove datastore 14101 <ul> 14102 <li>This was deprecated and it caused a lot of problems</li> 14103 <li>Modification times and MD5SUMs no longer stored</li> 14104 </ul></li> 14105 <li>Fix uploading files > 2GB</li> 14106 </ul></li> 14107 <li>s3 14108 <ul> 14109 <li>use official AWS SDK from github.com/aws/aws-sdk-go</li> 14110 <li><strong>NB</strong> will most likely require you to delete and recreate remote</li> 14111 <li>enable multipart upload which enables files > 5GB</li> 14112 <li>tested with Ceph / RadosGW / S3 emulation</li> 14113 <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> 14114 </ul></li> 14115 <li>misc 14116 <ul> 14117 <li>Show errors when reading the config file</li> 14118 <li>Do not print stats in quiet mode - thanks Leonid Shalupov</li> 14119 <li>Add FAQ</li> 14120 <li>Fix created directories not obeying umask</li> 14121 <li>Linux installation instructions - thanks Shimon Doodkin</li> 14122 </ul></li> 14123 </ul> 14124 <h2 id="v1.17---2015-06-14">v1.17 - 2015-06-14</h2> 14125 <ul> 14126 <li>dropbox: fix case insensitivity issues - thanks Leonid Shalupov</li> 14127 </ul> 14128 <h2 id="v1.16---2015-06-09">v1.16 - 2015-06-09</h2> 14129 <ul> 14130 <li>Fix uploading big files which was causing timeouts or panics</li> 14131 <li>Don’t check md5sum after download with –size-only</li> 14132 </ul> 14133 <h2 id="v1.15---2015-06-06">v1.15 - 2015-06-06</h2> 14134 <ul> 14135 <li>Add –checksum flag to only discard transfers by MD5SUM - thanks Alex Couper</li> 14136 <li>Implement –size-only flag to sync on size not checksum & modtime</li> 14137 <li>Expand docs and remove duplicated information</li> 14138 <li>Document rclone’s limitations with directories</li> 14139 <li>dropbox: update docs about case insensitivity</li> 14140 </ul> 14141 <h2 id="v1.14---2015-05-21">v1.14 - 2015-05-21</h2> 14142 <ul> 14143 <li>local: fix encoding of non utf-8 file names - fixes a duplicate file problem</li> 14144 <li>drive: docs about rate limiting</li> 14145 <li>google cloud storage: Fix compile after API change in “google.golang.org/api/storage/v1”</li> 14146 </ul> 14147 <h2 id="v1.13---2015-05-10">v1.13 - 2015-05-10</h2> 14148 <ul> 14149 <li>Revise documentation (especially sync)</li> 14150 <li>Implement –timeout and –conntimeout</li> 14151 <li>s3: ignore etags from multipart uploads which aren’t md5sums</li> 14152 </ul> 14153 <h2 id="v1.12---2015-03-15">v1.12 - 2015-03-15</h2> 14154 <ul> 14155 <li>drive: Use chunked upload for files above a certain size</li> 14156 <li>drive: add –drive-chunk-size and –drive-upload-cutoff parameters</li> 14157 <li>drive: switch to insert from update when a failed copy deletes the upload</li> 14158 <li>core: Log duplicate files if they are detected</li> 14159 </ul> 14160 <h2 id="v1.11---2015-03-04">v1.11 - 2015-03-04</h2> 14161 <ul> 14162 <li>swift: add region parameter</li> 14163 <li>drive: fix crash on failed to update remote mtime</li> 14164 <li>In remote paths, change native directory separators to /</li> 14165 <li>Add synchronization to ls/lsl/lsd output to stop corruptions</li> 14166 <li>Ensure all stats/log messages to go stderr</li> 14167 <li>Add –log-file flag to log everything (including panics) to file</li> 14168 <li>Make it possible to disable stats printing with –stats=0</li> 14169 <li>Implement –bwlimit to limit data transfer bandwidth</li> 14170 </ul> 14171 <h2 id="v1.10---2015-02-12">v1.10 - 2015-02-12</h2> 14172 <ul> 14173 <li>s3: list an unlimited number of items</li> 14174 <li>Fix getting stuck in the configurator</li> 14175 </ul> 14176 <h2 id="v1.09---2015-02-07">v1.09 - 2015-02-07</h2> 14177 <ul> 14178 <li>windows: Stop drive letters (eg C:) getting mixed up with remotes (eg drive:)</li> 14179 <li>local: Fix directory separators on Windows</li> 14180 <li>drive: fix rate limit exceeded errors</li> 14181 </ul> 14182 <h2 id="v1.08---2015-02-04">v1.08 - 2015-02-04</h2> 14183 <ul> 14184 <li>drive: fix subdirectory listing to not list entire drive</li> 14185 <li>drive: Fix SetModTime</li> 14186 <li>dropbox: adapt code to recent library changes</li> 14187 </ul> 14188 <h2 id="v1.07---2014-12-23">v1.07 - 2014-12-23</h2> 14189 <ul> 14190 <li>google cloud storage: fix memory leak</li> 14191 </ul> 14192 <h2 id="v1.06---2014-12-12">v1.06 - 2014-12-12</h2> 14193 <ul> 14194 <li>Fix “Couldn’t find home directory” on OSX</li> 14195 <li>swift: Add tenant parameter</li> 14196 <li>Use new location of Google API packages</li> 14197 </ul> 14198 <h2 id="v1.05---2014-08-09">v1.05 - 2014-08-09</h2> 14199 <ul> 14200 <li>Improved tests and consequently lots of minor fixes</li> 14201 <li>core: Fix race detected by go race detector</li> 14202 <li>core: Fixes after running errcheck</li> 14203 <li>drive: reset root directory on Rmdir and Purge</li> 14204 <li>fs: Document that Purger returns error on empty directory, test and fix</li> 14205 <li>google cloud storage: fix ListDir on subdirectory</li> 14206 <li>google cloud storage: re-read metadata in SetModTime</li> 14207 <li>s3: make reading metadata more reliable to work around eventual consistency problems</li> 14208 <li>s3: strip trailing / from ListDir()</li> 14209 <li>swift: return directories without / in ListDir</li> 14210 </ul> 14211 <h2 id="v1.04---2014-07-21">v1.04 - 2014-07-21</h2> 14212 <ul> 14213 <li>google cloud storage: Fix crash on Update</li> 14214 </ul> 14215 <h2 id="v1.03---2014-07-20">v1.03 - 2014-07-20</h2> 14216 <ul> 14217 <li>swift, s3, dropbox: fix updated files being marked as corrupted</li> 14218 <li>Make compile with go 1.1 again</li> 14219 </ul> 14220 <h2 id="v1.02---2014-07-19">v1.02 - 2014-07-19</h2> 14221 <ul> 14222 <li>Implement Dropbox remote</li> 14223 <li>Implement Google Cloud Storage remote</li> 14224 <li>Verify Md5sums and Sizes after copies</li> 14225 <li>Remove times from “ls” command - lists sizes only</li> 14226 <li>Add add “lsl” - lists times and sizes</li> 14227 <li>Add “md5sum” command</li> 14228 </ul> 14229 <h2 id="v1.01---2014-07-04">v1.01 - 2014-07-04</h2> 14230 <ul> 14231 <li>drive: fix transfer of big files using up lots of memory</li> 14232 </ul> 14233 <h2 id="v1.00---2014-07-03">v1.00 - 2014-07-03</h2> 14234 <ul> 14235 <li>drive: fix whole second dates</li> 14236 </ul> 14237 <h2 id="v0.99---2014-06-26">v0.99 - 2014-06-26</h2> 14238 <ul> 14239 <li>Fix –dry-run not working</li> 14240 <li>Make compatible with go 1.1</li> 14241 </ul> 14242 <h2 id="v0.98---2014-05-30">v0.98 - 2014-05-30</h2> 14243 <ul> 14244 <li>s3: Treat missing Content-Length as 0 for some ceph installations</li> 14245 <li>rclonetest: add file with a space in</li> 14246 </ul> 14247 <h2 id="v0.97---2014-05-05">v0.97 - 2014-05-05</h2> 14248 <ul> 14249 <li>Implement copying of single files</li> 14250 <li>s3 & swift: support paths inside containers/buckets</li> 14251 </ul> 14252 <h2 id="v0.96---2014-04-24">v0.96 - 2014-04-24</h2> 14253 <ul> 14254 <li>drive: Fix multiple files of same name being created</li> 14255 <li>drive: Use o.Update and fs.Put to optimise transfers</li> 14256 <li>Add version number, -V and –version</li> 14257 </ul> 14258 <h2 id="v0.95---2014-03-28">v0.95 - 2014-03-28</h2> 14259 <ul> 14260 <li>rclone.org: website, docs and graphics</li> 14261 <li>drive: fix path parsing</li> 14262 </ul> 14263 <h2 id="v0.94---2014-03-27">v0.94 - 2014-03-27</h2> 14264 <ul> 14265 <li>Change remote format one last time</li> 14266 <li>GNU style flags</li> 14267 </ul> 14268 <h2 id="v0.93---2014-03-16">v0.93 - 2014-03-16</h2> 14269 <ul> 14270 <li>drive: store token in config file</li> 14271 <li>cross compile other versions</li> 14272 <li>set strict permissions on config file</li> 14273 </ul> 14274 <h2 id="v0.92---2014-03-15">v0.92 - 2014-03-15</h2> 14275 <ul> 14276 <li>Config fixes and –config option</li> 14277 </ul> 14278 <h2 id="v0.91---2014-03-15">v0.91 - 2014-03-15</h2> 14279 <ul> 14280 <li>Make config file</li> 14281 </ul> 14282 <h2 id="v0.90---2013-06-27">v0.90 - 2013-06-27</h2> 14283 <ul> 14284 <li>Project named rclone</li> 14285 </ul> 14286 <h2 id="v0.00---2012-11-18">v0.00 - 2012-11-18</h2> 14287 <ul> 14288 <li>Project started</li> 14289 </ul> 14290 <h2 id="bugs-and-limitations">Bugs and Limitations</h2> 14291 <h3 id="empty-directories-are-left-behind-not-created">Empty directories are left behind / not created</h3> 14292 <p>With remotes that have a concept of directory, eg Local and Drive, empty directories may be left behind, or not created when one was expected.</p> 14293 <p>This is because rclone doesn’t have a concept of a directory - it only works on objects. Most of the object storage systems can’t actually store a directory so there is nowhere for rclone to store anything about directories.</p> 14294 <p>You can work round this to some extent with the<code>purge</code> command which will delete everything under the path, <strong>inluding</strong> empty directories.</p> 14295 <p>This may be fixed at some point in <a href="https://github.com/ncw/rclone/issues/100">Issue #100</a></p> 14296 <h3 id="directory-timestamps-arent-preserved">Directory timestamps aren’t preserved</h3> 14297 <p>For the same reason as the above, rclone doesn’t have a concept of a directory - it only works on objects, therefore it can’t preserve the timestamps of directories.</p> 14298 <h2 id="frequently-asked-questions">Frequently Asked Questions</h2> 14299 <h3 id="do-all-cloud-storage-systems-support-all-rclone-commands">Do all cloud storage systems support all rclone commands</h3> 14300 <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> 14301 <h3 id="can-i-copy-the-config-from-one-machine-to-another">Can I copy the config from one machine to another</h3> 14302 <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> 14303 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for more info.</p> 14304 <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> 14305 <p>This has now been documented in its own <a href="https://rclone.org/remote_setup/">remote setup page</a>.</p> 14306 <h3 id="can-rclone-sync-directly-from-drive-to-s3">Can rclone sync directly from drive to s3</h3> 14307 <p>Rclone can sync between two remote cloud storage systems just fine.</p> 14308 <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> 14309 <p>The syncs would be incremental (on a file by file basis).</p> 14310 <p>Eg</p> 14311 <pre><code>rclone sync drive:Folder s3:bucket</code></pre> 14312 <h3 id="using-rclone-from-multiple-locations-at-the-same-time">Using rclone from multiple locations at the same time</h3> 14313 <p>You can use rclone from multiple places at the same time if you choose different subdirectory for the output, eg</p> 14314 <pre><code>Server A> rclone sync /tmp/whatever remote:ServerA 14315 Server B> rclone sync /tmp/whatever remote:ServerB</code></pre> 14316 <p>If you sync to the same directory then you should use rclone copy otherwise the two rclones may delete each others files, eg</p> 14317 <pre><code>Server A> rclone copy /tmp/whatever remote:Backup 14318 Server B> rclone copy /tmp/whatever remote:Backup</code></pre> 14319 <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> 14320 <h3 id="why-doesnt-rclone-support-partial-transfers-binary-diffs-like-rsync">Why doesn’t rclone support partial transfers / binary diffs like rsync?</h3> 14321 <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> 14322 <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> 14323 <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> 14324 <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> 14325 <h3 id="can-rclone-do-bi-directional-sync">Can rclone do bi-directional sync?</h3> 14326 <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> 14327 <h3 id="can-i-use-rclone-with-an-http-proxy">Can I use rclone with an HTTP proxy?</h3> 14328 <p>Yes. rclone will follow the standard environment variables for proxies, similar to cURL and other programs.</p> 14329 <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> 14330 <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> 14331 <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> 14332 <pre><code>export http_proxy=http://proxyserver:12345 14333 export https_proxy=$http_proxy 14334 export HTTP_PROXY=$http_proxy 14335 export HTTPS_PROXY=$http_proxy</code></pre> 14336 <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> 14337 <p>e.g.</p> 14338 <pre><code>export no_proxy=localhost,127.0.0.0/8,my.host.name 14339 export NO_PROXY=$no_proxy</code></pre> 14340 <p>Note that the ftp backend does not support <code>ftp_proxy</code> yet.</p> 14341 <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> 14342 <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> 14343 <p>Rclone (via the Go runtime) tries to load the root certificates from these places on Linux.</p> 14344 <pre><code>"/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu/Gentoo etc. 14345 "/etc/pki/tls/certs/ca-bundle.crt", // Fedora/RHEL 14346 "/etc/ssl/ca-bundle.pem", // OpenSUSE 14347 "/etc/pki/tls/cacert.pem", // OpenELEC</code></pre> 14348 <p>So doing something like this should fix the problem. It also sets the time which is important for SSL to work properly.</p> 14349 <pre><code>mkdir -p /etc/ssl/certs/ 14350 curl -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt 14351 ntpclient -s -h pool.ntp.org</code></pre> 14352 <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 pacakge</a>, provide an additional way to provide the SSL root certificates.</p> 14353 <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> 14354 <pre><code>curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt</code></pre> 14355 <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> 14356 <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> 14357 <p>See the <a href="https://golang.org/doc/install">system requirements section in the go install docs</a> for full details.</p> 14358 <h3 id="all-my-uploaded-docxxlsxpptx-files-appear-as-archivezip">All my uploaded docx/xlsx/pptx files appear as archive/zip</h3> 14359 <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> 14360 <h3 id="tcp-lookup-some.domain.com-no-such-host">tcp lookup some.domain.com no such host</h3> 14361 <p>This happens when rclone cannot resolve a domain. Please check that your DNS setup is generally working, e.g.</p> 14362 <pre><code># both should print a long list of possible IP addresses 14363 dig www.googleapis.com # resolve using your default DNS 14364 dig www.googleapis.com @8.8.8.8 # resolve with Google's DNS server</code></pre> 14365 <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> 14366 <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> 14367 <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> 14368 <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="/docs/#max-backlog-n">–max-backlog</a> flag.</p> 14369 <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> 14370 <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> 14371 <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> 14372 <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> 14373 <h2 id="license">License</h2> 14374 <p>This is free software under the terms of MIT the license (check the COPYING file included with the source code).</p> 14375 <pre><code>Copyright (C) 2012 by Nick Craig-Wood https://www.craig-wood.com/nick/ 14376 14377 Permission is hereby granted, free of charge, to any person obtaining a copy 14378 of this software and associated documentation files (the "Software"), to deal 14379 in the Software without restriction, including without limitation the rights 14380 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 14381 copies of the Software, and to permit persons to whom the Software is 14382 furnished to do so, subject to the following conditions: 14383 14384 The above copyright notice and this permission notice shall be included in 14385 all copies or substantial portions of the Software. 14386 14387 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14388 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 14389 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 14390 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 14391 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 14392 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 14393 THE SOFTWARE.</code></pre> 14394 <h2 id="authors">Authors</h2> 14395 <ul> 14396 <li>Nick Craig-Wood <a href="mailto:nick@craig-wood.com">nick@craig-wood.com</a></li> 14397 </ul> 14398 <h2 id="contributors">Contributors</h2> 14399 <ul> 14400 <li>Alex Couper <a href="mailto:amcouper@gmail.com">amcouper@gmail.com</a></li> 14401 <li>Leonid Shalupov <a href="mailto:leonid@shalupov.com">leonid@shalupov.com</a> <a href="mailto:shalupov@diverse.org.ru">shalupov@diverse.org.ru</a></li> 14402 <li>Shimon Doodkin <a href="mailto:helpmepro1@gmail.com">helpmepro1@gmail.com</a></li> 14403 <li>Colin Nicholson <a href="mailto:colin@colinn.com">colin@colinn.com</a></li> 14404 <li>Klaus Post <a href="mailto:klauspost@gmail.com">klauspost@gmail.com</a></li> 14405 <li>Sergey Tolmachev <a href="mailto:tolsi.ru@gmail.com">tolsi.ru@gmail.com</a></li> 14406 <li>Adriano Aurélio Meirelles <a href="mailto:adriano@atinge.com">adriano@atinge.com</a></li> 14407 <li>C. Bess <a href="mailto:cbess@users.noreply.github.com">cbess@users.noreply.github.com</a></li> 14408 <li>Dmitry Burdeev <a href="mailto:dibu28@gmail.com">dibu28@gmail.com</a></li> 14409 <li>Joseph Spurrier <a href="mailto:github@josephspurrier.com">github@josephspurrier.com</a></li> 14410 <li>Björn Harrtell <a href="mailto:bjorn@wololo.org">bjorn@wololo.org</a></li> 14411 <li>Xavier Lucas <a href="mailto:xavier.lucas@corp.ovh.com">xavier.lucas@corp.ovh.com</a></li> 14412 <li>Werner Beroux <a href="mailto:werner@beroux.com">werner@beroux.com</a></li> 14413 <li>Brian Stengaard <a href="mailto:brian@stengaard.eu">brian@stengaard.eu</a></li> 14414 <li>Jakub Gedeon <a href="mailto:jgedeon@sofi.com">jgedeon@sofi.com</a></li> 14415 <li>Jim Tittsler <a href="mailto:jwt@onjapan.net">jwt@onjapan.net</a></li> 14416 <li>Michal Witkowski <a href="mailto:michal@improbable.io">michal@improbable.io</a></li> 14417 <li>Fabian Ruff <a href="mailto:fabian.ruff@sap.com">fabian.ruff@sap.com</a></li> 14418 <li>Leigh Klotz <a href="mailto:klotz@quixey.com">klotz@quixey.com</a></li> 14419 <li>Romain Lapray <a href="mailto:lapray.romain@gmail.com">lapray.romain@gmail.com</a></li> 14420 <li>Justin R. Wilson <a href="mailto:jrw972@gmail.com">jrw972@gmail.com</a></li> 14421 <li>Antonio Messina <a href="mailto:antonio.s.messina@gmail.com">antonio.s.messina@gmail.com</a></li> 14422 <li>Stefan G. Weichinger <a href="mailto:office@oops.co.at">office@oops.co.at</a></li> 14423 <li>Per Cederberg <a href="mailto:cederberg@gmail.com">cederberg@gmail.com</a></li> 14424 <li>Radek Šenfeld <a href="mailto:rush@logic.cz">rush@logic.cz</a></li> 14425 <li>Fredrik Fornwall <a href="mailto:fredrik@fornwall.net">fredrik@fornwall.net</a></li> 14426 <li>Asko Tamm <a href="mailto:asko@deekit.net">asko@deekit.net</a></li> 14427 <li>xor-zz <a href="mailto:xor@gstocco.com">xor@gstocco.com</a></li> 14428 <li>Tomasz Mazur <a href="mailto:tmazur90@gmail.com">tmazur90@gmail.com</a></li> 14429 <li>Marco Paganini <a href="mailto:paganini@paganini.net">paganini@paganini.net</a></li> 14430 <li>Felix Bünemann <a href="mailto:buenemann@louis.info">buenemann@louis.info</a></li> 14431 <li>Durval Menezes <a href="mailto:jmrclone@durval.com">jmrclone@durval.com</a></li> 14432 <li>Luiz Carlos Rumbelsperger Viana <a href="mailto:maxd13_luiz_carlos@hotmail.com">maxd13_luiz_carlos@hotmail.com</a></li> 14433 <li>Stefan Breunig <a href="mailto:stefan-github@yrden.de">stefan-github@yrden.de</a></li> 14434 <li>Alishan Ladhani <a href="mailto:ali-l@users.noreply.github.com">ali-l@users.noreply.github.com</a></li> 14435 <li>0xJAKE <a href="mailto:0xJAKE@users.noreply.github.com">0xJAKE@users.noreply.github.com</a></li> 14436 <li>Thibault Molleman <a href="mailto:thibaultmol@users.noreply.github.com">thibaultmol@users.noreply.github.com</a></li> 14437 <li>Scott McGillivray <a href="mailto:scott.mcgillivray@gmail.com">scott.mcgillivray@gmail.com</a></li> 14438 <li>Bjørn Erik Pedersen <a href="mailto:bjorn.erik.pedersen@gmail.com">bjorn.erik.pedersen@gmail.com</a></li> 14439 <li>Lukas Loesche <a href="mailto:lukas@mesosphere.io">lukas@mesosphere.io</a></li> 14440 <li>emyarod <a href="mailto:allllaboutyou@gmail.com">allllaboutyou@gmail.com</a></li> 14441 <li>T.C. Ferguson <a href="mailto:tcf909@gmail.com">tcf909@gmail.com</a></li> 14442 <li>Brandur <a href="mailto:brandur@mutelight.org">brandur@mutelight.org</a></li> 14443 <li>Dario Giovannetti <a href="mailto:dev@dariogiovannetti.net">dev@dariogiovannetti.net</a></li> 14444 <li>Károly Oláh <a href="mailto:okaresz@aol.com">okaresz@aol.com</a></li> 14445 <li>Jon Yergatian <a href="mailto:jon@macfanatic.ca">jon@macfanatic.ca</a></li> 14446 <li>Jack Schmidt <a href="mailto:github@mowsey.org">github@mowsey.org</a></li> 14447 <li>Dedsec1 <a href="mailto:Dedsec1@users.noreply.github.com">Dedsec1@users.noreply.github.com</a></li> 14448 <li>Hisham Zarka <a href="mailto:hzarka@gmail.com">hzarka@gmail.com</a></li> 14449 <li>Jérôme Vizcaino <a href="mailto:jerome.vizcaino@gmail.com">jerome.vizcaino@gmail.com</a></li> 14450 <li>Mike Tesch <a href="mailto:mjt6129@rit.edu">mjt6129@rit.edu</a></li> 14451 <li>Marvin Watson <a href="mailto:marvwatson@users.noreply.github.com">marvwatson@users.noreply.github.com</a></li> 14452 <li>Danny Tsai <a href="mailto:danny8376@gmail.com">danny8376@gmail.com</a></li> 14453 <li>Yoni Jah <a href="mailto:yonjah+git@gmail.com">yonjah+git@gmail.com</a> <a href="mailto:yonjah+github@gmail.com">yonjah+github@gmail.com</a></li> 14454 <li>Stephen Harris <a href="mailto:github@spuddy.org">github@spuddy.org</a> <a href="mailto:sweharris@users.noreply.github.com">sweharris@users.noreply.github.com</a></li> 14455 <li>Ihor Dvoretskyi <a href="mailto:ihor.dvoretskyi@gmail.com">ihor.dvoretskyi@gmail.com</a></li> 14456 <li>Jon Craton <a href="mailto:jncraton@gmail.com">jncraton@gmail.com</a></li> 14457 <li>Hraban Luyat <a href="mailto:hraban@0brg.net">hraban@0brg.net</a></li> 14458 <li>Michael Ledin <a href="mailto:mledin89@gmail.com">mledin89@gmail.com</a></li> 14459 <li>Martin Kristensen <a href="mailto:me@azgul.com">me@azgul.com</a></li> 14460 <li>Too Much IO <a href="mailto:toomuchio@users.noreply.github.com">toomuchio@users.noreply.github.com</a></li> 14461 <li>Anisse Astier <a href="mailto:anisse@astier.eu">anisse@astier.eu</a></li> 14462 <li>Zahiar Ahmed <a href="mailto:zahiar@live.com">zahiar@live.com</a></li> 14463 <li>Igor Kharin <a href="mailto:igorkharin@gmail.com">igorkharin@gmail.com</a></li> 14464 <li>Bill Zissimopoulos <a href="mailto:billziss@navimatics.com">billziss@navimatics.com</a></li> 14465 <li>Bob Potter <a href="mailto:bobby.potter@gmail.com">bobby.potter@gmail.com</a></li> 14466 <li>Steven Lu <a href="mailto:tacticalazn@gmail.com">tacticalazn@gmail.com</a></li> 14467 <li>Sjur Fredriksen <a href="mailto:sjurtf@ifi.uio.no">sjurtf@ifi.uio.no</a></li> 14468 <li>Ruwbin <a href="mailto:hubus12345@gmail.com">hubus12345@gmail.com</a></li> 14469 <li>Fabian Möller <a href="mailto:fabianm88@gmail.com">fabianm88@gmail.com</a> <a href="mailto:f.moeller@nynex.de">f.moeller@nynex.de</a></li> 14470 <li>Edward Q. Bridges <a href="mailto:github@eqbridges.com">github@eqbridges.com</a></li> 14471 <li>Vasiliy Tolstov <a href="mailto:v.tolstov@selfip.ru">v.tolstov@selfip.ru</a></li> 14472 <li>Harshavardhana <a href="mailto:harsha@minio.io">harsha@minio.io</a></li> 14473 <li>sainaen <a href="mailto:sainaen@gmail.com">sainaen@gmail.com</a></li> 14474 <li>gdm85 <a href="mailto:gdm85@users.noreply.github.com">gdm85@users.noreply.github.com</a></li> 14475 <li>Yaroslav Halchenko <a href="mailto:debian@onerussian.com">debian@onerussian.com</a></li> 14476 <li>John Papandriopoulos <a href="mailto:jpap@users.noreply.github.com">jpap@users.noreply.github.com</a></li> 14477 <li>Zhiming Wang <a href="mailto:zmwangx@gmail.com">zmwangx@gmail.com</a></li> 14478 <li>Andy Pilate <a href="mailto:cubox@cubox.me">cubox@cubox.me</a></li> 14479 <li>Oliver Heyme <a href="mailto:olihey@googlemail.com">olihey@googlemail.com</a> <a href="mailto:olihey@users.noreply.github.com">olihey@users.noreply.github.com</a> <a href="mailto:de8olihe@lego.com">de8olihe@lego.com</a></li> 14480 <li>wuyu <a href="mailto:wuyu@yunify.com">wuyu@yunify.com</a></li> 14481 <li>Andrei Dragomir <a href="mailto:adragomi@adobe.com">adragomi@adobe.com</a></li> 14482 <li>Christian Brüggemann <a href="mailto:mail@cbruegg.com">mail@cbruegg.com</a></li> 14483 <li>Alex McGrath Kraak <a href="mailto:amkdude@gmail.com">amkdude@gmail.com</a></li> 14484 <li>bpicode <a href="mailto:bjoern.pirnay@googlemail.com">bjoern.pirnay@googlemail.com</a></li> 14485 <li>Daniel Jagszent <a href="mailto:daniel@jagszent.de">daniel@jagszent.de</a></li> 14486 <li>Josiah White <a href="mailto:thegenius2009@gmail.com">thegenius2009@gmail.com</a></li> 14487 <li>Ishuah Kariuki <a href="mailto:kariuki@ishuah.com">kariuki@ishuah.com</a> <a href="mailto:ishuah91@gmail.com">ishuah91@gmail.com</a></li> 14488 <li>Jan Varho <a href="mailto:jan@varho.org">jan@varho.org</a></li> 14489 <li>Girish Ramakrishnan <a href="mailto:girish@cloudron.io">girish@cloudron.io</a></li> 14490 <li>LingMan <a href="mailto:LingMan@users.noreply.github.com">LingMan@users.noreply.github.com</a></li> 14491 <li>Jacob McNamee <a href="mailto:jacobmcnamee@gmail.com">jacobmcnamee@gmail.com</a></li> 14492 <li>jersou <a href="mailto:jertux@gmail.com">jertux@gmail.com</a></li> 14493 <li>thierry <a href="mailto:thierry@substantiel.fr">thierry@substantiel.fr</a></li> 14494 <li>Simon Leinen <a href="mailto:simon.leinen@gmail.com">simon.leinen@gmail.com</a> <a href="mailto:ubuntu@s3-test.novalocal">ubuntu@s3-test.novalocal</a></li> 14495 <li>Dan Dascalescu <a href="mailto:ddascalescu+github@gmail.com">ddascalescu+github@gmail.com</a></li> 14496 <li>Jason Rose <a href="mailto:jason@jro.io">jason@jro.io</a></li> 14497 <li>Andrew Starr-Bochicchio <a href="mailto:a.starr.b@gmail.com">a.starr.b@gmail.com</a></li> 14498 <li>John Leach <a href="mailto:john@johnleach.co.uk">john@johnleach.co.uk</a></li> 14499 <li>Corban Raun <a href="mailto:craun@instructure.com">craun@instructure.com</a></li> 14500 <li>Pierre Carlson <a href="mailto:mpcarl@us.ibm.com">mpcarl@us.ibm.com</a></li> 14501 <li>Ernest Borowski <a href="mailto:er.borowski@gmail.com">er.borowski@gmail.com</a></li> 14502 <li>Remus Bunduc <a href="mailto:remus.bunduc@gmail.com">remus.bunduc@gmail.com</a></li> 14503 <li>Iakov Davydov <a href="mailto:iakov.davydov@unil.ch">iakov.davydov@unil.ch</a> <a href="mailto:dav05.gith@myths.ru">dav05.gith@myths.ru</a></li> 14504 <li>Jakub Tasiemski <a href="mailto:tasiemski@gmail.com">tasiemski@gmail.com</a></li> 14505 <li>David Minor <a href="mailto:dminor@saymedia.com">dminor@saymedia.com</a></li> 14506 <li>Tim Cooijmans <a href="mailto:cooijmans.tim@gmail.com">cooijmans.tim@gmail.com</a></li> 14507 <li>Laurence <a href="mailto:liuxy6@gmail.com">liuxy6@gmail.com</a></li> 14508 <li>Giovanni Pizzi <a href="mailto:gio.piz@gmail.com">gio.piz@gmail.com</a></li> 14509 <li>Filip Bartodziej <a href="mailto:filipbartodziej@gmail.com">filipbartodziej@gmail.com</a></li> 14510 <li>Jon Fautley <a href="mailto:jon@dead.li">jon@dead.li</a></li> 14511 <li>lewapm <a href="mailto:32110057+lewapm@users.noreply.github.com">32110057+lewapm@users.noreply.github.com</a></li> 14512 <li>Yassine Imounachen <a href="mailto:yassine256@gmail.com">yassine256@gmail.com</a></li> 14513 <li>Chris Redekop <a href="mailto:chris-redekop@users.noreply.github.com">chris-redekop@users.noreply.github.com</a> <a href="mailto:chris.redekop@gmail.com">chris.redekop@gmail.com</a></li> 14514 <li>Jon Fautley <a href="mailto:jon@adenoid.appstal.co.uk">jon@adenoid.appstal.co.uk</a></li> 14515 <li>Will Gunn <a href="mailto:WillGunn@users.noreply.github.com">WillGunn@users.noreply.github.com</a></li> 14516 <li>Lucas Bremgartner <a href="mailto:lucas@bremis.ch">lucas@bremis.ch</a></li> 14517 <li>Jody Frankowski <a href="mailto:jody.frankowski@gmail.com">jody.frankowski@gmail.com</a></li> 14518 <li>Andreas Roussos <a href="mailto:arouss1980@gmail.com">arouss1980@gmail.com</a></li> 14519 <li>nbuchanan <a href="mailto:nbuchanan@utah.gov">nbuchanan@utah.gov</a></li> 14520 <li>Durval Menezes <a href="mailto:rclone@durval.com">rclone@durval.com</a></li> 14521 <li>Victor <a href="mailto:vb-github@viblo.se">vb-github@viblo.se</a></li> 14522 <li>Mateusz <a href="mailto:pabian.mateusz@gmail.com">pabian.mateusz@gmail.com</a></li> 14523 <li>Daniel Loader <a href="mailto:spicypixel@gmail.com">spicypixel@gmail.com</a></li> 14524 <li>David0rk <a href="mailto:davidork@gmail.com">davidork@gmail.com</a></li> 14525 <li>Alexander Neumann <a href="mailto:alexander@bumpern.de">alexander@bumpern.de</a></li> 14526 <li>Giri Badanahatti <a href="mailto:gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local">gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local</a></li> 14527 <li>Leo R. Lundgren <a href="mailto:leo@finalresort.org">leo@finalresort.org</a></li> 14528 <li>wolfv <a href="mailto:wolfv6@users.noreply.github.com">wolfv6@users.noreply.github.com</a></li> 14529 <li>Dave Pedu <a href="mailto:dave@davepedu.com">dave@davepedu.com</a></li> 14530 <li>Stefan Lindblom <a href="mailto:lindblom@spotify.com">lindblom@spotify.com</a></li> 14531 <li>seuffert <a href="mailto:oliver@seuffert.biz">oliver@seuffert.biz</a></li> 14532 <li>gbadanahatti <a href="mailto:37121690+gbadanahatti@users.noreply.github.com">37121690+gbadanahatti@users.noreply.github.com</a></li> 14533 <li>Keith Goldfarb <a href="mailto:barkofdelight@gmail.com">barkofdelight@gmail.com</a></li> 14534 <li>Steve Kriss <a href="mailto:steve@heptio.com">steve@heptio.com</a></li> 14535 <li>Chih-Hsuan Yen <a href="mailto:yan12125@gmail.com">yan12125@gmail.com</a></li> 14536 <li>Alexander Neumann <a href="mailto:fd0@users.noreply.github.com">fd0@users.noreply.github.com</a></li> 14537 <li>Matt Holt <a href="mailto:mholt@users.noreply.github.com">mholt@users.noreply.github.com</a></li> 14538 <li>Eri Bastos <a href="mailto:bastos.eri@gmail.com">bastos.eri@gmail.com</a></li> 14539 <li>Michael P. Dubner <a href="mailto:pywebmail@list.ru">pywebmail@list.ru</a></li> 14540 <li>Antoine GIRARD <a href="mailto:sapk@users.noreply.github.com">sapk@users.noreply.github.com</a></li> 14541 <li>Mateusz Piotrowski <a href="mailto:mpp302@gmail.com">mpp302@gmail.com</a></li> 14542 <li>Animosity022 <a href="mailto:animosity22@users.noreply.github.com">animosity22@users.noreply.github.com</a> <a href="mailto:earl.texter@gmail.com">earl.texter@gmail.com</a></li> 14543 <li>Peter Baumgartner <a href="mailto:pete@lincolnloop.com">pete@lincolnloop.com</a></li> 14544 <li>Craig Rachel <a href="mailto:craig@craigrachel.com">craig@craigrachel.com</a></li> 14545 <li>Michael G. Noll <a href="mailto:miguno@users.noreply.github.com">miguno@users.noreply.github.com</a></li> 14546 <li>hensur <a href="mailto:me@hensur.de">me@hensur.de</a></li> 14547 <li>Oliver Heyme <a href="mailto:de8olihe@lego.com">de8olihe@lego.com</a></li> 14548 <li>Richard Yang <a href="mailto:richard@yenforyang.com">richard@yenforyang.com</a></li> 14549 <li>Piotr Oleszczyk <a href="mailto:piotr.oleszczyk@gmail.com">piotr.oleszczyk@gmail.com</a></li> 14550 <li>Rodrigo <a href="mailto:rodarima@gmail.com">rodarima@gmail.com</a></li> 14551 <li>NoLooseEnds <a href="mailto:NoLooseEnds@users.noreply.github.com">NoLooseEnds@users.noreply.github.com</a></li> 14552 <li>Jakub Karlicek <a href="mailto:jakub@karlicek.me">jakub@karlicek.me</a></li> 14553 <li>John Clayton <a href="mailto:john@codemonkeylabs.com">john@codemonkeylabs.com</a></li> 14554 <li>Kasper Byrdal Nielsen <a href="mailto:byrdal76@gmail.com">byrdal76@gmail.com</a></li> 14555 <li>Benjamin Joseph Dag <a href="mailto:bjdag1234@users.noreply.github.com">bjdag1234@users.noreply.github.com</a></li> 14556 <li>themylogin <a href="mailto:themylogin@gmail.com">themylogin@gmail.com</a></li> 14557 <li>Onno Zweers <a href="mailto:onno.zweers@surfsara.nl">onno.zweers@surfsara.nl</a></li> 14558 <li>Jasper Lievisse Adriaanse <a href="mailto:jasper@humppa.nl">jasper@humppa.nl</a></li> 14559 <li>sandeepkru <a href="mailto:sandeep.ummadi@gmail.com">sandeep.ummadi@gmail.com</a> <a href="mailto:sandeepkru@users.noreply.github.com">sandeepkru@users.noreply.github.com</a></li> 14560 <li>HerrH <a href="mailto:atomtigerzoo@users.noreply.github.com">atomtigerzoo@users.noreply.github.com</a></li> 14561 <li>Andrew <a href="mailto:4030760+sparkyman215@users.noreply.github.com">4030760+sparkyman215@users.noreply.github.com</a></li> 14562 <li>dan smith <a href="mailto:XX1011@gmail.com">XX1011@gmail.com</a></li> 14563 <li>Oleg Kovalov <a href="mailto:iamolegkovalov@gmail.com">iamolegkovalov@gmail.com</a></li> 14564 <li>Ruben Vandamme <a href="mailto:github-com-00ff86@vandamme.email">github-com-00ff86@vandamme.email</a></li> 14565 <li>Cnly <a href="mailto:minecnly@gmail.com">minecnly@gmail.com</a></li> 14566 <li>Andres Alvarez <a href="mailto:1671935+kir4h@users.noreply.github.com">1671935+kir4h@users.noreply.github.com</a></li> 14567 <li>reddi1 <a href="mailto:xreddi@gmail.com">xreddi@gmail.com</a></li> 14568 <li>Matt Tucker <a href="mailto:matthewtckr@gmail.com">matthewtckr@gmail.com</a></li> 14569 <li>Sebastian Bünger <a href="mailto:buengese@gmail.com">buengese@gmail.com</a></li> 14570 <li>Martin Polden <a href="mailto:mpolden@mpolden.no">mpolden@mpolden.no</a></li> 14571 <li>Alex Chen <a href="mailto:Cnly@users.noreply.github.com">Cnly@users.noreply.github.com</a></li> 14572 <li>Denis <a href="mailto:deniskovpen@gmail.com">deniskovpen@gmail.com</a></li> 14573 <li>bsteiss <a href="mailto:35940619+bsteiss@users.noreply.github.com">35940619+bsteiss@users.noreply.github.com</a></li> 14574 <li>Cédric Connes <a href="mailto:cedric.connes@gmail.com">cedric.connes@gmail.com</a></li> 14575 <li>Dr. Tobias Quathamer <a href="mailto:toddy15@users.noreply.github.com">toddy15@users.noreply.github.com</a></li> 14576 <li>dcpu <a href="mailto:42736967+dcpu@users.noreply.github.com">42736967+dcpu@users.noreply.github.com</a></li> 14577 <li>Sheldon Rupp <a href="mailto:me@shel.io">me@shel.io</a></li> 14578 <li>albertony <a href="mailto:12441419+albertony@users.noreply.github.com">12441419+albertony@users.noreply.github.com</a></li> 14579 <li>cron410 <a href="mailto:cron410@gmail.com">cron410@gmail.com</a></li> 14580 <li>Anagh Kumar Baranwal <a href="mailto:anaghk.dos@gmail.com">anaghk.dos@gmail.com</a></li> 14581 <li>Felix Brucker <a href="mailto:felix@felixbrucker.com">felix@felixbrucker.com</a></li> 14582 <li>Santiago Rodríguez <a href="mailto:scollazo@users.noreply.github.com">scollazo@users.noreply.github.com</a></li> 14583 <li>Craig Miskell <a href="mailto:craig.miskell@fluxfederation.com">craig.miskell@fluxfederation.com</a></li> 14584 <li>Antoine GIRARD <a href="mailto:sapk@sapk.fr">sapk@sapk.fr</a></li> 14585 <li>Joanna Marek <a href="mailto:joanna.marek@u2i.com">joanna.marek@u2i.com</a></li> 14586 <li>frenos <a href="mailto:frenos@users.noreply.github.com">frenos@users.noreply.github.com</a></li> 14587 <li>ssaqua <a href="mailto:ssaqua@users.noreply.github.com">ssaqua@users.noreply.github.com</a></li> 14588 <li>xnaas <a href="mailto:me@xnaas.info">me@xnaas.info</a></li> 14589 <li>Frantisek Fuka <a href="mailto:fuka@fuxoft.cz">fuka@fuxoft.cz</a></li> 14590 <li>Paul Kohout <a href="mailto:pauljkohout@yahoo.com">pauljkohout@yahoo.com</a></li> 14591 <li>dcpu <a href="mailto:43330287+dcpu@users.noreply.github.com">43330287+dcpu@users.noreply.github.com</a></li> 14592 <li>jackyzy823 <a href="mailto:jackyzy823@gmail.com">jackyzy823@gmail.com</a></li> 14593 <li>David Haguenauer <a href="mailto:ml@kurokatta.org">ml@kurokatta.org</a></li> 14594 <li>teresy <a href="mailto:hi.teresy@gmail.com">hi.teresy@gmail.com</a></li> 14595 <li>buergi <a href="mailto:patbuergi@gmx.de">patbuergi@gmx.de</a></li> 14596 <li>Florian Gamboeck <a href="mailto:mail@floga.de">mail@floga.de</a></li> 14597 <li>Ralf Hemberger <a href="mailto:10364191+rhemberger@users.noreply.github.com">10364191+rhemberger@users.noreply.github.com</a></li> 14598 <li>Scott Edlund <a href="mailto:sedlund@users.noreply.github.com">sedlund@users.noreply.github.com</a></li> 14599 <li>Erik Swanson <a href="mailto:erik@retailnext.net">erik@retailnext.net</a></li> 14600 <li>Jake Coggiano <a href="mailto:jake@stripe.com">jake@stripe.com</a></li> 14601 <li>brused27 <a href="mailto:brused27@noemailaddress">brused27@noemailaddress</a></li> 14602 <li>Peter Kaminski <a href="mailto:kaminski@istori.com">kaminski@istori.com</a></li> 14603 <li>Henry Ptasinski <a href="mailto:henry@logout.com">henry@logout.com</a></li> 14604 <li>Alexander <a href="mailto:kharkovalexander@gmail.com">kharkovalexander@gmail.com</a></li> 14605 <li>Garry McNulty <a href="mailto:garrmcnu@gmail.com">garrmcnu@gmail.com</a></li> 14606 <li>Mathieu Carbou <a href="mailto:mathieu.carbou@gmail.com">mathieu.carbou@gmail.com</a></li> 14607 <li>Mark Otway <a href="mailto:mark@otway.com">mark@otway.com</a></li> 14608 <li>William Cocker <a href="mailto:37018962+WilliamCocker@users.noreply.github.com">37018962+WilliamCocker@users.noreply.github.com</a></li> 14609 <li>François Leurent <a href="mailto:131.js@cloudyks.org">131.js@cloudyks.org</a></li> 14610 <li>Arkadius Stefanski <a href="mailto:arkste@gmail.com">arkste@gmail.com</a></li> 14611 <li>Jay <a href="mailto:dev@jaygoel.com">dev@jaygoel.com</a></li> 14612 <li>andrea rota <a href="mailto:a@xelera.eu">a@xelera.eu</a></li> 14613 <li>nicolov <a href="mailto:nicolov@users.noreply.github.com">nicolov@users.noreply.github.com</a></li> 14614 <li>Dario Guzik <a href="mailto:dario@guzik.com.ar">dario@guzik.com.ar</a></li> 14615 <li>qip <a href="mailto:qip@users.noreply.github.com">qip@users.noreply.github.com</a></li> 14616 <li>yair@unicorn <a href="mailto:yair@unicorn">yair@unicorn</a></li> 14617 <li>Matt Robinson <a href="mailto:brimstone@the.narro.ws">brimstone@the.narro.ws</a></li> 14618 <li>kayrus <a href="mailto:kay.diam@gmail.com">kay.diam@gmail.com</a></li> 14619 <li>Rémy Léone <a href="mailto:remy.leone@gmail.com">remy.leone@gmail.com</a></li> 14620 <li>Wojciech Smigielski <a href="mailto:wojciech.hieronim.smigielski@gmail.com">wojciech.hieronim.smigielski@gmail.com</a></li> 14621 <li>weetmuts <a href="mailto:oehrstroem@gmail.com">oehrstroem@gmail.com</a></li> 14622 <li>Jonathan <a href="mailto:vanillajonathan@users.noreply.github.com">vanillajonathan@users.noreply.github.com</a></li> 14623 <li>James Carpenter <a href="mailto:orbsmiv@users.noreply.github.com">orbsmiv@users.noreply.github.com</a></li> 14624 <li>Vince <a href="mailto:vince0villamora@gmail.com">vince0villamora@gmail.com</a></li> 14625 <li>Nestar47 <a href="mailto:47841759+Nestar47@users.noreply.github.com">47841759+Nestar47@users.noreply.github.com</a></li> 14626 <li>Six <a href="mailto:brbsix@gmail.com">brbsix@gmail.com</a></li> 14627 <li>Alexandru Bumbacea <a href="mailto:alexandru.bumbacea@booking.com">alexandru.bumbacea@booking.com</a></li> 14628 <li>calisro <a href="mailto:robert.calistri@gmail.com">robert.calistri@gmail.com</a></li> 14629 <li>Dr.Rx <a href="mailto:david.rey@nventive.com">david.rey@nventive.com</a></li> 14630 <li>marcintustin <a href="mailto:marcintustin@users.noreply.github.com">marcintustin@users.noreply.github.com</a></li> 14631 <li>jaKa Močnik <a href="mailto:jaka@koofr.net">jaka@koofr.net</a></li> 14632 <li>Fionera <a href="mailto:fionera@fionera.de">fionera@fionera.de</a></li> 14633 <li>Dan Walters <a href="mailto:dan@walters.io">dan@walters.io</a></li> 14634 <li>Danil Semelenov <a href="mailto:sgtpep@users.noreply.github.com">sgtpep@users.noreply.github.com</a></li> 14635 <li>xopez <a href="mailto:28950736+xopez@users.noreply.github.com">28950736+xopez@users.noreply.github.com</a></li> 14636 <li>Ben Boeckel <a href="mailto:mathstuf@gmail.com">mathstuf@gmail.com</a></li> 14637 <li>Manu <a href="mailto:manu@snapdragon.cc">manu@snapdragon.cc</a></li> 14638 <li>Kyle E. Mitchell <a href="mailto:kyle@kemitchell.com">kyle@kemitchell.com</a></li> 14639 <li>Gary Kim <a href="mailto:gary@garykim.dev">gary@garykim.dev</a></li> 14640 <li>Jon <a href="mailto:jonathn@github.com">jonathn@github.com</a></li> 14641 <li>Jeff Quinn <a href="mailto:jeffrey.quinn@bluevoyant.com">jeffrey.quinn@bluevoyant.com</a></li> 14642 <li>Peter Berbec <a href="mailto:peter@berbec.com">peter@berbec.com</a></li> 14643 <li>didil <a href="mailto:1284255+didil@users.noreply.github.com">1284255+didil@users.noreply.github.com</a></li> 14644 <li>id01 <a href="mailto:gaviniboom@gmail.com">gaviniboom@gmail.com</a></li> 14645 <li>Robert Marko <a href="mailto:robimarko@gmail.com">robimarko@gmail.com</a></li> 14646 <li>Philip Harvey <a href="mailto:32467456+pharveybattelle@users.noreply.github.com">32467456+pharveybattelle@users.noreply.github.com</a></li> 14647 <li>JorisE <a href="mailto:JorisE@users.noreply.github.com">JorisE@users.noreply.github.com</a></li> 14648 <li>garry415 <a href="mailto:garry.415@gmail.com">garry.415@gmail.com</a></li> 14649 <li>forgems <a href="mailto:forgems@gmail.com">forgems@gmail.com</a></li> 14650 <li>Florian Apolloner <a href="mailto:florian@apolloner.eu">florian@apolloner.eu</a></li> 14651 <li>Aleksandar Jankovic <a href="mailto:office@ajankovic.com">office@ajankovic.com</a></li> 14652 </ul> 14653 <h1 id="contact-the-rclone-project">Contact the rclone project</h1> 14654 <h2 id="forum">Forum</h2> 14655 <p>Forum for questions and general discussion:</p> 14656 <ul> 14657 <li>https://forum.rclone.org</li> 14658 </ul> 14659 <h2 id="gitub-project">Gitub project</h2> 14660 <p>The project website is at:</p> 14661 <ul> 14662 <li>https://github.com/ncw/rclone</li> 14663 </ul> 14664 <p>There you can file bug reports or contribute pull requests.</p> 14665 <h2 id="twitter">Twitter</h2> 14666 <p>You can also follow me on twitter for rclone announcements:</p> 14667 <ul> 14668 <li><span class="citation" data-cites="njcw">[@njcw]</span>(https://twitter.com/njcw)</li> 14669 </ul> 14670 <h2 id="email">Email</h2> 14671 <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></p> 14672 </body> 14673 </html>